xref: /petsc/src/dm/interface/dm.c (revision 5227eafbd66137d7b48012ee1940397bca0f0f51)
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};
252cbb9b06SVaclav Hapla const char *const DMCopyLabelsModes[] = {"replace","keep","fail","DMCopyLabelsMode","DM_COPY_LABELS_", NULL};
2660c22052SBarry Smith 
27a4121054SBarry Smith /*@
28de043629SMatthew G Knepley   DMCreate - Creates an empty DM object. The type can then be set with DMSetType().
29a4121054SBarry Smith 
30a4121054SBarry Smith    If you never  call DMSetType()  it will generate an
31a4121054SBarry Smith    error when you try to use the vector.
32a4121054SBarry Smith 
33d083f849SBarry Smith   Collective
34a4121054SBarry Smith 
35a4121054SBarry Smith   Input Parameter:
36a4121054SBarry Smith . comm - The communicator for the DM object
37a4121054SBarry Smith 
38a4121054SBarry Smith   Output Parameter:
39a4121054SBarry Smith . dm - The DM object
40a4121054SBarry Smith 
41a4121054SBarry Smith   Level: beginner
42a4121054SBarry Smith 
438472ad0fSDave May .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK
44a4121054SBarry Smith @*/
457087cfbeSBarry Smith PetscErrorCode  DMCreate(MPI_Comm comm,DM *dm)
46a4121054SBarry Smith {
47a4121054SBarry Smith   DM             v;
48e5e52638SMatthew G. Knepley   PetscDS        ds;
49a4121054SBarry Smith   PetscErrorCode ierr;
50a4121054SBarry Smith 
51a4121054SBarry Smith   PetscFunctionBegin;
521411c6eeSJed Brown   PetscValidPointer(dm,2);
530298fd71SBarry Smith   *dm = NULL;
54607a6623SBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
55a4121054SBarry Smith 
5673107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr);
57e7c4fc90SDmitry Karpeev 
5849be4549SMatthew G. Knepley   v->setupcalled              = PETSC_FALSE;
5949be4549SMatthew G. Knepley   v->setfromoptionscalled     = PETSC_FALSE;
600298fd71SBarry Smith   v->ltogmap                  = NULL;
61a4ea9b21SRichard Tran Mills   v->bind_below               = 0;
621411c6eeSJed Brown   v->bs                       = 1;
63171400e9SBarry Smith   v->coloringtype             = IS_COLORING_GLOBAL;
6488ed4aceSMatthew G Knepley   ierr                        = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr);
651bb6d2a8SBarry Smith   ierr                        = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr);
66c58f1c22SToby Isaac   v->labels                   = NULL;
6734aa8a36SMatthew G. Knepley   v->adjacency[0]             = PETSC_FALSE;
6834aa8a36SMatthew G. Knepley   v->adjacency[1]             = PETSC_TRUE;
69c58f1c22SToby Isaac   v->depthLabel               = NULL;
70ba2698f1SMatthew G. Knepley   v->celltypeLabel            = NULL;
711bb6d2a8SBarry Smith   v->localSection             = NULL;
721bb6d2a8SBarry Smith   v->globalSection            = NULL;
73fba222abSToby Isaac   v->defaultConstraintSection = NULL;
74fba222abSToby Isaac   v->defaultConstraintMat     = NULL;
75c6b900c6SMatthew G. Knepley   v->L                        = NULL;
76c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
775dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
789a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
7996173672SStefano Zampini   v->dim                      = PETSC_DETERMINE;
80435a35e8SMatthew G Knepley   {
81435a35e8SMatthew G Knepley     PetscInt i;
82435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
830298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
84f9d4088aSMatthew G. Knepley       v->nearnullspaceConstructors[i] = NULL;
85435a35e8SMatthew G Knepley     }
86435a35e8SMatthew G Knepley   }
8745480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
88b3cf3223SMatthew G. Knepley   ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr);
89e5e52638SMatthew G. Knepley   ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
909a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxCreate(&v->auxData);CHKERRQ(ierr);
9114f150ffSMatthew G. Knepley   v->dmBC = NULL;
92a8fb8f29SToby Isaac   v->coarseMesh = NULL;
93f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
94cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
95c0dedaeaSBarry Smith   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
96b412c318SBarry Smith   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
974a7a4c06SLawrence Mitchell 
981411c6eeSJed Brown   *dm = v;
99a4121054SBarry Smith   PetscFunctionReturn(0);
100a4121054SBarry Smith }
101a4121054SBarry Smith 
10238221697SMatthew G. Knepley /*@
10338221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
10438221697SMatthew G. Knepley 
105d083f849SBarry Smith   Collective
10638221697SMatthew G. Knepley 
10738221697SMatthew G. Knepley   Input Parameter:
10838221697SMatthew G. Knepley . dm - The original DM object
10938221697SMatthew G. Knepley 
11038221697SMatthew G. Knepley   Output Parameter:
11138221697SMatthew G. Knepley . newdm  - The new DM object
11238221697SMatthew G. Knepley 
11338221697SMatthew G. Knepley   Level: beginner
11438221697SMatthew G. Knepley 
1151cb8cacdSPatrick Sanan   Notes:
1161cb8cacdSPatrick Sanan   For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example,
1171cb8cacdSPatrick Sanan   DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not
1181cb8cacdSPatrick Sanan   share the PetscSection of the original DM.
1191bb6d2a8SBarry Smith 
12089706ed2SPatrick Sanan   The clone is considered set up iff the original is.
12189706ed2SPatrick Sanan 
12292cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection()
1231bb6d2a8SBarry Smith 
12438221697SMatthew G. Knepley @*/
12538221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
12638221697SMatthew G. Knepley {
12738221697SMatthew G. Knepley   PetscSF        sf;
12838221697SMatthew G. Knepley   Vec            coords;
12938221697SMatthew G. Knepley   void          *ctx;
130a3219837SMatthew G. Knepley   PetscInt       dim, cdim;
13138221697SMatthew G. Knepley   PetscErrorCode ierr;
13238221697SMatthew G. Knepley 
13338221697SMatthew G. Knepley   PetscFunctionBegin;
13438221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
13538221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
13638221697SMatthew G. Knepley   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
1372cbb9b06SVaclav Hapla   ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE, DM_COPY_LABELS_FAIL);CHKERRQ(ierr);
138ddf8437dSMatthew G. Knepley   (*newdm)->leveldown  = dm->leveldown;
139ddf8437dSMatthew G. Knepley   (*newdm)->levelup    = dm->levelup;
140c8a6034eSMark   (*newdm)->prealloc_only = dm->prealloc_only;
141a587d139SMark   ierr = PetscFree((*newdm)->vectype);CHKERRQ(ierr);
142a587d139SMark   ierr = PetscStrallocpy(dm->vectype,(char**)&(*newdm)->vectype);CHKERRQ(ierr);
143a587d139SMark   ierr = PetscFree((*newdm)->mattype);CHKERRQ(ierr);
144a587d139SMark   ierr = PetscStrallocpy(dm->mattype,(char**)&(*newdm)->mattype);CHKERRQ(ierr);
1451de53e9aSMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
1461de53e9aSMatthew G. Knepley   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
14738221697SMatthew G. Knepley   if (dm->ops->clone) {
14838221697SMatthew G. Knepley     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
14938221697SMatthew G. Knepley   }
1503f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
15138221697SMatthew G. Knepley   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
15238221697SMatthew G. Knepley   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
15338221697SMatthew G. Knepley   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
15438221697SMatthew G. Knepley   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
155be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
156be4c1c3eSMatthew G. Knepley     DM           ncdm;
157be4c1c3eSMatthew G. Knepley     PetscSection cs;
1585a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
159be4c1c3eSMatthew G. Knepley 
16092fd8e1eSJed Brown     ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
161be4c1c3eSMatthew G. Knepley     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
162ffc4695bSBarry Smith     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
1635a0206caSToby Isaac     if (pEndMax >= 0) {
164be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
16583bfc06fSMatthew Knepley       ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr);
16692fd8e1eSJed Brown       ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr);
167a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
168be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
169be4c1c3eSMatthew G. Knepley     }
170be4c1c3eSMatthew G. Knepley   }
171a3219837SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
172a3219837SMatthew G. Knepley   ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr);
17338221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
17438221697SMatthew G. Knepley   if (coords) {
17538221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
17638221697SMatthew G. Knepley   } else {
17738221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
17838221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
17938221697SMatthew G. Knepley   }
18090b157c4SStefano Zampini   {
18190b157c4SStefano Zampini     PetscBool             isper;
182c6b900c6SMatthew G. Knepley     const PetscReal      *maxCell, *L;
1835dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
18490b157c4SStefano Zampini     ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
18590b157c4SStefano Zampini     ierr = DMSetPeriodicity(*newdm, isper, maxCell,  L,  bd);CHKERRQ(ierr);
186c6b900c6SMatthew G. Knepley   }
18734aa8a36SMatthew G. Knepley   {
18834aa8a36SMatthew G. Knepley     PetscBool useCone, useClosure;
18934aa8a36SMatthew G. Knepley 
19034aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr);
19134aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
19234aa8a36SMatthew G. Knepley   }
19338221697SMatthew G. Knepley   PetscFunctionReturn(0);
19438221697SMatthew G. Knepley }
19538221697SMatthew G. Knepley 
1969a42bb27SBarry Smith /*@C
197564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1989a42bb27SBarry Smith 
199d083f849SBarry Smith    Logically Collective on da
2009a42bb27SBarry Smith 
2019a42bb27SBarry Smith    Input Parameter:
2029a42bb27SBarry Smith +  da - initial distributed array
203e9e886b6SKarl Rupp .  ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL
2049a42bb27SBarry Smith 
2059a42bb27SBarry Smith    Options Database:
206dd85299cSBarry Smith .   -dm_vec_type ctype
2079a42bb27SBarry Smith 
2089a42bb27SBarry Smith    Level: intermediate
2099a42bb27SBarry Smith 
210a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType()
2119a42bb27SBarry Smith @*/
21219fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
2139a42bb27SBarry Smith {
2149a42bb27SBarry Smith   PetscErrorCode ierr;
2159a42bb27SBarry Smith 
2169a42bb27SBarry Smith   PetscFunctionBegin;
2179a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
2189a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
21919fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
2209a42bb27SBarry Smith   PetscFunctionReturn(0);
2219a42bb27SBarry Smith }
2229a42bb27SBarry Smith 
223c0dedaeaSBarry Smith /*@C
224c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
225c0dedaeaSBarry Smith 
226d083f849SBarry Smith    Logically Collective on da
227c0dedaeaSBarry Smith 
228c0dedaeaSBarry Smith    Input Parameter:
229c0dedaeaSBarry Smith .  da - initial distributed array
230c0dedaeaSBarry Smith 
231c0dedaeaSBarry Smith    Output Parameter:
232c0dedaeaSBarry Smith .  ctype - the vector type
233c0dedaeaSBarry Smith 
234c0dedaeaSBarry Smith    Level: intermediate
235c0dedaeaSBarry Smith 
236a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType()
237c0dedaeaSBarry Smith @*/
238c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
239c0dedaeaSBarry Smith {
240c0dedaeaSBarry Smith   PetscFunctionBegin;
241c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
242c0dedaeaSBarry Smith   *ctype = da->vectype;
243c0dedaeaSBarry Smith   PetscFunctionReturn(0);
244c0dedaeaSBarry Smith }
245c0dedaeaSBarry Smith 
2465f1ad066SMatthew G Knepley /*@
24734f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2485f1ad066SMatthew G Knepley 
2495f1ad066SMatthew G Knepley   Not collective
2505f1ad066SMatthew G Knepley 
2515f1ad066SMatthew G Knepley   Input Parameter:
2525f1ad066SMatthew G Knepley . v - The Vec
2535f1ad066SMatthew G Knepley 
2545f1ad066SMatthew G Knepley   Output Parameter:
2555f1ad066SMatthew G Knepley . dm - The DM
2565f1ad066SMatthew G Knepley 
2575f1ad066SMatthew G Knepley   Level: intermediate
2585f1ad066SMatthew G Knepley 
2595f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2605f1ad066SMatthew G Knepley @*/
2615f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2625f1ad066SMatthew G Knepley {
2635f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2645f1ad066SMatthew G Knepley 
2655f1ad066SMatthew G Knepley   PetscFunctionBegin;
2665f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2675f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2685f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2695f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2705f1ad066SMatthew G Knepley }
2715f1ad066SMatthew G Knepley 
2725f1ad066SMatthew G Knepley /*@
273d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2745f1ad066SMatthew G Knepley 
2755f1ad066SMatthew G Knepley   Not collective
2765f1ad066SMatthew G Knepley 
2775f1ad066SMatthew G Knepley   Input Parameters:
2785f1ad066SMatthew G Knepley + v - The Vec
2795f1ad066SMatthew G Knepley - dm - The DM
2805f1ad066SMatthew G Knepley 
281d9805387SMatthew 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.
282d9805387SMatthew G. Knepley 
2835f1ad066SMatthew G Knepley   Level: intermediate
2845f1ad066SMatthew G Knepley 
2855f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2865f1ad066SMatthew G Knepley @*/
2875f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2885f1ad066SMatthew G Knepley {
2895f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2905f1ad066SMatthew G Knepley 
2915f1ad066SMatthew G Knepley   PetscFunctionBegin;
2925f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
293d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2945f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2955f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2965f1ad066SMatthew G Knepley }
2975f1ad066SMatthew G Knepley 
298521d9a4cSLisandro Dalcin /*@C
2998f1509bcSBarry Smith        DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM
3008f1509bcSBarry Smith 
301d083f849SBarry Smith    Logically Collective on dm
3028f1509bcSBarry Smith 
3038f1509bcSBarry Smith    Input Parameters:
3048f1509bcSBarry Smith +  dm - the DM context
3058f1509bcSBarry Smith -  ctype - the matrix type
3068f1509bcSBarry Smith 
3078f1509bcSBarry Smith    Options Database:
3088f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3098f1509bcSBarry Smith 
3108f1509bcSBarry Smith    Level: intermediate
3118f1509bcSBarry Smith 
3128f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3138f1509bcSBarry Smith           DMGetISColoringType()
3148f1509bcSBarry Smith @*/
3158f1509bcSBarry Smith PetscErrorCode  DMSetISColoringType(DM dm,ISColoringType ctype)
3168f1509bcSBarry Smith {
3178f1509bcSBarry Smith   PetscFunctionBegin;
3188f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3198f1509bcSBarry Smith   dm->coloringtype = ctype;
3208f1509bcSBarry Smith   PetscFunctionReturn(0);
3218f1509bcSBarry Smith }
3228f1509bcSBarry Smith 
3238f1509bcSBarry Smith /*@C
3248f1509bcSBarry Smith        DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM
325521d9a4cSLisandro Dalcin 
326d083f849SBarry Smith    Logically Collective on dm
327521d9a4cSLisandro Dalcin 
328521d9a4cSLisandro Dalcin    Input Parameter:
3298f1509bcSBarry Smith .  dm - the DM context
3308f1509bcSBarry Smith 
3318f1509bcSBarry Smith    Output Parameter:
3328f1509bcSBarry Smith .  ctype - the matrix type
3338f1509bcSBarry Smith 
3348f1509bcSBarry Smith    Options Database:
3358f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3368f1509bcSBarry Smith 
3378f1509bcSBarry Smith    Level: intermediate
3388f1509bcSBarry Smith 
3398f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3408f1509bcSBarry Smith           DMGetISColoringType()
3418f1509bcSBarry Smith @*/
3428f1509bcSBarry Smith PetscErrorCode  DMGetISColoringType(DM dm,ISColoringType *ctype)
3438f1509bcSBarry Smith {
3448f1509bcSBarry Smith   PetscFunctionBegin;
3458f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3468f1509bcSBarry Smith   *ctype = dm->coloringtype;
3478f1509bcSBarry Smith   PetscFunctionReturn(0);
3488f1509bcSBarry Smith }
3498f1509bcSBarry Smith 
3508f1509bcSBarry Smith /*@C
3518f1509bcSBarry Smith        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
3528f1509bcSBarry Smith 
353d083f849SBarry Smith    Logically Collective on dm
3548f1509bcSBarry Smith 
3558f1509bcSBarry Smith    Input Parameters:
356521d9a4cSLisandro Dalcin +  dm - the DM context
357a2b5a043SBarry Smith -  ctype - the matrix type
358521d9a4cSLisandro Dalcin 
359521d9a4cSLisandro Dalcin    Options Database:
360521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
361521d9a4cSLisandro Dalcin 
362521d9a4cSLisandro Dalcin    Level: intermediate
363521d9a4cSLisandro Dalcin 
364a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType()
365521d9a4cSLisandro Dalcin @*/
36619fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
367521d9a4cSLisandro Dalcin {
368521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
36988f0584fSBarry Smith 
370521d9a4cSLisandro Dalcin   PetscFunctionBegin;
371521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
372521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
37319fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
374521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
375521d9a4cSLisandro Dalcin }
376521d9a4cSLisandro Dalcin 
377c0dedaeaSBarry Smith /*@C
378c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
379c0dedaeaSBarry Smith 
380d083f849SBarry Smith    Logically Collective on dm
381c0dedaeaSBarry Smith 
382c0dedaeaSBarry Smith    Input Parameter:
383c0dedaeaSBarry Smith .  dm - the DM context
384c0dedaeaSBarry Smith 
385c0dedaeaSBarry Smith    Output Parameter:
386c0dedaeaSBarry Smith .  ctype - the matrix type
387c0dedaeaSBarry Smith 
388c0dedaeaSBarry Smith    Options Database:
389c0dedaeaSBarry Smith .   -dm_mat_type ctype
390c0dedaeaSBarry Smith 
391c0dedaeaSBarry Smith    Level: intermediate
392c0dedaeaSBarry Smith 
393a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType()
394c0dedaeaSBarry Smith @*/
395c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
396c0dedaeaSBarry Smith {
397c0dedaeaSBarry Smith   PetscFunctionBegin;
398c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
399c0dedaeaSBarry Smith   *ctype = dm->mattype;
400c0dedaeaSBarry Smith   PetscFunctionReturn(0);
401c0dedaeaSBarry Smith }
402c0dedaeaSBarry Smith 
403c688c046SMatthew G Knepley /*@
40434f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
405c688c046SMatthew G Knepley 
406c688c046SMatthew G Knepley   Not collective
407c688c046SMatthew G Knepley 
408c688c046SMatthew G Knepley   Input Parameter:
409c688c046SMatthew G Knepley . A - The Mat
410c688c046SMatthew G Knepley 
411c688c046SMatthew G Knepley   Output Parameter:
412c688c046SMatthew G Knepley . dm - The DM
413c688c046SMatthew G Knepley 
414c688c046SMatthew G Knepley   Level: intermediate
415c688c046SMatthew G Knepley 
4168f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4178f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4188f1509bcSBarry Smith 
419c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
420c688c046SMatthew G Knepley @*/
421c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
422c688c046SMatthew G Knepley {
423c688c046SMatthew G Knepley   PetscErrorCode ierr;
424c688c046SMatthew G Knepley 
425c688c046SMatthew G Knepley   PetscFunctionBegin;
426c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
427c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
428c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
429c688c046SMatthew G Knepley   PetscFunctionReturn(0);
430c688c046SMatthew G Knepley }
431c688c046SMatthew G Knepley 
432c688c046SMatthew G Knepley /*@
433c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
434c688c046SMatthew G Knepley 
435c688c046SMatthew G Knepley   Not collective
436c688c046SMatthew G Knepley 
437c688c046SMatthew G Knepley   Input Parameters:
438c688c046SMatthew G Knepley + A - The Mat
439c688c046SMatthew G Knepley - dm - The DM
440c688c046SMatthew G Knepley 
441c688c046SMatthew G Knepley   Level: intermediate
442c688c046SMatthew G Knepley 
4438f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4448f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4458f1509bcSBarry Smith 
446c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
447c688c046SMatthew G Knepley @*/
448c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
449c688c046SMatthew G Knepley {
450c688c046SMatthew G Knepley   PetscErrorCode ierr;
451c688c046SMatthew G Knepley 
452c688c046SMatthew G Knepley   PetscFunctionBegin;
453c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4548865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
455c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
456c688c046SMatthew G Knepley   PetscFunctionReturn(0);
457c688c046SMatthew G Knepley }
458c688c046SMatthew G Knepley 
4599a42bb27SBarry Smith /*@C
4609a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
4616757b960SDave May    DM options in the database.
4629a42bb27SBarry Smith 
463d083f849SBarry Smith    Logically Collective on dm
4649a42bb27SBarry Smith 
465d8d19677SJose E. Roman    Input Parameters:
4668353ddbbSDave May +  da - the DM context
4679a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
4689a42bb27SBarry Smith 
4699a42bb27SBarry Smith    Notes:
4709a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4719a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
4729a42bb27SBarry Smith 
4739a42bb27SBarry Smith    Level: advanced
4749a42bb27SBarry Smith 
4759a42bb27SBarry Smith .seealso: DMSetFromOptions()
4769a42bb27SBarry Smith @*/
4777087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
4789a42bb27SBarry Smith {
4799a42bb27SBarry Smith   PetscErrorCode ierr;
4809a42bb27SBarry Smith 
4819a42bb27SBarry Smith   PetscFunctionBegin;
4829a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4839a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
484691be533SLawrence Mitchell   if (dm->sf) {
485691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
486691be533SLawrence Mitchell   }
4871bb6d2a8SBarry Smith   if (dm->sectionSF) {
4881bb6d2a8SBarry Smith     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr);
489691be533SLawrence Mitchell   }
4909a42bb27SBarry Smith   PetscFunctionReturn(0);
4919a42bb27SBarry Smith }
4929a42bb27SBarry Smith 
49331697293SDave May /*@C
49431697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
49531697293SDave May    DM options in the database.
49631697293SDave May 
497d083f849SBarry Smith    Logically Collective on dm
49831697293SDave May 
49931697293SDave May    Input Parameters:
50031697293SDave May +  dm - the DM context
50131697293SDave May -  prefix - the prefix string to prepend to all DM option requests
50231697293SDave May 
50331697293SDave May    Notes:
50431697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
50531697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
50631697293SDave May 
50731697293SDave May    Level: advanced
50831697293SDave May 
50931697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
51031697293SDave May @*/
51131697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
51231697293SDave May {
51331697293SDave May   PetscErrorCode ierr;
51431697293SDave May 
51531697293SDave May   PetscFunctionBegin;
51631697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
51731697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
51831697293SDave May   PetscFunctionReturn(0);
51931697293SDave May }
52031697293SDave May 
52131697293SDave May /*@C
52231697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
52331697293SDave May    DM options in the database.
52431697293SDave May 
52531697293SDave May    Not Collective
52631697293SDave May 
52731697293SDave May    Input Parameters:
52831697293SDave May .  dm - the DM context
52931697293SDave May 
53031697293SDave May    Output Parameters:
53131697293SDave May .  prefix - pointer to the prefix string used is returned
53231697293SDave May 
53395452b02SPatrick Sanan    Notes:
53495452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prefix' of
53531697293SDave May    sufficient length to hold the prefix.
53631697293SDave May 
53731697293SDave May    Level: advanced
53831697293SDave May 
53931697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
54031697293SDave May @*/
54131697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
54231697293SDave May {
54331697293SDave May   PetscErrorCode ierr;
54431697293SDave May 
54531697293SDave May   PetscFunctionBegin;
54631697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
54731697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
54831697293SDave May   PetscFunctionReturn(0);
54931697293SDave May }
55031697293SDave May 
55188bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
55288bdff64SToby Isaac {
5536eb26441SStefano Zampini   PetscInt       refct = ((PetscObject) dm)->refct;
55488bdff64SToby Isaac   PetscErrorCode ierr;
55588bdff64SToby Isaac 
55688bdff64SToby Isaac   PetscFunctionBegin;
557aab5bcd8SJed Brown   *ncrefct = 0;
55888bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
55988bdff64SToby Isaac     refct--;
56088bdff64SToby Isaac     if (recurseCoarse) {
56188bdff64SToby Isaac       PetscInt coarseCount;
56288bdff64SToby Isaac 
56388bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
56488bdff64SToby Isaac       refct += coarseCount;
56588bdff64SToby Isaac     }
56688bdff64SToby Isaac   }
56788bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
56888bdff64SToby Isaac     refct--;
56988bdff64SToby Isaac     if (recurseFine) {
57088bdff64SToby Isaac       PetscInt fineCount;
57188bdff64SToby Isaac 
57288bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
57388bdff64SToby Isaac       refct += fineCount;
57488bdff64SToby Isaac     }
57588bdff64SToby Isaac   }
57688bdff64SToby Isaac   *ncrefct = refct;
57788bdff64SToby Isaac   PetscFunctionReturn(0);
57888bdff64SToby Isaac }
57988bdff64SToby Isaac 
580f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm)
581354557abSToby Isaac {
5825d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
583354557abSToby Isaac   PetscErrorCode ierr;
584354557abSToby Isaac 
585354557abSToby Isaac   PetscFunctionBegin;
586354557abSToby Isaac   /* destroy the labels */
587354557abSToby Isaac   while (next) {
588354557abSToby Isaac     DMLabelLink tmp = next->next;
589354557abSToby Isaac 
5905d80c0bfSVaclav Hapla     if (next->label == dm->depthLabel)    dm->depthLabel    = NULL;
591ba2698f1SMatthew G. Knepley     if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL;
592354557abSToby Isaac     ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
593354557abSToby Isaac     ierr = PetscFree(next);CHKERRQ(ierr);
594354557abSToby Isaac     next = tmp;
595354557abSToby Isaac   }
5965d80c0bfSVaclav Hapla   dm->labels = NULL;
597354557abSToby Isaac   PetscFunctionReturn(0);
598354557abSToby Isaac }
599354557abSToby Isaac 
6001fb7b255SJunchao Zhang /*@C
6018472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
60247c6ae99SBarry Smith 
603d083f849SBarry Smith     Collective on dm
60447c6ae99SBarry Smith 
60547c6ae99SBarry Smith     Input Parameter:
60647c6ae99SBarry Smith .   dm - the DM object to destroy
60747c6ae99SBarry Smith 
60847c6ae99SBarry Smith     Level: developer
60947c6ae99SBarry Smith 
610e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
61147c6ae99SBarry Smith 
61247c6ae99SBarry Smith @*/
613fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
61447c6ae99SBarry Smith {
6156eb26441SStefano Zampini   PetscInt       cnt;
616dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
61747c6ae99SBarry Smith   PetscErrorCode ierr;
61847c6ae99SBarry Smith 
61947c6ae99SBarry Smith   PetscFunctionBegin;
6206bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
6216bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
62287e657c6SBarry Smith 
62388bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
62488bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
62588bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
626ea78f98cSLisandro Dalcin   if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);}
6276bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
6286bf464f9SBarry Smith   ((PetscObject)(*dm))->refct = 0;
6296eb26441SStefano Zampini 
6306eb26441SStefano Zampini   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6316eb26441SStefano Zampini   ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr);
6326eb26441SStefano Zampini 
633f490541aSPeter Brune   nnext=(*dm)->namedglobal;
6340298fd71SBarry Smith   (*dm)->namedglobal = NULL;
635f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
6362348bcf4SPeter Brune     nnext = nlink->next;
6372c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
6382348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
6392348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
6402348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
6412348bcf4SPeter Brune   }
642f490541aSPeter Brune   nnext=(*dm)->namedlocal;
6430298fd71SBarry Smith   (*dm)->namedlocal = NULL;
644f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
645f490541aSPeter Brune     nnext = nlink->next;
6462c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
647f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
648f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
649f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
650f490541aSPeter Brune   }
6512348bcf4SPeter Brune 
652b17ce1afSJed Brown   /* Destroy the list of hooks */
653c833c3b5SJed Brown   {
654c833c3b5SJed Brown     DMCoarsenHookLink link,next;
655b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
656b17ce1afSJed Brown       next = link->next;
657b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
658b17ce1afSJed Brown     }
6590298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
660c833c3b5SJed Brown   }
661c833c3b5SJed Brown   {
662c833c3b5SJed Brown     DMRefineHookLink link,next;
663c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
664c833c3b5SJed Brown       next = link->next;
665c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
666c833c3b5SJed Brown     }
6670298fd71SBarry Smith     (*dm)->refinehook = NULL;
668c833c3b5SJed Brown   }
669be081cd6SPeter Brune   {
670be081cd6SPeter Brune     DMSubDomainHookLink link,next;
671be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
672be081cd6SPeter Brune       next = link->next;
673be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
674be081cd6SPeter Brune     }
6750298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
676be081cd6SPeter Brune   }
677baf369e7SPeter Brune   {
678baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
679baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
680baf369e7SPeter Brune       next = link->next;
681baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
682baf369e7SPeter Brune     }
6830298fd71SBarry Smith     (*dm)->gtolhook = NULL;
684baf369e7SPeter Brune   }
685d4d07f1eSToby Isaac   {
686d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
687d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
688d4d07f1eSToby Isaac       next = link->next;
689d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
690d4d07f1eSToby Isaac     }
691d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
692d4d07f1eSToby Isaac   }
693aa1993deSMatthew G Knepley   /* Destroy the work arrays */
694aa1993deSMatthew G Knepley   {
695aa1993deSMatthew G Knepley     DMWorkLink link,next;
6962c71b3e2SJacob Faibussowitsch     PetscCheckFalse((*dm)->workout,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
697aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
698aa1993deSMatthew G Knepley       next = link->next;
699aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
700aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
701aa1993deSMatthew G Knepley     }
7020298fd71SBarry Smith     (*dm)->workin = NULL;
703aa1993deSMatthew G Knepley   }
704c58f1c22SToby Isaac   /* destroy the labels */
705f4cdcedcSVaclav Hapla   ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr);
706f4cdcedcSVaclav Hapla   /* destroy the fields */
707e5e52638SMatthew G. Knepley   ierr = DMClearFields(*dm);CHKERRQ(ierr);
708f4cdcedcSVaclav Hapla   /* destroy the boundaries */
709e6f8dbb6SToby Isaac   {
710e6f8dbb6SToby Isaac     DMBoundary next = (*dm)->boundary;
711e6f8dbb6SToby Isaac     while (next) {
712e6f8dbb6SToby Isaac       DMBoundary b = next;
713e6f8dbb6SToby Isaac 
714e6f8dbb6SToby Isaac       next = b->next;
715e6f8dbb6SToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
716e6f8dbb6SToby Isaac     }
717e6f8dbb6SToby Isaac   }
718b17ce1afSJed Brown 
71952536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
72052536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
72152536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
72252536dc3SBarry Smith 
7231a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
7241a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
7251a266240SBarry Smith   }
72671cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
7276bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
7286bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
729073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
73088ed4aceSMatthew G Knepley 
7311bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr);
7321bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr);
7338b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
734fba222abSToby Isaac   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
735fba222abSToby Isaac   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
73688ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
7371bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr);
738736995cdSBlaise Bourdin   if ((*dm)->useNatural) {
739736995cdSBlaise Bourdin     if ((*dm)->sfNatural) {
7408e4ac7eaSMatthew G. Knepley       ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
741736995cdSBlaise Bourdin     }
742736995cdSBlaise Bourdin     ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr);
743736995cdSBlaise Bourdin   }
7449a2a23afSMatthew G. Knepley   {
7459a2a23afSMatthew G. Knepley     Vec     *auxData;
7469a2a23afSMatthew G. Knepley     PetscInt n, i, off = 0;
7479a2a23afSMatthew G. Knepley 
7489a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxGetSize((*dm)->auxData, &n);CHKERRQ(ierr);
7499a2a23afSMatthew G. Knepley     ierr = PetscMalloc1(n, &auxData);CHKERRQ(ierr);
7509a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxGetVals((*dm)->auxData, &off, auxData);CHKERRQ(ierr);
7519a2a23afSMatthew G. Knepley     for (i = 0; i < n; ++i) {ierr = VecDestroy(&auxData[i]);CHKERRQ(ierr);}
7529a2a23afSMatthew G. Knepley     ierr = PetscFree(auxData);CHKERRQ(ierr);
7539a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxDestroy(&(*dm)->auxData);CHKERRQ(ierr);
7549a2a23afSMatthew G. Knepley   }
75588bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
75688bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
75788bdff64SToby Isaac   }
7586eb26441SStefano Zampini 
759a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
76088bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
76188bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
76288bdff64SToby Isaac   }
76388bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
764f19dbd58SToby Isaac   ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr);
7656636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
7666636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
7676636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
768412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->L);CHKERRQ(ierr);
769412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr);
770412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr);
771ca3d3a14SMatthew G. Knepley   if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);}
772ca3d3a14SMatthew G. Knepley   ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr);
773ca3d3a14SMatthew G. Knepley   ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr);
7746636e97aSMatthew G Knepley 
775e5e52638SMatthew G. Knepley   ierr = DMClearDS(*dm);CHKERRQ(ierr);
77614f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
777e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
778e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
779732e2eb9SMatthew G Knepley 
780ed3c66a1SDave May   if ((*dm)->ops->destroy) {
7816bf464f9SBarry Smith     ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
782ed3c66a1SDave May   }
783c0f0dcc3SMatthew G. Knepley   ierr = DMMonitorCancel(*dm);CHKERRQ(ierr);
784f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
785a2c9b50fSJeremy L Thompson   ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ_CEED(ierr);
786a2c9b50fSJeremy L Thompson   ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ_CEED(ierr);
787f918ec44SMatthew G. Knepley #endif
788435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
789732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
79047c6ae99SBarry Smith   PetscFunctionReturn(0);
79147c6ae99SBarry Smith }
79247c6ae99SBarry Smith 
793d7bf68aeSBarry Smith /*@
794d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
795d7bf68aeSBarry Smith 
796d083f849SBarry Smith     Collective on dm
797d7bf68aeSBarry Smith 
798d7bf68aeSBarry Smith     Input Parameter:
799d7bf68aeSBarry Smith .   dm - the DM object to setup
800d7bf68aeSBarry Smith 
801d7bf68aeSBarry Smith     Level: developer
802d7bf68aeSBarry Smith 
803e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
804d7bf68aeSBarry Smith 
805d7bf68aeSBarry Smith @*/
8067087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
807d7bf68aeSBarry Smith {
808d7bf68aeSBarry Smith   PetscErrorCode ierr;
809d7bf68aeSBarry Smith 
810d7bf68aeSBarry Smith   PetscFunctionBegin;
811171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8128387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
813d7bf68aeSBarry Smith   if (dm->ops->setup) {
814d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
815d7bf68aeSBarry Smith   }
8168387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
817d7bf68aeSBarry Smith   PetscFunctionReturn(0);
818d7bf68aeSBarry Smith }
819d7bf68aeSBarry Smith 
820d7bf68aeSBarry Smith /*@
821d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
822d7bf68aeSBarry Smith 
823d083f849SBarry Smith     Collective on dm
824d7bf68aeSBarry Smith 
825d7bf68aeSBarry Smith     Input Parameter:
826d7bf68aeSBarry Smith .   dm - the DM object to set options for
827d7bf68aeSBarry Smith 
828732e2eb9SMatthew G Knepley     Options Database:
8294164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
8304164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
8314164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
832a4ea9b21SRichard Tran Mills .   -dm_is_coloring_type - <global or local>
833a4ea9b21SRichard Tran Mills -   -dm_bind_below <n>   - bind (force execution on CPU) for Vec and Mat objects with local size (number of vector entries or matrix rows) below n; currently only supported for DMDA
834732e2eb9SMatthew G Knepley 
8359318fe57SMatthew G. Knepley     DMPLEX Specific creation options
8369318fe57SMatthew G. Knepley + -dm_plex_filename <str>           - File containing a mesh
8379318fe57SMatthew G. Knepley . -dm_plex_boundary_filename <str>  - File containing a mesh boundary
838cd7e8a5eSksagiyam . -dm_plex_name <str>               - Name of the mesh in the file
8399318fe57SMatthew G. Knepley . -dm_plex_shape <shape>            - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc.
8409318fe57SMatthew G. Knepley . -dm_plex_cell <ct>                - Cell shape
8419318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain
8429318fe57SMatthew G. Knepley . -dm_plex_dim <dim>                - Set the topological dimension
8439318fe57SMatthew G. Knepley . -dm_plex_simplex <bool>           - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements
8449318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool>       - PETSC_TRUE turns on topological interpolation (creating edges and faces)
8459318fe57SMatthew G. Knepley . -dm_plex_scale <sc>               - Scale factor for mesh coordinates
8469318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p>        - Number of faces along each dimension
8479318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z>        - Specify lower-left-bottom coordinates for the box
8489318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z>        - Specify upper-right-top coordinates for the box
8499318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz>        - Specify the DMBoundaryType for each direction
8509318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r>        - The sphere radius
8519318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r>          - Radius of the ball
8529318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz>         - Boundary type in the z direction
8539318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n>  - Number of wedges around the cylinder
854bdf63967SMatthew G. Knepley . -dm_plex_reorder <order>          - Reorder the mesh using the specified algorithm
8559318fe57SMatthew G. Knepley . -dm_refine_pre <n>                - The number of refinements before distribution
8569318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool>     - Flag for uniform refinement before distribution
8579318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v>   - The maximum cell volume after refinement before distribution
8589318fe57SMatthew G. Knepley . -dm_refine <n>                    - The number of refinements after distribution
859bdf63967SMatthew G. Knepley . -dm_extrude <l>                   - Activate extrusion and specify the number of layers to extrude
860d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thickness <t>           - The total thickness of extruded layers
861d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_use_tensor <bool>       - Use tensor cells when extruding
862d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_symmetric <bool>        - Extrude layers symmetrically about the surface
863d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_normal <n0,...,nd>      - Specify the extrusion direction
864d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thicknesses <t0,...,tl> - Specify thickness of each layer
865909dfd52SMatthew G. Knepley . -dm_plex_create_fv_ghost_cells    - Flag to create finite volume ghost cells on the boundary
866909dfd52SMatthew G. Knepley . -dm_plex_fv_ghost_cells_label <name> - Label name for ghost cells boundary
8679318fe57SMatthew G. Knepley . -dm_distribute <bool>             - Flag to redistribute a mesh among processes
8689318fe57SMatthew G. Knepley . -dm_distribute_overlap <n>        - The size of the overlap halo
8699318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool>          - Set adjacency direction
8709318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool>       - Set adjacency size
8719318fe57SMatthew G. Knepley 
872384a6580SVaclav Hapla     DMPLEX Specific Checks
873384a6580SVaclav Hapla +   -dm_plex_check_symmetry        - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry()
874384a6580SVaclav Hapla .   -dm_plex_check_skeleton        - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton()
875384a6580SVaclav 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()
876384a6580SVaclav Hapla .   -dm_plex_check_geometry        - Check that cells have positive volume - DMPlexCheckGeometry()
877384a6580SVaclav Hapla .   -dm_plex_check_pointsf         - Check some necessary conditions for PointSF - DMPlexCheckPointSF()
878384a6580SVaclav Hapla .   -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones()
879384a6580SVaclav Hapla -   -dm_plex_check_all             - Perform all the checks above
880d7bf68aeSBarry Smith 
88195eb5ee5SVaclav Hapla     Level: intermediate
88295eb5ee5SVaclav Hapla 
88395eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(),
88495eb5ee5SVaclav Hapla     DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones()
885d7bf68aeSBarry Smith 
886d7bf68aeSBarry Smith @*/
8877087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm)
888d7bf68aeSBarry Smith {
8897781c08eSBarry Smith   char           typeName[256];
890ca266f36SBarry Smith   PetscBool      flg;
891d7bf68aeSBarry Smith   PetscErrorCode ierr;
892d7bf68aeSBarry Smith 
893d7bf68aeSBarry Smith   PetscFunctionBegin;
894171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
89549be4549SMatthew G. Knepley   dm->setfromoptionscalled = PETSC_TRUE;
89649be4549SMatthew G. Knepley   if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);}
8971bb6d2a8SBarry Smith   if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);}
8983194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
8990298fd71SBarry 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);
900a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
901f9ba7244SBarry Smith   if (flg) {
902f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
903f9ba7244SBarry Smith   }
904a264d7a6SBarry 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);
905073dac72SJed Brown   if (flg) {
906521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
907073dac72SJed Brown   }
9088f1509bcSBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
909a4ea9b21SRichard Tran Mills   ierr = PetscOptionsInt("-dm_bind_below","Set the size threshold (in entries) below which the Vec is bound to the CPU","VecBindToCPU",dm->bind_below,&dm->bind_below,&flg);CHKERRQ(ierr);
910f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
911e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
912f9ba7244SBarry Smith   }
913f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
9140633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
91582fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
916d7bf68aeSBarry Smith   PetscFunctionReturn(0);
917d7bf68aeSBarry Smith }
918d7bf68aeSBarry Smith 
919fc9bc008SSatish Balay /*@C
920fe2efc57SMark    DMViewFromOptions - View from Options
921fe2efc57SMark 
922fe2efc57SMark    Collective on DM
923fe2efc57SMark 
924fe2efc57SMark    Input Parameters:
925fe2efc57SMark +  dm - the DM object
926736c3998SJose E. Roman .  obj - Optional object
927736c3998SJose E. Roman -  name - command line option
928fe2efc57SMark 
929fe2efc57SMark    Level: intermediate
930fe2efc57SMark .seealso:  DM, DMView, PetscObjectViewFromOptions(), DMCreate()
931fe2efc57SMark @*/
932fe2efc57SMark PetscErrorCode  DMViewFromOptions(DM dm,PetscObject obj,const char name[])
933fe2efc57SMark {
934fe2efc57SMark   PetscErrorCode ierr;
935fe2efc57SMark 
936fe2efc57SMark   PetscFunctionBegin;
937fe2efc57SMark   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
938fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr);
939fe2efc57SMark   PetscFunctionReturn(0);
940fe2efc57SMark }
941fe2efc57SMark 
942fe2efc57SMark /*@C
943224748a4SBarry Smith     DMView - Views a DM
94447c6ae99SBarry Smith 
945d083f849SBarry Smith     Collective on dm
94647c6ae99SBarry Smith 
947d8d19677SJose E. Roman     Input Parameters:
94847c6ae99SBarry Smith +   dm - the DM object to view
94947c6ae99SBarry Smith -   v - the viewer
95047c6ae99SBarry Smith 
951cd7e8a5eSksagiyam     Notes:
952cd7e8a5eSksagiyam     Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex
953cd7e8a5eSksagiyam     meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName()
954cd7e8a5eSksagiyam     before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object.
955cd7e8a5eSksagiyam 
956224748a4SBarry Smith     Level: beginner
95747c6ae99SBarry Smith 
958cd7e8a5eSksagiyam .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMLoad(), PetscObjectSetName()
95947c6ae99SBarry Smith 
96047c6ae99SBarry Smith @*/
9617087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
96247c6ae99SBarry Smith {
96347c6ae99SBarry Smith   PetscErrorCode    ierr;
96432c0f0efSBarry Smith   PetscBool         isbinary;
96576a8abe0SBarry Smith   PetscMPIInt       size;
96676a8abe0SBarry Smith   PetscViewerFormat format;
96747c6ae99SBarry Smith 
96847c6ae99SBarry Smith   PetscFunctionBegin;
969171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9703014e516SBarry Smith   if (!v) {
971ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
9723014e516SBarry Smith   }
973b1b135c8SBarry Smith   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2);
97474903a4fSStefano Zampini   /* Ideally, we would like to have this test on.
97574903a4fSStefano Zampini      However, it currently breaks socket viz via GLVis.
97674903a4fSStefano Zampini      During DMView(parallel_mesh,glvis_viewer), each
97774903a4fSStefano Zampini      process opens a sequential ASCII socket to visualize
97874903a4fSStefano Zampini      the local mesh, and PetscObjectView(dm,local_socket)
97974903a4fSStefano Zampini      is internally called inside VecView_GLVis, incurring
98074903a4fSStefano Zampini      in an error here */
98174903a4fSStefano Zampini   /* PetscCheckSameComm(dm,1,v,2); */
9828bfd1ab9SVaclav Hapla   ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr);
983b1b135c8SBarry Smith 
98476a8abe0SBarry Smith   ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr);
985ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRMPI(ierr);
98676a8abe0SBarry Smith   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0);
98798c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
98832c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
98932c0f0efSBarry Smith   if (isbinary) {
99055849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
99132c0f0efSBarry Smith     char     type[256];
99232c0f0efSBarry Smith 
993f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr);
99432c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
995f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr);
99632c0f0efSBarry Smith   }
9970c010503SBarry Smith   if (dm->ops->view) {
9980c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
99947c6ae99SBarry Smith   }
100047c6ae99SBarry Smith   PetscFunctionReturn(0);
100147c6ae99SBarry Smith }
100247c6ae99SBarry Smith 
100347c6ae99SBarry Smith /*@
10048472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
100547c6ae99SBarry Smith 
1006d083f849SBarry Smith     Collective on dm
100747c6ae99SBarry Smith 
100847c6ae99SBarry Smith     Input Parameter:
100947c6ae99SBarry Smith .   dm - the DM object
101047c6ae99SBarry Smith 
101147c6ae99SBarry Smith     Output Parameter:
101247c6ae99SBarry Smith .   vec - the global vector
101347c6ae99SBarry Smith 
1014073dac72SJed Brown     Level: beginner
101547c6ae99SBarry Smith 
1016ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
101747c6ae99SBarry Smith 
101847c6ae99SBarry Smith @*/
10197087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
102047c6ae99SBarry Smith {
102147c6ae99SBarry Smith   PetscErrorCode ierr;
102247c6ae99SBarry Smith 
102347c6ae99SBarry Smith   PetscFunctionBegin;
1024171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1025b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
10262c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createglobalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name);
102747c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
102876bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1029c6b011d8SStefano Zampini     DM vdm;
1030c6b011d8SStefano Zampini 
1031c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
10322c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name);
1033c6b011d8SStefano Zampini   }
103447c6ae99SBarry Smith   PetscFunctionReturn(0);
103547c6ae99SBarry Smith }
103647c6ae99SBarry Smith 
103747c6ae99SBarry Smith /*@
10388472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
103947c6ae99SBarry Smith 
104047c6ae99SBarry Smith     Not Collective
104147c6ae99SBarry Smith 
104247c6ae99SBarry Smith     Input Parameter:
104347c6ae99SBarry Smith .   dm - the DM object
104447c6ae99SBarry Smith 
104547c6ae99SBarry Smith     Output Parameter:
104647c6ae99SBarry Smith .   vec - the local vector
104747c6ae99SBarry Smith 
1048073dac72SJed Brown     Level: beginner
104947c6ae99SBarry Smith 
1050ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
105147c6ae99SBarry Smith 
105247c6ae99SBarry Smith @*/
10537087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
105447c6ae99SBarry Smith {
105547c6ae99SBarry Smith   PetscErrorCode ierr;
105647c6ae99SBarry Smith 
105747c6ae99SBarry Smith   PetscFunctionBegin;
1058171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1059b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
10602c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createlocalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name);
106147c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
106276bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1063c6b011d8SStefano Zampini     DM vdm;
1064c6b011d8SStefano Zampini 
1065c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
10662c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name);
1067c6b011d8SStefano Zampini   }
106847c6ae99SBarry Smith   PetscFunctionReturn(0);
106947c6ae99SBarry Smith }
107047c6ae99SBarry Smith 
10711411c6eeSJed Brown /*@
10721411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
10731411c6eeSJed Brown 
1074d083f849SBarry Smith    Collective on dm
10751411c6eeSJed Brown 
10761411c6eeSJed Brown    Input Parameter:
10771411c6eeSJed Brown .  dm - the DM that provides the mapping
10781411c6eeSJed Brown 
10791411c6eeSJed Brown    Output Parameter:
10801411c6eeSJed Brown .  ltog - the mapping
10811411c6eeSJed Brown 
10821411c6eeSJed Brown    Level: intermediate
10831411c6eeSJed Brown 
10841411c6eeSJed Brown    Notes:
10851411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
10861411c6eeSJed Brown    MatSetLocalToGlobalMapping().
10871411c6eeSJed Brown 
1088fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
10891411c6eeSJed Brown @*/
10907087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
10911411c6eeSJed Brown {
10920be3e97aSMatthew G. Knepley   PetscInt       bs = -1, bsLocal[2], bsMinMax[2];
10931411c6eeSJed Brown   PetscErrorCode ierr;
10941411c6eeSJed Brown 
10951411c6eeSJed Brown   PetscFunctionBegin;
10961411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
10971411c6eeSJed Brown   PetscValidPointer(ltog,2);
10981411c6eeSJed Brown   if (!dm->ltogmap) {
109937d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
110037d0c07bSMatthew G Knepley 
110192fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
110237d0c07bSMatthew G Knepley     if (section) {
1103a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
110437d0c07bSMatthew G Knepley       PetscInt       *ltog;
1105ccf3bd66SMatthew G. Knepley       PetscInt        pStart, pEnd, n, p, k, l;
110637d0c07bSMatthew G Knepley 
1107e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
110837d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
1109ccf3bd66SMatthew G. Knepley       ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr);
1110ccf3bd66SMatthew G. Knepley       ierr = PetscMalloc1(n, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
111137d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
1112e6befd46SJed Brown         PetscInt bdof, cdof, dof, off, c, cind;
111337d0c07bSMatthew G Knepley 
111437d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
111537d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
1116a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
1117a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
111837d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
11191a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
11201a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
11211a7dc684SMatthew G. Knepley         if (dof) {
1122b190aa46SMatthew G. Knepley           if (bs < 0)          {bs = bdof;}
1123b190aa46SMatthew G. Knepley           else if (bs != bdof) {bs = 1;}
11241a7dc684SMatthew G. Knepley         }
1125*5227eafbSStefano Zampini 
1126e6befd46SJed Brown         for (c = 0, cind = 0; c < dof; ++c, ++l) {
1127*5227eafbSStefano Zampini           if (cind < cdof && c == cdofs[cind]) {
1128e6befd46SJed Brown             ltog[l] = off < 0 ? off-c : -(off+c+1);
1129e6befd46SJed Brown             cind++;
1130e6befd46SJed Brown           } else {
1131*5227eafbSStefano Zampini             ltog[l] = (off < 0 ? -(off+1) : off) + c - cind;
1132e6befd46SJed Brown           }
113337d0c07bSMatthew G Knepley         }
113437d0c07bSMatthew G Knepley       }
1135bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
11360be3e97aSMatthew G. Knepley       bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs;
11370be3e97aSMatthew G. Knepley       ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr);
11380be3e97aSMatthew G. Knepley       if (bsMinMax[0] != bsMinMax[1]) {bs = 1;}
11390be3e97aSMatthew G. Knepley       else                            {bs = bsMinMax[0];}
11407591dbb2SMatthew G. Knepley       bs = bs < 0 ? 1 : bs;
11417591dbb2SMatthew G. Knepley       /* Must reduce indices by blocksize */
1142ccf3bd66SMatthew G. Knepley       if (bs > 1) {
1143ca469d19SJed Brown         for (l = 0, k = 0; l < n; l += bs, ++k) {
1144ca469d19SJed Brown           // Integer division of negative values truncates toward zero(!), not toward negative infinity
1145ca469d19SJed Brown           ltog[k] = ltog[l] >= 0 ? ltog[l]/bs : -(-(ltog[l]+1)/bs + 1);
1146ca469d19SJed Brown         }
1147ccf3bd66SMatthew G. Knepley         n /= bs;
1148ccf3bd66SMatthew G. Knepley       }
1149ccf3bd66SMatthew G. Knepley       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
11503bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
115137d0c07bSMatthew G Knepley     } else {
11522c71b3e2SJacob Faibussowitsch       PetscCheckFalse(!dm->ops->getlocaltoglobalmapping,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name);
1153184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
11541411c6eeSJed Brown     }
115537d0c07bSMatthew G Knepley   }
11561411c6eeSJed Brown   *ltog = dm->ltogmap;
11571411c6eeSJed Brown   PetscFunctionReturn(0);
11581411c6eeSJed Brown }
11591411c6eeSJed Brown 
11601411c6eeSJed Brown /*@
11611411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
11621411c6eeSJed Brown 
11631411c6eeSJed Brown    Not Collective
11641411c6eeSJed Brown 
11651411c6eeSJed Brown    Input Parameter:
11661411c6eeSJed Brown .  dm - the DM with block structure
11671411c6eeSJed Brown 
11681411c6eeSJed Brown    Output Parameter:
11691411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
11701411c6eeSJed Brown 
11711411c6eeSJed Brown    Level: intermediate
11721411c6eeSJed Brown 
1173fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
11741411c6eeSJed Brown @*/
11757087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
11761411c6eeSJed Brown {
11771411c6eeSJed Brown   PetscFunctionBegin;
11781411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1179534a8f05SLisandro Dalcin   PetscValidIntPointer(bs,2);
11802c71b3e2SJacob Faibussowitsch   PetscCheckFalse(dm->bs < 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet");
11811411c6eeSJed Brown   *bs = dm->bs;
11821411c6eeSJed Brown   PetscFunctionReturn(0);
11831411c6eeSJed Brown }
11841411c6eeSJed Brown 
118548eeb7c8SBarry Smith /*@C
11868472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
118747c6ae99SBarry Smith 
1188a5bc1bf3SBarry Smith     Collective on dmc
118947c6ae99SBarry Smith 
1190d8d19677SJose E. Roman     Input Parameters:
1191a5bc1bf3SBarry Smith +   dmc - the DM object
1192a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
119347c6ae99SBarry Smith 
1194d8d19677SJose E. Roman     Output Parameters:
119547c6ae99SBarry Smith +  mat - the interpolation
119647c6ae99SBarry Smith -  vec - the scaling (optional)
119747c6ae99SBarry Smith 
119847c6ae99SBarry Smith     Level: developer
119947c6ae99SBarry Smith 
120095452b02SPatrick Sanan     Notes:
120195452b02SPatrick 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
120285afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1203d52bd9f3SBarry Smith 
12041f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1205d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
120685afcc9aSBarry Smith 
12072ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale()
120847c6ae99SBarry Smith 
120947c6ae99SBarry Smith @*/
1210a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec)
121147c6ae99SBarry Smith {
121247c6ae99SBarry Smith   PetscErrorCode ierr;
121347c6ae99SBarry Smith 
121447c6ae99SBarry Smith   PetscFunctionBegin;
1215a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1216a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1217c7d20fa0SStefano Zampini   PetscValidPointer(mat,3);
12182c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dmc->ops->createinterpolation,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name);
1219a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
1220a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr);
1221a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
122247c6ae99SBarry Smith   PetscFunctionReturn(0);
122347c6ae99SBarry Smith }
122447c6ae99SBarry Smith 
12253ad4599aSBarry Smith /*@
1226d3e313eaSPatrick Sanan     DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction.
12272ed6491fSPatrick Sanan 
12282ed6491fSPatrick Sanan   Input Parameters:
12292ed6491fSPatrick Sanan +      dac - DM that defines a coarse mesh
12302ed6491fSPatrick Sanan .      daf - DM that defines a fine mesh
12312ed6491fSPatrick Sanan -      mat - the restriction (or interpolation operator) from fine to coarse
12322ed6491fSPatrick Sanan 
12332ed6491fSPatrick Sanan   Output Parameter:
12342ed6491fSPatrick Sanan .    scale - the scaled vector
12352ed6491fSPatrick Sanan 
12362ed6491fSPatrick Sanan   Level: developer
12372ed6491fSPatrick Sanan 
1238e9c74fd6SRichard Tran Mills   Developer Notes:
1239e9c74fd6SRichard Tran Mills   If the fine-scale DMDA has the -dm_bind_below option set to true, then DMCreateInterpolationScale() calls MatSetBindingPropagates()
1240e9c74fd6SRichard Tran Mills   on the restriction/interpolation operator to set the bindingpropagates flag to true.
1241e9c74fd6SRichard Tran Mills 
12422ed6491fSPatrick Sanan .seealso: DMCreateInterpolation()
12432ed6491fSPatrick Sanan 
12442ed6491fSPatrick Sanan @*/
12452ed6491fSPatrick Sanan PetscErrorCode  DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale)
12462ed6491fSPatrick Sanan {
12472ed6491fSPatrick Sanan   PetscErrorCode ierr;
12482ed6491fSPatrick Sanan   Vec            fine;
12492ed6491fSPatrick Sanan   PetscScalar    one = 1.0;
12509704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
1251e9c74fd6SRichard Tran Mills   PetscBool      bindingpropagates,isbound;
12529704db99SRichard Tran Mills #endif
12532ed6491fSPatrick Sanan 
12542ed6491fSPatrick Sanan   PetscFunctionBegin;
12552ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr);
12562ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr);
12572ed6491fSPatrick Sanan   ierr = VecSet(fine,one);CHKERRQ(ierr);
12589704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
12599704db99SRichard Tran Mills   /* If the 'fine' Vec is bound to the CPU, it makes sense to bind 'mat' as well.
12609704db99SRichard Tran Mills    * Note that we only do this for the CUDA case, right now, but if we add support for MatMultTranspose() via ViennaCL,
12619704db99SRichard Tran Mills    * we'll need to do it for that case, too.*/
1262e9c74fd6SRichard Tran Mills   ierr = VecGetBindingPropagates(fine,&bindingpropagates);CHKERRQ(ierr);
1263e9c74fd6SRichard Tran Mills   if (bindingpropagates) {
1264b1538989SRichard Tran Mills     ierr = MatSetBindingPropagates(mat,PETSC_TRUE);CHKERRQ(ierr);
1265e9c74fd6SRichard Tran Mills     ierr = VecBoundToCPU(fine,&isbound);CHKERRQ(ierr);
1266e9c74fd6SRichard Tran Mills     ierr = MatBindToCPU(mat,isbound);CHKERRQ(ierr);
126783aa49f4SRichard Tran Mills   }
12689704db99SRichard Tran Mills #endif
12692ed6491fSPatrick Sanan   ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr);
12702ed6491fSPatrick Sanan   ierr = VecDestroy(&fine);CHKERRQ(ierr);
12712ed6491fSPatrick Sanan   ierr = VecReciprocal(*scale);CHKERRQ(ierr);
12722ed6491fSPatrick Sanan   PetscFunctionReturn(0);
12732ed6491fSPatrick Sanan }
12742ed6491fSPatrick Sanan 
12752ed6491fSPatrick Sanan /*@
12763ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
12773ad4599aSBarry Smith 
1278a5bc1bf3SBarry Smith     Collective on dmc
12793ad4599aSBarry Smith 
1280d8d19677SJose E. Roman     Input Parameters:
1281a5bc1bf3SBarry Smith +   dmc - the DM object
1282a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
12833ad4599aSBarry Smith 
12843ad4599aSBarry Smith     Output Parameter:
12853ad4599aSBarry Smith .  mat - the restriction
12863ad4599aSBarry Smith 
12873ad4599aSBarry Smith     Level: developer
12883ad4599aSBarry Smith 
128995452b02SPatrick Sanan     Notes:
129095452b02SPatrick 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
12913ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
12923ad4599aSBarry Smith 
12933ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
12943ad4599aSBarry Smith 
12953ad4599aSBarry Smith @*/
1296a5bc1bf3SBarry Smith PetscErrorCode  DMCreateRestriction(DM dmc,DM dmf,Mat *mat)
12973ad4599aSBarry Smith {
12983ad4599aSBarry Smith   PetscErrorCode ierr;
12993ad4599aSBarry Smith 
13003ad4599aSBarry Smith   PetscFunctionBegin;
1301a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1302a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
13035a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13042c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dmc->ops->createrestriction,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name);
1305a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
1306a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr);
1307a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
13083ad4599aSBarry Smith   PetscFunctionReturn(0);
13093ad4599aSBarry Smith }
13103ad4599aSBarry Smith 
131147c6ae99SBarry Smith /*@
13128472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
131347c6ae99SBarry Smith 
1314a5bc1bf3SBarry Smith     Collective on dac
131547c6ae99SBarry Smith 
1316d8d19677SJose E. Roman     Input Parameters:
1317a5bc1bf3SBarry Smith +   dac - the DM object
1318a5bc1bf3SBarry Smith -   daf - the second, finer DM object
131947c6ae99SBarry Smith 
132047c6ae99SBarry Smith     Output Parameter:
13216dbf9973SLawrence Mitchell .   mat - the injection
132247c6ae99SBarry Smith 
132347c6ae99SBarry Smith     Level: developer
132447c6ae99SBarry Smith 
132595452b02SPatrick Sanan    Notes:
132695452b02SPatrick 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
132785afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
132885afcc9aSBarry Smith 
1329e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
133047c6ae99SBarry Smith 
133147c6ae99SBarry Smith @*/
1332a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInjection(DM dac,DM daf,Mat *mat)
133347c6ae99SBarry Smith {
133447c6ae99SBarry Smith   PetscErrorCode ierr;
133547c6ae99SBarry Smith 
133647c6ae99SBarry Smith   PetscFunctionBegin;
1337a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac,DM_CLASSID,1);
1338a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf,DM_CLASSID,2);
13395a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13402c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dac->ops->createinjection,PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name);
1341a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
1342a5bc1bf3SBarry Smith   ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr);
1343a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
134447c6ae99SBarry Smith   PetscFunctionReturn(0);
134547c6ae99SBarry Smith }
134647c6ae99SBarry Smith 
1347b412c318SBarry Smith /*@
1348bd041c0cSMatthew G. Knepley   DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j
1349bd041c0cSMatthew G. Knepley 
1350a5bc1bf3SBarry Smith   Collective on dac
1351bd041c0cSMatthew G. Knepley 
1352d8d19677SJose E. Roman   Input Parameters:
1353b4937a87SMatthew G. Knepley + dmc - the target DM object
1354b4937a87SMatthew G. Knepley - dmf - the source DM object
1355bd041c0cSMatthew G. Knepley 
1356bd041c0cSMatthew G. Knepley   Output Parameter:
1357b4937a87SMatthew G. Knepley . mat - the mass matrix
1358bd041c0cSMatthew G. Knepley 
1359bd041c0cSMatthew G. Knepley   Level: developer
1360bd041c0cSMatthew G. Knepley 
1361b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrixLumped(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1362bd041c0cSMatthew G. Knepley @*/
1363b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrix(DM dmc, DM dmf, Mat *mat)
1364bd041c0cSMatthew G. Knepley {
1365bd041c0cSMatthew G. Knepley   PetscErrorCode ierr;
1366bd041c0cSMatthew G. Knepley 
1367bd041c0cSMatthew G. Knepley   PetscFunctionBegin;
1368b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dmc, DM_CLASSID, 1);
1369b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dmf, DM_CLASSID, 2);
13705a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13712c71b3e2SJacob Faibussowitsch   PetscCheck(dmc->ops->createmassmatrix,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dmc)->type_name);
1372b4937a87SMatthew G. Knepley   ierr = (*dmc->ops->createmassmatrix)(dmc, dmf, mat);CHKERRQ(ierr);
1373b4937a87SMatthew G. Knepley   PetscFunctionReturn(0);
1374b4937a87SMatthew G. Knepley }
1375b4937a87SMatthew G. Knepley 
1376b4937a87SMatthew G. Knepley /*@
1377b4937a87SMatthew G. Knepley   DMCreateMassMatrixLumped - Gets the lumped mass matrix for a given DM
1378b4937a87SMatthew G. Knepley 
1379b4937a87SMatthew G. Knepley   Collective on dm
1380b4937a87SMatthew G. Knepley 
1381b4937a87SMatthew G. Knepley   Input Parameter:
1382b4937a87SMatthew G. Knepley . dm - the DM object
1383b4937a87SMatthew G. Knepley 
1384b4937a87SMatthew G. Knepley   Output Parameter:
1385b4937a87SMatthew G. Knepley . lm - the lumped mass matrix
1386b4937a87SMatthew G. Knepley 
1387b4937a87SMatthew G. Knepley   Level: developer
1388b4937a87SMatthew G. Knepley 
1389b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrix(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1390b4937a87SMatthew G. Knepley @*/
1391b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrixLumped(DM dm, Vec *lm)
1392b4937a87SMatthew G. Knepley {
1393b4937a87SMatthew G. Knepley   PetscErrorCode ierr;
1394b4937a87SMatthew G. Knepley 
1395b4937a87SMatthew G. Knepley   PetscFunctionBegin;
1396b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1397b4937a87SMatthew G. Knepley   PetscValidPointer(lm,2);
13982c71b3e2SJacob Faibussowitsch   PetscCheck(dm->ops->createmassmatrixlumped,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrixLumped",((PetscObject)dm)->type_name);
1399b4937a87SMatthew G. Knepley   ierr = (*dm->ops->createmassmatrixlumped)(dm, lm);CHKERRQ(ierr);
1400bd041c0cSMatthew G. Knepley   PetscFunctionReturn(0);
1401bd041c0cSMatthew G. Knepley }
1402bd041c0cSMatthew G. Knepley 
1403bd041c0cSMatthew G. Knepley /*@
1404b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
140547c6ae99SBarry Smith 
1406d083f849SBarry Smith     Collective on dm
140747c6ae99SBarry Smith 
1408d8d19677SJose E. Roman     Input Parameters:
140947c6ae99SBarry Smith +   dm - the DM object
14105bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
141147c6ae99SBarry Smith 
141247c6ae99SBarry Smith     Output Parameter:
141347c6ae99SBarry Smith .   coloring - the coloring
141447c6ae99SBarry Smith 
1415ec5066bdSBarry Smith     Notes:
1416ec5066bdSBarry 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
1417ec5066bdSBarry Smith        matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors).
1418ec5066bdSBarry Smith 
1419ec5066bdSBarry Smith        This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate()
1420ec5066bdSBarry Smith 
142147c6ae99SBarry Smith     Level: developer
142247c6ae99SBarry Smith 
1423ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate()
142447c6ae99SBarry Smith 
1425aab9d709SJed Brown @*/
1426b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
142747c6ae99SBarry Smith {
142847c6ae99SBarry Smith   PetscErrorCode ierr;
142947c6ae99SBarry Smith 
143047c6ae99SBarry Smith   PetscFunctionBegin;
1431171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
14325a84ad33SLisandro Dalcin   PetscValidPointer(coloring,3);
14332c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->getcoloring,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name);
1434b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
143547c6ae99SBarry Smith   PetscFunctionReturn(0);
143647c6ae99SBarry Smith }
143747c6ae99SBarry Smith 
1438b412c318SBarry Smith /*@
14398472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
144047c6ae99SBarry Smith 
1441d083f849SBarry Smith     Collective on dm
144247c6ae99SBarry Smith 
144347c6ae99SBarry Smith     Input Parameter:
1444b412c318SBarry Smith .   dm - the DM object
144547c6ae99SBarry Smith 
144647c6ae99SBarry Smith     Output Parameter:
144747c6ae99SBarry Smith .   mat - the empty Jacobian
144847c6ae99SBarry Smith 
1449073dac72SJed Brown     Level: beginner
145047c6ae99SBarry Smith 
1451f27dd7c6SMatthew G. Knepley     Options Database Keys:
1452f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1453f27dd7c6SMatthew G. Knepley 
145495452b02SPatrick Sanan     Notes:
145595452b02SPatrick Sanan     This properly preallocates the number of nonzeros in the sparse matrix so you
145694013140SBarry Smith        do not need to do it yourself.
145794013140SBarry Smith 
145894013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
14597889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
146094013140SBarry Smith 
146194013140SBarry 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
146294013140SBarry Smith        internally by PETSc.
146394013140SBarry Smith 
146494013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1465aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
146694013140SBarry Smith 
1467b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
146847c6ae99SBarry Smith 
1469aab9d709SJed Brown @*/
1470b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
147147c6ae99SBarry Smith {
147247c6ae99SBarry Smith   PetscErrorCode ierr;
147347c6ae99SBarry Smith 
147447c6ae99SBarry Smith   PetscFunctionBegin;
1475171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1476064a246eSJacob Faibussowitsch   PetscValidPointer(mat,2);
14772c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->creatematrix,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
14785a84ad33SLisandro Dalcin   ierr = MatInitializePackage();CHKERRQ(ierr);
1479fdc842d1SBarry Smith   ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1480b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
148176bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1482c6b011d8SStefano Zampini     DM mdm;
1483c6b011d8SStefano Zampini 
1484c6b011d8SStefano Zampini     ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr);
14852c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!mdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix",((PetscObject)dm)->type_name);
1486c6b011d8SStefano Zampini   }
1487e571a35bSMatthew G. Knepley   /* Handle nullspace and near nullspace */
1488e5e52638SMatthew G. Knepley   if (dm->Nf) {
1489e571a35bSMatthew G. Knepley     MatNullSpace nullSpace;
1490649ef022SMatthew Knepley     PetscInt     Nf, f;
1491e571a35bSMatthew G. Knepley 
1492e5e52638SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
1493649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1494649ef022SMatthew Knepley       if (dm->nullspaceConstructors[f]) {
1495649ef022SMatthew Knepley         ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1496e571a35bSMatthew G. Knepley         ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1497e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1498649ef022SMatthew Knepley         break;
1499e571a35bSMatthew G. Knepley       }
1500649ef022SMatthew Knepley     }
1501649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1502649ef022SMatthew Knepley       if (dm->nearnullspaceConstructors[f]) {
1503649ef022SMatthew Knepley         ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1504e571a35bSMatthew G. Knepley         ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1505e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1506e571a35bSMatthew G. Knepley       }
1507e571a35bSMatthew G. Knepley     }
1508e571a35bSMatthew G. Knepley   }
1509fdc842d1SBarry Smith   ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
151047c6ae99SBarry Smith   PetscFunctionReturn(0);
151147c6ae99SBarry Smith }
151247c6ae99SBarry Smith 
1513732e2eb9SMatthew G Knepley /*@
1514950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1515732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1516732e2eb9SMatthew G Knepley 
1517d083f849SBarry Smith   Logically Collective on dm
1518732e2eb9SMatthew G Knepley 
1519d8d19677SJose E. Roman   Input Parameters:
1520732e2eb9SMatthew G Knepley + dm - the DM
1521732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1522732e2eb9SMatthew G Knepley 
1523732e2eb9SMatthew G Knepley   Level: developer
1524f27dd7c6SMatthew G. Knepley 
1525f27dd7c6SMatthew G. Knepley   Options Database Keys:
1526f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1527f27dd7c6SMatthew G. Knepley 
1528b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1529732e2eb9SMatthew G Knepley @*/
1530732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1531732e2eb9SMatthew G Knepley {
1532732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1533732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1534732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1535732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1536732e2eb9SMatthew G Knepley }
1537732e2eb9SMatthew G Knepley 
1538b06ff27eSHong Zhang /*@
1539b06ff27eSHong Zhang   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1540b06ff27eSHong Zhang     but the array for values will not be allocated.
1541b06ff27eSHong Zhang 
1542d083f849SBarry Smith   Logically Collective on dm
1543b06ff27eSHong Zhang 
1544d8d19677SJose E. Roman   Input Parameters:
1545b06ff27eSHong Zhang + dm - the DM
1546b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture
1547b06ff27eSHong Zhang 
1548b06ff27eSHong Zhang   Level: developer
1549b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1550b06ff27eSHong Zhang @*/
1551b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1552b06ff27eSHong Zhang {
1553b06ff27eSHong Zhang   PetscFunctionBegin;
1554b06ff27eSHong Zhang   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1555b06ff27eSHong Zhang   dm->structure_only = only;
1556b06ff27eSHong Zhang   PetscFunctionReturn(0);
1557b06ff27eSHong Zhang }
1558b06ff27eSHong Zhang 
1559a89ea682SMatthew G Knepley /*@C
1560aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1561a89ea682SMatthew G Knepley 
1562a89ea682SMatthew G Knepley   Not Collective
1563a89ea682SMatthew G Knepley 
1564a89ea682SMatthew G Knepley   Input Parameters:
1565a89ea682SMatthew G Knepley + dm - the DM object
1566a5b23f4aSJose E. Roman . count - The minimum size
156769291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1568a89ea682SMatthew G Knepley 
1569a89ea682SMatthew G Knepley   Output Parameter:
1570a89ea682SMatthew G Knepley . array - the work array
1571a89ea682SMatthew G Knepley 
1572a89ea682SMatthew G Knepley   Level: developer
1573a89ea682SMatthew G Knepley 
1574a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1575a89ea682SMatthew G Knepley @*/
157669291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1577a89ea682SMatthew G Knepley {
1578a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1579aa1993deSMatthew G Knepley   DMWorkLink     link;
158069291d52SBarry Smith   PetscMPIInt    dsize;
1581a89ea682SMatthew G Knepley 
1582a89ea682SMatthew G Knepley   PetscFunctionBegin;
1583a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1584aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1585aa1993deSMatthew G Knepley   if (dm->workin) {
1586aa1993deSMatthew G Knepley     link       = dm->workin;
1587aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1588aa1993deSMatthew G Knepley   } else {
1589b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1590a89ea682SMatthew G Knepley   }
1591ffc4695bSBarry Smith   ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr);
15925056fcd2SBarry Smith   if (((size_t)dsize*count) > link->bytes) {
1593aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1594854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1595854ce69bSBarry Smith     link->bytes = dsize*count;
1596aa1993deSMatthew G Knepley   }
1597aa1993deSMatthew G Knepley   link->next   = dm->workout;
1598aa1993deSMatthew G Knepley   dm->workout  = link;
159900d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
160000d952a4SJed Brown   VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count);
160100d952a4SJed Brown   VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count);
160200d952a4SJed Brown #endif
1603aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1604a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1605a89ea682SMatthew G Knepley }
1606a89ea682SMatthew G Knepley 
1607aa1993deSMatthew G Knepley /*@C
1608aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1609aa1993deSMatthew G Knepley 
1610aa1993deSMatthew G Knepley   Not Collective
1611aa1993deSMatthew G Knepley 
1612aa1993deSMatthew G Knepley   Input Parameters:
1613aa1993deSMatthew G Knepley + dm - the DM object
1614a5b23f4aSJose E. Roman . count - The minimum size
161569291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT
1616aa1993deSMatthew G Knepley 
1617aa1993deSMatthew G Knepley   Output Parameter:
1618aa1993deSMatthew G Knepley . array - the work array
1619aa1993deSMatthew G Knepley 
1620aa1993deSMatthew G Knepley   Level: developer
1621aa1993deSMatthew G Knepley 
162295452b02SPatrick Sanan   Developer Notes:
162395452b02SPatrick Sanan     count and dtype are ignored, they are only needed for DMGetWorkArray()
1624aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1625aa1993deSMatthew G Knepley @*/
162669291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1627aa1993deSMatthew G Knepley {
1628aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1629aa1993deSMatthew G Knepley 
1630aa1993deSMatthew G Knepley   PetscFunctionBegin;
1631aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1632aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1633aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1634aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1635aa1993deSMatthew G Knepley       *p           = link->next;
1636aa1993deSMatthew G Knepley       link->next   = dm->workin;
1637aa1993deSMatthew G Knepley       dm->workin   = link;
16380298fd71SBarry Smith       *(void**)mem = NULL;
1639aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1640aa1993deSMatthew G Knepley     }
1641aa1993deSMatthew G Knepley   }
1642aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1643aa1993deSMatthew G Knepley }
1644e7c4fc90SDmitry Karpeev 
16458cda7954SMatthew G. Knepley /*@C
16468cda7954SMatthew G. Knepley   DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field
16478cda7954SMatthew G. Knepley 
16488cda7954SMatthew G. Knepley   Logically collective on DM
16498cda7954SMatthew G. Knepley 
16508cda7954SMatthew G. Knepley   Input Parameters:
16518cda7954SMatthew G. Knepley + dm     - The DM
16528cda7954SMatthew G. Knepley . field  - The field number for the nullspace
16538cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace
16548cda7954SMatthew G. Knepley 
16558cda7954SMatthew G. Knepley   Notes:
16568cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16578cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16588cda7954SMatthew G. Knepley $ dm        - The present DM
16598cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16608cda7954SMatthew G. Knepley $ field     - The field number in dm
16618cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16628cda7954SMatthew G. Knepley 
16638cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16648cda7954SMatthew G. Knepley 
16658cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16668cda7954SMatthew G. Knepley */
16678cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1668435a35e8SMatthew G Knepley {
1669435a35e8SMatthew G Knepley   PetscFunctionBegin;
1670435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
16712c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1672435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1673435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1674435a35e8SMatthew G Knepley }
1675435a35e8SMatthew G Knepley 
16768cda7954SMatthew G. Knepley /*@C
16778cda7954SMatthew G. Knepley   DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL
16788cda7954SMatthew G. Knepley 
16798cda7954SMatthew G. Knepley   Not collective
16808cda7954SMatthew G. Knepley 
16818cda7954SMatthew G. Knepley   Input Parameters:
16828cda7954SMatthew G. Knepley + dm     - The DM
16838cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16848cda7954SMatthew G. Knepley 
16858cda7954SMatthew G. Knepley   Output Parameter:
16868cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace
16878cda7954SMatthew G. Knepley 
16888cda7954SMatthew G. Knepley   Notes:
16898cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16908cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16918cda7954SMatthew G. Knepley $ dm        - The present DM
16928cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16938cda7954SMatthew G. Knepley $ field     - The field number in dm
16948cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16958cda7954SMatthew G. Knepley 
16968cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16978cda7954SMatthew G. Knepley 
16988cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16998cda7954SMatthew G. Knepley */
17008cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
17010a50eb56SMatthew G. Knepley {
17020a50eb56SMatthew G. Knepley   PetscFunctionBegin;
17030a50eb56SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1704f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
17052c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
17060a50eb56SMatthew G. Knepley   *nullsp = dm->nullspaceConstructors[field];
17070a50eb56SMatthew G. Knepley   PetscFunctionReturn(0);
17080a50eb56SMatthew G. Knepley }
17090a50eb56SMatthew G. Knepley 
17108cda7954SMatthew G. Knepley /*@C
17118cda7954SMatthew G. Knepley   DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field
17128cda7954SMatthew G. Knepley 
17138cda7954SMatthew G. Knepley   Logically collective on DM
17148cda7954SMatthew G. Knepley 
17158cda7954SMatthew G. Knepley   Input Parameters:
17168cda7954SMatthew G. Knepley + dm     - The DM
17178cda7954SMatthew G. Knepley . field  - The field number for the nullspace
17188cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace
17198cda7954SMatthew G. Knepley 
17208cda7954SMatthew G. Knepley   Notes:
17218cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
17228cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
17238cda7954SMatthew G. Knepley $ dm        - The present DM
17248cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
17258cda7954SMatthew G. Knepley $ field     - The field number in dm
17268cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
17278cda7954SMatthew G. Knepley 
17288cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
17298cda7954SMatthew G. Knepley 
17308cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
17318cda7954SMatthew G. Knepley */
17328cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1733f9d4088aSMatthew G. Knepley {
1734f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1735f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
17362c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1737f9d4088aSMatthew G. Knepley   dm->nearnullspaceConstructors[field] = nullsp;
1738f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1739f9d4088aSMatthew G. Knepley }
1740f9d4088aSMatthew G. Knepley 
17418cda7954SMatthew G. Knepley /*@C
17428cda7954SMatthew G. Knepley   DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL
17438cda7954SMatthew G. Knepley 
17448cda7954SMatthew G. Knepley   Not collective
17458cda7954SMatthew G. Knepley 
17468cda7954SMatthew G. Knepley   Input Parameters:
17478cda7954SMatthew G. Knepley + dm     - The DM
17488cda7954SMatthew G. Knepley - field  - The field number for the nullspace
17498cda7954SMatthew G. Knepley 
17508cda7954SMatthew G. Knepley   Output Parameter:
17518cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace
17528cda7954SMatthew G. Knepley 
17538cda7954SMatthew G. Knepley   Notes:
17548cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
17558cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
17568cda7954SMatthew G. Knepley $ dm        - The present DM
17578cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
17588cda7954SMatthew G. Knepley $ field     - The field number in dm
17598cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
17608cda7954SMatthew G. Knepley 
17618cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
17628cda7954SMatthew G. Knepley 
17638cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
17648cda7954SMatthew G. Knepley */
17658cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1766f9d4088aSMatthew G. Knepley {
1767f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1768f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1769f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
17702c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1771f9d4088aSMatthew G. Knepley   *nullsp = dm->nearnullspaceConstructors[field];
1772f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1773f9d4088aSMatthew G. Knepley }
1774f9d4088aSMatthew G. Knepley 
17754f3b5142SJed Brown /*@C
17764d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
17774d343eeaSMatthew G Knepley 
17784d343eeaSMatthew G Knepley   Not collective
17794d343eeaSMatthew G Knepley 
17804d343eeaSMatthew G Knepley   Input Parameter:
17814d343eeaSMatthew G Knepley . dm - the DM object
17824d343eeaSMatthew G Knepley 
17834d343eeaSMatthew G Knepley   Output Parameters:
17840298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
17850298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
17860298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
17874d343eeaSMatthew G Knepley 
17884d343eeaSMatthew G Knepley   Level: intermediate
17894d343eeaSMatthew G Knepley 
179021c9b008SJed Brown   Notes:
179121c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
179221c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
179321c9b008SJed Brown   PetscFree().
179421c9b008SJed Brown 
17954d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
17964d343eeaSMatthew G Knepley @*/
179737d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
17984d343eeaSMatthew G Knepley {
179937d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
18004d343eeaSMatthew G Knepley   PetscErrorCode ierr;
18014d343eeaSMatthew G Knepley 
18024d343eeaSMatthew G Knepley   PetscFunctionBegin;
18034d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
180469ca1f37SDmitry Karpeev   if (numFields) {
1805534a8f05SLisandro Dalcin     PetscValidIntPointer(numFields,2);
180669ca1f37SDmitry Karpeev     *numFields = 0;
180769ca1f37SDmitry Karpeev   }
180837d0c07bSMatthew G Knepley   if (fieldNames) {
180937d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
18100298fd71SBarry Smith     *fieldNames = NULL;
181169ca1f37SDmitry Karpeev   }
181269ca1f37SDmitry Karpeev   if (fields) {
181369ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
18140298fd71SBarry Smith     *fields = NULL;
181569ca1f37SDmitry Karpeev   }
181692fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
181737d0c07bSMatthew G Knepley   if (section) {
18183a544194SStefano Zampini     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
181937d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
182037d0c07bSMatthew G Knepley 
1821e87a4003SBarry Smith     ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
182237d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
18233a544194SStefano Zampini     ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr);
182437d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
182537d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
182637d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
18273a544194SStefano Zampini       ierr          = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr);
182837d0c07bSMatthew G Knepley     }
182937d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
183037d0c07bSMatthew G Knepley       PetscInt gdof;
183137d0c07bSMatthew G Knepley 
183237d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
183337d0c07bSMatthew G Knepley       if (gdof > 0) {
183437d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
18353a544194SStefano Zampini           PetscInt fdof, fcdof, fpdof;
183637d0c07bSMatthew G Knepley 
183737d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
183837d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
18393a544194SStefano Zampini           fpdof = fdof-fcdof;
18403a544194SStefano Zampini           if (fpdof && fpdof != fieldNc[f]) {
18413a544194SStefano Zampini             /* Layout does not admit a pointwise block size */
18423a544194SStefano Zampini             fieldNc[f] = 1;
18433a544194SStefano Zampini           }
18443a544194SStefano Zampini           fieldSizes[f] += fpdof;
184537d0c07bSMatthew G Knepley         }
184637d0c07bSMatthew G Knepley       }
184737d0c07bSMatthew G Knepley     }
184837d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1849785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
185037d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
185137d0c07bSMatthew G Knepley     }
185237d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
185337d0c07bSMatthew G Knepley       PetscInt gdof, goff;
185437d0c07bSMatthew G Knepley 
185537d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
185637d0c07bSMatthew G Knepley       if (gdof > 0) {
185737d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
185837d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
185937d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
186037d0c07bSMatthew G Knepley 
186137d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
186237d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
186337d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
186437d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
186537d0c07bSMatthew G Knepley           }
186637d0c07bSMatthew G Knepley         }
186737d0c07bSMatthew G Knepley       }
186837d0c07bSMatthew G Knepley     }
18698865f1eaSKarl Rupp     if (numFields) *numFields = nF;
187037d0c07bSMatthew G Knepley     if (fieldNames) {
1871785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
187237d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
187337d0c07bSMatthew G Knepley         const char *fieldName;
187437d0c07bSMatthew G Knepley 
187537d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
187637d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
187737d0c07bSMatthew G Knepley       }
187837d0c07bSMatthew G Knepley     }
187937d0c07bSMatthew G Knepley     if (fields) {
1880785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
188137d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
18823a544194SStefano Zampini         PetscInt bs, in[2], out[2];
18833a544194SStefano Zampini 
188482f516ccSBarry Smith         ierr  = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
18853a544194SStefano Zampini         in[0] = -fieldNc[f];
18863a544194SStefano Zampini         in[1] = fieldNc[f];
1887820f2d46SBarry Smith         ierr  = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
18883a544194SStefano Zampini         bs    = (-out[0] == out[1]) ? out[1] : 1;
18893a544194SStefano Zampini         ierr  = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr);
189037d0c07bSMatthew G Knepley       }
189137d0c07bSMatthew G Knepley     }
18923a544194SStefano Zampini     ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr);
18938865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
18948865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
189569ca1f37SDmitry Karpeev   }
18964d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
18974d343eeaSMatthew G Knepley }
18984d343eeaSMatthew G Knepley 
189916621825SDmitry Karpeev /*@C
190016621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
190116621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
190216621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1903e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1904e7c4fc90SDmitry Karpeev 
1905e7c4fc90SDmitry Karpeev   Not collective
1906e7c4fc90SDmitry Karpeev 
1907e7c4fc90SDmitry Karpeev   Input Parameter:
1908e7c4fc90SDmitry Karpeev . dm - the DM object
1909e7c4fc90SDmitry Karpeev 
1910e7c4fc90SDmitry Karpeev   Output Parameters:
19110298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
19120298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
19130298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
19140298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1915e7c4fc90SDmitry Karpeev 
1916e7c4fc90SDmitry Karpeev   Level: intermediate
1917e7c4fc90SDmitry Karpeev 
1918e7c4fc90SDmitry Karpeev   Notes:
1919e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1920e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1921e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1922e7c4fc90SDmitry Karpeev 
1923e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1924e7c4fc90SDmitry Karpeev @*/
192516621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1926e7c4fc90SDmitry Karpeev {
1927e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1928e7c4fc90SDmitry Karpeev 
1929e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1930e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
19318865f1eaSKarl Rupp   if (len) {
1932534a8f05SLisandro Dalcin     PetscValidIntPointer(len,2);
19338865f1eaSKarl Rupp     *len = 0;
19348865f1eaSKarl Rupp   }
19358865f1eaSKarl Rupp   if (namelist) {
19368865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
1937ea78f98cSLisandro Dalcin     *namelist = NULL;
19388865f1eaSKarl Rupp   }
19398865f1eaSKarl Rupp   if (islist) {
19408865f1eaSKarl Rupp     PetscValidPointer(islist,4);
1941ea78f98cSLisandro Dalcin     *islist = NULL;
19428865f1eaSKarl Rupp   }
19438865f1eaSKarl Rupp   if (dmlist) {
19448865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
1945ea78f98cSLisandro Dalcin     *dmlist = NULL;
19468865f1eaSKarl Rupp   }
1947f3f0edfdSDmitry Karpeev   /*
1948f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1949f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1950f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1951f3f0edfdSDmitry Karpeev    */
19522c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
195316621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1954435a35e8SMatthew G Knepley     PetscSection section;
1955435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1956435a35e8SMatthew G Knepley 
195792fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1958435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1959435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1960f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
196103dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
196203dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
196303dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1964435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1965435a35e8SMatthew G Knepley         const char *fieldName;
1966435a35e8SMatthew G Knepley 
196703dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
196803dc3394SMatthew G. Knepley         if (namelist) {
1969435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1970435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1971435a35e8SMatthew G Knepley         }
197203dc3394SMatthew G. Knepley       }
1973435a35e8SMatthew G Knepley     } else {
197469ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1975e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
19760298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1977e7c4fc90SDmitry Karpeev     }
19788865f1eaSKarl Rupp   } else {
197916621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
198016621825SDmitry Karpeev   }
198116621825SDmitry Karpeev   PetscFunctionReturn(0);
198216621825SDmitry Karpeev }
198316621825SDmitry Karpeev 
1984564cec59SMatthew G. Knepley /*@
1985435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1986435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1987435a35e8SMatthew G Knepley 
1988435a35e8SMatthew G Knepley   Not collective
1989435a35e8SMatthew G Knepley 
1990435a35e8SMatthew G Knepley   Input Parameters:
19912adcc780SMatthew G. Knepley + dm        - The DM object
19922adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem
19932adcc780SMatthew G. Knepley - fields    - The field numbers of the selected fields
1994435a35e8SMatthew G Knepley 
1995435a35e8SMatthew G Knepley   Output Parameters:
19962adcc780SMatthew G. Knepley + is - The global indices for the subproblem
19972adcc780SMatthew G. Knepley - subdm - The DM for the subproblem
1998435a35e8SMatthew G Knepley 
19995d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
20005d3b26e6SMatthew G. Knepley 
2001435a35e8SMatthew G Knepley   Level: intermediate
2002435a35e8SMatthew G Knepley 
20035d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2004435a35e8SMatthew G Knepley @*/
200537bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
2006435a35e8SMatthew G Knepley {
2007435a35e8SMatthew G Knepley   PetscErrorCode ierr;
2008435a35e8SMatthew G Knepley 
2009435a35e8SMatthew G Knepley   PetscFunctionBegin;
2010435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2011435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
20128865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
20138865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
20142c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createsubdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
2015435a35e8SMatthew G Knepley   ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
2016435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
2017435a35e8SMatthew G Knepley }
2018435a35e8SMatthew G Knepley 
20192adcc780SMatthew G. Knepley /*@C
20202adcc780SMatthew G. Knepley   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
20212adcc780SMatthew G. Knepley 
20222adcc780SMatthew G. Knepley   Not collective
20232adcc780SMatthew G. Knepley 
2024d8d19677SJose E. Roman   Input Parameters:
20252adcc780SMatthew G. Knepley + dms - The DM objects
20262adcc780SMatthew G. Knepley - len - The number of DMs
20272adcc780SMatthew G. Knepley 
20282adcc780SMatthew G. Knepley   Output Parameters:
2029a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL
20302adcc780SMatthew G. Knepley - superdm - The DM for the superproblem
20312adcc780SMatthew G. Knepley 
20325d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
20335d3b26e6SMatthew G. Knepley 
20342adcc780SMatthew G. Knepley   Level: intermediate
20352adcc780SMatthew G. Knepley 
20365d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
20372adcc780SMatthew G. Knepley @*/
20382adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
20392adcc780SMatthew G. Knepley {
20402adcc780SMatthew G. Knepley   PetscInt       i;
20412adcc780SMatthew G. Knepley   PetscErrorCode ierr;
20422adcc780SMatthew G. Knepley 
20432adcc780SMatthew G. Knepley   PetscFunctionBegin;
20442adcc780SMatthew G. Knepley   PetscValidPointer(dms,1);
20452adcc780SMatthew G. Knepley   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
20462adcc780SMatthew G. Knepley   if (is) PetscValidPointer(is,3);
2047a42bd24dSMatthew G. Knepley   PetscValidPointer(superdm,4);
20482c71b3e2SJacob Faibussowitsch   PetscCheckFalse(len < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
20492adcc780SMatthew G. Knepley   if (len) {
2050b9d85ea2SLisandro Dalcin     DM dm = dms[0];
20512c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->createsuperdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
2052b9d85ea2SLisandro Dalcin     ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr);
20532adcc780SMatthew G. Knepley   }
20542adcc780SMatthew G. Knepley   PetscFunctionReturn(0);
20552adcc780SMatthew G. Knepley }
20562adcc780SMatthew G. Knepley 
205716621825SDmitry Karpeev /*@C
20588d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
20598d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
20608d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
20618d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
20628d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
206316621825SDmitry Karpeev 
206416621825SDmitry Karpeev   Not collective
206516621825SDmitry Karpeev 
206616621825SDmitry Karpeev   Input Parameter:
206716621825SDmitry Karpeev . dm - the DM object
206816621825SDmitry Karpeev 
206916621825SDmitry Karpeev   Output Parameters:
20700298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
20710298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
20720298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
20730298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
20740298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
207516621825SDmitry Karpeev 
207616621825SDmitry Karpeev   Level: intermediate
207716621825SDmitry Karpeev 
207816621825SDmitry Karpeev   Notes:
207916621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
208016621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
208116621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
208216621825SDmitry Karpeev 
2083245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition()
208416621825SDmitry Karpeev @*/
20858d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
208616621825SDmitry Karpeev {
208716621825SDmitry Karpeev   PetscErrorCode      ierr;
2088be081cd6SPeter Brune   DMSubDomainHookLink link;
2089be081cd6SPeter Brune   PetscInt            i,l;
209016621825SDmitry Karpeev 
209116621825SDmitry Karpeev   PetscFunctionBegin;
209216621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
209314a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
20940298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
20950298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
20960298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
20970298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
2098f3f0edfdSDmitry Karpeev   /*
2099f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
2100f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
2101f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
2102f3f0edfdSDmitry Karpeev    */
21032c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
210416621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
2105be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
210614a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
2107f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
2108be081cd6SPeter Brune       for (i = 0; i < l; i++) {
2109be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
2110be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
2111be081cd6SPeter Brune         }
2112648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
2113e7c4fc90SDmitry Karpeev       }
211414a18fd3SPeter Brune     }
211514a18fd3SPeter Brune     if (len) *len = l;
211614a18fd3SPeter Brune   }
2117e30e807fSPeter Brune   PetscFunctionReturn(0);
2118e30e807fSPeter Brune }
2119e30e807fSPeter Brune 
2120e30e807fSPeter Brune /*@C
2121e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
2122e30e807fSPeter Brune 
2123e30e807fSPeter Brune   Not collective
2124e30e807fSPeter Brune 
2125e30e807fSPeter Brune   Input Parameters:
2126e30e807fSPeter Brune + dm - the DM object
2127e30e807fSPeter Brune . n  - the number of subdomain scatters
2128e30e807fSPeter Brune - subdms - the local subdomains
2129e30e807fSPeter Brune 
2130e30e807fSPeter Brune   Output Parameters:
21316b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2132e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2133e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2134e30e807fSPeter Brune 
213595452b02SPatrick Sanan   Notes:
213695452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2137e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2138e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2139e30e807fSPeter Brune   solution and residual data.
2140e30e807fSPeter Brune 
2141e30e807fSPeter Brune   Level: developer
2142e30e807fSPeter Brune 
2143e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2144e30e807fSPeter Brune @*/
2145e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2146e30e807fSPeter Brune {
2147e30e807fSPeter Brune   PetscErrorCode ierr;
2148e30e807fSPeter Brune 
2149e30e807fSPeter Brune   PetscFunctionBegin;
2150e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2151e30e807fSPeter Brune   PetscValidPointer(subdms,3);
21522c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createddscatters,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
2153e30e807fSPeter Brune   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
2154e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2155e7c4fc90SDmitry Karpeev }
2156e7c4fc90SDmitry Karpeev 
215747c6ae99SBarry Smith /*@
215847c6ae99SBarry Smith   DMRefine - Refines a DM object
215947c6ae99SBarry Smith 
2160d083f849SBarry Smith   Collective on dm
216147c6ae99SBarry Smith 
2162d8d19677SJose E. Roman   Input Parameters:
216347c6ae99SBarry Smith + dm   - the DM object
216491d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
216547c6ae99SBarry Smith 
216647c6ae99SBarry Smith   Output Parameter:
21670298fd71SBarry Smith . dmf - the refined DM, or NULL
2168ae0a1c52SMatthew G Knepley 
2169f27dd7c6SMatthew G. Knepley   Options Database Keys:
2170412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2171412e9a14SMatthew G. Knepley 
21720298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
217347c6ae99SBarry Smith 
217447c6ae99SBarry Smith   Level: developer
217547c6ae99SBarry Smith 
2176e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
217747c6ae99SBarry Smith @*/
21787087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
217947c6ae99SBarry Smith {
218047c6ae99SBarry Smith   PetscErrorCode   ierr;
2181c833c3b5SJed Brown   DMRefineHookLink link;
218247c6ae99SBarry Smith 
218347c6ae99SBarry Smith   PetscFunctionBegin;
2184732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
21852c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->refine,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
21861ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
218747c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
21884057135bSMatthew G Knepley   if (*dmf) {
218943842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
21908865f1eaSKarl Rupp 
21918cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
21928865f1eaSKarl Rupp 
2193644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
21940598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2195656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
21968865f1eaSKarl Rupp 
2197e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
2198c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
21998865f1eaSKarl Rupp       if (link->refinehook) {
22008865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
22018865f1eaSKarl Rupp       }
2202c833c3b5SJed Brown     }
2203c833c3b5SJed Brown   }
22041ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
2205c833c3b5SJed Brown   PetscFunctionReturn(0);
2206c833c3b5SJed Brown }
2207c833c3b5SJed Brown 
2208bb9467b5SJed Brown /*@C
2209c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2210c833c3b5SJed Brown 
2211c833c3b5SJed Brown    Logically Collective
2212c833c3b5SJed Brown 
22134165533cSJose E. Roman    Input Parameters:
2214c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2215c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2216c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22170298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2218c833c3b5SJed Brown 
2219c833c3b5SJed Brown    Calling sequence of refinehook:
2220c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2221c833c3b5SJed Brown 
2222c833c3b5SJed Brown +  coarse - coarse level DM
2223c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2224c833c3b5SJed Brown -  ctx - optional user-defined function context
2225c833c3b5SJed Brown 
2226c833c3b5SJed Brown    Calling sequence for interphook:
2227c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2228c833c3b5SJed Brown 
2229c833c3b5SJed Brown +  coarse - coarse level DM
2230c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2231c833c3b5SJed Brown .  fine - fine level DM to update
2232c833c3b5SJed Brown -  ctx - optional user-defined function context
2233c833c3b5SJed Brown 
2234c833c3b5SJed Brown    Level: advanced
2235c833c3b5SJed Brown 
2236c833c3b5SJed Brown    Notes:
2237c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2238c833c3b5SJed Brown 
2239c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2240c833c3b5SJed Brown 
2241bb9467b5SJed Brown    This function is currently not available from Fortran.
2242bb9467b5SJed Brown 
2243c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2244c833c3b5SJed Brown @*/
2245c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2246c833c3b5SJed Brown {
2247c833c3b5SJed Brown   PetscErrorCode   ierr;
2248c833c3b5SJed Brown   DMRefineHookLink link,*p;
2249c833c3b5SJed Brown 
2250c833c3b5SJed Brown   PetscFunctionBegin;
2251c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22523d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
22533d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
22543d8e3701SJed Brown   }
225595dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
2256c833c3b5SJed Brown   link->refinehook = refinehook;
2257c833c3b5SJed Brown   link->interphook = interphook;
2258c833c3b5SJed Brown   link->ctx        = ctx;
22590298fd71SBarry Smith   link->next       = NULL;
2260c833c3b5SJed Brown   *p               = link;
2261c833c3b5SJed Brown   PetscFunctionReturn(0);
2262c833c3b5SJed Brown }
2263c833c3b5SJed Brown 
22643d8e3701SJed Brown /*@C
22653d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
22663d8e3701SJed Brown 
22673d8e3701SJed Brown    Logically Collective
22683d8e3701SJed Brown 
22694165533cSJose E. Roman    Input Parameters:
22703d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
22713d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
22723d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22733d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
22743d8e3701SJed Brown 
22753d8e3701SJed Brown    Level: advanced
22763d8e3701SJed Brown 
22773d8e3701SJed Brown    Notes:
22783d8e3701SJed Brown    This function does nothing if the hook is not in the list.
22793d8e3701SJed Brown 
22803d8e3701SJed Brown    This function is currently not available from Fortran.
22813d8e3701SJed Brown 
22823d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
22833d8e3701SJed Brown @*/
22843d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
22853d8e3701SJed Brown {
22863d8e3701SJed Brown   PetscErrorCode   ierr;
22873d8e3701SJed Brown   DMRefineHookLink link,*p;
22883d8e3701SJed Brown 
22893d8e3701SJed Brown   PetscFunctionBegin;
22903d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22913d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
22923d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
22933d8e3701SJed Brown       link = *p;
22943d8e3701SJed Brown       *p = link->next;
22953d8e3701SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
22963d8e3701SJed Brown       break;
22973d8e3701SJed Brown     }
22983d8e3701SJed Brown   }
22993d8e3701SJed Brown   PetscFunctionReturn(0);
23003d8e3701SJed Brown }
23013d8e3701SJed Brown 
2302c833c3b5SJed Brown /*@
2303c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2304c833c3b5SJed Brown 
2305c833c3b5SJed Brown    Collective if any hooks are
2306c833c3b5SJed Brown 
23074165533cSJose E. Roman    Input Parameters:
2308c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2309e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2310c833c3b5SJed Brown -  fine - finer DM to update
2311c833c3b5SJed Brown 
2312c833c3b5SJed Brown    Level: developer
2313c833c3b5SJed Brown 
2314c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2315c833c3b5SJed Brown @*/
2316c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2317c833c3b5SJed Brown {
2318c833c3b5SJed Brown   PetscErrorCode   ierr;
2319c833c3b5SJed Brown   DMRefineHookLink link;
2320c833c3b5SJed Brown 
2321c833c3b5SJed Brown   PetscFunctionBegin;
2322c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
23238865f1eaSKarl Rupp     if (link->interphook) {
23248865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
23258865f1eaSKarl Rupp     }
23264057135bSMatthew G Knepley   }
232747c6ae99SBarry Smith   PetscFunctionReturn(0);
232847c6ae99SBarry Smith }
232947c6ae99SBarry Smith 
2330eb3f98d2SBarry Smith /*@
23311f3379b2SToby Isaac    DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh.
23321f3379b2SToby Isaac 
23331f3379b2SToby Isaac    Collective on DM
23341f3379b2SToby Isaac 
23354165533cSJose E. Roman    Input Parameters:
23361f3379b2SToby Isaac +  coarse - coarse DM
23371f3379b2SToby Isaac .  fine   - fine DM
23381f3379b2SToby Isaac .  interp - (optional) the matrix computed by DMCreateInterpolation().  Implementations may not need this, but if it
23391f3379b2SToby Isaac             is available it can avoid some recomputation.  If it is provided, MatInterpolate() will be used if
23401f3379b2SToby Isaac             the coarse DM does not have a specialized implementation.
23411f3379b2SToby Isaac -  coarseSol - solution on the coarse mesh
23421f3379b2SToby Isaac 
23434165533cSJose E. Roman    Output Parameter:
23441f3379b2SToby Isaac .  fineSol - the interpolation of coarseSol to the fine mesh
23451f3379b2SToby Isaac 
23461f3379b2SToby Isaac    Level: developer
23471f3379b2SToby Isaac 
23481f3379b2SToby Isaac    Note: This function exists because the interpolation of a solution vector between meshes is not always a linear
23491f3379b2SToby Isaac    map.  For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed
23501f3379b2SToby Isaac    out of the solution vector.  Or if interpolation is inherently a nonlinear operation, such as a method using
23511f3379b2SToby Isaac    slope-limiting reconstruction.
23521f3379b2SToby Isaac 
23531f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation()
23541f3379b2SToby Isaac @*/
23551f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol)
23561f3379b2SToby Isaac {
23571f3379b2SToby Isaac   PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL;
23581f3379b2SToby Isaac   PetscErrorCode ierr;
23591f3379b2SToby Isaac 
23601f3379b2SToby Isaac   PetscFunctionBegin;
23611f3379b2SToby Isaac   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
23621f3379b2SToby Isaac   if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3);
23631f3379b2SToby Isaac   PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4);
23641f3379b2SToby Isaac   PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5);
23651f3379b2SToby Isaac 
23661f3379b2SToby Isaac   ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr);
23671f3379b2SToby Isaac   if (interpsol) {
23681f3379b2SToby Isaac     ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr);
23691f3379b2SToby Isaac   } else if (interp) {
23701f3379b2SToby Isaac     ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr);
237198921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name);
23721f3379b2SToby Isaac   PetscFunctionReturn(0);
23731f3379b2SToby Isaac }
23741f3379b2SToby Isaac 
23751f3379b2SToby Isaac /*@
2376aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2377eb3f98d2SBarry Smith 
2378eb3f98d2SBarry Smith     Not Collective
2379eb3f98d2SBarry Smith 
2380eb3f98d2SBarry Smith     Input Parameter:
2381eb3f98d2SBarry Smith .   dm - the DM object
2382eb3f98d2SBarry Smith 
2383eb3f98d2SBarry Smith     Output Parameter:
2384eb3f98d2SBarry Smith .   level - number of refinements
2385eb3f98d2SBarry Smith 
2386eb3f98d2SBarry Smith     Level: developer
2387eb3f98d2SBarry Smith 
23886a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2389eb3f98d2SBarry Smith 
2390eb3f98d2SBarry Smith @*/
2391eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2392eb3f98d2SBarry Smith {
2393eb3f98d2SBarry Smith   PetscFunctionBegin;
2394eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2395eb3f98d2SBarry Smith   *level = dm->levelup;
2396eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2397eb3f98d2SBarry Smith }
2398eb3f98d2SBarry Smith 
2399fef3a512SBarry Smith /*@
2400aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2401fef3a512SBarry Smith 
2402fef3a512SBarry Smith     Not Collective
2403fef3a512SBarry Smith 
2404d8d19677SJose E. Roman     Input Parameters:
2405fef3a512SBarry Smith +   dm - the DM object
2406fef3a512SBarry Smith -   level - number of refinements
2407fef3a512SBarry Smith 
2408fef3a512SBarry Smith     Level: advanced
2409fef3a512SBarry Smith 
241095452b02SPatrick Sanan     Notes:
241195452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2412fef3a512SBarry Smith 
2413fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2414fef3a512SBarry Smith 
2415fef3a512SBarry Smith @*/
2416fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2417fef3a512SBarry Smith {
2418fef3a512SBarry Smith   PetscFunctionBegin;
2419fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2420fef3a512SBarry Smith   dm->levelup = level;
2421fef3a512SBarry Smith   PetscFunctionReturn(0);
2422fef3a512SBarry Smith }
2423fef3a512SBarry Smith 
2424d410b0cfSMatthew G. Knepley /*@
2425d410b0cfSMatthew G. Knepley   DMExtrude - Extrude a DM object from a surface
2426d410b0cfSMatthew G. Knepley 
2427d410b0cfSMatthew G. Knepley   Collective on dm
2428d410b0cfSMatthew G. Knepley 
2429f1a722f8SMatthew G. Knepley   Input Parameters:
2430d410b0cfSMatthew G. Knepley + dm     - the DM object
2431d410b0cfSMatthew G. Knepley - layers - the number of extruded cell layers
2432d410b0cfSMatthew G. Knepley 
2433d410b0cfSMatthew G. Knepley   Output Parameter:
2434d410b0cfSMatthew G. Knepley . dme - the extruded DM, or NULL
2435d410b0cfSMatthew G. Knepley 
2436d410b0cfSMatthew G. Knepley   Note: If no extrusion was done, the return value is NULL
2437d410b0cfSMatthew G. Knepley 
2438d410b0cfSMatthew G. Knepley   Level: developer
2439d410b0cfSMatthew G. Knepley 
2440d410b0cfSMatthew G. Knepley .seealso DMRefine(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector()
2441d410b0cfSMatthew G. Knepley @*/
2442d410b0cfSMatthew G. Knepley PetscErrorCode DMExtrude(DM dm, PetscInt layers, DM *dme)
2443d410b0cfSMatthew G. Knepley {
2444d410b0cfSMatthew G. Knepley   PetscErrorCode ierr;
2445d410b0cfSMatthew G. Knepley 
2446d410b0cfSMatthew G. Knepley   PetscFunctionBegin;
2447d410b0cfSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
24482c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->extrude,PetscObjectComm((PetscObject) dm), PETSC_ERR_SUP, "DM type %s does not implement DMExtrude", ((PetscObject) dm)->type_name);
2449d410b0cfSMatthew G. Knepley   ierr = (*dm->ops->extrude)(dm, layers, dme);CHKERRQ(ierr);
2450d410b0cfSMatthew G. Knepley   if (*dme) {
2451d410b0cfSMatthew G. Knepley     (*dme)->ops->creatematrix = dm->ops->creatematrix;
2452d410b0cfSMatthew G. Knepley     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject) dm, (PetscObject) *dme);CHKERRQ(ierr);
2453d410b0cfSMatthew G. Knepley     (*dme)->ctx = dm->ctx;
2454d410b0cfSMatthew G. Knepley     ierr = DMSetMatType(*dme, dm->mattype);CHKERRQ(ierr);
2455d410b0cfSMatthew G. Knepley   }
2456d410b0cfSMatthew G. Knepley   PetscFunctionReturn(0);
2457d410b0cfSMatthew G. Knepley }
2458d410b0cfSMatthew G. Knepley 
2459ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2460ca3d3a14SMatthew G. Knepley {
2461ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2462ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2463ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2464ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2465ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2466ca3d3a14SMatthew G. Knepley }
2467ca3d3a14SMatthew G. Knepley 
2468ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2469ca3d3a14SMatthew G. Knepley {
2470ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2471ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2472ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2473ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2474ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2475ca3d3a14SMatthew G. Knepley }
2476ca3d3a14SMatthew G. Knepley 
2477ca3d3a14SMatthew G. Knepley /*@
2478c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2479ca3d3a14SMatthew G. Knepley 
2480ca3d3a14SMatthew G. Knepley   Input Parameter:
2481ca3d3a14SMatthew G. Knepley . dm - The DM
2482ca3d3a14SMatthew G. Knepley 
2483ca3d3a14SMatthew G. Knepley   Output Parameter:
2484ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2485ca3d3a14SMatthew G. Knepley 
2486ca3d3a14SMatthew G. Knepley   Level: developer
2487ca3d3a14SMatthew G. Knepley 
2488436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2489ca3d3a14SMatthew G. Knepley @*/
2490ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2491ca3d3a14SMatthew G. Knepley {
2492ca3d3a14SMatthew G. Knepley   Vec            tv;
2493ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2494ca3d3a14SMatthew G. Knepley 
2495ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2496ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2497534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
2498ca3d3a14SMatthew G. Knepley   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2499ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2500ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2501ca3d3a14SMatthew G. Knepley }
2502ca3d3a14SMatthew G. Knepley 
2503ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2504ca3d3a14SMatthew G. Knepley {
2505ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2506ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2507ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2508ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2509ca3d3a14SMatthew G. Knepley 
2510ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2511ca3d3a14SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
251292fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2513ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2514ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2515ca3d3a14SMatthew G. Knepley   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
251692fd8e1eSJed Brown   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2517ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2518ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2519ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2520ca3d3a14SMatthew G. Knepley     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2521ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2522ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2523ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2524ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2525ca3d3a14SMatthew G. Knepley       if (!dof) continue;
2526ca3d3a14SMatthew G. Knepley       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2527ca3d3a14SMatthew G. Knepley       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2528ca3d3a14SMatthew G. Knepley     }
2529ca3d3a14SMatthew G. Knepley   }
2530ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2531ca3d3a14SMatthew G. Knepley   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2532ca3d3a14SMatthew G. Knepley   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2533ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2534ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2535ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2536ca3d3a14SMatthew G. Knepley       if (dof) {
2537ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2538ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2539ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2540ca3d3a14SMatthew G. Knepley 
2541ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
2542ca3d3a14SMatthew G. Knepley         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2543ca3d3a14SMatthew G. Knepley         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2544580bdb30SBarry Smith         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2545ca3d3a14SMatthew G. Knepley       }
2546ca3d3a14SMatthew G. Knepley     }
2547ca3d3a14SMatthew G. Knepley   }
2548ca3d3a14SMatthew G. Knepley   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2549ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2550ca3d3a14SMatthew G. Knepley }
2551ca3d3a14SMatthew G. Knepley 
2552ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2553ca3d3a14SMatthew G. Knepley {
2554ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2555ca3d3a14SMatthew G. Knepley 
2556ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2557ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2558ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2559ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2560ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2561ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2562ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
2563ca3d3a14SMatthew G. Knepley   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2564ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2565ca3d3a14SMatthew G. Knepley }
2566ca3d3a14SMatthew G. Knepley 
2567bb9467b5SJed Brown /*@C
2568baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2569baf369e7SPeter Brune 
2570baf369e7SPeter Brune    Logically Collective
2571baf369e7SPeter Brune 
25724165533cSJose E. Roman    Input Parameters:
2573baf369e7SPeter Brune +  dm - the DM
2574baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2575baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
25760298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2577baf369e7SPeter Brune 
2578baf369e7SPeter Brune    Calling sequence for beginhook:
2579baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2580baf369e7SPeter Brune 
2581baf369e7SPeter Brune +  dm - global DM
2582baf369e7SPeter Brune .  g - global vector
2583baf369e7SPeter Brune .  mode - mode
2584baf369e7SPeter Brune .  l - local vector
2585baf369e7SPeter Brune -  ctx - optional user-defined function context
2586baf369e7SPeter Brune 
2587baf369e7SPeter Brune    Calling sequence for endhook:
2588ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2589baf369e7SPeter Brune 
2590baf369e7SPeter Brune +  global - global DM
2591baf369e7SPeter Brune -  ctx - optional user-defined function context
2592baf369e7SPeter Brune 
2593baf369e7SPeter Brune    Level: advanced
2594baf369e7SPeter Brune 
2595baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2596baf369e7SPeter Brune @*/
2597baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2598baf369e7SPeter Brune {
2599baf369e7SPeter Brune   PetscErrorCode          ierr;
2600baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2601baf369e7SPeter Brune 
2602baf369e7SPeter Brune   PetscFunctionBegin;
2603baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2604baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
260595dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2606baf369e7SPeter Brune   link->beginhook = beginhook;
2607baf369e7SPeter Brune   link->endhook   = endhook;
2608baf369e7SPeter Brune   link->ctx       = ctx;
26090298fd71SBarry Smith   link->next      = NULL;
2610baf369e7SPeter Brune   *p              = link;
2611baf369e7SPeter Brune   PetscFunctionReturn(0);
2612baf369e7SPeter Brune }
2613baf369e7SPeter Brune 
26144c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
26154c274da1SToby Isaac {
26164c274da1SToby Isaac   Mat cMat;
26174c274da1SToby Isaac   Vec cVec;
26184c274da1SToby Isaac   PetscSection section, cSec;
26194c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
26204c274da1SToby Isaac   PetscErrorCode ierr;
26214c274da1SToby Isaac 
26224c274da1SToby Isaac   PetscFunctionBegin;
26234c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
26244c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
26254c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
26265db9a05bSToby Isaac     PetscInt nRows;
26275db9a05bSToby Isaac 
26285db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
26295db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
263092fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
26317711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
26324c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
26334c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
26344c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
26354c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
26364c274da1SToby Isaac       if (dof) {
26374c274da1SToby Isaac         PetscScalar *vals;
26384c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
26394c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
26404c274da1SToby Isaac       }
26414c274da1SToby Isaac     }
26424c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
26434c274da1SToby Isaac   }
26444c274da1SToby Isaac   PetscFunctionReturn(0);
26454c274da1SToby Isaac }
26464c274da1SToby Isaac 
264747c6ae99SBarry Smith /*@
264801729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
264901729b5cSPatrick Sanan 
2650d083f849SBarry Smith     Neighbor-wise Collective on dm
265101729b5cSPatrick Sanan 
265201729b5cSPatrick Sanan     Input Parameters:
265301729b5cSPatrick Sanan +   dm - the DM object
265401729b5cSPatrick Sanan .   g - the global vector
265501729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
265601729b5cSPatrick Sanan -   l - the local vector
265701729b5cSPatrick Sanan 
265801729b5cSPatrick Sanan     Notes:
265901729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
266001729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
266101729b5cSPatrick Sanan 
266201729b5cSPatrick Sanan     Level: beginner
266301729b5cSPatrick Sanan 
266401729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
266501729b5cSPatrick Sanan 
266601729b5cSPatrick Sanan @*/
266701729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
266801729b5cSPatrick Sanan {
266901729b5cSPatrick Sanan   PetscErrorCode ierr;
267001729b5cSPatrick Sanan 
267101729b5cSPatrick Sanan   PetscFunctionBegin;
267201729b5cSPatrick Sanan   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
267301729b5cSPatrick Sanan   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
267401729b5cSPatrick Sanan   PetscFunctionReturn(0);
267501729b5cSPatrick Sanan }
267601729b5cSPatrick Sanan 
267701729b5cSPatrick Sanan /*@
267847c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
267947c6ae99SBarry Smith 
2680d083f849SBarry Smith     Neighbor-wise Collective on dm
268147c6ae99SBarry Smith 
268247c6ae99SBarry Smith     Input Parameters:
268347c6ae99SBarry Smith +   dm - the DM object
268447c6ae99SBarry Smith .   g - the global vector
268547c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
268647c6ae99SBarry Smith -   l - the local vector
268747c6ae99SBarry Smith 
268801729b5cSPatrick Sanan     Level: intermediate
268947c6ae99SBarry Smith 
269001729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
269147c6ae99SBarry Smith 
269247c6ae99SBarry Smith @*/
26937087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
269447c6ae99SBarry Smith {
26957128ae9fSMatthew G Knepley   PetscSF                 sf;
269647c6ae99SBarry Smith   PetscErrorCode          ierr;
2697baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
269847c6ae99SBarry Smith 
269947c6ae99SBarry Smith   PetscFunctionBegin;
2700171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2701baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
27028865f1eaSKarl Rupp     if (link->beginhook) {
27038865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
27048865f1eaSKarl Rupp     }
2705baf369e7SPeter Brune   }
27061bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
27077128ae9fSMatthew G Knepley   if (sf) {
2708ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2709ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
2710d0295fc0SJunchao Zhang     PetscMemType      lmtype,gmtype;
27117128ae9fSMatthew G Knepley 
27122c71b3e2SJacob Faibussowitsch     PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2713a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2714a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2715ad227feaSJunchao Zhang     ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr);
2716a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2717a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
27187128ae9fSMatthew G Knepley   } else {
27192c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->globaltolocalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2720843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
27217128ae9fSMatthew G Knepley   }
272247c6ae99SBarry Smith   PetscFunctionReturn(0);
272347c6ae99SBarry Smith }
272447c6ae99SBarry Smith 
272547c6ae99SBarry Smith /*@
272647c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
272747c6ae99SBarry Smith 
2728d083f849SBarry Smith     Neighbor-wise Collective on dm
272947c6ae99SBarry Smith 
273047c6ae99SBarry Smith     Input Parameters:
273147c6ae99SBarry Smith +   dm - the DM object
273247c6ae99SBarry Smith .   g - the global vector
273347c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
273447c6ae99SBarry Smith -   l - the local vector
273547c6ae99SBarry Smith 
273601729b5cSPatrick Sanan     Level: intermediate
273747c6ae99SBarry Smith 
273801729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
273947c6ae99SBarry Smith 
274047c6ae99SBarry Smith @*/
27417087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
274247c6ae99SBarry Smith {
27437128ae9fSMatthew G Knepley   PetscSF                 sf;
274447c6ae99SBarry Smith   PetscErrorCode          ierr;
2745ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2746ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2747ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2748baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
2749d0295fc0SJunchao Zhang   PetscMemType            lmtype,gmtype;
275047c6ae99SBarry Smith 
275147c6ae99SBarry Smith   PetscFunctionBegin;
2752171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27531bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2754ca3d3a14SMatthew G. Knepley   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
27557128ae9fSMatthew G Knepley   if (sf) {
27562c71b3e2SJacob Faibussowitsch     PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
27577128ae9fSMatthew G Knepley 
2758a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2759a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2760ad227feaSJunchao Zhang     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr);
2761a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2762a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
2763ca3d3a14SMatthew G. Knepley     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
27647128ae9fSMatthew G Knepley   } else {
27652c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->globaltolocalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2766843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
27677128ae9fSMatthew G Knepley   }
27684c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2769baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2770baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2771baf369e7SPeter Brune   }
277247c6ae99SBarry Smith   PetscFunctionReturn(0);
277347c6ae99SBarry Smith }
277447c6ae99SBarry Smith 
2775d4d07f1eSToby Isaac /*@C
2776d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2777d4d07f1eSToby Isaac 
2778d4d07f1eSToby Isaac    Logically Collective
2779d4d07f1eSToby Isaac 
27804165533cSJose E. Roman    Input Parameters:
2781d4d07f1eSToby Isaac +  dm - the DM
2782d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2783d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2784d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2785d4d07f1eSToby Isaac 
2786d4d07f1eSToby Isaac    Calling sequence for beginhook:
2787d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2788d4d07f1eSToby Isaac 
2789d4d07f1eSToby Isaac +  dm - global DM
2790d4d07f1eSToby Isaac .  l - local vector
2791d4d07f1eSToby Isaac .  mode - mode
2792d4d07f1eSToby Isaac .  g - global vector
2793d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2794d4d07f1eSToby Isaac 
2795d4d07f1eSToby Isaac    Calling sequence for endhook:
2796d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2797d4d07f1eSToby Isaac 
2798d4d07f1eSToby Isaac +  global - global DM
2799d4d07f1eSToby Isaac .  l - local vector
2800d4d07f1eSToby Isaac .  mode - mode
2801d4d07f1eSToby Isaac .  g - global vector
2802d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2803d4d07f1eSToby Isaac 
2804d4d07f1eSToby Isaac    Level: advanced
2805d4d07f1eSToby Isaac 
2806d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2807d4d07f1eSToby Isaac @*/
2808d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2809d4d07f1eSToby Isaac {
2810d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2811d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2812d4d07f1eSToby Isaac 
2813d4d07f1eSToby Isaac   PetscFunctionBegin;
2814d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2815d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
281695dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2817d4d07f1eSToby Isaac   link->beginhook = beginhook;
2818d4d07f1eSToby Isaac   link->endhook   = endhook;
2819d4d07f1eSToby Isaac   link->ctx       = ctx;
2820d4d07f1eSToby Isaac   link->next      = NULL;
2821d4d07f1eSToby Isaac   *p              = link;
2822d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2823d4d07f1eSToby Isaac }
2824d4d07f1eSToby Isaac 
28254c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
28264c274da1SToby Isaac {
28274c274da1SToby Isaac   Mat cMat;
28284c274da1SToby Isaac   Vec cVec;
28294c274da1SToby Isaac   PetscSection section, cSec;
28304c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
28314c274da1SToby Isaac   PetscErrorCode ierr;
28324c274da1SToby Isaac 
28334c274da1SToby Isaac   PetscFunctionBegin;
28344c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
28354c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
28364c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
28375db9a05bSToby Isaac     PetscInt nRows;
28385db9a05bSToby Isaac 
28395db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
28405db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
284192fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
28427711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
28434c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
28444c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
28454c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
28464c274da1SToby Isaac       if (dof) {
28474c274da1SToby Isaac         PetscInt d;
28484c274da1SToby Isaac         PetscScalar *vals;
28494c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
28504c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
28514c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
28524c274da1SToby Isaac          * we just extracted */
28534c274da1SToby Isaac         for (d = 0; d < dof; d++) {
28544c274da1SToby Isaac           vals[d] = 0.;
28554c274da1SToby Isaac         }
28564c274da1SToby Isaac       }
28574c274da1SToby Isaac     }
28584c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
28594c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
28604c274da1SToby Isaac   }
28614c274da1SToby Isaac   PetscFunctionReturn(0);
28624c274da1SToby Isaac }
286301729b5cSPatrick Sanan /*@
286401729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
286501729b5cSPatrick Sanan 
2866d083f849SBarry Smith     Neighbor-wise Collective on dm
286701729b5cSPatrick Sanan 
286801729b5cSPatrick Sanan     Input Parameters:
286901729b5cSPatrick Sanan +   dm - the DM object
287001729b5cSPatrick Sanan .   l - the local vector
287101729b5cSPatrick 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.
287201729b5cSPatrick Sanan -   g - the global vector
287301729b5cSPatrick Sanan 
287401729b5cSPatrick Sanan     Notes:
287501729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
287601729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
287701729b5cSPatrick Sanan 
287801729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
287901729b5cSPatrick 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.
288001729b5cSPatrick Sanan 
288101729b5cSPatrick Sanan     Level: beginner
288201729b5cSPatrick Sanan 
288301729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
288401729b5cSPatrick Sanan 
288501729b5cSPatrick Sanan @*/
288601729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
288701729b5cSPatrick Sanan {
288801729b5cSPatrick Sanan   PetscErrorCode ierr;
288901729b5cSPatrick Sanan 
289001729b5cSPatrick Sanan   PetscFunctionBegin;
289101729b5cSPatrick Sanan   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
289201729b5cSPatrick Sanan   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
289301729b5cSPatrick Sanan   PetscFunctionReturn(0);
289401729b5cSPatrick Sanan }
28954c274da1SToby Isaac 
289647c6ae99SBarry Smith /*@
289701729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
28989a42bb27SBarry Smith 
2899d083f849SBarry Smith     Neighbor-wise Collective on dm
29009a42bb27SBarry Smith 
29019a42bb27SBarry Smith     Input Parameters:
29029a42bb27SBarry Smith +   dm - the DM object
2903f6813fd5SJed Brown .   l - the local vector
29041eb28f2eSBarry 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.
29051eb28f2eSBarry Smith -   g - the global vector
29069a42bb27SBarry Smith 
290795452b02SPatrick Sanan     Notes:
290895452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
290984330215SMatthew 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.
29109a42bb27SBarry Smith 
291101729b5cSPatrick Sanan     Level: intermediate
29129a42bb27SBarry Smith 
291301729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
29149a42bb27SBarry Smith 
29159a42bb27SBarry Smith @*/
29167087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
29179a42bb27SBarry Smith {
29187128ae9fSMatthew G Knepley   PetscSF                 sf;
291984330215SMatthew G. Knepley   PetscSection            s, gs;
2920d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2921ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2922ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2923ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2924fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
292584330215SMatthew G. Knepley   PetscErrorCode          ierr;
2926d0295fc0SJunchao Zhang   PetscMemType            lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST;
29279a42bb27SBarry Smith 
29289a42bb27SBarry Smith   PetscFunctionBegin;
2929171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2930d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2931d4d07f1eSToby Isaac     if (link->beginhook) {
2932d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2933d4d07f1eSToby Isaac     }
2934d4d07f1eSToby Isaac   }
29354c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
29361bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
293792fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
29387128ae9fSMatthew G Knepley   switch (mode) {
29397128ae9fSMatthew G Knepley   case INSERT_VALUES:
29407128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2941304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
294284330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
29437128ae9fSMatthew G Knepley   case ADD_VALUES:
29447128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2945304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
294684330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
29477128ae9fSMatthew G Knepley   default:
294898921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
29497128ae9fSMatthew G Knepley   }
2950ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
2951ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2952ca3d3a14SMatthew G. Knepley     if (transform) {
2953ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2954ca3d3a14SMatthew G. Knepley       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2955ca3d3a14SMatthew G. Knepley       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2956ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2957fa88e482SJed Brown     } else if (isInsert) {
2958ae5cfb4aSMatthew G. Knepley       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2959fa88e482SJed Brown     } else {
2960a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2961fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2962ca3d3a14SMatthew G. Knepley     }
2963fa88e482SJed Brown     if (s && isInsert) {
29647128ae9fSMatthew G Knepley       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2965fa88e482SJed Brown     } else {
2966a256111fSJunchao Zhang       ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2967fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2968fa88e482SJed Brown     }
2969ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
2970d0295fc0SJunchao Zhang       ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr);
297184330215SMatthew G. Knepley     } else if (s && isInsert) {
297284330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
297384330215SMatthew G. Knepley 
2974e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
297584330215SMatthew G. Knepley       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
297684330215SMatthew G. Knepley       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
297784330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2978b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
297984330215SMatthew G. Knepley 
298084330215SMatthew G. Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
298103442857SMatthew G. Knepley         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
298284330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2983b3b16f48SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
298484330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
298584330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2986b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
298703442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
29882c71b3e2SJacob Faibussowitsch         PetscCheckFalse(dof != gdof,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
2989b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2990b3b16f48SMatthew G. Knepley         if (!gcdof) {
299184330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2992b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2993b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
299484330215SMatthew G. Knepley           const PetscInt *cdofs;
299584330215SMatthew G. Knepley           PetscInt        cind = 0;
299684330215SMatthew G. Knepley 
299784330215SMatthew G. Knepley           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2998b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
299984330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
3000b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
300184330215SMatthew G. Knepley           }
300298921bdaSJacob Faibussowitsch         } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
300384330215SMatthew G. Knepley       }
3004ca3d3a14SMatthew G. Knepley     }
3005fa88e482SJed Brown     if (g_inplace) {
3006a256111fSJunchao Zhang       ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
3007fa88e482SJed Brown     } else {
30087128ae9fSMatthew G Knepley       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
3009fa88e482SJed Brown     }
3010ca3d3a14SMatthew G. Knepley     if (transform) {
3011ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3012ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3013fa88e482SJed Brown     } else if (l_inplace) {
3014a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
3015ca3d3a14SMatthew G. Knepley     } else {
3016ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
3017ca3d3a14SMatthew G. Knepley     }
30187128ae9fSMatthew G Knepley   } else {
30192c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->localtoglobalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
3020843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
30217128ae9fSMatthew G Knepley   }
30229a42bb27SBarry Smith   PetscFunctionReturn(0);
30239a42bb27SBarry Smith }
30249a42bb27SBarry Smith 
30259a42bb27SBarry Smith /*@
30269a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
302747c6ae99SBarry Smith 
3028d083f849SBarry Smith     Neighbor-wise Collective on dm
302947c6ae99SBarry Smith 
303047c6ae99SBarry Smith     Input Parameters:
303147c6ae99SBarry Smith +   dm - the DM object
3032f6813fd5SJed Brown .   l - the local vector
303347c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
3034f6813fd5SJed Brown -   g - the global vector
303547c6ae99SBarry Smith 
303601729b5cSPatrick Sanan     Level: intermediate
303747c6ae99SBarry Smith 
3038e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
303947c6ae99SBarry Smith 
304047c6ae99SBarry Smith @*/
30417087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
304247c6ae99SBarry Smith {
30437128ae9fSMatthew G Knepley   PetscSF                 sf;
304484330215SMatthew G. Knepley   PetscSection            s;
3045d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
3046ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
304784330215SMatthew G. Knepley   PetscErrorCode          ierr;
304847c6ae99SBarry Smith 
304947c6ae99SBarry Smith   PetscFunctionBegin;
3050171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
30511bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
305292fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
30537128ae9fSMatthew G Knepley   switch (mode) {
30547128ae9fSMatthew G Knepley   case INSERT_VALUES:
30557128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
305684330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
30577128ae9fSMatthew G Knepley   case ADD_VALUES:
30587128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
305984330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
30607128ae9fSMatthew G Knepley   default:
306198921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
30627128ae9fSMatthew G Knepley   }
306384330215SMatthew G. Knepley   if (sf && !isInsert) {
3064ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
3065ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
3066ca3d3a14SMatthew G. Knepley     Vec                tmpl;
306784330215SMatthew G. Knepley 
3068ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
3069ca3d3a14SMatthew G. Knepley     if (transform) {
3070ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3071ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3072ca3d3a14SMatthew G. Knepley     } else {
3073a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr);
3074ca3d3a14SMatthew G. Knepley     }
3075a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr);
3076a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
3077ca3d3a14SMatthew G. Knepley     if (transform) {
3078ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3079ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3080ca3d3a14SMatthew G. Knepley     } else {
3081a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
3082ca3d3a14SMatthew G. Knepley     }
3083a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
308484330215SMatthew G. Knepley   } else if (s && isInsert) {
30857128ae9fSMatthew G Knepley   } else {
30862c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->localtoglobalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
3087843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
30887128ae9fSMatthew G Knepley   }
3089d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
3090d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
3091d4d07f1eSToby Isaac   }
309247c6ae99SBarry Smith   PetscFunctionReturn(0);
309347c6ae99SBarry Smith }
309447c6ae99SBarry Smith 
3095f089877aSRichard Tran Mills /*@
3096bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
3097bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3098d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
3099f089877aSRichard Tran Mills 
3100d083f849SBarry Smith    Neighbor-wise Collective on dm
3101f089877aSRichard Tran Mills 
3102f089877aSRichard Tran Mills    Input Parameters:
3103f089877aSRichard Tran Mills +  dm - the DM object
3104bc0a1609SRichard Tran Mills .  g - the original local vector
3105bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3106f089877aSRichard Tran Mills 
3107bc0a1609SRichard Tran Mills    Output Parameter:
3108bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3109f089877aSRichard Tran Mills 
3110f089877aSRichard Tran Mills    Level: intermediate
3111f089877aSRichard Tran Mills 
3112bc0a1609SRichard Tran Mills    Notes:
3113bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3114bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3115bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3116bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3117bc0a1609SRichard Tran Mills 
3118bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3119f089877aSRichard Tran Mills 
3120f089877aSRichard Tran Mills @*/
3121f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
3122f089877aSRichard Tran Mills {
3123f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3124f089877aSRichard Tran Mills 
3125f089877aSRichard Tran Mills   PetscFunctionBegin;
3126f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31272c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->localtolocalbegin,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3128f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3129f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3130f089877aSRichard Tran Mills }
3131f089877aSRichard Tran Mills 
3132f089877aSRichard Tran Mills /*@
3133bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
3134bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3135d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
3136f089877aSRichard Tran Mills 
3137d083f849SBarry Smith    Neighbor-wise Collective on dm
3138f089877aSRichard Tran Mills 
3139f089877aSRichard Tran Mills    Input Parameters:
3140bc0a1609SRichard Tran Mills +  da - the DM object
3141bc0a1609SRichard Tran Mills .  g - the original local vector
3142bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3143f089877aSRichard Tran Mills 
3144bc0a1609SRichard Tran Mills    Output Parameter:
3145bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3146f089877aSRichard Tran Mills 
3147f089877aSRichard Tran Mills    Level: intermediate
3148f089877aSRichard Tran Mills 
3149bc0a1609SRichard Tran Mills    Notes:
3150bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3151bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3152bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3153bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3154bc0a1609SRichard Tran Mills 
3155bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3156f089877aSRichard Tran Mills 
3157f089877aSRichard Tran Mills @*/
3158f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
3159f089877aSRichard Tran Mills {
3160f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3161f089877aSRichard Tran Mills 
3162f089877aSRichard Tran Mills   PetscFunctionBegin;
3163f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31642c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->localtolocalend,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3165f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3166f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3167f089877aSRichard Tran Mills }
3168f089877aSRichard Tran Mills 
316947c6ae99SBarry Smith /*@
317047c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
317147c6ae99SBarry Smith 
3172d083f849SBarry Smith     Collective on dm
317347c6ae99SBarry Smith 
3174d8d19677SJose E. Roman     Input Parameters:
317547c6ae99SBarry Smith +   dm - the DM object
317691d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
317747c6ae99SBarry Smith 
317847c6ae99SBarry Smith     Output Parameter:
317947c6ae99SBarry Smith .   dmc - the coarsened DM
318047c6ae99SBarry Smith 
318147c6ae99SBarry Smith     Level: developer
318247c6ae99SBarry Smith 
3183e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
318447c6ae99SBarry Smith 
318547c6ae99SBarry Smith @*/
31867087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
318747c6ae99SBarry Smith {
318847c6ae99SBarry Smith   PetscErrorCode    ierr;
3189b17ce1afSJed Brown   DMCoarsenHookLink link;
319047c6ae99SBarry Smith 
319147c6ae99SBarry Smith   PetscFunctionBegin;
3192171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31932c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->coarsen,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
319447a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
319547c6ae99SBarry Smith   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
3196b9d85ea2SLisandro Dalcin   if (*dmc) {
3197a3574896SRichard Tran Mills     (*dmc)->bind_below = dm->bind_below; /* Propagate this from parent DM; otherwise -dm_bind_below will be useless for multigrid cases. */
3198a8fb8f29SToby Isaac     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
319943842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
32008cd211a4SJed Brown     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
3201644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
32020598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
3203656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
3204e4b4b23bSJed Brown     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
3205b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
3206b17ce1afSJed Brown       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
3207b17ce1afSJed Brown     }
3208b9d85ea2SLisandro Dalcin   }
320947a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
32102c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!(*dmc),PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3211b17ce1afSJed Brown   PetscFunctionReturn(0);
3212b17ce1afSJed Brown }
3213b17ce1afSJed Brown 
3214bb9467b5SJed Brown /*@C
3215b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3216b17ce1afSJed Brown 
3217b17ce1afSJed Brown    Logically Collective
3218b17ce1afSJed Brown 
32194165533cSJose E. Roman    Input Parameters:
3220b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3221b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3222b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
32230298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3224b17ce1afSJed Brown 
3225b17ce1afSJed Brown    Calling sequence of coarsenhook:
3226b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3227b17ce1afSJed Brown 
3228b17ce1afSJed Brown +  fine - fine level DM
3229b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3230b17ce1afSJed Brown -  ctx - optional user-defined function context
3231b17ce1afSJed Brown 
3232b17ce1afSJed Brown    Calling sequence for restricthook:
3233c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3234b17ce1afSJed Brown 
3235b17ce1afSJed Brown +  fine - fine level DM
3236b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3237c833c3b5SJed Brown .  rscale - scaling vector for restriction
3238c833c3b5SJed Brown .  inject - matrix restricting by injection
3239b17ce1afSJed Brown .  coarse - coarse level DM to update
3240b17ce1afSJed Brown -  ctx - optional user-defined function context
3241b17ce1afSJed Brown 
3242b17ce1afSJed Brown    Level: advanced
3243b17ce1afSJed Brown 
3244b17ce1afSJed Brown    Notes:
3245b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3246b17ce1afSJed Brown 
3247b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3248b17ce1afSJed Brown 
3249b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3250b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3251b17ce1afSJed Brown 
3252bb9467b5SJed Brown    This function is currently not available from Fortran.
3253bb9467b5SJed Brown 
3254dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3255b17ce1afSJed Brown @*/
3256b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3257b17ce1afSJed Brown {
3258b17ce1afSJed Brown   PetscErrorCode    ierr;
3259b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3260b17ce1afSJed Brown 
3261b17ce1afSJed Brown   PetscFunctionBegin;
3262b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
32631e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
32641e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
32651e3d8eccSJed Brown   }
326695dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
3267b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3268b17ce1afSJed Brown   link->restricthook = restricthook;
3269b17ce1afSJed Brown   link->ctx          = ctx;
32700298fd71SBarry Smith   link->next         = NULL;
3271b17ce1afSJed Brown   *p                 = link;
3272b17ce1afSJed Brown   PetscFunctionReturn(0);
3273b17ce1afSJed Brown }
3274b17ce1afSJed Brown 
3275dc822a44SJed Brown /*@C
3276dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3277dc822a44SJed Brown 
3278dc822a44SJed Brown    Logically Collective
3279dc822a44SJed Brown 
32804165533cSJose E. Roman    Input Parameters:
3281dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3282dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3283dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3284dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3285dc822a44SJed Brown 
3286dc822a44SJed Brown    Level: advanced
3287dc822a44SJed Brown 
3288dc822a44SJed Brown    Notes:
3289dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3290dc822a44SJed Brown 
3291dc822a44SJed Brown    This function is currently not available from Fortran.
3292dc822a44SJed Brown 
3293dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3294dc822a44SJed Brown @*/
3295dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3296dc822a44SJed Brown {
3297dc822a44SJed Brown   PetscErrorCode    ierr;
3298dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3299dc822a44SJed Brown 
3300dc822a44SJed Brown   PetscFunctionBegin;
3301dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3302dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3303dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3304dc822a44SJed Brown       link = *p;
3305dc822a44SJed Brown       *p = link->next;
3306dc822a44SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3307dc822a44SJed Brown       break;
3308dc822a44SJed Brown     }
3309dc822a44SJed Brown   }
3310dc822a44SJed Brown   PetscFunctionReturn(0);
3311dc822a44SJed Brown }
3312dc822a44SJed Brown 
3313b17ce1afSJed Brown /*@
3314b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3315b17ce1afSJed Brown 
3316b17ce1afSJed Brown    Collective if any hooks are
3317b17ce1afSJed Brown 
33184165533cSJose E. Roman    Input Parameters:
3319b17ce1afSJed Brown +  fine - finer DM to use as a base
3320b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3321e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3322b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3323e91eccc2SStefano Zampini -  coarse - coarser DM to update
3324b17ce1afSJed Brown 
3325b17ce1afSJed Brown    Level: developer
3326b17ce1afSJed Brown 
3327b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3328b17ce1afSJed Brown @*/
3329b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3330b17ce1afSJed Brown {
3331b17ce1afSJed Brown   PetscErrorCode    ierr;
3332b17ce1afSJed Brown   DMCoarsenHookLink link;
3333b17ce1afSJed Brown 
3334b17ce1afSJed Brown   PetscFunctionBegin;
3335b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
33368865f1eaSKarl Rupp     if (link->restricthook) {
33378865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
33388865f1eaSKarl Rupp     }
3339b17ce1afSJed Brown   }
334047c6ae99SBarry Smith   PetscFunctionReturn(0);
334147c6ae99SBarry Smith }
334247c6ae99SBarry Smith 
3343bb9467b5SJed Brown /*@C
3344be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
33455dbd56e3SPeter Brune 
3346d083f849SBarry Smith    Logically Collective on global
33475dbd56e3SPeter Brune 
33484165533cSJose E. Roman    Input Parameters:
33495dbd56e3SPeter Brune +  global - global DM
3350ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
33515dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
33520298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
33535dbd56e3SPeter Brune 
3354ec4806b8SPeter Brune    Calling sequence for ddhook:
3355ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3356ec4806b8SPeter Brune 
3357ec4806b8SPeter Brune +  global - global DM
3358ec4806b8SPeter Brune .  block  - block DM
3359ec4806b8SPeter Brune -  ctx - optional user-defined function context
3360ec4806b8SPeter Brune 
33615dbd56e3SPeter Brune    Calling sequence for restricthook:
3362ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
33635dbd56e3SPeter Brune 
33645dbd56e3SPeter Brune +  global - global DM
33655dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
33665dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3367ec4806b8SPeter Brune .  block  - block DM
33685dbd56e3SPeter Brune -  ctx - optional user-defined function context
33695dbd56e3SPeter Brune 
33705dbd56e3SPeter Brune    Level: advanced
33715dbd56e3SPeter Brune 
33725dbd56e3SPeter Brune    Notes:
3373ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
33745dbd56e3SPeter Brune 
33755dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
33765dbd56e3SPeter Brune 
33775dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3378ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
33795dbd56e3SPeter Brune 
3380bb9467b5SJed Brown    This function is currently not available from Fortran.
3381bb9467b5SJed Brown 
33825dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
33835dbd56e3SPeter Brune @*/
3384be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
33855dbd56e3SPeter Brune {
33865dbd56e3SPeter Brune   PetscErrorCode      ierr;
3387be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
33885dbd56e3SPeter Brune 
33895dbd56e3SPeter Brune   PetscFunctionBegin;
33905dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3391b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3392b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3393b3a6b972SJed Brown   }
339495dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
33955dbd56e3SPeter Brune   link->restricthook = restricthook;
3396be081cd6SPeter Brune   link->ddhook       = ddhook;
33975dbd56e3SPeter Brune   link->ctx          = ctx;
33980298fd71SBarry Smith   link->next         = NULL;
33995dbd56e3SPeter Brune   *p                 = link;
34005dbd56e3SPeter Brune   PetscFunctionReturn(0);
34015dbd56e3SPeter Brune }
34025dbd56e3SPeter Brune 
3403b3a6b972SJed Brown /*@C
3404b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3405b3a6b972SJed Brown 
3406b3a6b972SJed Brown    Logically Collective
3407b3a6b972SJed Brown 
34084165533cSJose E. Roman    Input Parameters:
3409b3a6b972SJed Brown +  global - global DM
3410b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3411b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3412b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3413b3a6b972SJed Brown 
3414b3a6b972SJed Brown    Level: advanced
3415b3a6b972SJed Brown 
3416b3a6b972SJed Brown    Notes:
3417b3a6b972SJed Brown 
3418b3a6b972SJed Brown    This function is currently not available from Fortran.
3419b3a6b972SJed Brown 
3420b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3421b3a6b972SJed Brown @*/
3422b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3423b3a6b972SJed Brown {
3424b3a6b972SJed Brown   PetscErrorCode      ierr;
3425b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3426b3a6b972SJed Brown 
3427b3a6b972SJed Brown   PetscFunctionBegin;
3428b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3429b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3430b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3431b3a6b972SJed Brown       link = *p;
3432b3a6b972SJed Brown       *p = link->next;
3433b3a6b972SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3434b3a6b972SJed Brown       break;
3435b3a6b972SJed Brown     }
3436b3a6b972SJed Brown   }
3437b3a6b972SJed Brown   PetscFunctionReturn(0);
3438b3a6b972SJed Brown }
3439b3a6b972SJed Brown 
34405dbd56e3SPeter Brune /*@
3441be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
34425dbd56e3SPeter Brune 
34435dbd56e3SPeter Brune    Collective if any hooks are
34445dbd56e3SPeter Brune 
34454165533cSJose E. Roman    Input Parameters:
34465dbd56e3SPeter Brune +  fine - finer DM to use as a base
3447be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3448be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
34495dbd56e3SPeter Brune -  coarse - coarer DM to update
34505dbd56e3SPeter Brune 
34515dbd56e3SPeter Brune    Level: developer
34525dbd56e3SPeter Brune 
34535dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
34545dbd56e3SPeter Brune @*/
3455be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
34565dbd56e3SPeter Brune {
34575dbd56e3SPeter Brune   PetscErrorCode      ierr;
3458be081cd6SPeter Brune   DMSubDomainHookLink link;
34595dbd56e3SPeter Brune 
34605dbd56e3SPeter Brune   PetscFunctionBegin;
3461be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
34628865f1eaSKarl Rupp     if (link->restricthook) {
34638865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
34648865f1eaSKarl Rupp     }
34655dbd56e3SPeter Brune   }
34665dbd56e3SPeter Brune   PetscFunctionReturn(0);
34675dbd56e3SPeter Brune }
34685dbd56e3SPeter Brune 
34695fe1f584SPeter Brune /*@
34706a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
34715fe1f584SPeter Brune 
34725fe1f584SPeter Brune     Not Collective
34735fe1f584SPeter Brune 
34745fe1f584SPeter Brune     Input Parameter:
34755fe1f584SPeter Brune .   dm - the DM object
34765fe1f584SPeter Brune 
34775fe1f584SPeter Brune     Output Parameter:
34786a7d9d85SPeter Brune .   level - number of coarsenings
34795fe1f584SPeter Brune 
34805fe1f584SPeter Brune     Level: developer
34815fe1f584SPeter Brune 
34826a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34835fe1f584SPeter Brune 
34845fe1f584SPeter Brune @*/
34855fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
34865fe1f584SPeter Brune {
34875fe1f584SPeter Brune   PetscFunctionBegin;
34885fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3489b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
34905fe1f584SPeter Brune   *level = dm->leveldown;
34915fe1f584SPeter Brune   PetscFunctionReturn(0);
34925fe1f584SPeter Brune }
34935fe1f584SPeter Brune 
34949a64c4a8SMatthew G. Knepley /*@
34959a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
34969a64c4a8SMatthew G. Knepley 
34979a64c4a8SMatthew G. Knepley     Not Collective
34989a64c4a8SMatthew G. Knepley 
34999a64c4a8SMatthew G. Knepley     Input Parameters:
35009a64c4a8SMatthew G. Knepley +   dm - the DM object
35019a64c4a8SMatthew G. Knepley -   level - number of coarsenings
35029a64c4a8SMatthew G. Knepley 
35039a64c4a8SMatthew G. Knepley     Level: developer
35049a64c4a8SMatthew G. Knepley 
35059a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
35069a64c4a8SMatthew G. Knepley @*/
35079a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
35089a64c4a8SMatthew G. Knepley {
35099a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
35109a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35119a64c4a8SMatthew G. Knepley   dm->leveldown = level;
35129a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
35139a64c4a8SMatthew G. Knepley }
35149a64c4a8SMatthew G. Knepley 
351547c6ae99SBarry Smith /*@C
351647c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
351747c6ae99SBarry Smith 
3518d083f849SBarry Smith     Collective on dm
351947c6ae99SBarry Smith 
3520d8d19677SJose E. Roman     Input Parameters:
352147c6ae99SBarry Smith +   dm - the DM object
352247c6ae99SBarry Smith -   nlevels - the number of levels of refinement
352347c6ae99SBarry Smith 
352447c6ae99SBarry Smith     Output Parameter:
352547c6ae99SBarry Smith .   dmf - the refined DM hierarchy
352647c6ae99SBarry Smith 
352747c6ae99SBarry Smith     Level: developer
352847c6ae99SBarry Smith 
3529e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
353047c6ae99SBarry Smith 
353147c6ae99SBarry Smith @*/
35327087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
353347c6ae99SBarry Smith {
353447c6ae99SBarry Smith   PetscErrorCode ierr;
353547c6ae99SBarry Smith 
353647c6ae99SBarry Smith   PetscFunctionBegin;
3537171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35382c71b3e2SJacob Faibussowitsch   PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
353947c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3540b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
354147c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
354247c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
354347c6ae99SBarry Smith   } else if (dm->ops->refine) {
354447c6ae99SBarry Smith     PetscInt i;
354547c6ae99SBarry Smith 
3546ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
354747c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3548ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
354947c6ae99SBarry Smith     }
3550ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
355147c6ae99SBarry Smith   PetscFunctionReturn(0);
355247c6ae99SBarry Smith }
355347c6ae99SBarry Smith 
355447c6ae99SBarry Smith /*@C
355547c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
355647c6ae99SBarry Smith 
3557d083f849SBarry Smith     Collective on dm
355847c6ae99SBarry Smith 
3559d8d19677SJose E. Roman     Input Parameters:
356047c6ae99SBarry Smith +   dm - the DM object
356147c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
356247c6ae99SBarry Smith 
356347c6ae99SBarry Smith     Output Parameter:
356447c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
356547c6ae99SBarry Smith 
356647c6ae99SBarry Smith     Level: developer
356747c6ae99SBarry Smith 
3568e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
356947c6ae99SBarry Smith 
357047c6ae99SBarry Smith @*/
35717087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
357247c6ae99SBarry Smith {
357347c6ae99SBarry Smith   PetscErrorCode ierr;
357447c6ae99SBarry Smith 
357547c6ae99SBarry Smith   PetscFunctionBegin;
3576171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35772c71b3e2SJacob Faibussowitsch   PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
357847c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
357947c6ae99SBarry Smith   PetscValidPointer(dmc,3);
358047c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
358147c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
358247c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
358347c6ae99SBarry Smith     PetscInt i;
358447c6ae99SBarry Smith 
3585ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
358647c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3587ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
358847c6ae99SBarry Smith     }
3589ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
359047c6ae99SBarry Smith   PetscFunctionReturn(0);
359147c6ae99SBarry Smith }
359247c6ae99SBarry Smith 
35931a266240SBarry Smith /*@C
35941a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
35951a266240SBarry Smith 
35961a266240SBarry Smith     Not Collective
35971a266240SBarry Smith 
35981a266240SBarry Smith     Input Parameters:
35991a266240SBarry Smith +   dm - the DM object
36001a266240SBarry Smith -   destroy - the destroy function
36011a266240SBarry Smith 
36021a266240SBarry Smith     Level: intermediate
36031a266240SBarry Smith 
3604e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
36051a266240SBarry Smith 
3606f07f9ceaSJed Brown @*/
36071a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
36081a266240SBarry Smith {
36091a266240SBarry Smith   PetscFunctionBegin;
3610171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
36111a266240SBarry Smith   dm->ctxdestroy = destroy;
36121a266240SBarry Smith   PetscFunctionReturn(0);
36131a266240SBarry Smith }
36141a266240SBarry Smith 
3615b07ff414SBarry Smith /*@
36161b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
361747c6ae99SBarry Smith 
361847c6ae99SBarry Smith     Not Collective
361947c6ae99SBarry Smith 
362047c6ae99SBarry Smith     Input Parameters:
362147c6ae99SBarry Smith +   dm - the DM object
362247c6ae99SBarry Smith -   ctx - the user context
362347c6ae99SBarry Smith 
362447c6ae99SBarry Smith     Level: intermediate
362547c6ae99SBarry Smith 
3626e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
362747c6ae99SBarry Smith 
362847c6ae99SBarry Smith @*/
36291b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
363047c6ae99SBarry Smith {
363147c6ae99SBarry Smith   PetscFunctionBegin;
3632171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
363347c6ae99SBarry Smith   dm->ctx = ctx;
363447c6ae99SBarry Smith   PetscFunctionReturn(0);
363547c6ae99SBarry Smith }
363647c6ae99SBarry Smith 
363747c6ae99SBarry Smith /*@
36381b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
363947c6ae99SBarry Smith 
364047c6ae99SBarry Smith     Not Collective
364147c6ae99SBarry Smith 
364247c6ae99SBarry Smith     Input Parameter:
364347c6ae99SBarry Smith .   dm - the DM object
364447c6ae99SBarry Smith 
364547c6ae99SBarry Smith     Output Parameter:
364647c6ae99SBarry Smith .   ctx - the user context
364747c6ae99SBarry Smith 
364847c6ae99SBarry Smith     Level: intermediate
364947c6ae99SBarry Smith 
3650e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
365147c6ae99SBarry Smith 
365247c6ae99SBarry Smith @*/
36531b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
365447c6ae99SBarry Smith {
365547c6ae99SBarry Smith   PetscFunctionBegin;
3656171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
36571b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
365847c6ae99SBarry Smith   PetscFunctionReturn(0);
365947c6ae99SBarry Smith }
366047c6ae99SBarry Smith 
366108da532bSDmitry Karpeev /*@C
3662df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
366308da532bSDmitry Karpeev 
3664d083f849SBarry Smith     Logically Collective on dm
366508da532bSDmitry Karpeev 
3666d8d19677SJose E. Roman     Input Parameters:
366708da532bSDmitry Karpeev +   dm - the DM object
36680298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
366908da532bSDmitry Karpeev 
367008da532bSDmitry Karpeev     Level: intermediate
367108da532bSDmitry Karpeev 
3672835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
367308da532bSDmitry Karpeev          DMSetJacobian()
367408da532bSDmitry Karpeev 
367508da532bSDmitry Karpeev @*/
367608da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
367708da532bSDmitry Karpeev {
367808da532bSDmitry Karpeev   PetscFunctionBegin;
36795a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
368008da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
368108da532bSDmitry Karpeev   PetscFunctionReturn(0);
368208da532bSDmitry Karpeev }
368308da532bSDmitry Karpeev 
368408da532bSDmitry Karpeev /*@
368508da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
368608da532bSDmitry Karpeev 
368708da532bSDmitry Karpeev     Not Collective
368808da532bSDmitry Karpeev 
368908da532bSDmitry Karpeev     Input Parameter:
369008da532bSDmitry Karpeev .   dm - the DM object to destroy
369108da532bSDmitry Karpeev 
369208da532bSDmitry Karpeev     Output Parameter:
369308da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
369408da532bSDmitry Karpeev 
369508da532bSDmitry Karpeev     Level: developer
369608da532bSDmitry Karpeev 
369774e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
369808da532bSDmitry Karpeev 
369908da532bSDmitry Karpeev @*/
370008da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
370108da532bSDmitry Karpeev {
370208da532bSDmitry Karpeev   PetscFunctionBegin;
37035a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3704534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
370508da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
370608da532bSDmitry Karpeev   PetscFunctionReturn(0);
370708da532bSDmitry Karpeev }
370808da532bSDmitry Karpeev 
370908da532bSDmitry Karpeev /*@C
371008da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
371108da532bSDmitry Karpeev 
3712d083f849SBarry Smith     Logically Collective on dm
371308da532bSDmitry Karpeev 
3714f899ff85SJose E. Roman     Input Parameter:
3715907376e6SBarry Smith .   dm - the DM object
371608da532bSDmitry Karpeev 
371708da532bSDmitry Karpeev     Output parameters:
371808da532bSDmitry Karpeev +   xl - lower bound
371908da532bSDmitry Karpeev -   xu - upper bound
372008da532bSDmitry Karpeev 
3721907376e6SBarry Smith     Level: advanced
3722907376e6SBarry Smith 
372395452b02SPatrick Sanan     Notes:
372495452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
372508da532bSDmitry Karpeev 
372674e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
372708da532bSDmitry Karpeev 
372808da532bSDmitry Karpeev @*/
372908da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
373008da532bSDmitry Karpeev {
373108da532bSDmitry Karpeev   PetscErrorCode ierr;
37325fd66863SKarl Rupp 
373308da532bSDmitry Karpeev   PetscFunctionBegin;
37345a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
373508da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
37365a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
37372c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computevariablebounds,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
373808da532bSDmitry Karpeev   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
373908da532bSDmitry Karpeev   PetscFunctionReturn(0);
374008da532bSDmitry Karpeev }
374108da532bSDmitry Karpeev 
3742b0ae01b7SPeter Brune /*@
3743b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3744b0ae01b7SPeter Brune 
3745b0ae01b7SPeter Brune     Not Collective
3746b0ae01b7SPeter Brune 
3747b0ae01b7SPeter Brune     Input Parameter:
3748b0ae01b7SPeter Brune .   dm - the DM object
3749b0ae01b7SPeter Brune 
3750b0ae01b7SPeter Brune     Output Parameter:
3751b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3752b0ae01b7SPeter Brune 
3753b0ae01b7SPeter Brune     Level: developer
3754b0ae01b7SPeter Brune 
37551565f0a7SPatrick Sanan .seealso DMCreateColoring()
3756b0ae01b7SPeter Brune 
3757b0ae01b7SPeter Brune @*/
3758b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3759b0ae01b7SPeter Brune {
3760b0ae01b7SPeter Brune   PetscFunctionBegin;
37615a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3762534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3763b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3764b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3765b0ae01b7SPeter Brune }
3766b0ae01b7SPeter Brune 
37673ad4599aSBarry Smith /*@
37683ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
37693ad4599aSBarry Smith 
37703ad4599aSBarry Smith     Not Collective
37713ad4599aSBarry Smith 
37723ad4599aSBarry Smith     Input Parameter:
37733ad4599aSBarry Smith .   dm - the DM object
37743ad4599aSBarry Smith 
37753ad4599aSBarry Smith     Output Parameter:
37763ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
37773ad4599aSBarry Smith 
37783ad4599aSBarry Smith     Level: developer
37793ad4599aSBarry Smith 
37801565f0a7SPatrick Sanan .seealso DMCreateRestriction()
37813ad4599aSBarry Smith 
37823ad4599aSBarry Smith @*/
37833ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
37843ad4599aSBarry Smith {
37853ad4599aSBarry Smith   PetscFunctionBegin;
37865a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3787534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37883ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
37893ad4599aSBarry Smith   PetscFunctionReturn(0);
37903ad4599aSBarry Smith }
37913ad4599aSBarry Smith 
3792a7058e45SLawrence Mitchell /*@
3793a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3794a7058e45SLawrence Mitchell 
3795a7058e45SLawrence Mitchell     Not Collective
3796a7058e45SLawrence Mitchell 
3797a7058e45SLawrence Mitchell     Input Parameter:
3798a7058e45SLawrence Mitchell .   dm - the DM object
3799a7058e45SLawrence Mitchell 
3800a7058e45SLawrence Mitchell     Output Parameter:
3801a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3802a7058e45SLawrence Mitchell 
3803a7058e45SLawrence Mitchell     Level: developer
3804a7058e45SLawrence Mitchell 
38051565f0a7SPatrick Sanan .seealso DMCreateInjection()
3806a7058e45SLawrence Mitchell 
3807a7058e45SLawrence Mitchell @*/
3808a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3809a7058e45SLawrence Mitchell {
38104a7a4c06SLawrence Mitchell   PetscErrorCode ierr;
38115a84ad33SLisandro Dalcin 
3812a7058e45SLawrence Mitchell   PetscFunctionBegin;
38135a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3814534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
38155a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
38164a7a4c06SLawrence Mitchell     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
38175a84ad33SLisandro Dalcin   } else {
38185a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
38195a84ad33SLisandro Dalcin   }
3820a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3821a7058e45SLawrence Mitchell }
3822a7058e45SLawrence Mitchell 
38230298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3824264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3825264ace61SBarry Smith 
3826264ace61SBarry Smith /*@C
3827264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3828264ace61SBarry Smith 
3829d083f849SBarry Smith   Collective on dm
3830264ace61SBarry Smith 
3831264ace61SBarry Smith   Input Parameters:
3832264ace61SBarry Smith + dm     - The DM object
3833264ace61SBarry Smith - method - The name of the DM type
3834264ace61SBarry Smith 
3835264ace61SBarry Smith   Options Database Key:
3836264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3837264ace61SBarry Smith 
3838264ace61SBarry Smith   Notes:
3839e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3840264ace61SBarry Smith 
3841264ace61SBarry Smith   Level: intermediate
3842264ace61SBarry Smith 
3843264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3844264ace61SBarry Smith @*/
384519fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3846264ace61SBarry Smith {
3847264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3848264ace61SBarry Smith   PetscBool      match;
3849264ace61SBarry Smith   PetscErrorCode ierr;
3850264ace61SBarry Smith 
3851264ace61SBarry Smith   PetscFunctionBegin;
3852264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3853251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3854264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3855264ace61SBarry Smith 
38560f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
38571c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
38582c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!r,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3859264ace61SBarry Smith 
3860264ace61SBarry Smith   if (dm->ops->destroy) {
3861264ace61SBarry Smith     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3862264ace61SBarry Smith   }
3863d57f96a3SLisandro Dalcin   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3864264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3865d57f96a3SLisandro Dalcin   ierr = (*r)(dm);CHKERRQ(ierr);
3866264ace61SBarry Smith   PetscFunctionReturn(0);
3867264ace61SBarry Smith }
3868264ace61SBarry Smith 
3869264ace61SBarry Smith /*@C
3870264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3871264ace61SBarry Smith 
3872264ace61SBarry Smith   Not Collective
3873264ace61SBarry Smith 
3874264ace61SBarry Smith   Input Parameter:
3875264ace61SBarry Smith . dm  - The DM
3876264ace61SBarry Smith 
3877264ace61SBarry Smith   Output Parameter:
3878264ace61SBarry Smith . type - The DM type name
3879264ace61SBarry Smith 
3880264ace61SBarry Smith   Level: intermediate
3881264ace61SBarry Smith 
3882264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3883264ace61SBarry Smith @*/
388419fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3885264ace61SBarry Smith {
3886264ace61SBarry Smith   PetscErrorCode ierr;
3887264ace61SBarry Smith 
3888264ace61SBarry Smith   PetscFunctionBegin;
3889264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3890c959eef4SJed Brown   PetscValidPointer(type,2);
3891607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3892264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3893264ace61SBarry Smith   PetscFunctionReturn(0);
3894264ace61SBarry Smith }
3895264ace61SBarry Smith 
389667a56275SMatthew G Knepley /*@C
389767a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
389867a56275SMatthew G Knepley 
3899d083f849SBarry Smith   Collective on dm
390067a56275SMatthew G Knepley 
390167a56275SMatthew G Knepley   Input Parameters:
390267a56275SMatthew G Knepley + dm - the DM
390367a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
390467a56275SMatthew G Knepley 
390567a56275SMatthew G Knepley   Output Parameter:
390667a56275SMatthew G Knepley . M - pointer to new DM
390767a56275SMatthew G Knepley 
390867a56275SMatthew G Knepley   Notes:
390967a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
391067a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
391167a56275SMatthew G Knepley   of the input DM.
391267a56275SMatthew G Knepley 
391367a56275SMatthew G Knepley   Level: intermediate
391467a56275SMatthew G Knepley 
391567a56275SMatthew G Knepley .seealso: DMCreate()
391667a56275SMatthew G Knepley @*/
391719fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
391867a56275SMatthew G Knepley {
391967a56275SMatthew G Knepley   DM             B;
392067a56275SMatthew G Knepley   char           convname[256];
3921c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
392267a56275SMatthew G Knepley   PetscErrorCode ierr;
392367a56275SMatthew G Knepley 
392467a56275SMatthew G Knepley   PetscFunctionBegin;
392567a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
392667a56275SMatthew G Knepley   PetscValidType(dm,1);
392767a56275SMatthew G Knepley   PetscValidPointer(M,3);
3928251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3929c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3930c067b6caSMatthew G. Knepley   if (sametype) {
3931c067b6caSMatthew G. Knepley     *M   = dm;
3932c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3933c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3934c067b6caSMatthew G. Knepley   } else {
39350298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
393667a56275SMatthew G Knepley 
393767a56275SMatthew G Knepley     /*
393867a56275SMatthew G Knepley        Order of precedence:
393967a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
394067a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
394167a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
394267a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
394367a56275SMatthew G Knepley        5) Use a really basic converter.
394467a56275SMatthew G Knepley     */
394567a56275SMatthew G Knepley 
394667a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
3947a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3948a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3949a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3950a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3951a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
39520005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
395367a56275SMatthew G Knepley     if (conv) goto foundconv;
395467a56275SMatthew G Knepley 
395567a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
395682f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
395767a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3958a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3959a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3960a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3961a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3962a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
39630005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
396467a56275SMatthew G Knepley     if (conv) {
3965fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
396667a56275SMatthew G Knepley       goto foundconv;
396767a56275SMatthew G Knepley     }
396867a56275SMatthew G Knepley 
396967a56275SMatthew G Knepley #if 0
397067a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
397167a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3972fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
397367a56275SMatthew G Knepley     if (conv) goto foundconv;
397467a56275SMatthew G Knepley 
397567a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
397667a56275SMatthew G Knepley     if (dm->ops->convert) {
397767a56275SMatthew G Knepley       conv = dm->ops->convert;
397867a56275SMatthew G Knepley     }
397967a56275SMatthew G Knepley     if (conv) goto foundconv;
398067a56275SMatthew G Knepley #endif
398167a56275SMatthew G Knepley 
398267a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
398398921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
398467a56275SMatthew G Knepley 
398567a56275SMatthew G Knepley foundconv:
398667a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
398767a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
398812fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
398990b157c4SStefano Zampini     {
399090b157c4SStefano Zampini       PetscBool             isper;
399112fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
399212fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
399390b157c4SStefano Zampini       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
399490b157c4SStefano Zampini       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
3995c8a6034eSMark       (*M)->prealloc_only = dm->prealloc_only;
3996a587d139SMark       ierr = PetscFree((*M)->vectype);CHKERRQ(ierr);
3997a587d139SMark       ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr);
3998a587d139SMark       ierr = PetscFree((*M)->mattype);CHKERRQ(ierr);
3999a587d139SMark       ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr);
400012fa691eSMatthew G. Knepley     }
400167a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
400267a56275SMatthew G Knepley   }
400367a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
400467a56275SMatthew G Knepley   PetscFunctionReturn(0);
400567a56275SMatthew G Knepley }
4006264ace61SBarry Smith 
4007264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
4008264ace61SBarry Smith 
4009264ace61SBarry Smith /*@C
40101c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
40111c84c290SBarry Smith 
40121c84c290SBarry Smith   Not Collective
40131c84c290SBarry Smith 
40141c84c290SBarry Smith   Input Parameters:
40151c84c290SBarry Smith + name        - The name of a new user-defined creation routine
40161c84c290SBarry Smith - create_func - The creation routine itself
40171c84c290SBarry Smith 
40181c84c290SBarry Smith   Notes:
40191c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
40201c84c290SBarry Smith 
40211c84c290SBarry Smith   Sample usage:
40221c84c290SBarry Smith .vb
4023bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
40241c84c290SBarry Smith .ve
40251c84c290SBarry Smith 
40261c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
40271c84c290SBarry Smith .vb
40281c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
40291c84c290SBarry Smith     DMSetType(DM,"my_da");
40301c84c290SBarry Smith .ve
40311c84c290SBarry Smith    or at runtime via the option
40321c84c290SBarry Smith .vb
40331c84c290SBarry Smith     -da_type my_da
40341c84c290SBarry Smith .ve
4035264ace61SBarry Smith 
4036264ace61SBarry Smith   Level: advanced
40371c84c290SBarry Smith 
4038bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
40391c84c290SBarry Smith 
4040264ace61SBarry Smith @*/
4041bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
4042264ace61SBarry Smith {
4043264ace61SBarry Smith   PetscErrorCode ierr;
4044264ace61SBarry Smith 
4045264ace61SBarry Smith   PetscFunctionBegin;
40461d36bdfdSBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
4047a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
4048264ace61SBarry Smith   PetscFunctionReturn(0);
4049264ace61SBarry Smith }
4050264ace61SBarry Smith 
4051b859378eSBarry Smith /*@C
405255849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
4053b859378eSBarry Smith 
4054d083f849SBarry Smith   Collective on viewer
4055b859378eSBarry Smith 
4056b859378eSBarry Smith   Input Parameters:
4057b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
4058b859378eSBarry Smith            some related function before a call to DMLoad().
4059b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
4060b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
4061b859378eSBarry Smith 
4062b859378eSBarry Smith    Level: intermediate
4063b859378eSBarry Smith 
4064b859378eSBarry Smith   Notes:
406555849f57SBarry Smith   The type is determined by the data in the file, any type set into the DM before this call is ignored.
4066b859378eSBarry Smith 
4067cd7e8a5eSksagiyam   Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex
4068cd7e8a5eSksagiyam   meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName()
4069cd7e8a5eSksagiyam   before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object.
4070cd7e8a5eSksagiyam 
4071b859378eSBarry Smith   Notes for advanced users:
4072b859378eSBarry Smith   Most users should not need to know the details of the binary storage
4073b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
4074b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
4075b859378eSBarry Smith   format is
4076b859378eSBarry Smith .vb
4077b859378eSBarry Smith      has not yet been determined
4078b859378eSBarry Smith .ve
4079b859378eSBarry Smith 
4080b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
4081b859378eSBarry Smith @*/
4082b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
4083b859378eSBarry Smith {
40849331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
4085b859378eSBarry Smith   PetscErrorCode ierr;
4086b859378eSBarry Smith 
4087b859378eSBarry Smith   PetscFunctionBegin;
4088b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
4089b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
4090fb694a9eSVaclav Hapla   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
409132c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
40929331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
409358cd63d5SVaclav Hapla   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
40949331c7a4SMatthew G. Knepley   if (isbinary) {
40959331c7a4SMatthew G. Knepley     PetscInt classid;
40969331c7a4SMatthew G. Knepley     char     type[256];
4097b859378eSBarry Smith 
4098060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
40992c71b3e2SJacob Faibussowitsch     PetscCheckFalse(classid != DM_FILE_CLASSID,PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
4100060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
410132c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
41029331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
41039331c7a4SMatthew G. Knepley   } else if (ishdf5) {
41049331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
41059331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
410658cd63d5SVaclav Hapla   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
4107b859378eSBarry Smith   PetscFunctionReturn(0);
4108b859378eSBarry Smith }
4109b859378eSBarry Smith 
4110b2e4378dSMatthew G. Knepley /*@
4111b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
4112b2e4378dSMatthew G. Knepley 
4113b2e4378dSMatthew G. Knepley   Not collective
4114b2e4378dSMatthew G. Knepley 
4115b2e4378dSMatthew G. Knepley   Input Parameter:
4116b2e4378dSMatthew G. Knepley . dm - the DM
4117b2e4378dSMatthew G. Knepley 
4118b2e4378dSMatthew G. Knepley   Output Parameters:
4119b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
4120b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
4121b2e4378dSMatthew G. Knepley 
4122b2e4378dSMatthew G. Knepley   Level: beginner
4123b2e4378dSMatthew G. Knepley 
4124b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
4125b2e4378dSMatthew G. Knepley 
4126b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
4127b2e4378dSMatthew G. Knepley @*/
4128b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
4129b2e4378dSMatthew G. Knepley {
4130b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
4131b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
4132b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
4133b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
4134b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
4135b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
4136b2e4378dSMatthew G. Knepley   PetscErrorCode     ierr;
4137b2e4378dSMatthew G. Knepley 
4138b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4139b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4140b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4141b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
4142b2e4378dSMatthew G. Knepley   if (coords) {
4143b2e4378dSMatthew G. Knepley     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
4144b2e4378dSMatthew G. Knepley     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
4145b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
4146b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
4147b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
4148b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4149b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4150b2e4378dSMatthew G. Knepley       }
4151b2e4378dSMatthew G. Knepley     }
4152b2e4378dSMatthew G. Knepley     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
4153b2e4378dSMatthew G. Knepley   } else {
4154b2e4378dSMatthew G. Knepley     PetscBool isda;
4155b2e4378dSMatthew G. Knepley 
4156b2e4378dSMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
4157b2e4378dSMatthew G. Knepley     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
4158b2e4378dSMatthew G. Knepley   }
4159b2e4378dSMatthew G. Knepley   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
4160b2e4378dSMatthew G. Knepley   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
4161b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4162b2e4378dSMatthew G. Knepley }
4163b2e4378dSMatthew G. Knepley 
4164b2e4378dSMatthew G. Knepley /*@
4165b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
4166b2e4378dSMatthew G. Knepley 
4167b2e4378dSMatthew G. Knepley   Collective
4168b2e4378dSMatthew G. Knepley 
4169b2e4378dSMatthew G. Knepley   Input Parameter:
4170b2e4378dSMatthew G. Knepley . dm - the DM
4171b2e4378dSMatthew G. Knepley 
4172b2e4378dSMatthew G. Knepley   Output Parameters:
4173b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
4174b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
4175b2e4378dSMatthew G. Knepley 
4176b2e4378dSMatthew G. Knepley   Level: beginner
4177b2e4378dSMatthew G. Knepley 
4178b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
4179b2e4378dSMatthew G. Knepley @*/
4180b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
4181b2e4378dSMatthew G. Knepley {
4182b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
41836ce308c4SMatthew G. Knepley   PetscInt       cdim;
41846ce308c4SMatthew G. Knepley   PetscMPIInt    count;
4185b2e4378dSMatthew G. Knepley   PetscErrorCode ierr;
4186b2e4378dSMatthew G. Knepley 
4187b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4188b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4189b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4190b2e4378dSMatthew G. Knepley   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
4191b2e4378dSMatthew G. Knepley   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
4192820f2d46SBarry Smith   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4193820f2d46SBarry Smith   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4194b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4195b2e4378dSMatthew G. Knepley }
4196b2e4378dSMatthew G. Knepley 
41977da65231SMatthew G Knepley /******************************** FEM Support **********************************/
41987da65231SMatthew G Knepley 
4199a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
4200a6dfd86eSKarl Rupp {
42011d47ebbbSSatish Balay   PetscInt       f;
42021b30c384SMatthew G Knepley   PetscErrorCode ierr;
42031b30c384SMatthew G Knepley 
42047da65231SMatthew G Knepley   PetscFunctionBegin;
420574778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
42061d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
420757622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
42087da65231SMatthew G Knepley   }
42097da65231SMatthew G Knepley   PetscFunctionReturn(0);
42107da65231SMatthew G Knepley }
42117da65231SMatthew G Knepley 
4212a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4213a6dfd86eSKarl Rupp {
42141b30c384SMatthew G Knepley   PetscInt       f, g;
42157da65231SMatthew G Knepley   PetscErrorCode ierr;
42167da65231SMatthew G Knepley 
42177da65231SMatthew G Knepley   PetscFunctionBegin;
421874778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
42191d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
422074778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
42211d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
4222e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
42237da65231SMatthew G Knepley     }
422474778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
42257da65231SMatthew G Knepley   }
42267da65231SMatthew G Knepley   PetscFunctionReturn(0);
42277da65231SMatthew G Knepley }
4228e7c4fc90SDmitry Karpeev 
42296113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4230e759306cSMatthew G. Knepley {
42310c5b8624SToby Isaac   PetscInt          localSize, bs;
42320c5b8624SToby Isaac   PetscMPIInt       size;
42330c5b8624SToby Isaac   Vec               x, xglob;
42340c5b8624SToby Isaac   const PetscScalar *xarray;
4235e759306cSMatthew G. Knepley   PetscErrorCode    ierr;
4236e759306cSMatthew G. Knepley 
4237e759306cSMatthew G. Knepley   PetscFunctionBegin;
4238ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr);
4239e759306cSMatthew G. Knepley   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
4240e759306cSMatthew G. Knepley   ierr = VecCopy(X, x);CHKERRQ(ierr);
42416113b454SMatthew G. Knepley   ierr = VecChop(x, tol);CHKERRQ(ierr);
42420c5b8624SToby Isaac   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
42430c5b8624SToby Isaac   if (size > 1) {
42440c5b8624SToby Isaac     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
42450c5b8624SToby Isaac     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
42460c5b8624SToby Isaac     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
42470c5b8624SToby Isaac     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
42480c5b8624SToby Isaac   } else {
42490c5b8624SToby Isaac     xglob = x;
42500c5b8624SToby Isaac   }
42510c5b8624SToby Isaac   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
42520c5b8624SToby Isaac   if (size > 1) {
42530c5b8624SToby Isaac     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
42540c5b8624SToby Isaac     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
42550c5b8624SToby Isaac   }
4256e759306cSMatthew G. Knepley   ierr = VecDestroy(&x);CHKERRQ(ierr);
4257e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4258e759306cSMatthew G. Knepley }
4259e759306cSMatthew G. Knepley 
426088ed4aceSMatthew G Knepley /*@
42611bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4262061576a5SJed Brown 
4263061576a5SJed Brown   Input Parameter:
4264061576a5SJed Brown . dm - The DM
4265061576a5SJed Brown 
4266061576a5SJed Brown   Output Parameter:
4267061576a5SJed Brown . section - The PetscSection
4268061576a5SJed Brown 
4269061576a5SJed Brown   Options Database Keys:
4270061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4271061576a5SJed Brown 
4272061576a5SJed Brown   Level: advanced
4273061576a5SJed Brown 
4274061576a5SJed Brown   Notes:
4275061576a5SJed Brown   Use DMGetLocalSection() in new code.
4276061576a5SJed Brown 
4277061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4278061576a5SJed Brown 
4279061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4280061576a5SJed Brown @*/
4281061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4282061576a5SJed Brown {
4283061576a5SJed Brown   PetscErrorCode ierr;
4284061576a5SJed Brown 
4285061576a5SJed Brown   PetscFunctionBegin;
4286061576a5SJed Brown   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
4287061576a5SJed Brown   PetscFunctionReturn(0);
4288061576a5SJed Brown }
4289061576a5SJed Brown 
4290061576a5SJed Brown /*@
4291061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
429288ed4aceSMatthew G Knepley 
429388ed4aceSMatthew G Knepley   Input Parameter:
429488ed4aceSMatthew G Knepley . dm - The DM
429588ed4aceSMatthew G Knepley 
429688ed4aceSMatthew G Knepley   Output Parameter:
429788ed4aceSMatthew G Knepley . section - The PetscSection
429888ed4aceSMatthew G Knepley 
4299e5893cccSMatthew G. Knepley   Options Database Keys:
4300e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4301e5893cccSMatthew G. Knepley 
430288ed4aceSMatthew G Knepley   Level: intermediate
430388ed4aceSMatthew G Knepley 
430488ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
430588ed4aceSMatthew G Knepley 
4306061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
430788ed4aceSMatthew G Knepley @*/
4308061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
43090adebc6cSBarry Smith {
4310fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
4311fd59a867SMatthew G. Knepley 
431288ed4aceSMatthew G Knepley   PetscFunctionBegin;
431388ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
431488ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
43151bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4316e5e52638SMatthew G. Knepley     PetscInt d;
4317e5e52638SMatthew G. Knepley 
431845480ffeSMatthew G. Knepley     if (dm->setfromoptionscalled) {
431945480ffeSMatthew G. Knepley       PetscObject       obj = (PetscObject) dm;
432045480ffeSMatthew G. Knepley       PetscViewer       viewer;
432145480ffeSMatthew G. Knepley       PetscViewerFormat format;
432245480ffeSMatthew G. Knepley       PetscBool         flg;
432345480ffeSMatthew G. Knepley 
432445480ffeSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr);
432545480ffeSMatthew G. Knepley       if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);}
432645480ffeSMatthew G. Knepley       for (d = 0; d < dm->Nds; ++d) {
432745480ffeSMatthew G. Knepley         ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);
432845480ffeSMatthew G. Knepley         if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);}
432945480ffeSMatthew G. Knepley       }
433045480ffeSMatthew G. Knepley       if (flg) {
433145480ffeSMatthew G. Knepley         ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
433245480ffeSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
433345480ffeSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
433445480ffeSMatthew G. Knepley       }
433545480ffeSMatthew G. Knepley     }
43361bb6d2a8SBarry Smith     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
43371bb6d2a8SBarry Smith     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
43382f0f8703SMatthew G. Knepley   }
43391bb6d2a8SBarry Smith   *section = dm->localSection;
434088ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
434188ed4aceSMatthew G Knepley }
434288ed4aceSMatthew G Knepley 
434388ed4aceSMatthew G Knepley /*@
43441bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4345061576a5SJed Brown 
4346061576a5SJed Brown   Input Parameters:
4347061576a5SJed Brown + dm - The DM
4348061576a5SJed Brown - section - The PetscSection
4349061576a5SJed Brown 
4350061576a5SJed Brown   Level: advanced
4351061576a5SJed Brown 
4352061576a5SJed Brown   Notes:
4353061576a5SJed Brown   Use DMSetLocalSection() in new code.
4354061576a5SJed Brown 
4355061576a5SJed Brown   Any existing Section will be destroyed
4356061576a5SJed Brown 
4357061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4358061576a5SJed Brown @*/
4359061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4360061576a5SJed Brown {
4361061576a5SJed Brown   PetscErrorCode ierr;
4362061576a5SJed Brown 
4363061576a5SJed Brown   PetscFunctionBegin;
4364061576a5SJed Brown   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4365061576a5SJed Brown   PetscFunctionReturn(0);
4366061576a5SJed Brown }
4367061576a5SJed Brown 
4368061576a5SJed Brown /*@
4369061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
437088ed4aceSMatthew G Knepley 
437188ed4aceSMatthew G Knepley   Input Parameters:
437288ed4aceSMatthew G Knepley + dm - The DM
437388ed4aceSMatthew G Knepley - section - The PetscSection
437488ed4aceSMatthew G Knepley 
437588ed4aceSMatthew G Knepley   Level: intermediate
437688ed4aceSMatthew G Knepley 
437788ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
437888ed4aceSMatthew G Knepley 
4379061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
438088ed4aceSMatthew G Knepley @*/
4381061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
43820adebc6cSBarry Smith {
4383c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4384af122d2aSMatthew G Knepley   PetscInt       f;
438588ed4aceSMatthew G Knepley   PetscErrorCode ierr;
438688ed4aceSMatthew G Knepley 
438788ed4aceSMatthew G Knepley   PetscFunctionBegin;
438888ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4389b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
43901d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
43911bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
43921bb6d2a8SBarry Smith   dm->localSection = section;
43931bb6d2a8SBarry Smith   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4394af122d2aSMatthew G Knepley   if (numFields) {
4395af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4396af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
43970f21e855SMatthew G. Knepley       PetscObject disc;
4398af122d2aSMatthew G Knepley       const char *name;
4399af122d2aSMatthew G Knepley 
44001bb6d2a8SBarry Smith       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
440144a7f3ddSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
44020f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4403af122d2aSMatthew G Knepley     }
4404af122d2aSMatthew G Knepley   }
4405e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
44061bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
440788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
440888ed4aceSMatthew G Knepley }
440988ed4aceSMatthew G Knepley 
44109435951eSToby Isaac /*@
4411b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
44129435951eSToby Isaac 
4413e228b242SToby Isaac   not collective
4414e228b242SToby Isaac 
44159435951eSToby Isaac   Input Parameter:
44169435951eSToby Isaac . dm - The DM
44179435951eSToby Isaac 
4418d8d19677SJose E. Roman   Output Parameters:
44199435951eSToby 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.
44209435951eSToby 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.
44219435951eSToby Isaac 
44229435951eSToby Isaac   Level: advanced
44239435951eSToby Isaac 
44249435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
44259435951eSToby Isaac 
44269435951eSToby Isaac .seealso: DMSetDefaultConstraints()
44279435951eSToby Isaac @*/
44289435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
44299435951eSToby Isaac {
44309435951eSToby Isaac   PetscErrorCode ierr;
44319435951eSToby Isaac 
44329435951eSToby Isaac   PetscFunctionBegin;
44339435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
44349435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
443545a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
443645a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
44379435951eSToby Isaac   PetscFunctionReturn(0);
44389435951eSToby Isaac }
44399435951eSToby Isaac 
44409435951eSToby Isaac /*@
4441b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
44429435951eSToby Isaac 
44439435951eSToby 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().
44449435951eSToby Isaac 
44459435951eSToby 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.
44469435951eSToby Isaac 
4447e228b242SToby Isaac   collective on dm
4448e228b242SToby Isaac 
44499435951eSToby Isaac   Input Parameters:
44509435951eSToby Isaac + dm - The DM
4451e228b242SToby 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).
4452e228b242SToby 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).
44539435951eSToby Isaac 
44549435951eSToby Isaac   Level: advanced
44559435951eSToby Isaac 
44569435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
44579435951eSToby Isaac 
44589435951eSToby Isaac .seealso: DMGetDefaultConstraints()
44599435951eSToby Isaac @*/
44609435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
44619435951eSToby Isaac {
4462e228b242SToby Isaac   PetscMPIInt result;
44639435951eSToby Isaac   PetscErrorCode ierr;
44649435951eSToby Isaac 
44659435951eSToby Isaac   PetscFunctionBegin;
44669435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4467e228b242SToby Isaac   if (section) {
4468e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4469ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr);
44702c71b3e2SJacob Faibussowitsch     PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4471e228b242SToby Isaac   }
4472e228b242SToby Isaac   if (mat) {
4473e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4474ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr);
44752c71b3e2SJacob Faibussowitsch     PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4476e228b242SToby Isaac   }
44779435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
44789435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
44799435951eSToby Isaac   dm->defaultConstraintSection = section;
44809435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
44819435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
44829435951eSToby Isaac   dm->defaultConstraintMat = mat;
44839435951eSToby Isaac   PetscFunctionReturn(0);
44849435951eSToby Isaac }
44859435951eSToby Isaac 
4486497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4487507e4973SMatthew G. Knepley /*
4488507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4489507e4973SMatthew G. Knepley 
4490507e4973SMatthew G. Knepley   Input Parameters:
4491507e4973SMatthew G. Knepley + dm - The DM
4492507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4493507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4494507e4973SMatthew G. Knepley 
4495507e4973SMatthew G. Knepley   Level: intermediate
4496507e4973SMatthew G. Knepley 
44971bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4498507e4973SMatthew G. Knepley */
4499f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4500507e4973SMatthew G. Knepley {
4501507e4973SMatthew G. Knepley   MPI_Comm        comm;
4502507e4973SMatthew G. Knepley   PetscLayout     layout;
4503507e4973SMatthew G. Knepley   const PetscInt *ranges;
4504507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4505507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4506507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4507507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
4508507e4973SMatthew G. Knepley 
4509507e4973SMatthew G. Knepley   PetscFunctionBegin;
4510507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4511507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4512ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
4513ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
4514507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4515507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4516507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4517507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4518507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4519507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4520507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4521507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4522f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4523507e4973SMatthew G. Knepley 
4524507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4525507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4526507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4527507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4528507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4529507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4530507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
4531507e4973SMatthew 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;}
4532507e4973SMatthew 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;}
4533507e4973SMatthew G. Knepley     if (gdof < 0) {
4534507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4535507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4536507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4537507e4973SMatthew G. Knepley 
4538507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4539507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
4540507e4973SMatthew 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;}
4541507e4973SMatthew G. Knepley       }
4542507e4973SMatthew G. Knepley     }
4543507e4973SMatthew G. Knepley   }
4544507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4545507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4546820f2d46SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
4547507e4973SMatthew G. Knepley   if (!gvalid) {
4548507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4549507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4550507e4973SMatthew G. Knepley   }
4551507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4552507e4973SMatthew G. Knepley }
4553f741bcd2SMatthew G. Knepley #endif
4554507e4973SMatthew G. Knepley 
455588ed4aceSMatthew G Knepley /*@
4556e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
455788ed4aceSMatthew G Knepley 
4558d083f849SBarry Smith   Collective on dm
45598b1ab98fSJed Brown 
456088ed4aceSMatthew G Knepley   Input Parameter:
456188ed4aceSMatthew G Knepley . dm - The DM
456288ed4aceSMatthew G Knepley 
456388ed4aceSMatthew G Knepley   Output Parameter:
456488ed4aceSMatthew G Knepley . section - The PetscSection
456588ed4aceSMatthew G Knepley 
456688ed4aceSMatthew G Knepley   Level: intermediate
456788ed4aceSMatthew G Knepley 
456888ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
456988ed4aceSMatthew G Knepley 
457092fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
457188ed4aceSMatthew G Knepley @*/
4572e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
45730adebc6cSBarry Smith {
457488ed4aceSMatthew G Knepley   PetscErrorCode ierr;
457588ed4aceSMatthew G Knepley 
457688ed4aceSMatthew G Knepley   PetscFunctionBegin;
457788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
457888ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
45791bb6d2a8SBarry Smith   if (!dm->globalSection) {
4580fd59a867SMatthew G. Knepley     PetscSection s;
4581fd59a867SMatthew G. Knepley 
458292fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
45832c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!s,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection");
45842c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->sf,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection");
45851bb6d2a8SBarry Smith     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4586cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
45871bb6d2a8SBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
45881bb6d2a8SBarry Smith     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
458988ed4aceSMatthew G Knepley   }
45901bb6d2a8SBarry Smith   *section = dm->globalSection;
459188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
459288ed4aceSMatthew G Knepley }
459388ed4aceSMatthew G Knepley 
4594b21d0597SMatthew G Knepley /*@
4595e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4596b21d0597SMatthew G Knepley 
4597b21d0597SMatthew G Knepley   Input Parameters:
4598b21d0597SMatthew G Knepley + dm - The DM
45995080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4600b21d0597SMatthew G Knepley 
4601b21d0597SMatthew G Knepley   Level: intermediate
4602b21d0597SMatthew G Knepley 
4603b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4604b21d0597SMatthew G Knepley 
460592fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4606b21d0597SMatthew G Knepley @*/
4607e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
46080adebc6cSBarry Smith {
4609b21d0597SMatthew G Knepley   PetscErrorCode ierr;
4610b21d0597SMatthew G Knepley 
4611b21d0597SMatthew G Knepley   PetscFunctionBegin;
4612b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
46135080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
46141d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
46151bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
46161bb6d2a8SBarry Smith   dm->globalSection = section;
4617497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
46181bb6d2a8SBarry Smith   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4619507e4973SMatthew G. Knepley #endif
4620b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4621b21d0597SMatthew G Knepley }
4622b21d0597SMatthew G Knepley 
462388ed4aceSMatthew G Knepley /*@
46241bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
462588ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
462688ed4aceSMatthew G Knepley 
462788ed4aceSMatthew G Knepley   Input Parameter:
462888ed4aceSMatthew G Knepley . dm - The DM
462988ed4aceSMatthew G Knepley 
463088ed4aceSMatthew G Knepley   Output Parameter:
463188ed4aceSMatthew G Knepley . sf - The PetscSF
463288ed4aceSMatthew G Knepley 
463388ed4aceSMatthew G Knepley   Level: intermediate
463488ed4aceSMatthew G Knepley 
463588ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
463688ed4aceSMatthew G Knepley 
46371bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
463888ed4aceSMatthew G Knepley @*/
46391bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
46400adebc6cSBarry Smith {
464188ed4aceSMatthew G Knepley   PetscInt       nroots;
464288ed4aceSMatthew G Knepley   PetscErrorCode ierr;
464388ed4aceSMatthew G Knepley 
464488ed4aceSMatthew G Knepley   PetscFunctionBegin;
464588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
464688ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
46471bb6d2a8SBarry Smith   if (!dm->sectionSF) {
46481bb6d2a8SBarry Smith     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
464933907cc2SStefano Zampini   }
46501bb6d2a8SBarry Smith   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
465188ed4aceSMatthew G Knepley   if (nroots < 0) {
465288ed4aceSMatthew G Knepley     PetscSection section, gSection;
465388ed4aceSMatthew G Knepley 
465492fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
465531ea6d37SMatthew G Knepley     if (section) {
4656e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
46571bb6d2a8SBarry Smith       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
465831ea6d37SMatthew G Knepley     } else {
46590298fd71SBarry Smith       *sf = NULL;
466031ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
466131ea6d37SMatthew G Knepley     }
466288ed4aceSMatthew G Knepley   }
46631bb6d2a8SBarry Smith   *sf = dm->sectionSF;
466488ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
466588ed4aceSMatthew G Knepley }
466688ed4aceSMatthew G Knepley 
466788ed4aceSMatthew G Knepley /*@
46681bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
466988ed4aceSMatthew G Knepley 
467088ed4aceSMatthew G Knepley   Input Parameters:
467188ed4aceSMatthew G Knepley + dm - The DM
467288ed4aceSMatthew G Knepley - sf - The PetscSF
467388ed4aceSMatthew G Knepley 
467488ed4aceSMatthew G Knepley   Level: intermediate
467588ed4aceSMatthew G Knepley 
467688ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
467788ed4aceSMatthew G Knepley 
46781bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
467988ed4aceSMatthew G Knepley @*/
46801bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
46810adebc6cSBarry Smith {
468288ed4aceSMatthew G Knepley   PetscErrorCode ierr;
468388ed4aceSMatthew G Knepley 
468488ed4aceSMatthew G Knepley   PetscFunctionBegin;
468588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4686b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
468733907cc2SStefano Zampini   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
46881bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
46891bb6d2a8SBarry Smith   dm->sectionSF = sf;
469088ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
469188ed4aceSMatthew G Knepley }
469288ed4aceSMatthew G Knepley 
469388ed4aceSMatthew G Knepley /*@C
46941bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
469588ed4aceSMatthew G Knepley   describing the data layout.
469688ed4aceSMatthew G Knepley 
469788ed4aceSMatthew G Knepley   Input Parameters:
469888ed4aceSMatthew G Knepley + dm - The DM
469988ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
470088ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
470188ed4aceSMatthew G Knepley 
47021bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
470388ed4aceSMatthew G Knepley 
47041bb6d2a8SBarry Smith   Level: developer
47051bb6d2a8SBarry Smith 
47061bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
47071bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
47081bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
47091bb6d2a8SBarry Smith 
47101bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
471188ed4aceSMatthew G Knepley @*/
47121bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
471388ed4aceSMatthew G Knepley {
471488ed4aceSMatthew G Knepley   PetscErrorCode ierr;
471588ed4aceSMatthew G Knepley 
471688ed4aceSMatthew G Knepley   PetscFunctionBegin;
471788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4718b0c7db22SLisandro Dalcin   ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr);
471988ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
472088ed4aceSMatthew G Knepley }
4721af122d2aSMatthew G Knepley 
4722b21d0597SMatthew G Knepley /*@
4723b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4724b21d0597SMatthew G Knepley 
4725b21d0597SMatthew G Knepley   Input Parameter:
4726b21d0597SMatthew G Knepley . dm - The DM
4727b21d0597SMatthew G Knepley 
4728b21d0597SMatthew G Knepley   Output Parameter:
4729b21d0597SMatthew G Knepley . sf - The PetscSF
4730b21d0597SMatthew G Knepley 
4731b21d0597SMatthew G Knepley   Level: intermediate
4732b21d0597SMatthew G Knepley 
4733b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4734b21d0597SMatthew G Knepley 
47351bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4736b21d0597SMatthew G Knepley @*/
47370adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
47380adebc6cSBarry Smith {
4739b21d0597SMatthew G Knepley   PetscFunctionBegin;
4740b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4741b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4742b21d0597SMatthew G Knepley   *sf = dm->sf;
4743b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4744b21d0597SMatthew G Knepley }
4745b21d0597SMatthew G Knepley 
4746057b4bcdSMatthew G Knepley /*@
4747057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4748057b4bcdSMatthew G Knepley 
4749057b4bcdSMatthew G Knepley   Input Parameters:
4750057b4bcdSMatthew G Knepley + dm - The DM
4751057b4bcdSMatthew G Knepley - sf - The PetscSF
4752057b4bcdSMatthew G Knepley 
4753057b4bcdSMatthew G Knepley   Level: intermediate
4754057b4bcdSMatthew G Knepley 
47551bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4756057b4bcdSMatthew G Knepley @*/
47570adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
47580adebc6cSBarry Smith {
4759057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
4760057b4bcdSMatthew G Knepley 
4761057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4762057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4763b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4764057b4bcdSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
476533907cc2SStefano Zampini   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4766057b4bcdSMatthew G Knepley   dm->sf = sf;
4767057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4768057b4bcdSMatthew G Knepley }
4769057b4bcdSMatthew G Knepley 
47704f37162bSMatthew G. Knepley /*@
47714f37162bSMatthew G. Knepley   DMGetNaturalSF - Get the PetscSF encoding the map back to the original mesh ordering
47724f37162bSMatthew G. Knepley 
47734f37162bSMatthew G. Knepley   Input Parameter:
47744f37162bSMatthew G. Knepley . dm - The DM
47754f37162bSMatthew G. Knepley 
47764f37162bSMatthew G. Knepley   Output Parameter:
47774f37162bSMatthew G. Knepley . sf - The PetscSF
47784f37162bSMatthew G. Knepley 
47794f37162bSMatthew G. Knepley   Level: intermediate
47804f37162bSMatthew G. Knepley 
47814f37162bSMatthew G. Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
47824f37162bSMatthew G. Knepley 
47834f37162bSMatthew G. Knepley .seealso: DMSetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
47844f37162bSMatthew G. Knepley @*/
47854f37162bSMatthew G. Knepley PetscErrorCode DMGetNaturalSF(DM dm, PetscSF *sf)
47864f37162bSMatthew G. Knepley {
47874f37162bSMatthew G. Knepley   PetscFunctionBegin;
47884f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
47894f37162bSMatthew G. Knepley   PetscValidPointer(sf, 2);
47904f37162bSMatthew G. Knepley   *sf = dm->sfNatural;
47914f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
47924f37162bSMatthew G. Knepley }
47934f37162bSMatthew G. Knepley 
47944f37162bSMatthew G. Knepley /*@
47954f37162bSMatthew G. Knepley   DMSetNaturalSF - Set the PetscSF encoding the map back to the original mesh ordering
47964f37162bSMatthew G. Knepley 
47974f37162bSMatthew G. Knepley   Input Parameters:
47984f37162bSMatthew G. Knepley + dm - The DM
47994f37162bSMatthew G. Knepley - sf - The PetscSF
48004f37162bSMatthew G. Knepley 
48014f37162bSMatthew G. Knepley   Level: intermediate
48024f37162bSMatthew G. Knepley 
48034f37162bSMatthew G. Knepley .seealso: DMGetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
48044f37162bSMatthew G. Knepley @*/
48054f37162bSMatthew G. Knepley PetscErrorCode DMSetNaturalSF(DM dm, PetscSF sf)
48064f37162bSMatthew G. Knepley {
48074f37162bSMatthew G. Knepley   PetscErrorCode ierr;
48084f37162bSMatthew G. Knepley 
48094f37162bSMatthew G. Knepley   PetscFunctionBegin;
48104f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
48114f37162bSMatthew G. Knepley   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
48124f37162bSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
48134f37162bSMatthew G. Knepley   ierr = PetscSFDestroy(&dm->sfNatural);CHKERRQ(ierr);
48144f37162bSMatthew G. Knepley   dm->sfNatural = sf;
48154f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
48164f37162bSMatthew G. Knepley }
48174f37162bSMatthew G. Knepley 
481834aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
481934aa8a36SMatthew G. Knepley {
482034aa8a36SMatthew G. Knepley   PetscClassId   id;
482134aa8a36SMatthew G. Knepley   PetscErrorCode ierr;
482234aa8a36SMatthew G. Knepley 
482334aa8a36SMatthew G. Knepley   PetscFunctionBegin;
482434aa8a36SMatthew G. Knepley   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
482534aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
482634aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
482734aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
482834aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
482917c1d62eSMatthew G. Knepley   } else {
483017c1d62eSMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
483134aa8a36SMatthew G. Knepley   }
483234aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
483334aa8a36SMatthew G. Knepley }
483434aa8a36SMatthew G. Knepley 
483544a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
483644a7f3ddSMatthew G. Knepley {
483744a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
483844a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
483944a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
484044a7f3ddSMatthew G. Knepley 
484144a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
484244a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
484344a7f3ddSMatthew G. Knepley   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
484444a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4845e0b68406SMatthew Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;}
484644a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
484744a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
484844a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
484944a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
485044a7f3ddSMatthew G. Knepley }
485144a7f3ddSMatthew G. Knepley 
485244a7f3ddSMatthew G. Knepley /*@
485344a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
485444a7f3ddSMatthew G. Knepley 
4855d083f849SBarry Smith   Logically collective on dm
485644a7f3ddSMatthew G. Knepley 
485744a7f3ddSMatthew G. Knepley   Input Parameter:
485844a7f3ddSMatthew G. Knepley . dm - The DM
485944a7f3ddSMatthew G. Knepley 
486044a7f3ddSMatthew G. Knepley   Level: intermediate
486144a7f3ddSMatthew G. Knepley 
486244a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
486344a7f3ddSMatthew G. Knepley @*/
486444a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
486544a7f3ddSMatthew G. Knepley {
486644a7f3ddSMatthew G. Knepley   PetscInt       f;
486744a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
486844a7f3ddSMatthew G. Knepley 
486944a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
487044a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
487144a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
487244a7f3ddSMatthew G. Knepley     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
487344a7f3ddSMatthew G. Knepley     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
487444a7f3ddSMatthew G. Knepley   }
487544a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
487644a7f3ddSMatthew G. Knepley   dm->fields = NULL;
487744a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
487844a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
487944a7f3ddSMatthew G. Knepley }
488044a7f3ddSMatthew G. Knepley 
4881689b5837SMatthew G. Knepley /*@
4882689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4883689b5837SMatthew G. Knepley 
4884689b5837SMatthew G. Knepley   Not collective
4885689b5837SMatthew G. Knepley 
4886689b5837SMatthew G. Knepley   Input Parameter:
4887689b5837SMatthew G. Knepley . dm - The DM
4888689b5837SMatthew G. Knepley 
4889689b5837SMatthew G. Knepley   Output Parameter:
4890689b5837SMatthew G. Knepley . Nf - The number of fields
4891689b5837SMatthew G. Knepley 
4892689b5837SMatthew G. Knepley   Level: intermediate
4893689b5837SMatthew G. Knepley 
4894689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4895689b5837SMatthew G. Knepley @*/
48960f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
48970f21e855SMatthew G. Knepley {
48980f21e855SMatthew G. Knepley   PetscFunctionBegin;
48990f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4900534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
490144a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4902af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4903af122d2aSMatthew G Knepley }
4904af122d2aSMatthew G Knepley 
4905689b5837SMatthew G. Knepley /*@
4906689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4907689b5837SMatthew G. Knepley 
4908d083f849SBarry Smith   Logically collective on dm
4909689b5837SMatthew G. Knepley 
4910689b5837SMatthew G. Knepley   Input Parameters:
4911689b5837SMatthew G. Knepley + dm - The DM
4912689b5837SMatthew G. Knepley - Nf - The number of fields
4913689b5837SMatthew G. Knepley 
4914689b5837SMatthew G. Knepley   Level: intermediate
4915689b5837SMatthew G. Knepley 
4916689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4917689b5837SMatthew G. Knepley @*/
4918af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4919af122d2aSMatthew G Knepley {
49200f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4921af122d2aSMatthew G Knepley   PetscErrorCode ierr;
4922af122d2aSMatthew G Knepley 
4923af122d2aSMatthew G Knepley   PetscFunctionBegin;
4924af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
492544a7f3ddSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
49260f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
49270f21e855SMatthew G. Knepley     PetscContainer obj;
49280f21e855SMatthew G. Knepley 
49290f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
493044a7f3ddSMatthew G. Knepley     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
49310f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4932af122d2aSMatthew G Knepley   }
4933af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4934af122d2aSMatthew G Knepley }
4935af122d2aSMatthew G Knepley 
4936c1929be8SMatthew G. Knepley /*@
4937c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4938c1929be8SMatthew G. Knepley 
4939c1929be8SMatthew G. Knepley   Not collective
4940c1929be8SMatthew G. Knepley 
4941c1929be8SMatthew G. Knepley   Input Parameters:
4942c1929be8SMatthew G. Knepley + dm - The DM
4943c1929be8SMatthew G. Knepley - f  - The field number
4944c1929be8SMatthew G. Knepley 
494544a7f3ddSMatthew G. Knepley   Output Parameters:
494644a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
494744a7f3ddSMatthew G. Knepley - field - The discretization object
4948c1929be8SMatthew G. Knepley 
494944a7f3ddSMatthew G. Knepley   Level: intermediate
4950c1929be8SMatthew G. Knepley 
495144a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4952c1929be8SMatthew G. Knepley @*/
495344a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4954af122d2aSMatthew G Knepley {
4955af122d2aSMatthew G Knepley   PetscFunctionBegin;
4956af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4957064a246eSJacob Faibussowitsch   PetscValidPointer(field, 4);
49582c71b3e2SJacob Faibussowitsch   PetscCheckFalse((f < 0) || (f >= dm->Nf),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf);
495944a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
496044a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4961decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4962decb47aaSMatthew G. Knepley }
4963decb47aaSMatthew G. Knepley 
4964083401c6SMatthew G. Knepley /* Does not clear the DS */
4965083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4966083401c6SMatthew G. Knepley {
4967083401c6SMatthew G. Knepley   PetscErrorCode ierr;
4968083401c6SMatthew G. Knepley 
4969083401c6SMatthew G. Knepley   PetscFunctionBegin;
4970083401c6SMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4971083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4972083401c6SMatthew G. Knepley   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4973083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4974083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
4975083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4976083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4977083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4978083401c6SMatthew G. Knepley }
4979083401c6SMatthew G. Knepley 
4980c1929be8SMatthew G. Knepley /*@
4981c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4982c1929be8SMatthew G. Knepley 
4983d083f849SBarry Smith   Logically collective on dm
4984c1929be8SMatthew G. Knepley 
4985c1929be8SMatthew G. Knepley   Input Parameters:
4986c1929be8SMatthew G. Knepley + dm    - The DM
4987c1929be8SMatthew G. Knepley . f     - The field number
498844a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
4989c1929be8SMatthew G. Knepley - field - The discretization object
4990c1929be8SMatthew G. Knepley 
499144a7f3ddSMatthew G. Knepley   Level: intermediate
4992c1929be8SMatthew G. Knepley 
499344a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
4994c1929be8SMatthew G. Knepley @*/
499544a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4996decb47aaSMatthew G. Knepley {
4997decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
4998decb47aaSMatthew G. Knepley 
4999decb47aaSMatthew G. Knepley   PetscFunctionBegin;
5000decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5001e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
500244a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
50032c71b3e2SJacob Faibussowitsch   PetscCheckFalse(f < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
5004083401c6SMatthew G. Knepley   ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr);
500534aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
50062df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
500744a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
500844a7f3ddSMatthew G. Knepley }
500944a7f3ddSMatthew G. Knepley 
501044a7f3ddSMatthew G. Knepley /*@
501144a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
501244a7f3ddSMatthew G. Knepley 
5013d083f849SBarry Smith   Logically collective on dm
501444a7f3ddSMatthew G. Knepley 
501544a7f3ddSMatthew G. Knepley   Input Parameters:
501644a7f3ddSMatthew G. Knepley + dm    - The DM
501744a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
501844a7f3ddSMatthew G. Knepley - field - The discretization object
501944a7f3ddSMatthew G. Knepley 
502044a7f3ddSMatthew G. Knepley   Level: intermediate
502144a7f3ddSMatthew G. Knepley 
502244a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
502344a7f3ddSMatthew G. Knepley @*/
502444a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
502544a7f3ddSMatthew G. Knepley {
502644a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
502744a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
502844a7f3ddSMatthew G. Knepley 
502944a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
503044a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5031064a246eSJacob Faibussowitsch   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
503244a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
503344a7f3ddSMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
503444a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
503544a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
503644a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
503744a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
503834aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
50392df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
5040af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
5041af122d2aSMatthew G Knepley }
50426636e97aSMatthew G Knepley 
5043e5e52638SMatthew G. Knepley /*@
5044e0b68406SMatthew Knepley   DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells
5045e0b68406SMatthew Knepley 
5046e0b68406SMatthew Knepley   Logically collective on dm
5047e0b68406SMatthew Knepley 
5048e0b68406SMatthew Knepley   Input Parameters:
5049e0b68406SMatthew Knepley + dm          - The DM
5050e0b68406SMatthew Knepley . f           - The field index
5051e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells
5052e0b68406SMatthew Knepley 
5053e0b68406SMatthew Knepley   Level: intermediate
5054e0b68406SMatthew Knepley 
5055e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField()
5056e0b68406SMatthew Knepley @*/
5057e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor)
5058e0b68406SMatthew Knepley {
5059e0b68406SMatthew Knepley   PetscFunctionBegin;
50602c71b3e2SJacob Faibussowitsch   PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
5061e0b68406SMatthew Knepley   dm->fields[f].avoidTensor = avoidTensor;
5062e0b68406SMatthew Knepley   PetscFunctionReturn(0);
5063e0b68406SMatthew Knepley }
5064e0b68406SMatthew Knepley 
5065e0b68406SMatthew Knepley /*@
5066e0b68406SMatthew Knepley   DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells
5067e0b68406SMatthew Knepley 
5068e0b68406SMatthew Knepley   Logically collective on dm
5069e0b68406SMatthew Knepley 
5070e0b68406SMatthew Knepley   Input Parameters:
5071e0b68406SMatthew Knepley + dm          - The DM
5072e0b68406SMatthew Knepley - f           - The field index
5073e0b68406SMatthew Knepley 
5074e0b68406SMatthew Knepley   Output Parameter:
5075e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells
5076e0b68406SMatthew Knepley 
5077e0b68406SMatthew Knepley   Level: intermediate
5078e0b68406SMatthew Knepley 
5079e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField()
5080e0b68406SMatthew Knepley @*/
5081e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor)
5082e0b68406SMatthew Knepley {
5083e0b68406SMatthew Knepley   PetscFunctionBegin;
50842c71b3e2SJacob Faibussowitsch   PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
5085e0b68406SMatthew Knepley   *avoidTensor = dm->fields[f].avoidTensor;
5086e0b68406SMatthew Knepley   PetscFunctionReturn(0);
5087e0b68406SMatthew Knepley }
5088e0b68406SMatthew Knepley 
5089e0b68406SMatthew Knepley /*@
5090e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
5091e5e52638SMatthew G. Knepley 
5092d083f849SBarry Smith   Collective on dm
5093e5e52638SMatthew G. Knepley 
5094e5e52638SMatthew G. Knepley   Input Parameter:
5095e5e52638SMatthew G. Knepley . dm - The DM
5096e5e52638SMatthew G. Knepley 
5097e5e52638SMatthew G. Knepley   Output Parameter:
5098e5e52638SMatthew G. Knepley . newdm - The DM
5099e5e52638SMatthew G. Knepley 
5100e5e52638SMatthew G. Knepley   Level: advanced
5101e5e52638SMatthew G. Knepley 
5102e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
5103e5e52638SMatthew G. Knepley @*/
5104e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
5105e5e52638SMatthew G. Knepley {
5106e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
5107e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5108e5e52638SMatthew G. Knepley 
5109e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5110e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5111e5e52638SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5112e5e52638SMatthew G. Knepley   ierr = DMClearFields(newdm);CHKERRQ(ierr);
5113e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5114e5e52638SMatthew G. Knepley     DMLabel     label;
5115e5e52638SMatthew G. Knepley     PetscObject field;
511634aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
5117e5e52638SMatthew G. Knepley 
5118e5e52638SMatthew G. Knepley     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
5119e5e52638SMatthew G. Knepley     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
512034aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
512134aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
512234aa8a36SMatthew G. Knepley   }
512334aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
512434aa8a36SMatthew G. Knepley }
512534aa8a36SMatthew G. Knepley 
512634aa8a36SMatthew G. Knepley /*@
512734aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
512834aa8a36SMatthew G. Knepley 
512934aa8a36SMatthew G. Knepley   Not collective
513034aa8a36SMatthew G. Knepley 
513134aa8a36SMatthew G. Knepley   Input Parameters:
513234aa8a36SMatthew G. Knepley + dm - The DM object
513334aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
513434aa8a36SMatthew G. Knepley 
5135d8d19677SJose E. Roman   Output Parameters:
513634aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
513734aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
513834aa8a36SMatthew G. Knepley 
513934aa8a36SMatthew G. Knepley   Notes:
514034aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
514134aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
514234aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5143979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
514434aa8a36SMatthew G. Knepley 
514534aa8a36SMatthew G. Knepley   Level: developer
514634aa8a36SMatthew G. Knepley 
514734aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
514834aa8a36SMatthew G. Knepley @*/
514934aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
515034aa8a36SMatthew G. Knepley {
515134aa8a36SMatthew G. Knepley   PetscFunctionBegin;
515234aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5153534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
5154534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
515534aa8a36SMatthew G. Knepley   if (f < 0) {
515634aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
515734aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
515834aa8a36SMatthew G. Knepley   } else {
515934aa8a36SMatthew G. Knepley     PetscInt       Nf;
516034aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
516134aa8a36SMatthew G. Knepley 
516234aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
51632c71b3e2SJacob Faibussowitsch     PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
516434aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
516534aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
516634aa8a36SMatthew G. Knepley   }
516734aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
516834aa8a36SMatthew G. Knepley }
516934aa8a36SMatthew G. Knepley 
517034aa8a36SMatthew G. Knepley /*@
517134aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
517234aa8a36SMatthew G. Knepley 
517334aa8a36SMatthew G. Knepley   Not collective
517434aa8a36SMatthew G. Knepley 
517534aa8a36SMatthew G. Knepley   Input Parameters:
517634aa8a36SMatthew G. Knepley + dm         - The DM object
517734aa8a36SMatthew G. Knepley . f          - The field number
517834aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
517934aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
518034aa8a36SMatthew G. Knepley 
518134aa8a36SMatthew G. Knepley   Notes:
518234aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
518334aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
518434aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5185979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
518634aa8a36SMatthew G. Knepley 
518734aa8a36SMatthew G. Knepley   Level: developer
518834aa8a36SMatthew G. Knepley 
518934aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
519034aa8a36SMatthew G. Knepley @*/
519134aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
519234aa8a36SMatthew G. Knepley {
519334aa8a36SMatthew G. Knepley   PetscFunctionBegin;
519434aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
519534aa8a36SMatthew G. Knepley   if (f < 0) {
519634aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
519734aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
519834aa8a36SMatthew G. Knepley   } else {
519934aa8a36SMatthew G. Knepley     PetscInt       Nf;
520034aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
520134aa8a36SMatthew G. Knepley 
520234aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
52032c71b3e2SJacob Faibussowitsch     PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
520434aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
520534aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
5206e5e52638SMatthew G. Knepley   }
5207e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5208e5e52638SMatthew G. Knepley }
5209e5e52638SMatthew G. Knepley 
5210b0441da4SMatthew G. Knepley /*@
5211b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
5212b0441da4SMatthew G. Knepley 
5213b0441da4SMatthew G. Knepley   Not collective
5214b0441da4SMatthew G. Knepley 
5215f899ff85SJose E. Roman   Input Parameter:
5216b0441da4SMatthew G. Knepley . dm - The DM object
5217b0441da4SMatthew G. Knepley 
5218d8d19677SJose E. Roman   Output Parameters:
5219b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
5220b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5221b0441da4SMatthew G. Knepley 
5222b0441da4SMatthew G. Knepley   Notes:
5223b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5224b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5225b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5226b0441da4SMatthew G. Knepley 
5227b0441da4SMatthew G. Knepley   Level: developer
5228b0441da4SMatthew G. Knepley 
5229b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
5230b0441da4SMatthew G. Knepley @*/
5231b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
5232b0441da4SMatthew G. Knepley {
5233b0441da4SMatthew G. Knepley   PetscInt       Nf;
5234b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5235b0441da4SMatthew G. Knepley 
5236b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5237b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5238064a246eSJacob Faibussowitsch   if (useCone)    PetscValidBoolPointer(useCone, 2);
5239064a246eSJacob Faibussowitsch   if (useClosure) PetscValidBoolPointer(useClosure, 3);
5240b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5241b0441da4SMatthew G. Knepley   if (!Nf) {
5242b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5243b0441da4SMatthew G. Knepley   } else {
5244b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5245b0441da4SMatthew G. Knepley   }
5246b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
5247b0441da4SMatthew G. Knepley }
5248b0441da4SMatthew G. Knepley 
5249b0441da4SMatthew G. Knepley /*@
5250b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
5251b0441da4SMatthew G. Knepley 
5252b0441da4SMatthew G. Knepley   Not collective
5253b0441da4SMatthew G. Knepley 
5254b0441da4SMatthew G. Knepley   Input Parameters:
5255b0441da4SMatthew G. Knepley + dm         - The DM object
5256b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5257b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5258b0441da4SMatthew G. Knepley 
5259b0441da4SMatthew G. Knepley   Notes:
5260b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5261b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5262b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5263b0441da4SMatthew G. Knepley 
5264b0441da4SMatthew G. Knepley   Level: developer
5265b0441da4SMatthew G. Knepley 
5266b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5267b0441da4SMatthew G. Knepley @*/
5268b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5269b0441da4SMatthew G. Knepley {
5270b0441da4SMatthew G. Knepley   PetscInt       Nf;
5271b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5272b0441da4SMatthew G. Knepley 
5273b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5274b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5275b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5276b0441da4SMatthew G. Knepley   if (!Nf) {
5277b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5278b0441da4SMatthew G. Knepley   } else {
5279b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5280e5e52638SMatthew G. Knepley   }
5281e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5282e5e52638SMatthew G. Knepley }
5283e5e52638SMatthew G. Knepley 
5284783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
528545480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label)
5286783e2ec8SMatthew G. Knepley {
5287783e2ec8SMatthew G. Knepley   PetscObject    obj;
5288783e2ec8SMatthew G. Knepley   PetscClassId   id;
5289783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5290783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5291783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5292783e2ec8SMatthew G. Knepley   PetscErrorCode ierr;
5293783e2ec8SMatthew G. Knepley 
5294783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
5295783e2ec8SMatthew G. Knepley   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
5296783e2ec8SMatthew G. Knepley   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5297783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5298783e2ec8SMatthew G. Knepley   if (isFE && label) {
5299783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
5300783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5301783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
530245480ffeSMatthew G. Knepley       DMLabel l;
5303783e2ec8SMatthew G. Knepley 
530445480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
530545480ffeSMatthew G. Knepley       duplicate = l == label ? PETSC_TRUE : PETSC_FALSE;
5306783e2ec8SMatthew G. Knepley       if (duplicate) break;
5307783e2ec8SMatthew G. Knepley     }
5308783e2ec8SMatthew G. Knepley     if (!duplicate) {
5309783e2ec8SMatthew G. Knepley       DM plex;
5310783e2ec8SMatthew G. Knepley 
5311783e2ec8SMatthew G. Knepley       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5312783e2ec8SMatthew G. Knepley       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
5313783e2ec8SMatthew G. Knepley       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5314783e2ec8SMatthew G. Knepley     }
5315783e2ec8SMatthew G. Knepley   }
5316783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5317783e2ec8SMatthew G. Knepley }
5318783e2ec8SMatthew G. Knepley 
5319e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5320e5e52638SMatthew G. Knepley {
5321e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5322e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5323e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5324e5e52638SMatthew G. Knepley 
5325e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5326e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
5327e5e52638SMatthew G. Knepley   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
5328e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5329b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
5330e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5331e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5332e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5333e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5334e5e52638SMatthew G. Knepley }
5335e5e52638SMatthew G. Knepley 
5336e5e52638SMatthew G. Knepley /*@
5337e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5338e5e52638SMatthew G. Knepley 
5339e5e52638SMatthew G. Knepley   Not collective
5340e5e52638SMatthew G. Knepley 
5341e5e52638SMatthew G. Knepley   Input Parameter:
5342e5e52638SMatthew G. Knepley . dm - The DM
5343e5e52638SMatthew G. Knepley 
5344e5e52638SMatthew G. Knepley   Output Parameter:
5345e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5346e5e52638SMatthew G. Knepley 
5347e5e52638SMatthew G. Knepley   Level: intermediate
5348e5e52638SMatthew G. Knepley 
5349e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5350e5e52638SMatthew G. Knepley @*/
5351e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5352e5e52638SMatthew G. Knepley {
5353e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5354e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5355534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5356e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5357e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5358e5e52638SMatthew G. Knepley }
5359e5e52638SMatthew G. Knepley 
5360e5e52638SMatthew G. Knepley /*@
5361e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5362e5e52638SMatthew G. Knepley 
5363d083f849SBarry Smith   Logically collective on dm
5364e5e52638SMatthew G. Knepley 
5365e5e52638SMatthew G. Knepley   Input Parameter:
5366e5e52638SMatthew G. Knepley . dm - The DM
5367e5e52638SMatthew G. Knepley 
5368e5e52638SMatthew G. Knepley   Level: intermediate
5369e5e52638SMatthew G. Knepley 
5370e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5371e5e52638SMatthew G. Knepley @*/
5372e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5373e5e52638SMatthew G. Knepley {
5374e5e52638SMatthew G. Knepley   PetscInt       s;
5375e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5376e5e52638SMatthew G. Knepley 
5377e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5378e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5379e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5380e5e52638SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5381e5e52638SMatthew G. Knepley     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5382b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5383e5e52638SMatthew G. Knepley   }
5384e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5385e5e52638SMatthew G. Knepley   dm->probs = NULL;
5386e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5387e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5388e5e52638SMatthew G. Knepley }
5389e5e52638SMatthew G. Knepley 
5390e5e52638SMatthew G. Knepley /*@
5391e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5392e5e52638SMatthew G. Knepley 
5393e5e52638SMatthew G. Knepley   Not collective
5394e5e52638SMatthew G. Knepley 
5395e5e52638SMatthew G. Knepley   Input Parameter:
5396e5e52638SMatthew G. Knepley . dm    - The DM
5397e5e52638SMatthew G. Knepley 
5398e5e52638SMatthew G. Knepley   Output Parameter:
5399e5e52638SMatthew G. Knepley . prob - The default PetscDS
5400e5e52638SMatthew G. Knepley 
5401e5e52638SMatthew G. Knepley   Level: intermediate
5402e5e52638SMatthew G. Knepley 
5403e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5404e5e52638SMatthew G. Knepley @*/
5405e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5406e5e52638SMatthew G. Knepley {
5407b0143b4dSMatthew G. Knepley   PetscErrorCode ierr;
5408b0143b4dSMatthew G. Knepley 
5409e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5410e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5411e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5412b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5413b0143b4dSMatthew G. Knepley     PetscDS ds;
5414b0143b4dSMatthew G. Knepley 
541545480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5416b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5417b0143b4dSMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5418b0143b4dSMatthew G. Knepley   }
5419b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5420e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5421e5e52638SMatthew G. Knepley }
5422e5e52638SMatthew G. Knepley 
5423e5e52638SMatthew G. Knepley /*@
5424e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5425e5e52638SMatthew G. Knepley 
5426e5e52638SMatthew G. Knepley   Not collective
5427e5e52638SMatthew G. Knepley 
5428e5e52638SMatthew G. Knepley   Input Parameters:
5429e5e52638SMatthew G. Knepley + dm    - The DM
5430e5e52638SMatthew G. Knepley - point - Cell for the DS
5431e5e52638SMatthew G. Knepley 
5432e5e52638SMatthew G. Knepley   Output Parameter:
5433e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5434e5e52638SMatthew G. Knepley 
5435e5e52638SMatthew G. Knepley   Level: developer
5436e5e52638SMatthew G. Knepley 
5437b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5438e5e52638SMatthew G. Knepley @*/
5439e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5440e5e52638SMatthew G. Knepley {
5441e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5442e5e52638SMatthew G. Knepley   PetscInt       s;
5443e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5444e5e52638SMatthew G. Knepley 
5445e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5446e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5447e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
54482c71b3e2SJacob Faibussowitsch   PetscCheckFalse(point < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5449e5e52638SMatthew G. Knepley   *prob = NULL;
5450e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5451e5e52638SMatthew G. Knepley     PetscInt val;
5452e5e52638SMatthew G. Knepley 
5453e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5454e5e52638SMatthew G. Knepley     else {
5455e5e52638SMatthew G. Knepley       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5456e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5457e5e52638SMatthew G. Knepley     }
5458e5e52638SMatthew G. Knepley   }
5459e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5460e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5461e5e52638SMatthew G. Knepley }
5462e5e52638SMatthew G. Knepley 
5463e5e52638SMatthew G. Knepley /*@
5464e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5465e5e52638SMatthew G. Knepley 
5466e5e52638SMatthew G. Knepley   Not collective
5467e5e52638SMatthew G. Knepley 
5468e5e52638SMatthew G. Knepley   Input Parameters:
5469e5e52638SMatthew G. Knepley + dm    - The DM
5470e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5471e5e52638SMatthew G. Knepley 
5472b3cf3223SMatthew G. Knepley   Output Parameters:
5473b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5474b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5475e5e52638SMatthew G. Knepley 
5476154ca461SJed Brown   Note:
5477154ca461SJed Brown   If a non-NULL label is given, but there is no PetscDS on that specific label,
5478154ca461SJed Brown   the PetscDS for the full domain (if present) is returned. Returns with
5479154ca461SJed Brown   fields=NULL and prob=NULL if there is no PetscDS for the full domain.
5480e5e52638SMatthew G. Knepley 
5481e5e52638SMatthew G. Knepley   Level: advanced
5482e5e52638SMatthew G. Knepley 
5483e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5484e5e52638SMatthew G. Knepley @*/
5485b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5486e5e52638SMatthew G. Knepley {
5487e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5488e5e52638SMatthew G. Knepley 
5489e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5490e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5491e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5492b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5493b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5494e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5495154ca461SJed Brown     if (dm->probs[s].label == label || !dm->probs[s].label) {
5496b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5497b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5498154ca461SJed Brown       if (dm->probs[s].label) PetscFunctionReturn(0);
5499b3cf3223SMatthew G. Knepley     }
5500e5e52638SMatthew G. Knepley   }
55012df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5502e5e52638SMatthew G. Knepley }
5503e5e52638SMatthew G. Knepley 
5504e5e52638SMatthew G. Knepley /*@
5505083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5506083401c6SMatthew G. Knepley 
5507083401c6SMatthew G. Knepley   Collective on dm
5508083401c6SMatthew G. Knepley 
5509083401c6SMatthew G. Knepley   Input Parameters:
5510083401c6SMatthew G. Knepley + dm     - The DM
5511083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5512083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5513083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5514083401c6SMatthew G. Knepley 
5515083401c6SMatthew 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,
5516083401c6SMatthew G. Knepley   the fields argument is ignored.
5517083401c6SMatthew G. Knepley 
5518083401c6SMatthew G. Knepley   Level: advanced
5519083401c6SMatthew G. Knepley 
5520083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5521083401c6SMatthew G. Knepley @*/
5522083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5523083401c6SMatthew G. Knepley {
5524083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5525083401c6SMatthew G. Knepley   PetscErrorCode ierr;
5526083401c6SMatthew G. Knepley 
5527083401c6SMatthew G. Knepley   PetscFunctionBegin;
5528083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5529083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5530064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4);
5531083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5532083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
5533083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5534083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5535083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5536083401c6SMatthew G. Knepley     }
5537083401c6SMatthew G. Knepley   }
5538083401c6SMatthew G. Knepley   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5539083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5540083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5541083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5542083401c6SMatthew G. Knepley   if (!label) {
5543083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5544083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5545083401c6SMatthew G. Knepley     Nds = 0;
5546083401c6SMatthew G. Knepley   }
5547083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5548083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5549083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5550083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5551083401c6SMatthew G. Knepley }
5552083401c6SMatthew G. Knepley 
5553083401c6SMatthew G. Knepley /*@
5554e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5555e5e52638SMatthew G. Knepley 
5556e5e52638SMatthew G. Knepley   Not collective
5557e5e52638SMatthew G. Knepley 
5558e5e52638SMatthew G. Knepley   Input Parameters:
5559e5e52638SMatthew G. Knepley + dm  - The DM
5560e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5561e5e52638SMatthew G. Knepley 
5562e5e52638SMatthew G. Knepley   Output Parameters:
5563b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5564b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5565083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5566e5e52638SMatthew G. Knepley 
5567e5e52638SMatthew G. Knepley   Level: advanced
5568e5e52638SMatthew G. Knepley 
5569e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5570e5e52638SMatthew G. Knepley @*/
5571b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5572e5e52638SMatthew G. Knepley {
5573e5e52638SMatthew G. Knepley   PetscInt       Nds;
5574e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5575e5e52638SMatthew G. Knepley 
5576e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5577e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5578e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
55792c71b3e2SJacob Faibussowitsch   PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5580e5e52638SMatthew G. Knepley   if (label) {
5581e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5582e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5583e5e52638SMatthew G. Knepley   }
5584b3cf3223SMatthew G. Knepley   if (fields) {
5585b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5586b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5587b3cf3223SMatthew G. Knepley   }
5588e5e52638SMatthew G. Knepley   if (ds) {
5589b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5590e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5591e5e52638SMatthew G. Knepley   }
5592e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5593e5e52638SMatthew G. Knepley }
5594e5e52638SMatthew G. Knepley 
5595e5e52638SMatthew G. Knepley /*@
5596083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5597e5e52638SMatthew G. Knepley 
5598083401c6SMatthew G. Knepley   Not collective
5599e5e52638SMatthew G. Knepley 
5600e5e52638SMatthew G. Knepley   Input Parameters:
5601e5e52638SMatthew G. Knepley + dm     - The DM
5602083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5603083401c6SMatthew G. Knepley . label  - The region label, or NULL
5604083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5605083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5606e5e52638SMatthew G. Knepley 
5607e5e52638SMatthew G. Knepley   Level: advanced
5608e5e52638SMatthew G. Knepley 
5609083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5610e5e52638SMatthew G. Knepley @*/
5611083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5612e5e52638SMatthew G. Knepley {
5613083401c6SMatthew G. Knepley   PetscInt       Nds;
5614e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5615e5e52638SMatthew G. Knepley 
5616e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5617e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5618083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
5619083401c6SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
56202c71b3e2SJacob Faibussowitsch   PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5621e5e52638SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5622083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr);
5623083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5624083401c6SMatthew G. Knepley   if (fields) {
5625083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
5626b3cf3223SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5627083401c6SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr);
5628083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5629e5e52638SMatthew G. Knepley   }
5630083401c6SMatthew G. Knepley   if (ds) {
5631083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
5632083401c6SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5633083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr);
5634083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5635083401c6SMatthew G. Knepley   }
5636e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5637e5e52638SMatthew G. Knepley }
5638e5e52638SMatthew G. Knepley 
5639e5e52638SMatthew G. Knepley /*@
56401d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
56411d3af9e0SMatthew G. Knepley 
56421d3af9e0SMatthew G. Knepley   Not collective
56431d3af9e0SMatthew G. Knepley 
56441d3af9e0SMatthew G. Knepley   Input Parameters:
56451d3af9e0SMatthew G. Knepley + dm  - The DM
56461d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
56471d3af9e0SMatthew G. Knepley 
56481d3af9e0SMatthew G. Knepley   Output Parameter:
56491d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
56501d3af9e0SMatthew G. Knepley 
56511d3af9e0SMatthew G. Knepley   Level: advanced
56521d3af9e0SMatthew G. Knepley 
56531d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
56541d3af9e0SMatthew G. Knepley @*/
56551d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
56561d3af9e0SMatthew G. Knepley {
56571d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
56581d3af9e0SMatthew G. Knepley   PetscErrorCode ierr;
56591d3af9e0SMatthew G. Knepley 
56601d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
56611d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
56621d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
56631d3af9e0SMatthew G. Knepley   PetscValidPointer(num, 3);
56641d3af9e0SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
56651d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
56661d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
56671d3af9e0SMatthew G. Knepley   else          *num = n;
56681d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
56691d3af9e0SMatthew G. Knepley }
56701d3af9e0SMatthew G. Knepley 
56712df84da0SMatthew G. Knepley /*@C
56722df84da0SMatthew G. Knepley   DMCreateFEDefault - Create a PetscFE based on the celltype for the mesh
56732df84da0SMatthew G. Knepley 
56742df84da0SMatthew G. Knepley   Not collective
56752df84da0SMatthew G. Knepley 
5676f1a722f8SMatthew G. Knepley   Input Parameters:
56772df84da0SMatthew G. Knepley + dm     - The DM
56782df84da0SMatthew G. Knepley . Nc     - The number of components for the field
56792df84da0SMatthew G. Knepley . prefix - The options prefix for the output PetscFE, or NULL
56802df84da0SMatthew G. Knepley - qorder - The quadrature order or PETSC_DETERMINE to use PetscSpace polynomial degree
56812df84da0SMatthew G. Knepley 
56822df84da0SMatthew G. Knepley   Output Parameter:
56832df84da0SMatthew G. Knepley . fem - The PetscFE
56842df84da0SMatthew G. Knepley 
56852df84da0SMatthew G. Knepley   Note: This is a convenience method that just calls PetscFECreateByCell() underneath.
56862df84da0SMatthew G. Knepley 
56872df84da0SMatthew G. Knepley   Level: intermediate
56882df84da0SMatthew G. Knepley 
56892df84da0SMatthew G. Knepley .seealso: PetscFECreateByCell(), DMAddField(), DMCreateDS(), DMGetCellDS(), DMGetRegionDS()
56902df84da0SMatthew G. Knepley @*/
56912df84da0SMatthew G. Knepley PetscErrorCode DMCreateFEDefault(DM dm, PetscInt Nc, const char prefix[], PetscInt qorder, PetscFE *fem)
56922df84da0SMatthew G. Knepley {
56932df84da0SMatthew G. Knepley   DMPolytopeType ct;
56942df84da0SMatthew G. Knepley   PetscInt       dim, cStart;
56952df84da0SMatthew G. Knepley   PetscErrorCode ierr;
56962df84da0SMatthew G. Knepley 
56972df84da0SMatthew G. Knepley   PetscFunctionBegin;
56982df84da0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
56992df84da0SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 2);
57002df84da0SMatthew G. Knepley   if (prefix) PetscValidCharPointer(prefix, 3);
57012df84da0SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, qorder, 4);
57022df84da0SMatthew G. Knepley   PetscValidPointer(fem, 5);
57032df84da0SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
57042df84da0SMatthew G. Knepley   ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
57052df84da0SMatthew G. Knepley   ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
57062df84da0SMatthew G. Knepley   ierr = PetscFECreateByCell(PETSC_COMM_SELF, dim, Nc, ct, prefix, qorder, fem);CHKERRQ(ierr);
57072df84da0SMatthew G. Knepley   PetscFunctionReturn(0);
57082df84da0SMatthew G. Knepley }
57092df84da0SMatthew G. Knepley 
57101d3af9e0SMatthew G. Knepley /*@
5711e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5712e5e52638SMatthew G. Knepley 
5713d083f849SBarry Smith   Collective on dm
5714e5e52638SMatthew G. Knepley 
5715e5e52638SMatthew G. Knepley   Input Parameter:
5716e5e52638SMatthew G. Knepley . dm - The DM
5717e5e52638SMatthew G. Knepley 
571845480ffeSMatthew G. Knepley   Options Database Keys:
571945480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM
572045480ffeSMatthew G. Knepley 
5721e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5722e5e52638SMatthew G. Knepley 
5723e5e52638SMatthew G. Knepley   Level: intermediate
5724e5e52638SMatthew G. Knepley 
5725e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5726e5e52638SMatthew G. Knepley @*/
5727e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5728e5e52638SMatthew G. Knepley {
5729e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5730083401c6SMatthew G. Knepley   PetscDS        dsDef;
5731083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5732f9244615SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k;
5733f9244615SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE, flg;
5734e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5735e5e52638SMatthew G. Knepley 
5736e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5737e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5738e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
5739e5e52638SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5740083401c6SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
5741083401c6SMatthew G. Knepley   /* Determine how many regions we have */
5742083401c6SMatthew G. Knepley   ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr);
5743083401c6SMatthew G. Knepley   Nl   = 0;
5744083401c6SMatthew G. Knepley   Ndef = 0;
5745083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5746083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5747083401c6SMatthew G. Knepley     PetscInt l;
5748083401c6SMatthew G. Knepley 
5749f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
5750f918ec44SMatthew G. Knepley     /* Move CEED context to discretizations */
5751f918ec44SMatthew G. Knepley     {
5752f918ec44SMatthew G. Knepley       PetscClassId id;
5753f918ec44SMatthew G. Knepley 
5754f918ec44SMatthew G. Knepley       ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr);
5755f918ec44SMatthew G. Knepley       if (id == PETSCFE_CLASSID) {
5756f918ec44SMatthew G. Knepley         Ceed ceed;
5757f918ec44SMatthew G. Knepley 
5758f918ec44SMatthew G. Knepley         ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr);
5759f918ec44SMatthew G. Knepley         ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr);
5760f918ec44SMatthew G. Knepley       }
5761f918ec44SMatthew G. Knepley     }
5762f918ec44SMatthew G. Knepley #endif
5763083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5764083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5765083401c6SMatthew G. Knepley     if (l < Nl) continue;
5766083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5767083401c6SMatthew G. Knepley   }
5768083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
5769083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5770083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5771b3cf3223SMatthew G. Knepley     IS        fields;
5772b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5773b3cf3223SMatthew G. Knepley 
5774b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
57752c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!nf,comm, PETSC_ERR_PLIB, "All fields have labels, but we are trying to create a default DS");
5776b3cf3223SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5777b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
577888f0c812SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
577988f0c812SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
578088f0c812SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
578188f0c812SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
578288f0c812SMatthew G. Knepley 
578345480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5784083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr);
5785083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5786b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
57872df9ee95SMatthew G. Knepley   }
5788083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5789083401c6SMatthew G. Knepley   if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);}
5790083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5791083401c6SMatthew G. Knepley   if (Ndef && Nl) {
57920122748bSMatthew G. Knepley     DM              plex;
5793083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5794083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5795083401c6SMatthew G. Knepley     PetscInt       *fields;
5796083401c6SMatthew G. Knepley     const PetscInt *cells;
5797083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
57980122748bSMatthew G. Knepley 
57990122748bSMatthew G. Knepley     ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
58000122748bSMatthew G. Knepley     ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5801083401c6SMatthew G. Knepley     ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr);
5802083401c6SMatthew G. Knepley     if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);}
58035fedec97SMatthew G. Knepley     /* TODO This looks like it only works for one label */
5804083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5805083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5806083401c6SMatthew G. Knepley       IS      pointIS;
5807083401c6SMatthew G. Knepley 
5808083401c6SMatthew G. Knepley       ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5809083401c6SMatthew G. Knepley       ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr);
5810083401c6SMatthew G. Knepley       ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr);
5811083401c6SMatthew G. Knepley       ierr = ISDestroy(&pointIS);CHKERRQ(ierr);
5812083401c6SMatthew G. Knepley     }
5813083401c6SMatthew G. Knepley     ierr = ISDestroy(&allcellIS);CHKERRQ(ierr);
5814083401c6SMatthew G. Knepley 
5815083401c6SMatthew G. Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr);
5816083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr);
5817083401c6SMatthew G. Knepley     ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr);
5818083401c6SMatthew G. Knepley     for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);}
5819083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr);
5820083401c6SMatthew G. Knepley     ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5821083401c6SMatthew G. Knepley     ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr);
5822083401c6SMatthew G. Knepley 
5823083401c6SMatthew G. Knepley     ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr);
5824083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
5825083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr);
5826083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr);
5827083401c6SMatthew G. Knepley     ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr);
5828083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr);
5829083401c6SMatthew G. Knepley 
583045480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5831083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr);
5832083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);
58335fedec97SMatthew G. Knepley     ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr);
5834083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5835083401c6SMatthew G. Knepley     ierr = ISDestroy(&fieldIS);CHKERRQ(ierr);
58360122748bSMatthew G. Knepley     ierr = DMDestroy(&plex);CHKERRQ(ierr);
5837083401c6SMatthew G. Knepley   }
5838083401c6SMatthew G. Knepley   /* Create label DSes
5839083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5840083401c6SMatthew G. Knepley   */
5841083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5842083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5843083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5844083401c6SMatthew G. Knepley     PetscDS   ds;
5845083401c6SMatthew G. Knepley     IS        fields;
5846083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5847083401c6SMatthew G. Knepley 
584845480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5849083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
5850083401c6SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5851083401c6SMatthew G. Knepley     for (f = 0, nf  = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
5852083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5853083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5854083401c6SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5855083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5856083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr);
5857083401c6SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5858083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr);
5859083401c6SMatthew G. Knepley     {
5860083401c6SMatthew G. Knepley       DMPolytopeType ct;
5861083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
58625fedec97SMatthew G. Knepley       PetscBool      isCohesiveLocal = PETSC_FALSE, isCohesive;
58630122748bSMatthew G. Knepley 
5864e5e52638SMatthew G. Knepley       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5865665f567fSMatthew G. Knepley       if (lStart >= 0) {
5866412e9a14SMatthew G. Knepley         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5867412e9a14SMatthew G. Knepley         switch (ct) {
5868412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5869412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5870412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5871412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
58725fedec97SMatthew G. Knepley             isCohesiveLocal = PETSC_TRUE;break;
5873083401c6SMatthew G. Knepley           default: break;
5874412e9a14SMatthew G. Knepley         }
5875665f567fSMatthew G. Knepley       }
58765fedec97SMatthew G. Knepley       ierr = MPI_Allreduce(&isCohesiveLocal, &isCohesive, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr);
58775fedec97SMatthew G. Knepley       for (f = 0, nf  = 0; f < Nf; ++f) {
58785fedec97SMatthew G. Knepley         if (label == dm->fields[f].label || !dm->fields[f].label) {
58795fedec97SMatthew G. Knepley           if (label == dm->fields[f].label) {
58805fedec97SMatthew G. Knepley             ierr = PetscDSSetDiscretization(ds, nf, NULL);CHKERRQ(ierr);
58815fedec97SMatthew G. Knepley             ierr = PetscDSSetCohesive(ds, nf, isCohesive);CHKERRQ(ierr);
58825fedec97SMatthew G. Knepley           }
58835fedec97SMatthew G. Knepley           ++nf;
58845fedec97SMatthew G. Knepley         }
58855fedec97SMatthew G. Knepley       }
5886e5e52638SMatthew G. Knepley     }
5887083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5888e5e52638SMatthew G. Knepley   }
5889083401c6SMatthew G. Knepley   ierr = PetscFree(labelSet);CHKERRQ(ierr);
5890e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5891083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5892083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5893083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5894083401c6SMatthew G. Knepley     const PetscInt *fld;
58955fedec97SMatthew G. Knepley     PetscInt        nf, dsnf;
58965fedec97SMatthew G. Knepley     PetscBool       isCohesive;
5897e5e52638SMatthew G. Knepley 
58985fedec97SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsnf);CHKERRQ(ierr);
58995fedec97SMatthew G. Knepley     ierr = PetscDSIsCohesive(ds, &isCohesive);CHKERRQ(ierr);
5900083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr);
5901083401c6SMatthew G. Knepley     ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr);
5902083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5903083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
59045fedec97SMatthew G. Knepley       PetscBool    isCohesiveField;
5905e5e52638SMatthew G. Knepley       PetscClassId id;
5906e5e52638SMatthew G. Knepley 
59075fedec97SMatthew G. Knepley       /* Handle DS with no fields */
59085fedec97SMatthew G. Knepley       if (dsnf) {ierr = PetscDSGetCohesive(ds, f, &isCohesiveField);CHKERRQ(ierr);}
59095fedec97SMatthew G. Knepley       /* If this is a cohesive cell, then regular fields need the lower dimensional discretization */
59105fedec97SMatthew G. Knepley       if (isCohesive && !isCohesiveField) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);}
5911083401c6SMatthew G. Knepley       ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr);
5912083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
5913e5e52638SMatthew G. Knepley       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5914e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5915e5e52638SMatthew G. Knepley     }
5916083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr);
5917e5e52638SMatthew G. Knepley   }
5918f9244615SMatthew G. Knepley   /* Allow k-jet tabulation */
5919f9244615SMatthew G. Knepley   ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr);
5920f9244615SMatthew G. Knepley   if (flg) {
59213b4aee56SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {
59223b4aee56SMatthew G. Knepley       PetscDS  ds = dm->probs[s].ds;
59233b4aee56SMatthew G. Knepley       PetscInt Nf, f;
59243b4aee56SMatthew G. Knepley 
59253b4aee56SMatthew G. Knepley       ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
59263b4aee56SMatthew G. Knepley       for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);}
59273b4aee56SMatthew G. Knepley     }
5928f9244615SMatthew G. Knepley   }
5929e5e52638SMatthew G. Knepley   /* Setup DSes */
5930e5e52638SMatthew G. Knepley   if (doSetup) {
5931e5e52638SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5932e5e52638SMatthew G. Knepley   }
5933e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5934e5e52638SMatthew G. Knepley }
5935e5e52638SMatthew G. Knepley 
5936e5e52638SMatthew G. Knepley /*@
59377f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
59387f96f943SMatthew G. Knepley 
5939f2cacb80SMatthew G. Knepley   Collective on DM
5940f2cacb80SMatthew G. Knepley 
59417f96f943SMatthew G. Knepley   Input Parameters:
59427f96f943SMatthew G. Knepley + dm   - The DM
59437f96f943SMatthew G. Knepley - time - The time
59447f96f943SMatthew G. Knepley 
59457f96f943SMatthew G. Knepley   Output Parameters:
5946f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5947f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
59487f96f943SMatthew G. Knepley 
59497f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
59507f96f943SMatthew G. Knepley 
59517f96f943SMatthew G. Knepley   Level: developer
59527f96f943SMatthew G. Knepley 
59537f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
59547f96f943SMatthew G. Knepley @*/
5955f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
59567f96f943SMatthew G. Knepley {
59577f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
59587f96f943SMatthew G. Knepley   void            **ectxs;
59597f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
59607f96f943SMatthew G. Knepley   PetscErrorCode    ierr;
59617f96f943SMatthew G. Knepley 
59627f96f943SMatthew G. Knepley   PetscFunctionBegin;
5963f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5964f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5965f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
59667f96f943SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
59677f96f943SMatthew G. Knepley   ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr);
59687f96f943SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
59697f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
59707f96f943SMatthew G. Knepley     PetscDS         ds;
59717f96f943SMatthew G. Knepley     DMLabel         label;
59727f96f943SMatthew G. Knepley     IS              fieldIS;
59737f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
59747f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
59757f96f943SMatthew G. Knepley 
59767f96f943SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
59777f96f943SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
59787f96f943SMatthew G. Knepley     ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);
59797f96f943SMatthew G. Knepley     ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
59807f96f943SMatthew G. Knepley     ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5981f2cacb80SMatthew G. Knepley     if (u) {
59827f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
59837f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
59847f96f943SMatthew G. Knepley         ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
59857f96f943SMatthew G. Knepley       }
59867f96f943SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
59877f96f943SMatthew G. Knepley       if (label) {
59887f96f943SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
59897f96f943SMatthew G. Knepley       } else {
59907f96f943SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
59917f96f943SMatthew G. Knepley       }
59927f96f943SMatthew G. Knepley     }
5993f2cacb80SMatthew G. Knepley     if (u_t) {
5994f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
5995f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5996f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
5997f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
5998f2cacb80SMatthew G. Knepley         ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
5999f2cacb80SMatthew G. Knepley       }
6000f2cacb80SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
6001f2cacb80SMatthew G. Knepley       if (label) {
6002f2cacb80SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
6003f2cacb80SMatthew G. Knepley       } else {
6004f2cacb80SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
6005f2cacb80SMatthew G. Knepley       }
6006f2cacb80SMatthew G. Knepley     }
6007f2cacb80SMatthew G. Knepley   }
6008f2cacb80SMatthew G. Knepley   if (u) {
60097f96f943SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr);
60107f96f943SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr);
6011f2cacb80SMatthew G. Knepley   }
6012f2cacb80SMatthew G. Knepley   if (u_t) {
6013f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr);
6014f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr);
6015f2cacb80SMatthew G. Knepley   }
60167f96f943SMatthew G. Knepley   ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr);
60177f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
60187f96f943SMatthew G. Knepley }
60197f96f943SMatthew G. Knepley 
602045480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds)
602145480ffeSMatthew G. Knepley {
602245480ffeSMatthew G. Knepley   PetscDS        dsNew;
602345480ffeSMatthew G. Knepley   DSBoundary     b;
602445480ffeSMatthew G. Knepley   PetscInt       cdim, Nf, f;
60255fedec97SMatthew G. Knepley   PetscBool      isCohesive;
602645480ffeSMatthew G. Knepley   void          *ctx;
602745480ffeSMatthew G. Knepley   PetscErrorCode ierr;
602845480ffeSMatthew G. Knepley 
602945480ffeSMatthew G. Knepley   PetscFunctionBegin;
603045480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr);
603145480ffeSMatthew G. Knepley   ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr);
603245480ffeSMatthew G. Knepley   ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr);
603345480ffeSMatthew G. Knepley   ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
603445480ffeSMatthew G. Knepley   ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr);
603545480ffeSMatthew G. Knepley   ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
603645480ffeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
603745480ffeSMatthew G. Knepley     ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr);
603845480ffeSMatthew G. Knepley     ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr);
60395fedec97SMatthew G. Knepley     ierr = PetscDSGetCohesive(ds, f, &isCohesive);CHKERRQ(ierr);
60405fedec97SMatthew G. Knepley     ierr = PetscDSSetCohesive(dsNew, f, isCohesive);CHKERRQ(ierr);
604145480ffeSMatthew G. Knepley   }
604245480ffeSMatthew G. Knepley   if (Nf) {
604345480ffeSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr);
604445480ffeSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr);
604545480ffeSMatthew G. Knepley   }
604645480ffeSMatthew G. Knepley   ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
604745480ffeSMatthew G. Knepley   for (b = dsNew->boundary; b; b = b->next) {
604845480ffeSMatthew G. Knepley     ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr);
604945480ffeSMatthew G. Knepley     /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
60502c71b3e2SJacob Faibussowitsch     //PetscCheckFalse(!b->label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name);
605145480ffeSMatthew G. Knepley   }
605245480ffeSMatthew G. Knepley 
605345480ffeSMatthew G. Knepley   ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr);
605445480ffeSMatthew G. Knepley   ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr);
605545480ffeSMatthew G. Knepley   PetscFunctionReturn(0);
605645480ffeSMatthew G. Knepley }
605745480ffeSMatthew G. Knepley 
60587f96f943SMatthew G. Knepley /*@
6059e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
6060e5e52638SMatthew G. Knepley 
6061d083f849SBarry Smith   Collective on dm
6062e5e52638SMatthew G. Knepley 
6063e5e52638SMatthew G. Knepley   Input Parameter:
6064e5e52638SMatthew G. Knepley . dm - The DM
6065e5e52638SMatthew G. Knepley 
6066e5e52638SMatthew G. Knepley   Output Parameter:
6067e5e52638SMatthew G. Knepley . newdm - The DM
6068e5e52638SMatthew G. Knepley 
6069e5e52638SMatthew G. Knepley   Level: advanced
6070e5e52638SMatthew G. Knepley 
6071e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
6072e5e52638SMatthew G. Knepley @*/
6073e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
6074e5e52638SMatthew G. Knepley {
6075e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
6076e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
6077e5e52638SMatthew G. Knepley 
6078e5e52638SMatthew G. Knepley   PetscFunctionBegin;
6079e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
6080e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
6081e5e52638SMatthew G. Knepley   ierr = DMClearDS(newdm);CHKERRQ(ierr);
6082e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
6083e5e52638SMatthew G. Knepley     DMLabel  label;
6084b3cf3223SMatthew G. Knepley     IS       fields;
608545480ffeSMatthew G. Knepley     PetscDS  ds, newds;
6086783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
6087e5e52638SMatthew G. Knepley 
6088b3cf3223SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
6089b8025e53SMatthew G. Knepley     /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */
609045480ffeSMatthew G. Knepley     ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr);
609145480ffeSMatthew G. Knepley     /* Commplete new labels in the new DS */
609245480ffeSMatthew G. Knepley     ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr);
609345480ffeSMatthew G. Knepley     ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr);
6094783e2ec8SMatthew G. Knepley     for (bd = 0; bd < Nbd; ++bd) {
6095b8025e53SMatthew G. Knepley       PetscWeakForm wf;
609645480ffeSMatthew G. Knepley       DMLabel       label;
6097783e2ec8SMatthew G. Knepley       PetscInt      field;
6098783e2ec8SMatthew G. Knepley 
6099b8025e53SMatthew G. Knepley       ierr = PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
610045480ffeSMatthew G. Knepley       ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr);
6101b8025e53SMatthew G. Knepley       ierr = PetscWeakFormReplaceLabel(wf, label);CHKERRQ(ierr);
6102783e2ec8SMatthew G. Knepley     }
6103e5e52638SMatthew G. Knepley   }
6104e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
6105e5e52638SMatthew G. Knepley }
6106e5e52638SMatthew G. Knepley 
6107e5e52638SMatthew G. Knepley /*@
6108e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
6109e5e52638SMatthew G. Knepley 
6110d083f849SBarry Smith   Collective on dm
6111e5e52638SMatthew G. Knepley 
6112e5e52638SMatthew G. Knepley   Input Parameter:
6113e5e52638SMatthew G. Knepley . dm - The DM
6114e5e52638SMatthew G. Knepley 
6115e5e52638SMatthew G. Knepley   Output Parameter:
6116e5e52638SMatthew G. Knepley . newdm - The DM
6117e5e52638SMatthew G. Knepley 
6118e5e52638SMatthew G. Knepley   Level: advanced
6119e5e52638SMatthew G. Knepley 
6120e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
6121e5e52638SMatthew G. Knepley @*/
6122e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
6123e5e52638SMatthew G. Knepley {
6124e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
6125e5e52638SMatthew G. Knepley 
6126e5e52638SMatthew G. Knepley   PetscFunctionBegin;
6127e5e52638SMatthew G. Knepley   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
6128e5e52638SMatthew G. Knepley   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
6129e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
6130e5e52638SMatthew G. Knepley }
6131e5e52638SMatthew G. Knepley 
6132b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
6133b64e0483SPeter Brune {
6134b64e0483SPeter Brune   DM dm_coord,dmc_coord;
6135b64e0483SPeter Brune   PetscErrorCode ierr;
6136b64e0483SPeter Brune   Vec coords,ccoords;
61376dbf9973SLawrence Mitchell   Mat inject;
6138b64e0483SPeter Brune   PetscFunctionBegin;
6139b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
6140b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
6141b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
6142b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
6143b64e0483SPeter Brune   if (coords && !ccoords) {
6144b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
61456668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
61466dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
61472adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
61486dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
6149b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
6150b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
6151b64e0483SPeter Brune   }
6152b64e0483SPeter Brune   PetscFunctionReturn(0);
6153b64e0483SPeter Brune }
6154b64e0483SPeter Brune 
615503dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
615603dadc2fSPeter Brune {
615703dadc2fSPeter Brune   DM dm_coord,subdm_coord;
615803dadc2fSPeter Brune   PetscErrorCode ierr;
615903dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
616003dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
616103dadc2fSPeter Brune   PetscFunctionBegin;
616203dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
616303dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
616403dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
616503dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
616603dadc2fSPeter Brune   if (coords && !ccoords) {
616703dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
61686668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
616903dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
617024640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
617103dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
617203dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
617303dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
61741ed9ada7SJunchao Zhang     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
617503dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
617603dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
617703dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
617803dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
617903dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
618003dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
618103dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
618203dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
618303dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
618403dadc2fSPeter Brune   }
618503dadc2fSPeter Brune   PetscFunctionReturn(0);
618603dadc2fSPeter Brune }
618703dadc2fSPeter Brune 
6188c73cfb54SMatthew G. Knepley /*@
6189c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
6190c73cfb54SMatthew G. Knepley 
6191c73cfb54SMatthew G. Knepley   Not collective
6192c73cfb54SMatthew G. Knepley 
6193c73cfb54SMatthew G. Knepley   Input Parameter:
6194c73cfb54SMatthew G. Knepley . dm - The DM
6195c73cfb54SMatthew G. Knepley 
6196c73cfb54SMatthew G. Knepley   Output Parameter:
6197c73cfb54SMatthew G. Knepley . dim - The topological dimension
6198c73cfb54SMatthew G. Knepley 
6199c73cfb54SMatthew G. Knepley   Level: beginner
6200c73cfb54SMatthew G. Knepley 
6201c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
6202c73cfb54SMatthew G. Knepley @*/
6203c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
6204c73cfb54SMatthew G. Knepley {
6205c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6206c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6207534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
6208c73cfb54SMatthew G. Knepley   *dim = dm->dim;
6209c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6210c73cfb54SMatthew G. Knepley }
6211c73cfb54SMatthew G. Knepley 
6212c73cfb54SMatthew G. Knepley /*@
6213c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
6214c73cfb54SMatthew G. Knepley 
6215c73cfb54SMatthew G. Knepley   Collective on dm
6216c73cfb54SMatthew G. Knepley 
6217c73cfb54SMatthew G. Knepley   Input Parameters:
6218c73cfb54SMatthew G. Knepley + dm - The DM
6219c73cfb54SMatthew G. Knepley - dim - The topological dimension
6220c73cfb54SMatthew G. Knepley 
6221c73cfb54SMatthew G. Knepley   Level: beginner
6222c73cfb54SMatthew G. Knepley 
6223c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
6224c73cfb54SMatthew G. Knepley @*/
6225c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
6226c73cfb54SMatthew G. Knepley {
6227e5e52638SMatthew G. Knepley   PetscDS        ds;
622845480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6229f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6230f17e8794SMatthew G. Knepley 
6231c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6232c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6233c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
6234c73cfb54SMatthew G. Knepley   dm->dim = dim;
6235d17bd122SMatthew G. Knepley   if (dm->dim >= 0) {
623645480ffeSMatthew G. Knepley     ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
623745480ffeSMatthew G. Knepley     for (n = 0; n < Nds; ++n) {
623845480ffeSMatthew G. Knepley       ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
623945480ffeSMatthew G. Knepley       if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);}
624045480ffeSMatthew G. Knepley     }
6241d17bd122SMatthew G. Knepley   }
6242c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6243c73cfb54SMatthew G. Knepley }
6244c73cfb54SMatthew G. Knepley 
6245793f3fe5SMatthew G. Knepley /*@
6246793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
6247793f3fe5SMatthew G. Knepley 
6248d083f849SBarry Smith   Collective on dm
6249793f3fe5SMatthew G. Knepley 
6250793f3fe5SMatthew G. Knepley   Input Parameters:
6251793f3fe5SMatthew G. Knepley + dm - the DM
6252793f3fe5SMatthew G. Knepley - dim - the dimension
6253793f3fe5SMatthew G. Knepley 
6254793f3fe5SMatthew G. Knepley   Output Parameters:
6255793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
6256aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
6257793f3fe5SMatthew G. Knepley 
6258793f3fe5SMatthew G. Knepley   Note:
6259793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
6260a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
6261793f3fe5SMatthew G. Knepley   then the interval is empty.
6262793f3fe5SMatthew G. Knepley 
6263793f3fe5SMatthew G. Knepley   Level: intermediate
6264793f3fe5SMatthew G. Knepley 
6265793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
6266793f3fe5SMatthew G. Knepley @*/
6267793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
6268793f3fe5SMatthew G. Knepley {
6269793f3fe5SMatthew G. Knepley   PetscInt       d;
6270793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
6271793f3fe5SMatthew G. Knepley 
6272793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
6273793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6274793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
62752c71b3e2SJacob Faibussowitsch   PetscCheckFalse((dim < 0) || (dim > d),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
62762c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->getdimpoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
6277793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
6278793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
6279793f3fe5SMatthew G. Knepley }
6280793f3fe5SMatthew G. Knepley 
62816636e97aSMatthew G Knepley /*@
62826636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
62836636e97aSMatthew G Knepley 
6284d083f849SBarry Smith   Collective on dm
62856636e97aSMatthew G Knepley 
62866636e97aSMatthew G Knepley   Input Parameters:
62876636e97aSMatthew G Knepley + dm - the DM
62886636e97aSMatthew G Knepley - c - coordinate vector
62896636e97aSMatthew G Knepley 
62902dd40e9bSPatrick Sanan   Notes:
62912dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
62922dd40e9bSPatrick Sanan 
62932dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
62946636e97aSMatthew G Knepley 
62956636e97aSMatthew G Knepley   Level: intermediate
62966636e97aSMatthew G Knepley 
629760c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
62986636e97aSMatthew G Knepley @*/
62996636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
63006636e97aSMatthew G Knepley {
63016636e97aSMatthew G Knepley   PetscErrorCode ierr;
63026636e97aSMatthew G Knepley 
63036636e97aSMatthew G Knepley   PetscFunctionBegin;
63046636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63056636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
63066636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
63076636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
63086636e97aSMatthew G Knepley   dm->coordinates = c;
63096636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
6310b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
631103dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
63126636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63136636e97aSMatthew G Knepley }
63146636e97aSMatthew G Knepley 
63156636e97aSMatthew G Knepley /*@
63166636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
63176636e97aSMatthew G Knepley 
63187058e716SVaclav Hapla   Not collective
63196636e97aSMatthew G Knepley 
63206636e97aSMatthew G Knepley    Input Parameters:
63216636e97aSMatthew G Knepley +  dm - the DM
63226636e97aSMatthew G Knepley -  c - coordinate vector
63236636e97aSMatthew G Knepley 
63242dd40e9bSPatrick Sanan   Notes:
63256636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
63266636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
63276636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
63286636e97aSMatthew G Knepley 
63292dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
63302dd40e9bSPatrick Sanan 
63316636e97aSMatthew G Knepley   Level: intermediate
63326636e97aSMatthew G Knepley 
63336636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
63346636e97aSMatthew G Knepley @*/
63356636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
63366636e97aSMatthew G Knepley {
63376636e97aSMatthew G Knepley   PetscErrorCode ierr;
63386636e97aSMatthew G Knepley 
63396636e97aSMatthew G Knepley   PetscFunctionBegin;
63406636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6341b7f5c055SJed Brown   if (c) PetscValidHeaderSpecific(c,VEC_CLASSID,2);
63426636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
63436636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
63448865f1eaSKarl Rupp 
63456636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
63468865f1eaSKarl Rupp 
63476636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
63486636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63496636e97aSMatthew G Knepley }
63506636e97aSMatthew G Knepley 
63516636e97aSMatthew G Knepley /*@
63526636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
63536636e97aSMatthew G Knepley 
6354d083f849SBarry Smith   Collective on dm
63556636e97aSMatthew G Knepley 
63566636e97aSMatthew G Knepley   Input Parameter:
63576636e97aSMatthew G Knepley . dm - the DM
63586636e97aSMatthew G Knepley 
63596636e97aSMatthew G Knepley   Output Parameter:
63606636e97aSMatthew G Knepley . c - global coordinate vector
63616636e97aSMatthew G Knepley 
63626636e97aSMatthew G Knepley   Note:
636360c22052SBarry Smith   This is a borrowed reference, so the user should NOT destroy this vector. When the DM is
636460c22052SBarry Smith   destroyed the array will no longer be valid.
63656636e97aSMatthew G Knepley 
6366959c7569SPatrick Sanan   Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates).
63676636e97aSMatthew G Knepley 
63686636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63696636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63706636e97aSMatthew G Knepley 
63716636e97aSMatthew G Knepley   Level: intermediate
63726636e97aSMatthew G Knepley 
637360c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
63746636e97aSMatthew G Knepley @*/
63756636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
63766636e97aSMatthew G Knepley {
63776636e97aSMatthew G Knepley   PetscErrorCode ierr;
63786636e97aSMatthew G Knepley 
63796636e97aSMatthew G Knepley   PetscFunctionBegin;
63806636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63816636e97aSMatthew G Knepley   PetscValidPointer(c,2);
63821f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
63830298fd71SBarry Smith     DM        cdm = NULL;
63841970a576SMatthew G. Knepley     PetscBool localized;
63856636e97aSMatthew G Knepley 
63866636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
63876636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
63881970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
63891970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
63901970a576SMatthew G. Knepley     if (localized) {
63911970a576SMatthew G. Knepley       PetscInt cdim;
63921970a576SMatthew G. Knepley 
63931970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
63941970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
63951970a576SMatthew G. Knepley     }
63966636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
63976636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
63986636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
63996636e97aSMatthew G Knepley   }
64006636e97aSMatthew G Knepley   *c = dm->coordinates;
64016636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64026636e97aSMatthew G Knepley }
64036636e97aSMatthew G Knepley 
64046636e97aSMatthew G Knepley /*@
640581e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
640681e9a530SVaclav Hapla 
6407d083f849SBarry Smith   Collective on dm
640881e9a530SVaclav Hapla 
640981e9a530SVaclav Hapla   Input Parameter:
641081e9a530SVaclav Hapla . dm - the DM
641181e9a530SVaclav Hapla 
641281e9a530SVaclav Hapla   Level: advanced
641381e9a530SVaclav Hapla 
641481e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
641581e9a530SVaclav Hapla @*/
641681e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
641781e9a530SVaclav Hapla {
641881e9a530SVaclav Hapla   PetscErrorCode ierr;
641981e9a530SVaclav Hapla 
642081e9a530SVaclav Hapla   PetscFunctionBegin;
642181e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
642281e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
64231970a576SMatthew G. Knepley     DM        cdm = NULL;
64241970a576SMatthew G. Knepley     PetscBool localized;
64251970a576SMatthew G. Knepley 
642681e9a530SVaclav Hapla     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
642781e9a530SVaclav Hapla     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
64281970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
64291970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
64301970a576SMatthew G. Knepley     if (localized) {
64311970a576SMatthew G. Knepley       PetscInt cdim;
64321970a576SMatthew G. Knepley 
64331970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
64341970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
64351970a576SMatthew G. Knepley     }
643681e9a530SVaclav Hapla     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
643781e9a530SVaclav Hapla     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
643881e9a530SVaclav Hapla     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
643981e9a530SVaclav Hapla   }
644081e9a530SVaclav Hapla   PetscFunctionReturn(0);
644181e9a530SVaclav Hapla }
644281e9a530SVaclav Hapla 
644381e9a530SVaclav Hapla /*@
64446636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
64456636e97aSMatthew G Knepley 
6446d083f849SBarry Smith   Collective on dm
64476636e97aSMatthew G Knepley 
64486636e97aSMatthew G Knepley   Input Parameter:
64496636e97aSMatthew G Knepley . dm - the DM
64506636e97aSMatthew G Knepley 
64516636e97aSMatthew G Knepley   Output Parameter:
64526636e97aSMatthew G Knepley . c - coordinate vector
64536636e97aSMatthew G Knepley 
64546636e97aSMatthew G Knepley   Note:
64556636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
64566636e97aSMatthew G Knepley 
64576636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
64586636e97aSMatthew G Knepley 
64596636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
64606636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
64616636e97aSMatthew G Knepley 
64626636e97aSMatthew G Knepley   Level: intermediate
64636636e97aSMatthew G Knepley 
646481e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
64656636e97aSMatthew G Knepley @*/
64666636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
64676636e97aSMatthew G Knepley {
64686636e97aSMatthew G Knepley   PetscErrorCode ierr;
64696636e97aSMatthew G Knepley 
64706636e97aSMatthew G Knepley   PetscFunctionBegin;
64716636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64726636e97aSMatthew G Knepley   PetscValidPointer(c,2);
647381e9a530SVaclav Hapla   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
64746636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
64756636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64766636e97aSMatthew G Knepley }
64776636e97aSMatthew G Knepley 
647881e9a530SVaclav Hapla /*@
647981e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
648081e9a530SVaclav Hapla 
648181e9a530SVaclav Hapla   Not collective
648281e9a530SVaclav Hapla 
648381e9a530SVaclav Hapla   Input Parameter:
648481e9a530SVaclav Hapla . dm - the DM
648581e9a530SVaclav Hapla 
648681e9a530SVaclav Hapla   Output Parameter:
648781e9a530SVaclav Hapla . c - coordinate vector
648881e9a530SVaclav Hapla 
648981e9a530SVaclav Hapla   Level: advanced
649081e9a530SVaclav Hapla 
649181e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
649281e9a530SVaclav Hapla @*/
649381e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
649481e9a530SVaclav Hapla {
649581e9a530SVaclav Hapla   PetscFunctionBegin;
649681e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
649781e9a530SVaclav Hapla   PetscValidPointer(c,2);
64982c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->coordinatesLocal && dm->coordinates,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
64996636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
65006636e97aSMatthew G Knepley   PetscFunctionReturn(0);
65016636e97aSMatthew G Knepley }
65026636e97aSMatthew G Knepley 
65032db98f8dSVaclav Hapla /*@
65042db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
65052db98f8dSVaclav Hapla 
65062db98f8dSVaclav Hapla   Not collective
65072db98f8dSVaclav Hapla 
6508d8d19677SJose E. Roman   Input Parameters:
65092db98f8dSVaclav Hapla + dm - the DM
65102db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
65112db98f8dSVaclav Hapla 
6512d8d19677SJose E. Roman   Output Parameters:
65132db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
65142db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
65152db98f8dSVaclav Hapla 
65162db98f8dSVaclav Hapla   Note:
65172db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
65182db98f8dSVaclav Hapla 
65192db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
65202db98f8dSVaclav Hapla 
65212db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
65222db98f8dSVaclav Hapla 
65232db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
65242db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
65252db98f8dSVaclav Hapla 
65262db98f8dSVaclav Hapla   Level: advanced
65272db98f8dSVaclav Hapla 
65282db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
65292db98f8dSVaclav Hapla @*/
65302db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
65312db98f8dSVaclav Hapla {
65322db98f8dSVaclav Hapla   PetscSection        cs, newcs;
65332db98f8dSVaclav Hapla   Vec                 coords;
65342db98f8dSVaclav Hapla   const PetscScalar   *arr;
65352db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
65362db98f8dSVaclav Hapla   PetscInt            n;
65372db98f8dSVaclav Hapla   PetscErrorCode      ierr;
65382db98f8dSVaclav Hapla 
65392db98f8dSVaclav Hapla   PetscFunctionBegin;
65402db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
65412db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
65422db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
65432db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
65442c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->coordinatesLocal,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
65452c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->coordinateDM || !dm->coordinateDM->localSection,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
65461bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
65472db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
65482db98f8dSVaclav Hapla   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
65492db98f8dSVaclav Hapla   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
65502db98f8dSVaclav Hapla   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
65512db98f8dSVaclav Hapla   if (pCoord) {
65522db98f8dSVaclav Hapla     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
65532db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
65542db98f8dSVaclav Hapla     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
65552db98f8dSVaclav Hapla     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
6556ad9ac99dSVaclav Hapla   } else {
6557ad9ac99dSVaclav Hapla     ierr = PetscFree(newarr);CHKERRQ(ierr);
65582db98f8dSVaclav Hapla   }
6559ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
6560ad9ac99dSVaclav Hapla   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
65612db98f8dSVaclav Hapla   PetscFunctionReturn(0);
65622db98f8dSVaclav Hapla }
65632db98f8dSVaclav Hapla 
6564f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6565f19dbd58SToby Isaac {
6566f19dbd58SToby Isaac   PetscErrorCode ierr;
6567f19dbd58SToby Isaac 
6568f19dbd58SToby Isaac   PetscFunctionBegin;
6569f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6570f19dbd58SToby Isaac   PetscValidPointer(field,2);
6571f19dbd58SToby Isaac   if (!dm->coordinateField) {
6572f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
6573f19dbd58SToby Isaac       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
6574f19dbd58SToby Isaac     }
6575f19dbd58SToby Isaac   }
6576f19dbd58SToby Isaac   *field = dm->coordinateField;
6577f19dbd58SToby Isaac   PetscFunctionReturn(0);
6578f19dbd58SToby Isaac }
6579f19dbd58SToby Isaac 
6580f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6581f19dbd58SToby Isaac {
6582f19dbd58SToby Isaac   PetscErrorCode ierr;
6583f19dbd58SToby Isaac 
6584f19dbd58SToby Isaac   PetscFunctionBegin;
6585f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6586f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
6587c4e6da2cSBarry Smith   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
6588f19dbd58SToby Isaac   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
6589f19dbd58SToby Isaac   dm->coordinateField = field;
6590f19dbd58SToby Isaac   PetscFunctionReturn(0);
6591f19dbd58SToby Isaac }
6592f19dbd58SToby Isaac 
65936636e97aSMatthew G Knepley /*@
65941cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
65956636e97aSMatthew G Knepley 
6596d083f849SBarry Smith   Collective on dm
65976636e97aSMatthew G Knepley 
65986636e97aSMatthew G Knepley   Input Parameter:
65996636e97aSMatthew G Knepley . dm - the DM
66006636e97aSMatthew G Knepley 
66016636e97aSMatthew G Knepley   Output Parameter:
66026636e97aSMatthew G Knepley . cdm - coordinate DM
66036636e97aSMatthew G Knepley 
66046636e97aSMatthew G Knepley   Level: intermediate
66056636e97aSMatthew G Knepley 
66061cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
66076636e97aSMatthew G Knepley @*/
66086636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
66096636e97aSMatthew G Knepley {
66106636e97aSMatthew G Knepley   PetscErrorCode ierr;
66116636e97aSMatthew G Knepley 
66126636e97aSMatthew G Knepley   PetscFunctionBegin;
66136636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
66146636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
66156636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6616308f8a94SToby Isaac     DM cdm;
6617308f8a94SToby Isaac 
66182c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->createcoordinatedm,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
6619308f8a94SToby Isaac     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
6620c9ad657eSksagiyam     ierr = PetscObjectSetName((PetscObject)cdm, "coordinateDM");CHKERRQ(ierr);
6621308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6622308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
6623308f8a94SToby Isaac     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
6624308f8a94SToby Isaac     dm->coordinateDM = cdm;
66256636e97aSMatthew G Knepley   }
66266636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
66276636e97aSMatthew G Knepley   PetscFunctionReturn(0);
66286636e97aSMatthew G Knepley }
6629e87bb0d3SMatthew G Knepley 
66301cfe2091SMatthew G. Knepley /*@
66311cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
66321cfe2091SMatthew G. Knepley 
6633d083f849SBarry Smith   Logically Collective on dm
66341cfe2091SMatthew G. Knepley 
66351cfe2091SMatthew G. Knepley   Input Parameters:
66361cfe2091SMatthew G. Knepley + dm - the DM
66371cfe2091SMatthew G. Knepley - cdm - coordinate DM
66381cfe2091SMatthew G. Knepley 
66391cfe2091SMatthew G. Knepley   Level: intermediate
66401cfe2091SMatthew G. Knepley 
66411cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
66421cfe2091SMatthew G. Knepley @*/
66431cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
66441cfe2091SMatthew G. Knepley {
66451cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
66461cfe2091SMatthew G. Knepley 
66471cfe2091SMatthew G. Knepley   PetscFunctionBegin;
66481cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
66491cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
6650f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
66511cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
66521cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
66531cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
66541cfe2091SMatthew G. Knepley }
66551cfe2091SMatthew G. Knepley 
665646e270d4SMatthew G. Knepley /*@
665746e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
665846e270d4SMatthew G. Knepley 
665946e270d4SMatthew G. Knepley   Not Collective
666046e270d4SMatthew G. Knepley 
666146e270d4SMatthew G. Knepley   Input Parameter:
666246e270d4SMatthew G. Knepley . dm - The DM object
666346e270d4SMatthew G. Knepley 
666446e270d4SMatthew G. Knepley   Output Parameter:
666546e270d4SMatthew G. Knepley . dim - The embedding dimension
666646e270d4SMatthew G. Knepley 
666746e270d4SMatthew G. Knepley   Level: intermediate
666846e270d4SMatthew G. Knepley 
666992fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
667046e270d4SMatthew G. Knepley @*/
667146e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
667246e270d4SMatthew G. Knepley {
667346e270d4SMatthew G. Knepley   PetscFunctionBegin;
667446e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6675534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
66769a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
66779a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
66789a9a41abSToby Isaac   }
667946e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
668046e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
668146e270d4SMatthew G. Knepley }
668246e270d4SMatthew G. Knepley 
668346e270d4SMatthew G. Knepley /*@
668446e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
668546e270d4SMatthew G. Knepley 
668646e270d4SMatthew G. Knepley   Not Collective
668746e270d4SMatthew G. Knepley 
668846e270d4SMatthew G. Knepley   Input Parameters:
668946e270d4SMatthew G. Knepley + dm  - The DM object
669046e270d4SMatthew G. Knepley - dim - The embedding dimension
669146e270d4SMatthew G. Knepley 
669246e270d4SMatthew G. Knepley   Level: intermediate
669346e270d4SMatthew G. Knepley 
669492fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
669546e270d4SMatthew G. Knepley @*/
669646e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
669746e270d4SMatthew G. Knepley {
6698e5e52638SMatthew G. Knepley   PetscDS        ds;
669945480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6700f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6701f17e8794SMatthew G. Knepley 
670246e270d4SMatthew G. Knepley   PetscFunctionBegin;
670346e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
670446e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
6705d17bd122SMatthew G. Knepley   if (dm->dim >= 0) {
670645480ffeSMatthew G. Knepley     ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
670745480ffeSMatthew G. Knepley     for (n = 0; n < Nds; ++n) {
670845480ffeSMatthew G. Knepley       ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
6709e5e52638SMatthew G. Knepley       ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
671045480ffeSMatthew G. Knepley     }
6711d17bd122SMatthew G. Knepley   }
671246e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
671346e270d4SMatthew G. Knepley }
671446e270d4SMatthew G. Knepley 
6715e8abe2deSMatthew G. Knepley /*@
6716e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6717e8abe2deSMatthew G. Knepley 
6718d083f849SBarry Smith   Collective on dm
6719e8abe2deSMatthew G. Knepley 
6720e8abe2deSMatthew G. Knepley   Input Parameter:
6721e8abe2deSMatthew G. Knepley . dm - The DM object
6722e8abe2deSMatthew G. Knepley 
6723e8abe2deSMatthew G. Knepley   Output Parameter:
6724e8abe2deSMatthew G. Knepley . section - The PetscSection object
6725e8abe2deSMatthew G. Knepley 
6726e8abe2deSMatthew G. Knepley   Level: intermediate
6727e8abe2deSMatthew G. Knepley 
672892fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6729e8abe2deSMatthew G. Knepley @*/
6730e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6731e8abe2deSMatthew G. Knepley {
6732e8abe2deSMatthew G. Knepley   DM             cdm;
6733e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6734e8abe2deSMatthew G. Knepley 
6735e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6736e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6737e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
6738e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
673992fd8e1eSJed Brown   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6740e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6741e8abe2deSMatthew G. Knepley }
6742e8abe2deSMatthew G. Knepley 
6743e8abe2deSMatthew G. Knepley /*@
6744e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6745e8abe2deSMatthew G. Knepley 
6746e8abe2deSMatthew G. Knepley   Not Collective
6747e8abe2deSMatthew G. Knepley 
6748e8abe2deSMatthew G. Knepley   Input Parameters:
6749e8abe2deSMatthew G. Knepley + dm      - The DM object
675046e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6751e8abe2deSMatthew G. Knepley - section - The PetscSection object
6752e8abe2deSMatthew G. Knepley 
6753e8abe2deSMatthew G. Knepley   Level: intermediate
6754e8abe2deSMatthew G. Knepley 
675592fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6756e8abe2deSMatthew G. Knepley @*/
675746e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6758e8abe2deSMatthew G. Knepley {
6759e8abe2deSMatthew G. Knepley   DM             cdm;
6760e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6761e8abe2deSMatthew G. Knepley 
6762e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6763e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
676446e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6765e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
676692fd8e1eSJed Brown   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
676746e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
67684c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
676946e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
677046e270d4SMatthew G. Knepley 
677146e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
677246e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
677346e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
677446e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
677546e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
677646e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
677746e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
677846e270d4SMatthew G. Knepley     }
6779ebfe4b0dSMatthew G. Knepley     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
678046e270d4SMatthew G. Knepley   }
6781e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6782e8abe2deSMatthew G. Knepley }
6783e8abe2deSMatthew G. Knepley 
6784d864a3eaSLisandro Dalcin /*@
6785d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6786d864a3eaSLisandro Dalcin 
6787d864a3eaSLisandro Dalcin   Input Parameters:
6788d864a3eaSLisandro Dalcin + dm      - The DM object
6789d864a3eaSLisandro Dalcin - disc    - The new coordinate discretization
6790d864a3eaSLisandro Dalcin 
6791d864a3eaSLisandro Dalcin   Level: intermediate
6792d864a3eaSLisandro Dalcin 
6793d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6794d864a3eaSLisandro Dalcin @*/
6795d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6796d864a3eaSLisandro Dalcin {
6797d864a3eaSLisandro Dalcin   PetscObject    discOld;
6798d864a3eaSLisandro Dalcin   PetscClassId   classid;
6799d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6800d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6801d864a3eaSLisandro Dalcin   Mat            matInterp;
6802d864a3eaSLisandro Dalcin   PetscErrorCode ierr;
6803d864a3eaSLisandro Dalcin 
6804d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6805d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6806d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6807d864a3eaSLisandro Dalcin 
6808d864a3eaSLisandro Dalcin   ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr);
6809d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
6810d864a3eaSLisandro Dalcin   ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr);
6811d864a3eaSLisandro Dalcin   ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr);
681229ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
681329ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
681429ad44c5SMatthew G. Knepley       PetscFE        feLinear;
681529ad44c5SMatthew G. Knepley       DMPolytopeType ct;
681629ad44c5SMatthew G. Knepley       PetscInt       dim, dE, cStart;
681729ad44c5SMatthew G. Knepley       PetscBool      simplex;
681829ad44c5SMatthew G. Knepley 
681929ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
682029ad44c5SMatthew G. Knepley       ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
682129ad44c5SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
682229ad44c5SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr);
682329ad44c5SMatthew G. Knepley       ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
682429ad44c5SMatthew G. Knepley       switch (ct) {
682529ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM:
682629ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM_TENSOR:
682729ad44c5SMatthew G. Knepley           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
682829ad44c5SMatthew G. Knepley         default: break;
682929ad44c5SMatthew G. Knepley       }
683029ad44c5SMatthew G. Knepley       simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
683129ad44c5SMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr);
683229ad44c5SMatthew G. Knepley       ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr);
683329ad44c5SMatthew G. Knepley       ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr);
683429ad44c5SMatthew G. Knepley       ierr = DMCreateDS(cdmOld);CHKERRQ(ierr);
683529ad44c5SMatthew G. Knepley     } else {
683629ad44c5SMatthew G. Knepley       const char *discname;
683729ad44c5SMatthew G. Knepley 
683829ad44c5SMatthew G. Knepley       ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr);
683998921bdaSJacob Faibussowitsch       SETERRQ(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
684029ad44c5SMatthew G. Knepley     }
684129ad44c5SMatthew G. Knepley   }
6842d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
6843d864a3eaSLisandro Dalcin   ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr);
6844d864a3eaSLisandro Dalcin   ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr);
6845d864a3eaSLisandro Dalcin   ierr = DMCreateDS(cdmNew);CHKERRQ(ierr);
6846d864a3eaSLisandro Dalcin   /* Project the coordinate vector from old to new space  */
6847d864a3eaSLisandro Dalcin   ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr);
6848d864a3eaSLisandro Dalcin   ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr);
6849d864a3eaSLisandro Dalcin   ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr);
6850d864a3eaSLisandro Dalcin   ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr);
6851d864a3eaSLisandro Dalcin   ierr = MatDestroy(&matInterp);CHKERRQ(ierr);
6852d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
6853d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr);
6854d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr);
6855d864a3eaSLisandro Dalcin   ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr);
6856d864a3eaSLisandro Dalcin   ierr = VecDestroy(&coordsNew);CHKERRQ(ierr);
6857d864a3eaSLisandro Dalcin   ierr = DMDestroy(&cdmNew);CHKERRQ(ierr);
6858d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6859d864a3eaSLisandro Dalcin }
6860d864a3eaSLisandro Dalcin 
68615dc8c3f7SMatthew G. Knepley /*@C
686290b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
68635dc8c3f7SMatthew G. Knepley 
6864f899ff85SJose E. Roman   Input Parameter:
686590b157c4SStefano Zampini . dm      - The DM object
686690b157c4SStefano Zampini 
686790b157c4SStefano Zampini   Output Parameters:
686890b157c4SStefano Zampini + per     - Whether the DM is periodic or not
68695dc8c3f7SMatthew 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
68705dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
68715dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
68725dc8c3f7SMatthew G. Knepley 
68735dc8c3f7SMatthew G. Knepley   Level: developer
68745dc8c3f7SMatthew G. Knepley 
68755dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
68765dc8c3f7SMatthew G. Knepley @*/
687790b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6878c6b900c6SMatthew G. Knepley {
6879c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6880c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
688190b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6882c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6883c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
68845dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6885c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6886c6b900c6SMatthew G. Knepley }
6887c6b900c6SMatthew G. Knepley 
68885dc8c3f7SMatthew G. Knepley /*@C
68895dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
68905dc8c3f7SMatthew G. Knepley 
68915dc8c3f7SMatthew G. Knepley   Input Parameters:
68925dc8c3f7SMatthew G. Knepley + dm      - The DM object
6893db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6894db2bf62eSStefano 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.
68955dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
68965dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
68975dc8c3f7SMatthew G. Knepley 
6898db2bf62eSStefano 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.
6899db2bf62eSStefano Zampini 
69005dc8c3f7SMatthew G. Knepley   Level: developer
69015dc8c3f7SMatthew G. Knepley 
69025dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
69035dc8c3f7SMatthew G. Knepley @*/
690490b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6905c6b900c6SMatthew G. Knepley {
6906c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6907c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
6908c6b900c6SMatthew G. Knepley 
6909c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6910c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
691190b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6912412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6913412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6914412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
69155dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
691690b157c4SStefano Zampini   if (maxCell) {
6917412e9a14SMatthew G. Knepley     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6918412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6919db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
6920db2bf62eSStefano Zampini     ierr = PetscFree(dm->maxCell);CHKERRQ(ierr);
6921412e9a14SMatthew G. Knepley   }
6922db2bf62eSStefano Zampini 
6923412e9a14SMatthew G. Knepley   if (L) {
6924412e9a14SMatthew G. Knepley     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6925412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6926412e9a14SMatthew G. Knepley   }
6927412e9a14SMatthew G. Knepley   if (bd) {
6928412e9a14SMatthew G. Knepley     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6929412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
693090b157c4SStefano Zampini   }
6931072d7d67SStefano Zampini   dm->periodic = per;
6932c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6933c6b900c6SMatthew G. Knepley }
6934c6b900c6SMatthew G. Knepley 
69352e17dfb7SMatthew G. Knepley /*@
69362e17dfb7SMatthew 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.
69372e17dfb7SMatthew G. Knepley 
69382e17dfb7SMatthew G. Knepley   Input Parameters:
69392e17dfb7SMatthew G. Knepley + dm     - The DM
694065da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
694165da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
69422e17dfb7SMatthew G. Knepley 
69432e17dfb7SMatthew G. Knepley   Output Parameter:
69442e17dfb7SMatthew G. Knepley . out - The localized coordinate point
69452e17dfb7SMatthew G. Knepley 
69462e17dfb7SMatthew G. Knepley   Level: developer
69472e17dfb7SMatthew G. Knepley 
69482e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
69492e17dfb7SMatthew G. Knepley @*/
695065da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
69512e17dfb7SMatthew G. Knepley {
69522e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
69532e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
69542e17dfb7SMatthew G. Knepley 
69552e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69562e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
69572e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
69582e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
69592e17dfb7SMatthew G. Knepley   } else {
696065da65dcSMatthew G. Knepley     if (endpoint) {
696165da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6962da3333bfSMatthew 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)) {
6963da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
696465da65dcSMatthew G. Knepley         } else {
6965da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
696665da65dcSMatthew G. Knepley         }
696765da65dcSMatthew G. Knepley       }
696865da65dcSMatthew G. Knepley     } else {
69692e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
69701118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
69712e17dfb7SMatthew G. Knepley       }
69722e17dfb7SMatthew G. Knepley     }
697365da65dcSMatthew G. Knepley   }
69742e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69752e17dfb7SMatthew G. Knepley }
69762e17dfb7SMatthew G. Knepley 
69772e17dfb7SMatthew G. Knepley /*
69782e17dfb7SMatthew 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.
69792e17dfb7SMatthew G. Knepley 
69802e17dfb7SMatthew G. Knepley   Input Parameters:
69812e17dfb7SMatthew G. Knepley + dm     - The DM
69822e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
69832e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
69842e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
69852e17dfb7SMatthew G. Knepley 
69862e17dfb7SMatthew G. Knepley   Output Parameter:
69872e17dfb7SMatthew G. Knepley . out - The localized coordinate point
69882e17dfb7SMatthew G. Knepley 
69892e17dfb7SMatthew G. Knepley   Level: developer
69902e17dfb7SMatthew G. Knepley 
69912e17dfb7SMatthew 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
69922e17dfb7SMatthew G. Knepley 
69932e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
69942e17dfb7SMatthew G. Knepley */
69952e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
69962e17dfb7SMatthew G. Knepley {
69972e17dfb7SMatthew G. Knepley   PetscInt d;
69982e17dfb7SMatthew G. Knepley 
69992e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70002e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
70012e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
70022e17dfb7SMatthew G. Knepley   } else {
70032e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
7004908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
70052e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
70062e17dfb7SMatthew G. Knepley       } else {
70072e17dfb7SMatthew G. Knepley         out[d] = in[d];
70082e17dfb7SMatthew G. Knepley       }
70092e17dfb7SMatthew G. Knepley     }
70102e17dfb7SMatthew G. Knepley   }
70112e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70122e17dfb7SMatthew G. Knepley }
7013a5801f52SStefano Zampini 
70142e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
70152e17dfb7SMatthew G. Knepley {
70162e17dfb7SMatthew G. Knepley   PetscInt d;
70172e17dfb7SMatthew G. Knepley 
70182e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70192e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
70202e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
70212e17dfb7SMatthew G. Knepley   } else {
70222e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
7023908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
70242e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
70252e17dfb7SMatthew G. Knepley       } else {
70262e17dfb7SMatthew G. Knepley         out[d] = in[d];
70272e17dfb7SMatthew G. Knepley       }
70282e17dfb7SMatthew G. Knepley     }
70292e17dfb7SMatthew G. Knepley   }
70302e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70312e17dfb7SMatthew G. Knepley }
70322e17dfb7SMatthew G. Knepley 
70332e17dfb7SMatthew G. Knepley /*
70342e17dfb7SMatthew 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.
70352e17dfb7SMatthew G. Knepley 
70362e17dfb7SMatthew G. Knepley   Input Parameters:
70372e17dfb7SMatthew G. Knepley + dm     - The DM
70382e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
70392e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
70402e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
70412e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
70422e17dfb7SMatthew G. Knepley 
70432e17dfb7SMatthew G. Knepley   Output Parameter:
70442e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
70452e17dfb7SMatthew G. Knepley 
70462e17dfb7SMatthew G. Knepley   Level: developer
70472e17dfb7SMatthew G. Knepley 
70482e17dfb7SMatthew 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
70492e17dfb7SMatthew G. Knepley 
70502e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
70512e17dfb7SMatthew G. Knepley */
70522e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
70532e17dfb7SMatthew G. Knepley {
70542e17dfb7SMatthew G. Knepley   PetscInt d;
70552e17dfb7SMatthew G. Knepley 
70562e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70572e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
70582e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
70592e17dfb7SMatthew G. Knepley   } else {
70602e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
7061412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
7062412e9a14SMatthew G. Knepley 
7063412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
7064412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
7065412e9a14SMatthew G. Knepley 
7066412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
706798921bdaSJacob Faibussowitsch           SETERRQ(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]));
7068412e9a14SMatthew G. Knepley         out[d] += newCoord;
70692e17dfb7SMatthew G. Knepley       } else {
70702e17dfb7SMatthew G. Knepley         out[d] += in[d];
70712e17dfb7SMatthew G. Knepley       }
70722e17dfb7SMatthew G. Knepley     }
70732e17dfb7SMatthew G. Knepley   }
70742e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70752e17dfb7SMatthew G. Knepley }
70762e17dfb7SMatthew G. Knepley 
707736447a5eSToby Isaac /*@
70788f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
70798f700142SStefano Zampini 
70808f700142SStefano Zampini   Not collective
708136447a5eSToby Isaac 
708236447a5eSToby Isaac   Input Parameter:
708336447a5eSToby Isaac . dm - The DM
708436447a5eSToby Isaac 
708536447a5eSToby Isaac   Output Parameter:
708636447a5eSToby Isaac   areLocalized - True if localized
708736447a5eSToby Isaac 
708836447a5eSToby Isaac   Level: developer
708936447a5eSToby Isaac 
70908f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
709136447a5eSToby Isaac @*/
70928f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
709336447a5eSToby Isaac {
709436447a5eSToby Isaac   DM             cdm;
709536447a5eSToby Isaac   PetscSection   coordSection;
70962ccac677SMatthew G. Knepley   PetscInt       depth, cStart, cEnd, sStart, sEnd, c, dof;
709746a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
709836447a5eSToby Isaac   PetscErrorCode ierr;
709936447a5eSToby Isaac 
710036447a5eSToby Isaac   PetscFunctionBegin;
710136447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7102534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
71038b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
710446a3a80fSLisandro Dalcin 
710536447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
710636447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
710746a3a80fSLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
71089f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
71092ccac677SMatthew G. Knepley   ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr);
71102ccac677SMatthew G. Knepley   if (!depth) PetscFunctionReturn(0);
711146a3a80fSLisandro Dalcin 
71129f7230bfSMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
711346a3a80fSLisandro Dalcin   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
711436447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
711536447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
711646a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
711746a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
711836447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
711946a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
712036447a5eSToby Isaac   }
71218f700142SStefano Zampini   *areLocalized = alreadyLocalized;
712236447a5eSToby Isaac   PetscFunctionReturn(0);
712336447a5eSToby Isaac }
712436447a5eSToby Isaac 
71258f700142SStefano Zampini /*@
71268f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
71278f700142SStefano Zampini 
71288f700142SStefano Zampini   Collective on dm
71298f700142SStefano Zampini 
71308f700142SStefano Zampini   Input Parameter:
71318f700142SStefano Zampini . dm - The DM
71328f700142SStefano Zampini 
71338f700142SStefano Zampini   Output Parameter:
71348f700142SStefano Zampini   areLocalized - True if localized
71358f700142SStefano Zampini 
71368f700142SStefano Zampini   Level: developer
71378f700142SStefano Zampini 
71388f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
71398f700142SStefano Zampini @*/
71408f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
71418f700142SStefano Zampini {
71428f700142SStefano Zampini   PetscBool      localized;
71438f700142SStefano Zampini   PetscErrorCode ierr;
71448f700142SStefano Zampini 
71458f700142SStefano Zampini   PetscFunctionBegin;
71468f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7147534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
71488f700142SStefano Zampini   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
7149820f2d46SBarry Smith   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
71508f700142SStefano Zampini   PetscFunctionReturn(0);
71518f700142SStefano Zampini }
715236447a5eSToby Isaac 
71532e17dfb7SMatthew G. Knepley /*@
7154492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
71552e17dfb7SMatthew G. Knepley 
71568f700142SStefano Zampini   Collective on dm
71578f700142SStefano Zampini 
71582e17dfb7SMatthew G. Knepley   Input Parameter:
71592e17dfb7SMatthew G. Knepley . dm - The DM
71602e17dfb7SMatthew G. Knepley 
71612e17dfb7SMatthew G. Knepley   Level: developer
71622e17dfb7SMatthew G. Knepley 
71638f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
71642e17dfb7SMatthew G. Knepley @*/
71652e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
71662e17dfb7SMatthew G. Knepley {
71672e17dfb7SMatthew G. Knepley   DM             cdm;
71682e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
71692e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
71703e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
71713e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
7172e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
71733e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
71743e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
71752e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
71762e17dfb7SMatthew G. Knepley 
71772e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
71782e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
717992c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
7180f7cbd40bSStefano Zampini   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
7181f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
7182f7cbd40bSStefano Zampini 
71832e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
71842e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
71852e17dfb7SMatthew G. Knepley   {
71862e17dfb7SMatthew G. Knepley     PetscBool isplex;
71872e17dfb7SMatthew G. Knepley 
71882e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
71892e17dfb7SMatthew G. Knepley     if (isplex) {
71902e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
71913e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
719269291d52SBarry Smith       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
71933e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
71943e922f36SToby Isaac       newStart = vStart;
71953e922f36SToby Isaac       newEnd   = vEnd;
71963e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
71973e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
71983e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
71993e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
72003e922f36SToby Isaac       }
72012e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
72022e17dfb7SMatthew G. Knepley   }
72032e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
72042c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!coordinates,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
72052e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
72063e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
7207e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
72083e922f36SToby Isaac 
72092e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
72102e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
72112e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
72122e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
72133e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
72143e922f36SToby Isaac 
721569291d52SBarry Smith   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
72163e922f36SToby Isaac   localized = &anchor[bs];
72173e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
72183e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
72193e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
72203e922f36SToby Isaac 
72213e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
72223e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
72233e922f36SToby Isaac       PetscInt     b;
72243e922f36SToby Isaac 
72253e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
72263e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
72273e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
72283e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
72293e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
72303e922f36SToby Isaac         for (b = 0; b < bs; b++) {
72313e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
72323e922f36SToby Isaac         }
72333e922f36SToby Isaac         if (b < bs) break;
72343e922f36SToby Isaac       }
72353e922f36SToby Isaac       if (d < dof/bs) {
72363e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
72373e922f36SToby Isaac           PetscInt cdof;
72383e922f36SToby Isaac 
72393e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
72403e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
72413e922f36SToby Isaac         }
72423e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
72433e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
72443e922f36SToby Isaac       }
72453e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
72463e922f36SToby Isaac     }
72473e922f36SToby Isaac   }
7248ffc4695bSBarry Smith   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
72493e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
725069291d52SBarry Smith     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
72513e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
725269291d52SBarry Smith     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
72533e922f36SToby Isaac     PetscFunctionReturn(0);
72543e922f36SToby Isaac   }
72552e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
72562e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
72572e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
72582e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
72592e17dfb7SMatthew G. Knepley   }
72602e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
72612e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
7262c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
72632e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
72642e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
72652e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
72662e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
7267c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
72682e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
72692e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
72702e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
72712e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
72722e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
72732e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
72742e17dfb7SMatthew G. Knepley   }
72753e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
72763e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
72773e922f36SToby Isaac 
72782e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
72792e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
72803e922f36SToby Isaac       PetscInt     b, cdof;
72812e17dfb7SMatthew G. Knepley 
72823e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
72833e922f36SToby Isaac       if (!cdof) continue;
72842e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
72852e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
72862e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
72872e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
72882e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
72892e17dfb7SMatthew G. Knepley     }
72903e922f36SToby Isaac   }
729169291d52SBarry Smith   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
729269291d52SBarry Smith   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
7293c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
72942e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
72952e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
72962e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
72972e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
72982e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
72992e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
73002e17dfb7SMatthew G. Knepley }
73012e17dfb7SMatthew G. Knepley 
7302e87bb0d3SMatthew G Knepley /*@
73033a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
7304e87bb0d3SMatthew G Knepley 
7305d083f849SBarry Smith   Collective on v (see explanation below)
7306e87bb0d3SMatthew G Knepley 
7307e87bb0d3SMatthew G Knepley   Input Parameters:
7308e87bb0d3SMatthew G Knepley + dm - The DM
73096b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
7310e87bb0d3SMatthew G Knepley 
73116b867d5aSJose E. Roman   Input/Output Parameters:
73126b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
73136b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point;
73146b867d5aSJose E. Roman            on output, the PetscSF containing the ranks and local indices of the containing points
73153a93e3b7SToby Isaac 
7316e87bb0d3SMatthew G Knepley   Level: developer
731761e3bb9bSMatthew G Knepley 
731862a38674SMatthew G. Knepley   Notes:
73193a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
732062a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
73213a93e3b7SToby Isaac 
73223a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
732362a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
73243a93e3b7SToby Isaac 
73253a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
73263a93e3b7SToby Isaac 
732762a38674SMatthew G. Knepley $    const PetscSFNode *cells;
732862a38674SMatthew G. Knepley $    PetscInt           nFound;
7329a6216909SToby Isaac $    const PetscInt    *found;
733062a38674SMatthew G. Knepley $
7331a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
73323a93e3b7SToby Isaac 
73333a93e3b7SToby 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
73343a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
73353a93e3b7SToby Isaac 
733662a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
733761e3bb9bSMatthew G Knepley @*/
733862a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
7339e87bb0d3SMatthew G Knepley {
7340735aa83eSMatthew G Knepley   PetscErrorCode ierr;
7341735aa83eSMatthew G Knepley 
7342e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
7343e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7344e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
7345e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
73463a93e3b7SToby Isaac   if (*cellSF) {
73473a93e3b7SToby Isaac     PetscMPIInt result;
73483a93e3b7SToby Isaac 
7349e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
7350ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr);
73512c71b3e2SJacob Faibussowitsch     PetscCheckFalse(result != MPI_IDENT && result != MPI_CONGRUENT,PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's");
7352e0fc9d1bSMatthew G. Knepley   } else {
73533a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
73543a93e3b7SToby Isaac   }
73552c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->locatepoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
735647a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
735762a38674SMatthew G. Knepley   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
735847a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
7359e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
7360e87bb0d3SMatthew G Knepley }
736114f150ffSMatthew G. Knepley 
7362f4d763aaSMatthew G. Knepley /*@
7363f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
7364f4d763aaSMatthew G. Knepley 
73658f700142SStefano Zampini   Collective on dm
73668f700142SStefano Zampini 
7367f4d763aaSMatthew G. Knepley   Input Parameter:
7368f4d763aaSMatthew G. Knepley . dm - The original DM
7369f4d763aaSMatthew G. Knepley 
7370f4d763aaSMatthew G. Knepley   Output Parameter:
7371f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
7372f4d763aaSMatthew G. Knepley 
7373f4d763aaSMatthew G. Knepley   Level: intermediate
7374f4d763aaSMatthew G. Knepley 
7375e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
7376f4d763aaSMatthew G. Knepley @*/
737714f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
737814f150ffSMatthew G. Knepley {
7379c26acbdeSMatthew G. Knepley   PetscSection   section;
73802d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
738114f150ffSMatthew G. Knepley   PetscErrorCode ierr;
738214f150ffSMatthew G. Knepley 
738314f150ffSMatthew G. Knepley   PetscFunctionBegin;
738414f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
738514f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
738692fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
7387c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
7388ffc4695bSBarry Smith   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);
73892d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7390c26acbdeSMatthew G. Knepley     *odm = dm;
7391c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7392c26acbdeSMatthew G. Knepley   }
739314f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7394c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
739514f150ffSMatthew G. Knepley     PetscSF      sf;
739614f150ffSMatthew G. Knepley 
739714f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
7398e5e52638SMatthew G. Knepley     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
739914f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
740092fd8e1eSJed Brown     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
740114f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
740214f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
740315b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
7404e87a4003SBarry Smith     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
740514f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
740614f150ffSMatthew G. Knepley   }
740714f150ffSMatthew G. Knepley   *odm = dm->dmBC;
740814f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
740914f150ffSMatthew G. Knepley }
7410f4d763aaSMatthew G. Knepley 
7411f4d763aaSMatthew G. Knepley /*@
7412cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7413f4d763aaSMatthew G. Knepley 
7414f4d763aaSMatthew G. Knepley   Input Parameter:
7415f4d763aaSMatthew G. Knepley . dm - The original DM
7416f4d763aaSMatthew G. Knepley 
7417cdb7a50dSMatthew G. Knepley   Output Parameters:
7418cdb7a50dSMatthew G. Knepley + num - The output sequence number
7419cdb7a50dSMatthew G. Knepley - val - The output sequence value
7420f4d763aaSMatthew G. Knepley 
7421f4d763aaSMatthew G. Knepley   Level: intermediate
7422f4d763aaSMatthew G. Knepley 
7423f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7424f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7425f4d763aaSMatthew G. Knepley 
7426f4d763aaSMatthew G. Knepley .seealso: VecView()
7427f4d763aaSMatthew G. Knepley @*/
7428cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7429f4d763aaSMatthew G. Knepley {
7430f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7431f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7432534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7433534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7434f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7435f4d763aaSMatthew G. Knepley }
7436f4d763aaSMatthew G. Knepley 
7437f4d763aaSMatthew G. Knepley /*@
7438cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7439f4d763aaSMatthew G. Knepley 
7440f4d763aaSMatthew G. Knepley   Input Parameters:
7441f4d763aaSMatthew G. Knepley + dm - The original DM
7442cdb7a50dSMatthew G. Knepley . num - The output sequence number
7443cdb7a50dSMatthew G. Knepley - val - The output sequence value
7444f4d763aaSMatthew G. Knepley 
7445f4d763aaSMatthew G. Knepley   Level: intermediate
7446f4d763aaSMatthew G. Knepley 
7447f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7448f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7449f4d763aaSMatthew G. Knepley 
7450f4d763aaSMatthew G. Knepley .seealso: VecView()
7451f4d763aaSMatthew G. Knepley @*/
7452cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7453f4d763aaSMatthew G. Knepley {
7454f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7455f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7456f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7457cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7458cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7459cdb7a50dSMatthew G. Knepley }
7460cdb7a50dSMatthew G. Knepley 
7461cdb7a50dSMatthew G. Knepley /*@C
7462cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7463cdb7a50dSMatthew G. Knepley 
7464cdb7a50dSMatthew G. Knepley   Input Parameters:
7465cdb7a50dSMatthew G. Knepley + dm   - The original DM
7466cdb7a50dSMatthew G. Knepley . name - The sequence name
7467cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7468cdb7a50dSMatthew G. Knepley 
7469cdb7a50dSMatthew G. Knepley   Output Parameter:
7470cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7471cdb7a50dSMatthew G. Knepley 
7472cdb7a50dSMatthew G. Knepley   Level: intermediate
7473cdb7a50dSMatthew G. Knepley 
7474cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7475cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7476cdb7a50dSMatthew G. Knepley 
7477cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7478cdb7a50dSMatthew G. Knepley @*/
7479cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7480cdb7a50dSMatthew G. Knepley {
7481cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7482cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
7483cdb7a50dSMatthew G. Knepley 
7484cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7485cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7486cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7487064a246eSJacob Faibussowitsch   PetscValidRealPointer(val,5);
7488cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
7489cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7490cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7491cdb7a50dSMatthew G. Knepley     PetscScalar value;
7492cdb7a50dSMatthew G. Knepley 
749339d25373SMatthew G. Knepley     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
74944aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7495cdb7a50dSMatthew G. Knepley #endif
7496cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7497f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7498f4d763aaSMatthew G. Knepley }
74998e4ac7eaSMatthew G. Knepley 
75008e4ac7eaSMatthew G. Knepley /*@
75018e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
75028e4ac7eaSMatthew G. Knepley 
75038e4ac7eaSMatthew G. Knepley   Not collective
75048e4ac7eaSMatthew G. Knepley 
75058e4ac7eaSMatthew G. Knepley   Input Parameter:
75068e4ac7eaSMatthew G. Knepley . dm - The DM
75078e4ac7eaSMatthew G. Knepley 
75088e4ac7eaSMatthew G. Knepley   Output Parameter:
75098e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
75108e4ac7eaSMatthew G. Knepley 
75118e4ac7eaSMatthew G. Knepley   Level: beginner
75128e4ac7eaSMatthew G. Knepley 
75138e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
75148e4ac7eaSMatthew G. Knepley @*/
75158e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
75168e4ac7eaSMatthew G. Knepley {
75178e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
75188e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7519534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
75208e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
75218e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
75228e4ac7eaSMatthew G. Knepley }
75238e4ac7eaSMatthew G. Knepley 
75248e4ac7eaSMatthew G. Knepley /*@
75255d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
75268e4ac7eaSMatthew G. Knepley 
75278e4ac7eaSMatthew G. Knepley   Collective on dm
75288e4ac7eaSMatthew G. Knepley 
75298e4ac7eaSMatthew G. Knepley   Input Parameters:
75308e4ac7eaSMatthew G. Knepley + dm - The DM
75318e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
75328e4ac7eaSMatthew G. Knepley 
75335d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
75345d3b26e6SMatthew G. Knepley 
75358e4ac7eaSMatthew G. Knepley   Level: beginner
75368e4ac7eaSMatthew G. Knepley 
75375d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
75388e4ac7eaSMatthew G. Knepley @*/
75398e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
75408e4ac7eaSMatthew G. Knepley {
75418e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
75428e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
75438833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
75448e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
75458e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
75468e4ac7eaSMatthew G. Knepley }
7547c58f1c22SToby Isaac 
7548c58f1c22SToby Isaac /*@C
7549c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7550c58f1c22SToby Isaac 
7551c58f1c22SToby Isaac   Not Collective
7552c58f1c22SToby Isaac 
7553c58f1c22SToby Isaac   Input Parameters:
7554c58f1c22SToby Isaac + dm   - The DM object
7555c58f1c22SToby Isaac - name - The label name
7556c58f1c22SToby Isaac 
7557c58f1c22SToby Isaac   Level: intermediate
7558c58f1c22SToby Isaac 
7559c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7560c58f1c22SToby Isaac @*/
7561c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7562c58f1c22SToby Isaac {
75635d80c0bfSVaclav Hapla   PetscBool      flg;
75645d80c0bfSVaclav Hapla   DMLabel        label;
7565c58f1c22SToby Isaac   PetscErrorCode ierr;
7566c58f1c22SToby Isaac 
7567c58f1c22SToby Isaac   PetscFunctionBegin;
7568c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7569c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
75705d80c0bfSVaclav Hapla   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
7571c58f1c22SToby Isaac   if (!flg) {
75725d80c0bfSVaclav Hapla     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
75735d80c0bfSVaclav Hapla     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
75745d80c0bfSVaclav Hapla     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
7575c58f1c22SToby Isaac   }
7576c58f1c22SToby Isaac   PetscFunctionReturn(0);
7577c58f1c22SToby Isaac }
7578c58f1c22SToby Isaac 
7579c58f1c22SToby Isaac /*@C
75800fdc7489SMatthew Knepley   DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index.
75810fdc7489SMatthew Knepley 
75820fdc7489SMatthew Knepley   Not Collective
75830fdc7489SMatthew Knepley 
75840fdc7489SMatthew Knepley   Input Parameters:
75850fdc7489SMatthew Knepley + dm   - The DM object
75860fdc7489SMatthew Knepley . l    - The index for the label
75870fdc7489SMatthew Knepley - name - The label name
75880fdc7489SMatthew Knepley 
75890fdc7489SMatthew Knepley   Level: intermediate
75900fdc7489SMatthew Knepley 
75910fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
75920fdc7489SMatthew Knepley @*/
75930fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[])
75940fdc7489SMatthew Knepley {
75950fdc7489SMatthew Knepley   DMLabelLink    orig, prev = NULL;
75960fdc7489SMatthew Knepley   DMLabel        label;
75970fdc7489SMatthew Knepley   PetscInt       Nl, m;
75980fdc7489SMatthew Knepley   PetscBool      flg, match;
75990fdc7489SMatthew Knepley   const char    *lname;
76000fdc7489SMatthew Knepley   PetscErrorCode ierr;
76010fdc7489SMatthew Knepley 
76020fdc7489SMatthew Knepley   PetscFunctionBegin;
76030fdc7489SMatthew Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7604064a246eSJacob Faibussowitsch   PetscValidCharPointer(name, 3);
76050fdc7489SMatthew Knepley   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
76060fdc7489SMatthew Knepley   if (!flg) {
76070fdc7489SMatthew Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
76080fdc7489SMatthew Knepley     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
76090fdc7489SMatthew Knepley     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
76100fdc7489SMatthew Knepley   }
76110fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
76122c71b3e2SJacob Faibussowitsch   PetscCheckFalse(l >= Nl,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl);
76130fdc7489SMatthew Knepley   for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) {
76140fdc7489SMatthew Knepley     ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr);
76150fdc7489SMatthew Knepley     ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr);
76160fdc7489SMatthew Knepley     if (match) break;
76170fdc7489SMatthew Knepley   }
76180fdc7489SMatthew Knepley   if (m == l) PetscFunctionReturn(0);
76190fdc7489SMatthew Knepley   if (!m) dm->labels = orig->next;
76200fdc7489SMatthew Knepley   else    prev->next = orig->next;
76210fdc7489SMatthew Knepley   if (!l) {
76220fdc7489SMatthew Knepley     orig->next = dm->labels;
76230fdc7489SMatthew Knepley     dm->labels = orig;
76240fdc7489SMatthew Knepley   } else {
76250fdc7489SMatthew Knepley     for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next);
76260fdc7489SMatthew Knepley     orig->next = prev->next;
76270fdc7489SMatthew Knepley     prev->next = orig;
76280fdc7489SMatthew Knepley   }
76290fdc7489SMatthew Knepley   PetscFunctionReturn(0);
76300fdc7489SMatthew Knepley }
76310fdc7489SMatthew Knepley 
76320fdc7489SMatthew Knepley /*@C
7633c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7634c58f1c22SToby Isaac 
7635c58f1c22SToby Isaac   Not Collective
7636c58f1c22SToby Isaac 
7637c58f1c22SToby Isaac   Input Parameters:
7638c58f1c22SToby Isaac + dm   - The DM object
7639c58f1c22SToby Isaac . name - The label name
7640c58f1c22SToby Isaac - point - The mesh point
7641c58f1c22SToby Isaac 
7642c58f1c22SToby Isaac   Output Parameter:
7643c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7644c58f1c22SToby Isaac 
7645c58f1c22SToby Isaac   Level: beginner
7646c58f1c22SToby Isaac 
7647c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7648c58f1c22SToby Isaac @*/
7649c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7650c58f1c22SToby Isaac {
7651c58f1c22SToby Isaac   DMLabel        label;
7652c58f1c22SToby Isaac   PetscErrorCode ierr;
7653c58f1c22SToby Isaac 
7654c58f1c22SToby Isaac   PetscFunctionBegin;
7655c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7656c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7657c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
76582c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
7659c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
7660c58f1c22SToby Isaac   PetscFunctionReturn(0);
7661c58f1c22SToby Isaac }
7662c58f1c22SToby Isaac 
7663c58f1c22SToby Isaac /*@C
7664c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7665c58f1c22SToby Isaac 
7666c58f1c22SToby Isaac   Not Collective
7667c58f1c22SToby Isaac 
7668c58f1c22SToby Isaac   Input Parameters:
7669c58f1c22SToby Isaac + dm   - The DM object
7670c58f1c22SToby Isaac . name - The label name
7671c58f1c22SToby Isaac . point - The mesh point
7672c58f1c22SToby Isaac - value - The label value for this point
7673c58f1c22SToby Isaac 
7674c58f1c22SToby Isaac   Output Parameter:
7675c58f1c22SToby Isaac 
7676c58f1c22SToby Isaac   Level: beginner
7677c58f1c22SToby Isaac 
7678c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7679c58f1c22SToby Isaac @*/
7680c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7681c58f1c22SToby Isaac {
7682c58f1c22SToby Isaac   DMLabel        label;
7683c58f1c22SToby Isaac   PetscErrorCode ierr;
7684c58f1c22SToby Isaac 
7685c58f1c22SToby Isaac   PetscFunctionBegin;
7686c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7687c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7688c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7689c58f1c22SToby Isaac   if (!label) {
7690c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
7691c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7692c58f1c22SToby Isaac   }
7693c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
7694c58f1c22SToby Isaac   PetscFunctionReturn(0);
7695c58f1c22SToby Isaac }
7696c58f1c22SToby Isaac 
7697c58f1c22SToby Isaac /*@C
7698c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7699c58f1c22SToby Isaac 
7700c58f1c22SToby Isaac   Not Collective
7701c58f1c22SToby Isaac 
7702c58f1c22SToby Isaac   Input Parameters:
7703c58f1c22SToby Isaac + dm   - The DM object
7704c58f1c22SToby Isaac . name - The label name
7705c58f1c22SToby Isaac . point - The mesh point
7706c58f1c22SToby Isaac - value - The label value for this point
7707c58f1c22SToby Isaac 
7708c58f1c22SToby Isaac   Output Parameter:
7709c58f1c22SToby Isaac 
7710c58f1c22SToby Isaac   Level: beginner
7711c58f1c22SToby Isaac 
7712c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7713c58f1c22SToby Isaac @*/
7714c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7715c58f1c22SToby Isaac {
7716c58f1c22SToby Isaac   DMLabel        label;
7717c58f1c22SToby Isaac   PetscErrorCode ierr;
7718c58f1c22SToby Isaac 
7719c58f1c22SToby Isaac   PetscFunctionBegin;
7720c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7721c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7722c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7723c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7724c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
7725c58f1c22SToby Isaac   PetscFunctionReturn(0);
7726c58f1c22SToby Isaac }
7727c58f1c22SToby Isaac 
7728c58f1c22SToby Isaac /*@C
7729c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7730c58f1c22SToby Isaac 
7731c58f1c22SToby Isaac   Not Collective
7732c58f1c22SToby Isaac 
7733c58f1c22SToby Isaac   Input Parameters:
7734c58f1c22SToby Isaac + dm   - The DM object
7735c58f1c22SToby Isaac - name - The label name
7736c58f1c22SToby Isaac 
7737c58f1c22SToby Isaac   Output Parameter:
7738c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7739c58f1c22SToby Isaac 
7740c58f1c22SToby Isaac   Level: beginner
7741c58f1c22SToby Isaac 
7742df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7743c58f1c22SToby Isaac @*/
7744c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7745c58f1c22SToby Isaac {
7746c58f1c22SToby Isaac   DMLabel        label;
7747c58f1c22SToby Isaac   PetscErrorCode ierr;
7748c58f1c22SToby Isaac 
7749c58f1c22SToby Isaac   PetscFunctionBegin;
7750c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7751c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7752534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
7753c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7754c58f1c22SToby Isaac   *size = 0;
7755c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7756c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
7757c58f1c22SToby Isaac   PetscFunctionReturn(0);
7758c58f1c22SToby Isaac }
7759c58f1c22SToby Isaac 
7760c58f1c22SToby Isaac /*@C
7761c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7762c58f1c22SToby Isaac 
7763c58f1c22SToby Isaac   Not Collective
7764c58f1c22SToby Isaac 
7765c58f1c22SToby Isaac   Input Parameters:
7766c58f1c22SToby Isaac + mesh - The DM object
7767c58f1c22SToby Isaac - name - The label name
7768c58f1c22SToby Isaac 
7769c58f1c22SToby Isaac   Output Parameter:
7770c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7771c58f1c22SToby Isaac 
7772c58f1c22SToby Isaac   Level: beginner
7773c58f1c22SToby Isaac 
7774c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7775c58f1c22SToby Isaac @*/
7776c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7777c58f1c22SToby Isaac {
7778c58f1c22SToby Isaac   DMLabel        label;
7779c58f1c22SToby Isaac   PetscErrorCode ierr;
7780c58f1c22SToby Isaac 
7781c58f1c22SToby Isaac   PetscFunctionBegin;
7782c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7783c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7784c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
7785c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7786c58f1c22SToby Isaac   *ids = NULL;
7787dab2e251SBlaise Bourdin  if (label) {
7788c58f1c22SToby Isaac     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
7789dab2e251SBlaise Bourdin   } else {
7790dab2e251SBlaise Bourdin     /* returning an empty IS */
7791dab2e251SBlaise Bourdin     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
7792dab2e251SBlaise Bourdin   }
7793c58f1c22SToby Isaac   PetscFunctionReturn(0);
7794c58f1c22SToby Isaac }
7795c58f1c22SToby Isaac 
7796c58f1c22SToby Isaac /*@C
7797c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
7798c58f1c22SToby Isaac 
7799c58f1c22SToby Isaac   Not Collective
7800c58f1c22SToby Isaac 
7801c58f1c22SToby Isaac   Input Parameters:
7802c58f1c22SToby Isaac + dm - The DM object
7803c58f1c22SToby Isaac . name - The label name
7804c58f1c22SToby Isaac - value - The stratum value
7805c58f1c22SToby Isaac 
7806c58f1c22SToby Isaac   Output Parameter:
7807c58f1c22SToby Isaac . size - The stratum size
7808c58f1c22SToby Isaac 
7809c58f1c22SToby Isaac   Level: beginner
7810c58f1c22SToby Isaac 
7811c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7812c58f1c22SToby Isaac @*/
7813c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7814c58f1c22SToby Isaac {
7815c58f1c22SToby Isaac   DMLabel        label;
7816c58f1c22SToby Isaac   PetscErrorCode ierr;
7817c58f1c22SToby Isaac 
7818c58f1c22SToby Isaac   PetscFunctionBegin;
7819c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7820c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7821534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
7822c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7823c58f1c22SToby Isaac   *size = 0;
7824c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7825c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
7826c58f1c22SToby Isaac   PetscFunctionReturn(0);
7827c58f1c22SToby Isaac }
7828c58f1c22SToby Isaac 
7829c58f1c22SToby Isaac /*@C
7830c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7831c58f1c22SToby Isaac 
7832c58f1c22SToby Isaac   Not Collective
7833c58f1c22SToby Isaac 
7834c58f1c22SToby Isaac   Input Parameters:
7835c58f1c22SToby Isaac + dm - The DM object
7836c58f1c22SToby Isaac . name - The label name
7837c58f1c22SToby Isaac - value - The stratum value
7838c58f1c22SToby Isaac 
7839c58f1c22SToby Isaac   Output Parameter:
7840c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7841c58f1c22SToby Isaac 
7842c58f1c22SToby Isaac   Level: beginner
7843c58f1c22SToby Isaac 
7844c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7845c58f1c22SToby Isaac @*/
7846c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7847c58f1c22SToby Isaac {
7848c58f1c22SToby Isaac   DMLabel        label;
7849c58f1c22SToby Isaac   PetscErrorCode ierr;
7850c58f1c22SToby Isaac 
7851c58f1c22SToby Isaac   PetscFunctionBegin;
7852c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7853c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7854c58f1c22SToby Isaac   PetscValidPointer(points, 4);
7855c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7856c58f1c22SToby Isaac   *points = NULL;
7857c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7858c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7859c58f1c22SToby Isaac   PetscFunctionReturn(0);
7860c58f1c22SToby Isaac }
7861c58f1c22SToby Isaac 
78624de306b1SToby Isaac /*@C
78639044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
78644de306b1SToby Isaac 
78654de306b1SToby Isaac   Not Collective
78664de306b1SToby Isaac 
78674de306b1SToby Isaac   Input Parameters:
78684de306b1SToby Isaac + dm - The DM object
78694de306b1SToby Isaac . name - The label name
78704de306b1SToby Isaac . value - The stratum value
78714de306b1SToby Isaac - points - The stratum points
78724de306b1SToby Isaac 
78734de306b1SToby Isaac   Level: beginner
78744de306b1SToby Isaac 
78754de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
78764de306b1SToby Isaac @*/
78774de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
78784de306b1SToby Isaac {
78794de306b1SToby Isaac   DMLabel        label;
78804de306b1SToby Isaac   PetscErrorCode ierr;
78814de306b1SToby Isaac 
78824de306b1SToby Isaac   PetscFunctionBegin;
78834de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
78844de306b1SToby Isaac   PetscValidCharPointer(name, 2);
78854de306b1SToby Isaac   PetscValidPointer(points, 4);
78864de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
78874de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
78884de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
78894de306b1SToby Isaac   PetscFunctionReturn(0);
78904de306b1SToby Isaac }
78914de306b1SToby Isaac 
7892c58f1c22SToby Isaac /*@C
7893c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7894c58f1c22SToby Isaac 
7895c58f1c22SToby Isaac   Not Collective
7896c58f1c22SToby Isaac 
7897c58f1c22SToby Isaac   Input Parameters:
7898c58f1c22SToby Isaac + dm   - The DM object
7899c58f1c22SToby Isaac . name - The label name
7900c58f1c22SToby Isaac - value - The label value for this point
7901c58f1c22SToby Isaac 
7902c58f1c22SToby Isaac   Output Parameter:
7903c58f1c22SToby Isaac 
7904c58f1c22SToby Isaac   Level: beginner
7905c58f1c22SToby Isaac 
7906c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7907c58f1c22SToby Isaac @*/
7908c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7909c58f1c22SToby Isaac {
7910c58f1c22SToby Isaac   DMLabel        label;
7911c58f1c22SToby Isaac   PetscErrorCode ierr;
7912c58f1c22SToby Isaac 
7913c58f1c22SToby Isaac   PetscFunctionBegin;
7914c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7915c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7916c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7917c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7918c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7919c58f1c22SToby Isaac   PetscFunctionReturn(0);
7920c58f1c22SToby Isaac }
7921c58f1c22SToby Isaac 
7922c58f1c22SToby Isaac /*@
7923c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7924c58f1c22SToby Isaac 
7925c58f1c22SToby Isaac   Not Collective
7926c58f1c22SToby Isaac 
7927c58f1c22SToby Isaac   Input Parameter:
7928c58f1c22SToby Isaac . dm   - The DM object
7929c58f1c22SToby Isaac 
7930c58f1c22SToby Isaac   Output Parameter:
7931c58f1c22SToby Isaac . numLabels - the number of Labels
7932c58f1c22SToby Isaac 
7933c58f1c22SToby Isaac   Level: intermediate
7934c58f1c22SToby Isaac 
7935c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7936c58f1c22SToby Isaac @*/
7937c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7938c58f1c22SToby Isaac {
79395d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7940c58f1c22SToby Isaac   PetscInt  n    = 0;
7941c58f1c22SToby Isaac 
7942c58f1c22SToby Isaac   PetscFunctionBegin;
7943c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7944534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7945c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7946c58f1c22SToby Isaac   *numLabels = n;
7947c58f1c22SToby Isaac   PetscFunctionReturn(0);
7948c58f1c22SToby Isaac }
7949c58f1c22SToby Isaac 
7950c58f1c22SToby Isaac /*@C
7951c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7952c58f1c22SToby Isaac 
7953c58f1c22SToby Isaac   Not Collective
7954c58f1c22SToby Isaac 
7955c58f1c22SToby Isaac   Input Parameters:
7956c58f1c22SToby Isaac + dm - The DM object
7957c58f1c22SToby Isaac - n  - the label number
7958c58f1c22SToby Isaac 
7959c58f1c22SToby Isaac   Output Parameter:
7960c58f1c22SToby Isaac . name - the label name
7961c58f1c22SToby Isaac 
7962c58f1c22SToby Isaac   Level: intermediate
7963c58f1c22SToby Isaac 
7964c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7965c58f1c22SToby Isaac @*/
7966c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7967c58f1c22SToby Isaac {
79685d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7969c58f1c22SToby Isaac   PetscInt       l    = 0;
7970d67d17b1SMatthew G. Knepley   PetscErrorCode ierr;
7971c58f1c22SToby Isaac 
7972c58f1c22SToby Isaac   PetscFunctionBegin;
7973c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7974c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7975c58f1c22SToby Isaac   while (next) {
7976c58f1c22SToby Isaac     if (l == n) {
7977d67d17b1SMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7978c58f1c22SToby Isaac       PetscFunctionReturn(0);
7979c58f1c22SToby Isaac     }
7980c58f1c22SToby Isaac     ++l;
7981c58f1c22SToby Isaac     next = next->next;
7982c58f1c22SToby Isaac   }
798398921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7984c58f1c22SToby Isaac }
7985c58f1c22SToby Isaac 
7986c58f1c22SToby Isaac /*@C
7987c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
7988c58f1c22SToby Isaac 
7989c58f1c22SToby Isaac   Not Collective
7990c58f1c22SToby Isaac 
7991c58f1c22SToby Isaac   Input Parameters:
7992c58f1c22SToby Isaac + dm   - The DM object
7993c58f1c22SToby Isaac - name - The label name
7994c58f1c22SToby Isaac 
7995c58f1c22SToby Isaac   Output Parameter:
7996c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
7997c58f1c22SToby Isaac 
7998c58f1c22SToby Isaac   Level: intermediate
7999c58f1c22SToby Isaac 
8000c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8001c58f1c22SToby Isaac @*/
8002c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
8003c58f1c22SToby Isaac {
80045d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8005d67d17b1SMatthew G. Knepley   const char    *lname;
8006c58f1c22SToby Isaac   PetscErrorCode ierr;
8007c58f1c22SToby Isaac 
8008c58f1c22SToby Isaac   PetscFunctionBegin;
8009c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8010c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
8011534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
8012c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
8013c58f1c22SToby Isaac   while (next) {
8014d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8015d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
8016c58f1c22SToby Isaac     if (*hasLabel) break;
8017c58f1c22SToby Isaac     next = next->next;
8018c58f1c22SToby Isaac   }
8019c58f1c22SToby Isaac   PetscFunctionReturn(0);
8020c58f1c22SToby Isaac }
8021c58f1c22SToby Isaac 
8022c58f1c22SToby Isaac /*@C
8023c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
8024c58f1c22SToby Isaac 
8025c58f1c22SToby Isaac   Not Collective
8026c58f1c22SToby Isaac 
8027c58f1c22SToby Isaac   Input Parameters:
8028c58f1c22SToby Isaac + dm   - The DM object
8029c58f1c22SToby Isaac - name - The label name
8030c58f1c22SToby Isaac 
8031c58f1c22SToby Isaac   Output Parameter:
8032c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
8033c58f1c22SToby Isaac 
80346d7c9049SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
80356d7c9049SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
80366d7c9049SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
80376d7c9049SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
80386d7c9049SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
80396d7c9049SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
80406d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
80416d7c9049SMatthew G. Knepley 
8042c58f1c22SToby Isaac   Level: intermediate
8043c58f1c22SToby Isaac 
80446d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
8045c58f1c22SToby Isaac @*/
8046c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
8047c58f1c22SToby Isaac {
80485d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8049c58f1c22SToby Isaac   PetscBool      hasLabel;
8050d67d17b1SMatthew G. Knepley   const char    *lname;
8051c58f1c22SToby Isaac   PetscErrorCode ierr;
8052c58f1c22SToby Isaac 
8053c58f1c22SToby Isaac   PetscFunctionBegin;
8054c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8055c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
8056c58f1c22SToby Isaac   PetscValidPointer(label, 3);
8057c58f1c22SToby Isaac   *label = NULL;
8058c58f1c22SToby Isaac   while (next) {
8059d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8060d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8061c58f1c22SToby Isaac     if (hasLabel) {
8062c58f1c22SToby Isaac       *label = next->label;
8063c58f1c22SToby Isaac       break;
8064c58f1c22SToby Isaac     }
8065c58f1c22SToby Isaac     next = next->next;
8066c58f1c22SToby Isaac   }
8067c58f1c22SToby Isaac   PetscFunctionReturn(0);
8068c58f1c22SToby Isaac }
8069c58f1c22SToby Isaac 
8070c58f1c22SToby Isaac /*@C
8071c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
8072c58f1c22SToby Isaac 
8073c58f1c22SToby Isaac   Not Collective
8074c58f1c22SToby Isaac 
8075c58f1c22SToby Isaac   Input Parameters:
8076c58f1c22SToby Isaac + dm - The DM object
8077c58f1c22SToby Isaac - n  - the label number
8078c58f1c22SToby Isaac 
8079c58f1c22SToby Isaac   Output Parameter:
8080c58f1c22SToby Isaac . label - the label
8081c58f1c22SToby Isaac 
8082c58f1c22SToby Isaac   Level: intermediate
8083c58f1c22SToby Isaac 
8084c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8085c58f1c22SToby Isaac @*/
8086c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
8087c58f1c22SToby Isaac {
80885d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
8089c58f1c22SToby Isaac   PetscInt    l    = 0;
8090c58f1c22SToby Isaac 
8091c58f1c22SToby Isaac   PetscFunctionBegin;
8092c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8093c58f1c22SToby Isaac   PetscValidPointer(label, 3);
8094c58f1c22SToby Isaac   while (next) {
8095c58f1c22SToby Isaac     if (l == n) {
8096c58f1c22SToby Isaac       *label = next->label;
8097c58f1c22SToby Isaac       PetscFunctionReturn(0);
8098c58f1c22SToby Isaac     }
8099c58f1c22SToby Isaac     ++l;
8100c58f1c22SToby Isaac     next = next->next;
8101c58f1c22SToby Isaac   }
810298921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
8103c58f1c22SToby Isaac }
8104c58f1c22SToby Isaac 
8105c58f1c22SToby Isaac /*@C
8106c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
8107c58f1c22SToby Isaac 
8108c58f1c22SToby Isaac   Not Collective
8109c58f1c22SToby Isaac 
8110c58f1c22SToby Isaac   Input Parameters:
8111c58f1c22SToby Isaac + dm   - The DM object
8112c58f1c22SToby Isaac - label - The DMLabel
8113c58f1c22SToby Isaac 
8114c58f1c22SToby Isaac   Level: developer
8115c58f1c22SToby Isaac 
8116c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8117c58f1c22SToby Isaac @*/
8118c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
8119c58f1c22SToby Isaac {
81205d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
8121c58f1c22SToby Isaac   PetscBool      hasLabel;
8122d67d17b1SMatthew G. Knepley   const char    *lname;
81235d80c0bfSVaclav Hapla   PetscBool      flg;
8124c58f1c22SToby Isaac   PetscErrorCode ierr;
8125c58f1c22SToby Isaac 
8126c58f1c22SToby Isaac   PetscFunctionBegin;
8127c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8128d67d17b1SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
8129d67d17b1SMatthew G. Knepley   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
81302c71b3e2SJacob Faibussowitsch   PetscCheckFalse(hasLabel,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
8131c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
8132c58f1c22SToby Isaac   tmpLabel->label  = label;
8133c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
81345d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
81355d80c0bfSVaclav Hapla   *p = tmpLabel;
813608f633c4SVaclav Hapla   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
81375d80c0bfSVaclav Hapla   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
81385d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
8139ba2698f1SMatthew G. Knepley   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
8140ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
8141c58f1c22SToby Isaac   PetscFunctionReturn(0);
8142c58f1c22SToby Isaac }
8143c58f1c22SToby Isaac 
8144c58f1c22SToby Isaac /*@C
81454a7ee7d0SMatthew G. Knepley   DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present
81464a7ee7d0SMatthew G. Knepley 
81474a7ee7d0SMatthew G. Knepley   Not Collective
81484a7ee7d0SMatthew G. Knepley 
81494a7ee7d0SMatthew G. Knepley   Input Parameters:
81504a7ee7d0SMatthew G. Knepley + dm    - The DM object
81514a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute
81524a7ee7d0SMatthew G. Knepley 
81534a7ee7d0SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
81544a7ee7d0SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
81554a7ee7d0SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
81564a7ee7d0SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
81574a7ee7d0SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
81584a7ee7d0SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
81594a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
81604a7ee7d0SMatthew G. Knepley 
81614a7ee7d0SMatthew G. Knepley   Level: intermediate
81624a7ee7d0SMatthew G. Knepley 
81634a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
81644a7ee7d0SMatthew G. Knepley @*/
81654a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label)
81664a7ee7d0SMatthew G. Knepley {
81674a7ee7d0SMatthew G. Knepley   DMLabelLink    next = dm->labels;
81684a7ee7d0SMatthew G. Knepley   PetscBool      hasLabel, flg;
81694a7ee7d0SMatthew G. Knepley   const char    *name, *lname;
81704a7ee7d0SMatthew G. Knepley   PetscErrorCode ierr;
81714a7ee7d0SMatthew G. Knepley 
81724a7ee7d0SMatthew G. Knepley   PetscFunctionBegin;
81734a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
81744a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
81754a7ee7d0SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr);
81764a7ee7d0SMatthew G. Knepley   while (next) {
81774a7ee7d0SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
81784a7ee7d0SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
81794a7ee7d0SMatthew G. Knepley     if (hasLabel) {
81804a7ee7d0SMatthew G. Knepley       ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
81814a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
81824a7ee7d0SMatthew G. Knepley       if (flg) dm->depthLabel = label;
81834a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
81844a7ee7d0SMatthew G. Knepley       if (flg) dm->celltypeLabel = label;
81854a7ee7d0SMatthew G. Knepley       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
81864a7ee7d0SMatthew G. Knepley       next->label = label;
81874a7ee7d0SMatthew G. Knepley       break;
81884a7ee7d0SMatthew G. Knepley     }
81894a7ee7d0SMatthew G. Knepley     next = next->next;
81904a7ee7d0SMatthew G. Knepley   }
81914a7ee7d0SMatthew G. Knepley   PetscFunctionReturn(0);
81924a7ee7d0SMatthew G. Knepley }
81934a7ee7d0SMatthew G. Knepley 
81944a7ee7d0SMatthew G. Knepley /*@C
8195e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
8196c58f1c22SToby Isaac 
8197c58f1c22SToby Isaac   Not Collective
8198c58f1c22SToby Isaac 
8199c58f1c22SToby Isaac   Input Parameters:
8200c58f1c22SToby Isaac + dm   - The DM object
8201c58f1c22SToby Isaac - name - The label name
8202c58f1c22SToby Isaac 
8203c58f1c22SToby Isaac   Output Parameter:
8204c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
8205c58f1c22SToby Isaac 
8206c58f1c22SToby Isaac   Level: developer
8207c58f1c22SToby Isaac 
8208e5472504SVaclav Hapla   Notes:
8209e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
8210e5472504SVaclav Hapla   DMLabelDestroy() on the label.
8211e5472504SVaclav Hapla 
8212e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
8213e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
8214e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
8215e5472504SVaclav Hapla 
8216e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
8217c58f1c22SToby Isaac @*/
8218c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
8219c58f1c22SToby Isaac {
822095d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
8221c58f1c22SToby Isaac   PetscBool      hasLabel;
8222d67d17b1SMatthew G. Knepley   const char    *lname;
8223c58f1c22SToby Isaac   PetscErrorCode ierr;
8224c58f1c22SToby Isaac 
8225c58f1c22SToby Isaac   PetscFunctionBegin;
8226c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8227e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
8228e5472504SVaclav Hapla   if (label) {
8229e5472504SVaclav Hapla     PetscValidPointer(label, 3);
8230c58f1c22SToby Isaac     *label = NULL;
8231e5472504SVaclav Hapla   }
82325d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
823395d578d6SVaclav Hapla     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
8234d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8235c58f1c22SToby Isaac     if (hasLabel) {
823695d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
8237c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
823895d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
8239ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
8240ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
824195d578d6SVaclav Hapla       if (label) *label = link->label;
824295d578d6SVaclav Hapla       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
824395d578d6SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8244c58f1c22SToby Isaac       break;
8245c58f1c22SToby Isaac     }
8246c58f1c22SToby Isaac   }
8247c58f1c22SToby Isaac   PetscFunctionReturn(0);
8248c58f1c22SToby Isaac }
8249c58f1c22SToby Isaac 
8250306894acSVaclav Hapla /*@
8251306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
8252306894acSVaclav Hapla 
8253306894acSVaclav Hapla   Not Collective
8254306894acSVaclav Hapla 
8255306894acSVaclav Hapla   Input Parameters:
8256306894acSVaclav Hapla + dm   - The DM object
8257876aa926SVaclav Hapla . label - The DMLabel to be removed from the DM
8258306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
8259306894acSVaclav Hapla 
8260306894acSVaclav Hapla   Level: developer
8261306894acSVaclav Hapla 
8262306894acSVaclav Hapla   Notes:
8263306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
8264306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
8265306894acSVaclav Hapla   *label nullified.
8266306894acSVaclav Hapla 
8267306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
8268306894acSVaclav Hapla @*/
8269306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
8270306894acSVaclav Hapla {
827143e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
8272306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
8273306894acSVaclav Hapla   PetscErrorCode ierr;
8274306894acSVaclav Hapla 
8275306894acSVaclav Hapla   PetscFunctionBegin;
8276306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8277306894acSVaclav Hapla   PetscValidPointer(label, 2);
8278f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
8279306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
8280306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
82815d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
828243e45a93SVaclav Hapla     if (*label == link->label) {
8283306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
828443e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
8285306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
8286ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
828743e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
828843e45a93SVaclav Hapla       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
828943e45a93SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8290306894acSVaclav Hapla       break;
8291306894acSVaclav Hapla     }
8292306894acSVaclav Hapla   }
82932c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!hasLabel && failNotFound,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
8294306894acSVaclav Hapla   PetscFunctionReturn(0);
8295306894acSVaclav Hapla }
8296306894acSVaclav Hapla 
8297c58f1c22SToby Isaac /*@C
8298c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
8299c58f1c22SToby Isaac 
8300c58f1c22SToby Isaac   Not Collective
8301c58f1c22SToby Isaac 
8302c58f1c22SToby Isaac   Input Parameters:
8303c58f1c22SToby Isaac + dm   - The DM object
8304c58f1c22SToby Isaac - name - The label name
8305c58f1c22SToby Isaac 
8306c58f1c22SToby Isaac   Output Parameter:
8307c58f1c22SToby Isaac . output - The flag for output
8308c58f1c22SToby Isaac 
8309c58f1c22SToby Isaac   Level: developer
8310c58f1c22SToby Isaac 
8311c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8312c58f1c22SToby Isaac @*/
8313c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
8314c58f1c22SToby Isaac {
83155d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8316d67d17b1SMatthew G. Knepley   const char    *lname;
8317c58f1c22SToby Isaac   PetscErrorCode ierr;
8318c58f1c22SToby Isaac 
8319c58f1c22SToby Isaac   PetscFunctionBegin;
8320c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8321c58f1c22SToby Isaac   PetscValidPointer(name, 2);
8322c58f1c22SToby Isaac   PetscValidPointer(output, 3);
8323c58f1c22SToby Isaac   while (next) {
8324c58f1c22SToby Isaac     PetscBool flg;
8325c58f1c22SToby Isaac 
8326d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8327d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8328c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
8329c58f1c22SToby Isaac     next = next->next;
8330c58f1c22SToby Isaac   }
833198921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8332c58f1c22SToby Isaac }
8333c58f1c22SToby Isaac 
8334c58f1c22SToby Isaac /*@C
8335c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
8336c58f1c22SToby Isaac 
8337c58f1c22SToby Isaac   Not Collective
8338c58f1c22SToby Isaac 
8339c58f1c22SToby Isaac   Input Parameters:
8340c58f1c22SToby Isaac + dm     - The DM object
8341c58f1c22SToby Isaac . name   - The label name
8342c58f1c22SToby Isaac - output - The flag for output
8343c58f1c22SToby Isaac 
8344c58f1c22SToby Isaac   Level: developer
8345c58f1c22SToby Isaac 
8346c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8347c58f1c22SToby Isaac @*/
8348c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
8349c58f1c22SToby Isaac {
83505d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8351d67d17b1SMatthew G. Knepley   const char    *lname;
8352c58f1c22SToby Isaac   PetscErrorCode ierr;
8353c58f1c22SToby Isaac 
8354c58f1c22SToby Isaac   PetscFunctionBegin;
8355c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8356534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
8357c58f1c22SToby Isaac   while (next) {
8358c58f1c22SToby Isaac     PetscBool flg;
8359c58f1c22SToby Isaac 
8360d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8361d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8362c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
8363c58f1c22SToby Isaac     next = next->next;
8364c58f1c22SToby Isaac   }
836598921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8366c58f1c22SToby Isaac }
8367c58f1c22SToby Isaac 
8368c58f1c22SToby Isaac /*@
8369c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
8370c58f1c22SToby Isaac 
8371d083f849SBarry Smith   Collective on dmA
8372c58f1c22SToby Isaac 
8373d8d19677SJose E. Roman   Input Parameters:
83745d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
83752cbb9b06SVaclav Hapla . dmB - The DM object to which labels are copied
83765d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
83772cbb9b06SVaclav Hapla . all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
83782cbb9b06SVaclav Hapla - emode - How to behave when a DMLabel in the source and destination DMs with the same name is encountered (see DMCopyLabelsMode)
8379c58f1c22SToby Isaac 
8380c58f1c22SToby Isaac   Level: intermediate
8381c58f1c22SToby Isaac 
83822cbb9b06SVaclav Hapla   Notes:
83832cbb9b06SVaclav Hapla   This is typically used when interpolating or otherwise adding to a mesh, or testing.
8384c58f1c22SToby Isaac 
83852cbb9b06SVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode
8386c58f1c22SToby Isaac @*/
83872cbb9b06SVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all, DMCopyLabelsMode emode)
8388c58f1c22SToby Isaac {
83892cbb9b06SVaclav Hapla   DMLabel        label, labelNew, labelOld;
8390c58f1c22SToby Isaac   const char    *name;
8391c58f1c22SToby Isaac   PetscBool      flg;
83925d80c0bfSVaclav Hapla   DMLabelLink    link;
83935d80c0bfSVaclav Hapla   PetscErrorCode ierr;
8394c58f1c22SToby Isaac 
83955d80c0bfSVaclav Hapla   PetscFunctionBegin;
83965d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
83975d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
83985d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
83995d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
84002c71b3e2SJacob Faibussowitsch   PetscCheckFalse(mode==PETSC_USE_POINTER,PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
84015d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
84025d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
84035d80c0bfSVaclav Hapla     label=link->label;
84045d80c0bfSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
84055d80c0bfSVaclav Hapla     if (!all) {
8406c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
8407c58f1c22SToby Isaac       if (flg) continue;
84087d5acc75SStefano Zampini       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
84097d5acc75SStefano Zampini       if (flg) continue;
8410ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
8411ba2698f1SMatthew G. Knepley       if (flg) continue;
84125d80c0bfSVaclav Hapla     }
84132cbb9b06SVaclav Hapla     ierr = DMGetLabel(dmB, name, &labelOld);CHKERRQ(ierr);
84142cbb9b06SVaclav Hapla     if (labelOld) {
84152cbb9b06SVaclav Hapla       switch (emode) {
84162cbb9b06SVaclav Hapla         case DM_COPY_LABELS_KEEP:
84172cbb9b06SVaclav Hapla           continue;
84182cbb9b06SVaclav Hapla         case DM_COPY_LABELS_REPLACE:
84192cbb9b06SVaclav Hapla           ierr = DMRemoveLabelBySelf(dmB, &labelOld, PETSC_TRUE);CHKERRQ(ierr);
84202cbb9b06SVaclav Hapla           break;
84212cbb9b06SVaclav Hapla         case DM_COPY_LABELS_FAIL:
842298921bdaSJacob Faibussowitsch           SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in destination DM", name);
84232cbb9b06SVaclav Hapla         default:
842498921bdaSJacob Faibussowitsch           SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Unhandled DMCopyLabelsMode %d", emode);
84252cbb9b06SVaclav Hapla       }
84262cbb9b06SVaclav Hapla     }
84275d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
8428c58f1c22SToby Isaac       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
84295d80c0bfSVaclav Hapla     } else {
84305d80c0bfSVaclav Hapla       labelNew = label;
84315d80c0bfSVaclav Hapla     }
8432c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
84335d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
8434c58f1c22SToby Isaac   }
8435c58f1c22SToby Isaac   PetscFunctionReturn(0);
8436c58f1c22SToby Isaac }
8437461a15a0SLisandro Dalcin 
8438609dae6eSVaclav Hapla /*@C
8439609dae6eSVaclav Hapla   DMCompareLabels - Compare labels of two DMPlex meshes
8440609dae6eSVaclav Hapla 
84415efe38ccSVaclav Hapla   Collective
8442609dae6eSVaclav Hapla 
8443609dae6eSVaclav Hapla   Input Parameters:
8444609dae6eSVaclav Hapla + dm0 - First DM object
8445609dae6eSVaclav Hapla - dm1 - Second DM object
8446609dae6eSVaclav Hapla 
8447609dae6eSVaclav Hapla   Output Parameters
84485efe38ccSVaclav Hapla + equal   - (Optional) Flag whether labels of dm0 and dm1 are the same
8449609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference
8450609dae6eSVaclav Hapla 
8451609dae6eSVaclav Hapla   Level: intermediate
8452609dae6eSVaclav Hapla 
8453609dae6eSVaclav Hapla   Notes:
84545efe38ccSVaclav Hapla   The output flag equal is the same on all processes.
84555efe38ccSVaclav Hapla   If it is passed as NULL and difference is found, an error is thrown on all processes.
84565efe38ccSVaclav Hapla   Make sure to pass NULL on all processes.
8457609dae6eSVaclav Hapla 
84585efe38ccSVaclav Hapla   The output message is set independently on each rank.
84595efe38ccSVaclav Hapla   It is set to NULL if no difference was found on the current rank. It must be freed by user.
84605efe38ccSVaclav Hapla   If message is passed as NULL and difference is found, the difference description is printed to stderr in synchronized manner.
84615efe38ccSVaclav Hapla   Make sure to pass NULL on all processes.
8462609dae6eSVaclav Hapla 
8463609dae6eSVaclav Hapla   Labels are matched by name. If the number of labels and their names are equal,
8464609dae6eSVaclav Hapla   DMLabelCompare() is used to compare each pair of labels with the same name.
8465609dae6eSVaclav Hapla 
8466609dae6eSVaclav Hapla   Fortran Notes:
8467609dae6eSVaclav Hapla   This function is currently not available from Fortran.
8468609dae6eSVaclav Hapla 
8469609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare()
8470609dae6eSVaclav Hapla @*/
84715efe38ccSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *equal, char **message)
8472609dae6eSVaclav Hapla {
84735efe38ccSVaclav Hapla   PetscInt        n, i;
8474609dae6eSVaclav Hapla   char            msg[PETSC_MAX_PATH_LEN] = "";
84755efe38ccSVaclav Hapla   PetscBool       eq;
8476609dae6eSVaclav Hapla   MPI_Comm        comm;
84775efe38ccSVaclav Hapla   PetscMPIInt     rank;
8478609dae6eSVaclav Hapla   PetscErrorCode  ierr;
8479609dae6eSVaclav Hapla 
8480609dae6eSVaclav Hapla   PetscFunctionBegin;
8481609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm0,DM_CLASSID,1);
8482609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm1,DM_CLASSID,2);
8483609dae6eSVaclav Hapla   PetscCheckSameComm(dm0,1,dm1,2);
84845efe38ccSVaclav Hapla   if (equal) PetscValidBoolPointer(equal,3);
8485609dae6eSVaclav Hapla   if (message) PetscValidPointer(message, 4);
8486609dae6eSVaclav Hapla   ierr = PetscObjectGetComm((PetscObject)dm0, &comm);CHKERRQ(ierr);
84875efe38ccSVaclav Hapla   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
84885efe38ccSVaclav Hapla   {
84895efe38ccSVaclav Hapla     PetscInt n1;
84905efe38ccSVaclav Hapla 
84915efe38ccSVaclav Hapla     ierr = DMGetNumLabels(dm0, &n);CHKERRQ(ierr);
8492609dae6eSVaclav Hapla     ierr = DMGetNumLabels(dm1, &n1);CHKERRQ(ierr);
84935efe38ccSVaclav Hapla     eq = (PetscBool) (n == n1);
84945efe38ccSVaclav Hapla     if (!eq) {
84955efe38ccSVaclav Hapla       ierr = PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n, n1);CHKERRQ(ierr);
8496609dae6eSVaclav Hapla     }
84975efe38ccSVaclav Hapla     ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
84985efe38ccSVaclav Hapla     if (!eq) goto finish;
84995efe38ccSVaclav Hapla   }
85005efe38ccSVaclav Hapla   for (i=0; i<n; i++) {
8501609dae6eSVaclav Hapla     DMLabel     l0, l1;
8502609dae6eSVaclav Hapla     const char *name;
8503609dae6eSVaclav Hapla     char       *msgInner;
8504609dae6eSVaclav Hapla 
8505609dae6eSVaclav Hapla     /* Ignore label order */
8506609dae6eSVaclav Hapla     ierr = DMGetLabelByNum(dm0, i, &l0);CHKERRQ(ierr);
8507609dae6eSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)l0, &name);CHKERRQ(ierr);
8508609dae6eSVaclav Hapla     ierr = DMGetLabel(dm1, name, &l1);CHKERRQ(ierr);
8509609dae6eSVaclav Hapla     if (!l1) {
8510609dae6eSVaclav Hapla       ierr = PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i);CHKERRQ(ierr);
85115efe38ccSVaclav Hapla       eq = PETSC_FALSE;
85125efe38ccSVaclav Hapla       break;
8513609dae6eSVaclav Hapla     }
85145efe38ccSVaclav Hapla     ierr = DMLabelCompare(comm, l0, l1, &eq, &msgInner);CHKERRQ(ierr);
8515609dae6eSVaclav Hapla     ierr = PetscStrncpy(msg, msgInner, sizeof(msg));CHKERRQ(ierr);
8516609dae6eSVaclav Hapla     ierr = PetscFree(msgInner);CHKERRQ(ierr);
85175efe38ccSVaclav Hapla     if (!eq) break;
8518609dae6eSVaclav Hapla   }
85195efe38ccSVaclav Hapla   ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
8520609dae6eSVaclav Hapla finish:
85215efe38ccSVaclav Hapla   /* If message output arg not set, print to stderr */
8522609dae6eSVaclav Hapla   if (message) {
8523609dae6eSVaclav Hapla     *message = NULL;
8524609dae6eSVaclav Hapla     if (msg[0]) {
8525609dae6eSVaclav Hapla       ierr = PetscStrallocpy(msg, message);CHKERRQ(ierr);
8526609dae6eSVaclav Hapla     }
85275efe38ccSVaclav Hapla   } else {
85285efe38ccSVaclav Hapla     if (msg[0]) {
85295efe38ccSVaclav Hapla       ierr = PetscSynchronizedFPrintf(comm, PETSC_STDERR, "[%d] %s\n", rank, msg);CHKERRQ(ierr);
8530609dae6eSVaclav Hapla     }
85315efe38ccSVaclav Hapla     ierr = PetscSynchronizedFlush(comm, PETSC_STDERR);CHKERRQ(ierr);
85325efe38ccSVaclav Hapla   }
85335efe38ccSVaclav Hapla   /* If same output arg not ser and labels are not equal, throw error */
85345efe38ccSVaclav Hapla   if (equal) *equal = eq;
85352c71b3e2SJacob Faibussowitsch   else PetscCheckFalse(!eq,comm, PETSC_ERR_ARG_INCOMP, "DMLabels are not the same in dm0 and dm1");
8536609dae6eSVaclav Hapla   PetscFunctionReturn(0);
8537609dae6eSVaclav Hapla }
8538609dae6eSVaclav Hapla 
8539461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value)
8540461a15a0SLisandro Dalcin {
8541461a15a0SLisandro Dalcin   PetscErrorCode ierr;
8542609dae6eSVaclav Hapla 
8543461a15a0SLisandro Dalcin   PetscFunctionBegin;
8544461a15a0SLisandro Dalcin   PetscValidPointer(label,2);
8545461a15a0SLisandro Dalcin   if (!*label) {
8546461a15a0SLisandro Dalcin     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
8547461a15a0SLisandro Dalcin     ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr);
8548461a15a0SLisandro Dalcin   }
8549461a15a0SLisandro Dalcin   ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr);
8550461a15a0SLisandro Dalcin   PetscFunctionReturn(0);
8551461a15a0SLisandro Dalcin }
8552461a15a0SLisandro Dalcin 
85530fdc7489SMatthew Knepley /*
85540fdc7489SMatthew Knepley   Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would
85550fdc7489SMatthew Knepley   like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every
85560fdc7489SMatthew Knepley   (label, id) pair in the DM.
85570fdc7489SMatthew Knepley 
85580fdc7489SMatthew Knepley   However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to
85590fdc7489SMatthew Knepley   each label.
85600fdc7489SMatthew Knepley */
85610fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal)
85620fdc7489SMatthew Knepley {
85630fdc7489SMatthew Knepley   DMUniversalLabel ul;
85640fdc7489SMatthew Knepley   PetscBool       *active;
85650fdc7489SMatthew Knepley   PetscInt         pStart, pEnd, p, Nl, l, m;
85660fdc7489SMatthew Knepley   PetscErrorCode   ierr;
85670fdc7489SMatthew Knepley 
85680fdc7489SMatthew Knepley   PetscFunctionBegin;
85690fdc7489SMatthew Knepley   ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr);
85700fdc7489SMatthew Knepley   ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr);
85710fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
85720fdc7489SMatthew Knepley   ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr);
85730fdc7489SMatthew Knepley   ul->Nl = 0;
85740fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
85750fdc7489SMatthew Knepley     PetscBool   isdepth, iscelltype;
85760fdc7489SMatthew Knepley     const char *name;
85770fdc7489SMatthew Knepley 
85780fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
85790fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr);
85800fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr);
85810fdc7489SMatthew Knepley     active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE;
85820fdc7489SMatthew Knepley     if (active[l]) ++ul->Nl;
85830fdc7489SMatthew Knepley   }
85840fdc7489SMatthew 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);
85850fdc7489SMatthew Knepley   ul->Nv = 0;
85860fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
85870fdc7489SMatthew Knepley     DMLabel     label;
85880fdc7489SMatthew Knepley     PetscInt    nv;
85890fdc7489SMatthew Knepley     const char *name;
85900fdc7489SMatthew Knepley 
85910fdc7489SMatthew Knepley     if (!active[l]) continue;
85920fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
85930fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
85940fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
85950fdc7489SMatthew Knepley     ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr);
85960fdc7489SMatthew Knepley     ul->indices[m]   = l;
85970fdc7489SMatthew Knepley     ul->Nv          += nv;
85980fdc7489SMatthew Knepley     ul->offsets[m+1] = nv;
85990fdc7489SMatthew Knepley     ul->bits[m+1]    = PetscCeilReal(PetscLog2Real(nv+1));
86000fdc7489SMatthew Knepley     ++m;
86010fdc7489SMatthew Knepley   }
86020fdc7489SMatthew Knepley   for (l = 1; l <= ul->Nl; ++l) {
86030fdc7489SMatthew Knepley     ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l];
86040fdc7489SMatthew Knepley     ul->bits[l]    = ul->bits[l-1]    + ul->bits[l];
86050fdc7489SMatthew Knepley   }
86060fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
86070fdc7489SMatthew Knepley     PetscInt b;
86080fdc7489SMatthew Knepley 
86090fdc7489SMatthew Knepley     ul->masks[l] = 0;
86100fdc7489SMatthew Knepley     for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b;
86110fdc7489SMatthew Knepley   }
86120fdc7489SMatthew Knepley   ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr);
86130fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
86140fdc7489SMatthew Knepley     DMLabel         label;
86150fdc7489SMatthew Knepley     IS              valueIS;
86160fdc7489SMatthew Knepley     const PetscInt *varr;
86170fdc7489SMatthew Knepley     PetscInt        nv, v;
86180fdc7489SMatthew Knepley 
86190fdc7489SMatthew Knepley     if (!active[l]) continue;
86200fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
86210fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
86220fdc7489SMatthew Knepley     ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr);
86230fdc7489SMatthew Knepley     ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr);
86240fdc7489SMatthew Knepley     for (v = 0; v < nv; ++v) {
86250fdc7489SMatthew Knepley       ul->values[ul->offsets[m]+v] = varr[v];
86260fdc7489SMatthew Knepley     }
86270fdc7489SMatthew Knepley     ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr);
86280fdc7489SMatthew Knepley     ierr = ISDestroy(&valueIS);CHKERRQ(ierr);
86290fdc7489SMatthew Knepley     ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr);
86300fdc7489SMatthew Knepley     ++m;
86310fdc7489SMatthew Knepley   }
86320fdc7489SMatthew Knepley   ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr);
86330fdc7489SMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
86340fdc7489SMatthew Knepley     PetscInt  uval = 0;
86350fdc7489SMatthew Knepley     PetscBool marked = PETSC_FALSE;
86360fdc7489SMatthew Knepley 
86370fdc7489SMatthew Knepley     for (l = 0, m = 0; l < Nl; ++l) {
86380fdc7489SMatthew Knepley       DMLabel  label;
86390649b39aSStefano Zampini       PetscInt val, defval, loc, nv;
86400fdc7489SMatthew Knepley 
86410fdc7489SMatthew Knepley       if (!active[l]) continue;
86420fdc7489SMatthew Knepley       ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
86430fdc7489SMatthew Knepley       ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr);
86440fdc7489SMatthew Knepley       ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr);
86450fdc7489SMatthew Knepley       if (val == defval) {++m; continue;}
86460649b39aSStefano Zampini       nv = ul->offsets[m+1]-ul->offsets[m];
86470fdc7489SMatthew Knepley       marked = PETSC_TRUE;
86480fdc7489SMatthew Knepley       ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr);
86492c71b3e2SJacob Faibussowitsch       PetscCheckFalse(loc < 0,PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val);
86500fdc7489SMatthew Knepley       uval += (loc+1) << ul->bits[m];
86510fdc7489SMatthew Knepley       ++m;
86520fdc7489SMatthew Knepley     }
86530fdc7489SMatthew Knepley     if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);}
86540fdc7489SMatthew Knepley   }
86550fdc7489SMatthew Knepley   ierr = PetscFree(active);CHKERRQ(ierr);
86560fdc7489SMatthew Knepley   *universal = ul;
86570fdc7489SMatthew Knepley   PetscFunctionReturn(0);
86580fdc7489SMatthew Knepley }
86590fdc7489SMatthew Knepley 
86600fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal)
86610fdc7489SMatthew Knepley {
86620fdc7489SMatthew Knepley   PetscInt       l;
86630fdc7489SMatthew Knepley   PetscErrorCode ierr;
86640fdc7489SMatthew Knepley 
86650fdc7489SMatthew Knepley   PetscFunctionBegin;
86660fdc7489SMatthew Knepley   for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);}
86670fdc7489SMatthew Knepley   ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr);
86680fdc7489SMatthew Knepley   ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr);
86690fdc7489SMatthew Knepley   ierr = PetscFree((*universal)->values);CHKERRQ(ierr);
86700fdc7489SMatthew Knepley   ierr = PetscFree(*universal);CHKERRQ(ierr);
86710fdc7489SMatthew Knepley   *universal = NULL;
86720fdc7489SMatthew Knepley   PetscFunctionReturn(0);
86730fdc7489SMatthew Knepley }
86740fdc7489SMatthew Knepley 
86750fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel)
86760fdc7489SMatthew Knepley {
86770fdc7489SMatthew Knepley   PetscFunctionBegin;
86780fdc7489SMatthew Knepley   PetscValidPointer(ulabel, 2);
86790fdc7489SMatthew Knepley   *ulabel = ul->label;
86800fdc7489SMatthew Knepley   PetscFunctionReturn(0);
86810fdc7489SMatthew Knepley }
86820fdc7489SMatthew Knepley 
86830fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm)
86840fdc7489SMatthew Knepley {
86850fdc7489SMatthew Knepley   PetscInt       Nl = ul->Nl, l;
86860fdc7489SMatthew Knepley   PetscErrorCode ierr;
86870fdc7489SMatthew Knepley 
86880fdc7489SMatthew Knepley   PetscFunctionBegin;
8689064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 3);
86900fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
86910fdc7489SMatthew Knepley     if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);}
86920fdc7489SMatthew Knepley     else               {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);}
86930fdc7489SMatthew Knepley   }
86940fdc7489SMatthew Knepley   if (preserveOrder) {
86950fdc7489SMatthew Knepley     for (l = 0; l < ul->Nl; ++l) {
86960fdc7489SMatthew Knepley       const char *name;
86970fdc7489SMatthew Knepley       PetscBool   match;
86980fdc7489SMatthew Knepley 
86990fdc7489SMatthew Knepley       ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr);
87000fdc7489SMatthew Knepley       ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr);
87012c71b3e2SJacob Faibussowitsch       PetscCheckFalse(!match,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]);
87020fdc7489SMatthew Knepley     }
87030fdc7489SMatthew Knepley   }
87040fdc7489SMatthew Knepley   PetscFunctionReturn(0);
87050fdc7489SMatthew Knepley }
87060fdc7489SMatthew Knepley 
87070fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value)
87080fdc7489SMatthew Knepley {
87090fdc7489SMatthew Knepley   PetscInt       l;
87100fdc7489SMatthew Knepley   PetscErrorCode ierr;
87110fdc7489SMatthew Knepley 
87120fdc7489SMatthew Knepley   PetscFunctionBegin;
87130fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
87140fdc7489SMatthew Knepley     DMLabel  label;
87150fdc7489SMatthew Knepley     PetscInt lval = (value & ul->masks[l]) >> ul->bits[l];
87160fdc7489SMatthew Knepley 
87170fdc7489SMatthew Knepley     if (lval) {
87180fdc7489SMatthew Knepley       if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);}
87190fdc7489SMatthew Knepley       else          {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);}
87200fdc7489SMatthew Knepley       ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr);
87210fdc7489SMatthew Knepley     }
87220fdc7489SMatthew Knepley   }
87230fdc7489SMatthew Knepley   PetscFunctionReturn(0);
87240fdc7489SMatthew Knepley }
8725a8fb8f29SToby Isaac 
8726a8fb8f29SToby Isaac /*@
8727a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
8728a8fb8f29SToby Isaac 
8729a8fb8f29SToby Isaac   Input Parameter:
8730a8fb8f29SToby Isaac . dm - The DM object
8731a8fb8f29SToby Isaac 
8732a8fb8f29SToby Isaac   Output Parameter:
8733a8fb8f29SToby Isaac . cdm - The coarse DM
8734a8fb8f29SToby Isaac 
8735a8fb8f29SToby Isaac   Level: intermediate
8736a8fb8f29SToby Isaac 
8737a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
8738a8fb8f29SToby Isaac @*/
8739a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
8740a8fb8f29SToby Isaac {
8741a8fb8f29SToby Isaac   PetscFunctionBegin;
8742a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8743a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
8744a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
8745a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8746a8fb8f29SToby Isaac }
8747a8fb8f29SToby Isaac 
8748a8fb8f29SToby Isaac /*@
8749a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
8750a8fb8f29SToby Isaac 
8751a8fb8f29SToby Isaac   Input Parameters:
8752a8fb8f29SToby Isaac + dm - The DM object
8753a8fb8f29SToby Isaac - cdm - The coarse DM
8754a8fb8f29SToby Isaac 
8755a8fb8f29SToby Isaac   Level: intermediate
8756a8fb8f29SToby Isaac 
8757a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
8758a8fb8f29SToby Isaac @*/
8759a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
8760a8fb8f29SToby Isaac {
8761a8fb8f29SToby Isaac   PetscErrorCode ierr;
8762a8fb8f29SToby Isaac 
8763a8fb8f29SToby Isaac   PetscFunctionBegin;
8764a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8765a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
8766a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
8767a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
8768a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
8769a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8770a8fb8f29SToby Isaac }
8771a8fb8f29SToby Isaac 
877288bdff64SToby Isaac /*@
877388bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
877488bdff64SToby Isaac 
877588bdff64SToby Isaac   Input Parameter:
877688bdff64SToby Isaac . dm - The DM object
877788bdff64SToby Isaac 
877888bdff64SToby Isaac   Output Parameter:
877988bdff64SToby Isaac . fdm - The fine DM
878088bdff64SToby Isaac 
878188bdff64SToby Isaac   Level: intermediate
878288bdff64SToby Isaac 
878388bdff64SToby Isaac .seealso: DMSetFineDM()
878488bdff64SToby Isaac @*/
878588bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
878688bdff64SToby Isaac {
878788bdff64SToby Isaac   PetscFunctionBegin;
878888bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
878988bdff64SToby Isaac   PetscValidPointer(fdm, 2);
879088bdff64SToby Isaac   *fdm = dm->fineMesh;
879188bdff64SToby Isaac   PetscFunctionReturn(0);
879288bdff64SToby Isaac }
879388bdff64SToby Isaac 
879488bdff64SToby Isaac /*@
879588bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
879688bdff64SToby Isaac 
879788bdff64SToby Isaac   Input Parameters:
879888bdff64SToby Isaac + dm - The DM object
879988bdff64SToby Isaac - fdm - The fine DM
880088bdff64SToby Isaac 
880188bdff64SToby Isaac   Level: intermediate
880288bdff64SToby Isaac 
880388bdff64SToby Isaac .seealso: DMGetFineDM()
880488bdff64SToby Isaac @*/
880588bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
880688bdff64SToby Isaac {
880788bdff64SToby Isaac   PetscErrorCode ierr;
880888bdff64SToby Isaac 
880988bdff64SToby Isaac   PetscFunctionBegin;
881088bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
881188bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
881288bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
881388bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
881488bdff64SToby Isaac   dm->fineMesh = fdm;
881588bdff64SToby Isaac   PetscFunctionReturn(0);
881688bdff64SToby Isaac }
881788bdff64SToby Isaac 
8818a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8819a6ba4734SToby Isaac 
8820a6ba4734SToby Isaac /*@C
8821a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8822a6ba4734SToby Isaac 
8823783e2ec8SMatthew G. Knepley   Collective on dm
8824783e2ec8SMatthew G. Knepley 
8825a6ba4734SToby Isaac   Input Parameters:
88264c258f51SMatthew G. Knepley + dm       - The DM, with a PetscDS that matches the problem being constrained
8827f971fd6bSMatthew G. Knepley . type     - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8828a6ba4734SToby Isaac . name     - The BC name
882945480ffeSMatthew G. Knepley . label    - The label defining constrained points
883045480ffeSMatthew G. Knepley . Nv       - The number of DMLabel values for constrained points
883145480ffeSMatthew G. Knepley . values   - An array of values for constrained points
8832a6ba4734SToby Isaac . field    - The field to constrain
883345480ffeSMatthew G. Knepley . Nc       - The number of constrained field components (0 will constrain all fields)
8834a6ba4734SToby Isaac . comps    - An array of constrained component numbers
8835a6ba4734SToby Isaac . bcFunc   - A pointwise function giving boundary values
883656cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL
8837a6ba4734SToby Isaac - ctx      - An optional user context for bcFunc
8838a6ba4734SToby Isaac 
883945480ffeSMatthew G. Knepley   Output Parameter:
884045480ffeSMatthew G. Knepley . bd          - (Optional) Boundary number
884145480ffeSMatthew G. Knepley 
8842a6ba4734SToby Isaac   Options Database Keys:
8843a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8844a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8845a6ba4734SToby Isaac 
884656cf3b9cSMatthew G. Knepley   Note:
884756cf3b9cSMatthew 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:
884856cf3b9cSMatthew G. Knepley 
884956cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
885056cf3b9cSMatthew G. Knepley 
885156cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
885256cf3b9cSMatthew G. Knepley 
885356cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
885456cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
885556cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
885656cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
885756cf3b9cSMatthew G. Knepley 
885856cf3b9cSMatthew G. Knepley + dim - the spatial dimension
885956cf3b9cSMatthew G. Knepley . Nf - the number of fields
886056cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
886156cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
886256cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
886356cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
886456cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
886556cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
886656cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
886756cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
886856cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
886956cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
887056cf3b9cSMatthew G. Knepley . t - current time
887156cf3b9cSMatthew G. Knepley . x - coordinates of the current point
887256cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
887356cf3b9cSMatthew G. Knepley . constants - constant parameters
887456cf3b9cSMatthew G. Knepley - bcval - output values at the current point
887556cf3b9cSMatthew G. Knepley 
8876a6ba4734SToby Isaac   Level: developer
8877a6ba4734SToby Isaac 
887845480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary()
8879a6ba4734SToby Isaac @*/
888045480ffeSMatthew 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)
8881a6ba4734SToby Isaac {
8882e5e52638SMatthew G. Knepley   PetscDS        ds;
8883a6ba4734SToby Isaac   PetscErrorCode ierr;
8884a6ba4734SToby Isaac 
8885a6ba4734SToby Isaac   PetscFunctionBegin;
8886a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8887783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
888845480ffeSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
888945480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nv, 5);
889045480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 7);
889145480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 8);
8892e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
889345480ffeSMatthew G. Knepley   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr);
889445480ffeSMatthew G. Knepley   ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr);
8895a6ba4734SToby Isaac   PetscFunctionReturn(0);
8896a6ba4734SToby Isaac }
8897a6ba4734SToby Isaac 
889845480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */
8899e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8900e6f8dbb6SToby Isaac {
8901e5e52638SMatthew G. Knepley   PetscDS        ds;
8902dff059c6SToby Isaac   DMBoundary    *lastnext;
8903e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8904e6f8dbb6SToby Isaac   PetscErrorCode ierr;
8905e6f8dbb6SToby Isaac 
8906e6f8dbb6SToby Isaac   PetscFunctionBegin;
8907e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8908e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
890947a1f5adSToby Isaac   if (dm->boundary) {
891047a1f5adSToby Isaac     DMBoundary next = dm->boundary;
891147a1f5adSToby Isaac 
891247a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
891347a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
891447a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
891547a1f5adSToby Isaac     while (next) {
891647a1f5adSToby Isaac       DMBoundary b = next;
891747a1f5adSToby Isaac 
891847a1f5adSToby Isaac       next = b->next;
891947a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
8920a6ba4734SToby Isaac     }
892147a1f5adSToby Isaac     dm->boundary = NULL;
8922a6ba4734SToby Isaac   }
892347a1f5adSToby Isaac 
8924dff059c6SToby Isaac   lastnext = &(dm->boundary);
8925e6f8dbb6SToby Isaac   while (dsbound) {
8926e6f8dbb6SToby Isaac     DMBoundary dmbound;
8927e6f8dbb6SToby Isaac 
8928e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
8929e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
893045480ffeSMatthew G. Knepley     dmbound->label      = dsbound->label;
893147a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8932dff059c6SToby Isaac     *lastnext = dmbound;
8933dff059c6SToby Isaac     lastnext = &(dmbound->next);
8934dff059c6SToby Isaac     dsbound = dsbound->next;
8935a6ba4734SToby Isaac   }
8936a6ba4734SToby Isaac   PetscFunctionReturn(0);
8937a6ba4734SToby Isaac }
8938a6ba4734SToby Isaac 
8939a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8940a6ba4734SToby Isaac {
8941b95f2879SToby Isaac   DMBoundary     b;
8942a6ba4734SToby Isaac   PetscErrorCode ierr;
8943a6ba4734SToby Isaac 
8944a6ba4734SToby Isaac   PetscFunctionBegin;
8945a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8946534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8947a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
8948e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
8949b95f2879SToby Isaac   b = dm->boundary;
8950a6ba4734SToby Isaac   while (b && !(*isBd)) {
8951e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8952e6f8dbb6SToby Isaac     DSBoundary dsb   = b->dsboundary;
8953a6ba4734SToby Isaac     PetscInt   i;
8954a6ba4734SToby Isaac 
895545480ffeSMatthew G. Knepley     if (label) {
895645480ffeSMatthew G. Knepley       for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);}
8957a6ba4734SToby Isaac     }
8958a6ba4734SToby Isaac     b = b->next;
8959a6ba4734SToby Isaac   }
8960a6ba4734SToby Isaac   PetscFunctionReturn(0);
8961a6ba4734SToby Isaac }
89624d6f44ffSToby Isaac 
89634d6f44ffSToby Isaac /*@C
8964a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8965a6e0b375SMatthew G. Knepley 
8966a6e0b375SMatthew G. Knepley   Collective on DM
89674d6f44ffSToby Isaac 
89684d6f44ffSToby Isaac   Input Parameters:
89694d6f44ffSToby Isaac + dm      - The DM
89700709b2feSToby Isaac . time    - The time
89714d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
89724d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
89734d6f44ffSToby Isaac - mode    - The insertion mode for values
89744d6f44ffSToby Isaac 
89754d6f44ffSToby Isaac   Output Parameter:
89764d6f44ffSToby Isaac . X - vector
89774d6f44ffSToby Isaac 
89784d6f44ffSToby Isaac    Calling sequence of func:
897977b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
89804d6f44ffSToby Isaac 
89814d6f44ffSToby Isaac +  dim - The spatial dimension
89828ec8862eSJed Brown .  time - The time at which to sample
89834d6f44ffSToby Isaac .  x   - The coordinates
898477b739a6SMatthew Knepley .  Nc  - The number of components
89854d6f44ffSToby Isaac .  u   - The output field values
89864d6f44ffSToby Isaac -  ctx - optional user-defined function context
89874d6f44ffSToby Isaac 
89884d6f44ffSToby Isaac   Level: developer
89894d6f44ffSToby Isaac 
8990a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
89914d6f44ffSToby Isaac @*/
89920709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
89934d6f44ffSToby Isaac {
89944d6f44ffSToby Isaac   Vec            localX;
89954d6f44ffSToby Isaac   PetscErrorCode ierr;
89964d6f44ffSToby Isaac 
89974d6f44ffSToby Isaac   PetscFunctionBegin;
89984d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
89994d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
90000709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
90014d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
90024d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
90034d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
90044d6f44ffSToby Isaac   PetscFunctionReturn(0);
90054d6f44ffSToby Isaac }
90064d6f44ffSToby Isaac 
9007a6e0b375SMatthew G. Knepley /*@C
9008a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
9009a6e0b375SMatthew G. Knepley 
9010a6e0b375SMatthew G. Knepley   Not collective
9011a6e0b375SMatthew G. Knepley 
9012a6e0b375SMatthew G. Knepley   Input Parameters:
9013a6e0b375SMatthew G. Knepley + dm      - The DM
9014a6e0b375SMatthew G. Knepley . time    - The time
9015a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
9016a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
9017a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9018a6e0b375SMatthew G. Knepley 
9019a6e0b375SMatthew G. Knepley   Output Parameter:
9020a6e0b375SMatthew G. Knepley . localX - vector
9021a6e0b375SMatthew G. Knepley 
9022a6e0b375SMatthew G. Knepley    Calling sequence of func:
902377b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
9024a6e0b375SMatthew G. Knepley 
9025a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
9026a6e0b375SMatthew G. Knepley .  x   - The coordinates
902777b739a6SMatthew Knepley .  Nc  - The number of components
9028a6e0b375SMatthew G. Knepley .  u   - The output field values
9029a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
9030a6e0b375SMatthew G. Knepley 
9031a6e0b375SMatthew G. Knepley   Level: developer
9032a6e0b375SMatthew G. Knepley 
9033a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
9034a6e0b375SMatthew G. Knepley @*/
90350709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
90364d6f44ffSToby Isaac {
90374d6f44ffSToby Isaac   PetscErrorCode ierr;
90384d6f44ffSToby Isaac 
90394d6f44ffSToby Isaac   PetscFunctionBegin;
90404d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9041064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
90422c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfunctionlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
90430709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
90444d6f44ffSToby Isaac   PetscFunctionReturn(0);
90454d6f44ffSToby Isaac }
90464d6f44ffSToby Isaac 
9047a6e0b375SMatthew G. Knepley /*@C
9048a6e0b375SMatthew 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.
9049a6e0b375SMatthew G. Knepley 
9050a6e0b375SMatthew G. Knepley   Collective on DM
9051a6e0b375SMatthew G. Knepley 
9052a6e0b375SMatthew G. Knepley   Input Parameters:
9053a6e0b375SMatthew G. Knepley + dm      - The DM
9054a6e0b375SMatthew G. Knepley . time    - The time
9055a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
9056a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
9057a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
9058a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9059a6e0b375SMatthew G. Knepley 
9060a6e0b375SMatthew G. Knepley   Output Parameter:
9061a6e0b375SMatthew G. Knepley . X - vector
9062a6e0b375SMatthew G. Knepley 
9063a6e0b375SMatthew G. Knepley    Calling sequence of func:
906477b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
9065a6e0b375SMatthew G. Knepley 
9066a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
9067a6e0b375SMatthew G. Knepley .  x   - The coordinates
906877b739a6SMatthew Knepley .  Nc  - The number of components
9069a6e0b375SMatthew G. Knepley .  u   - The output field values
9070a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
9071a6e0b375SMatthew G. Knepley 
9072a6e0b375SMatthew G. Knepley   Level: developer
9073a6e0b375SMatthew G. Knepley 
9074a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
9075a6e0b375SMatthew G. Knepley @*/
90762c53366bSMatthew 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)
90772c53366bSMatthew G. Knepley {
90782c53366bSMatthew G. Knepley   Vec            localX;
90792c53366bSMatthew G. Knepley   PetscErrorCode ierr;
90802c53366bSMatthew G. Knepley 
90812c53366bSMatthew G. Knepley   PetscFunctionBegin;
90822c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
90832c53366bSMatthew G. Knepley   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
90842c53366bSMatthew G. Knepley   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
90852c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
90862c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
90872c53366bSMatthew G. Knepley   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
90882c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
90892c53366bSMatthew G. Knepley }
90902c53366bSMatthew G. Knepley 
9091a6e0b375SMatthew G. Knepley /*@C
9092a6e0b375SMatthew 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.
9093a6e0b375SMatthew G. Knepley 
9094a6e0b375SMatthew G. Knepley   Not collective
9095a6e0b375SMatthew G. Knepley 
9096a6e0b375SMatthew G. Knepley   Input Parameters:
9097a6e0b375SMatthew G. Knepley + dm      - The DM
9098a6e0b375SMatthew G. Knepley . time    - The time
9099a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
9100a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
9101a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
9102a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9103a6e0b375SMatthew G. Knepley 
9104a6e0b375SMatthew G. Knepley   Output Parameter:
9105a6e0b375SMatthew G. Knepley . localX - vector
9106a6e0b375SMatthew G. Knepley 
9107a6e0b375SMatthew G. Knepley    Calling sequence of func:
910877b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
9109a6e0b375SMatthew G. Knepley 
9110a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
9111a6e0b375SMatthew G. Knepley .  x   - The coordinates
911277b739a6SMatthew Knepley .  Nc  - The number of components
9113a6e0b375SMatthew G. Knepley .  u   - The output field values
9114a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
9115a6e0b375SMatthew G. Knepley 
9116a6e0b375SMatthew G. Knepley   Level: developer
9117a6e0b375SMatthew G. Knepley 
9118a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
9119a6e0b375SMatthew G. Knepley @*/
91201c531cf8SMatthew 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)
91214d6f44ffSToby Isaac {
91224d6f44ffSToby Isaac   PetscErrorCode ierr;
91234d6f44ffSToby Isaac 
91244d6f44ffSToby Isaac   PetscFunctionBegin;
91254d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9126064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
91272c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfunctionlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
91281c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
91294d6f44ffSToby Isaac   PetscFunctionReturn(0);
91304d6f44ffSToby Isaac }
91312716604bSToby Isaac 
9132a6e0b375SMatthew G. Knepley /*@C
9133a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
9134a6e0b375SMatthew G. Knepley 
9135a6e0b375SMatthew G. Knepley   Not collective
9136a6e0b375SMatthew G. Knepley 
9137a6e0b375SMatthew G. Knepley   Input Parameters:
9138a6e0b375SMatthew G. Knepley + dm      - The DM
9139a6e0b375SMatthew G. Knepley . time    - The time
9140a6e0b375SMatthew G. Knepley . localU  - The input field vector
9141a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9142a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9143a6e0b375SMatthew G. Knepley 
9144a6e0b375SMatthew G. Knepley   Output Parameter:
9145a6e0b375SMatthew G. Knepley . localX  - The output vector
9146a6e0b375SMatthew G. Knepley 
9147a6e0b375SMatthew G. Knepley    Calling sequence of func:
9148a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9149a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9150a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9151a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9152a6e0b375SMatthew G. Knepley 
9153a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
9154a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
9155a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9156a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
9157a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9158a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
9159a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9160a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9161a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9162a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9163a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9164a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9165a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9166a6e0b375SMatthew G. Knepley .  t            - The current time
9167a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
9168a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
9169a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
9170a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
9171a6e0b375SMatthew G. Knepley 
9172a6e0b375SMatthew 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.
9173a6e0b375SMatthew 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
9174a6e0b375SMatthew 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
9175a6e0b375SMatthew 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.
9176a6e0b375SMatthew G. Knepley 
9177a6e0b375SMatthew G. Knepley   Level: intermediate
9178a6e0b375SMatthew G. Knepley 
9179a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9180a6e0b375SMatthew G. Knepley @*/
91818c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
91828c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
91838c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
91848c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9185191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
91868c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
91878c6c5593SMatthew G. Knepley {
91888c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
91898c6c5593SMatthew G. Knepley 
91908c6c5593SMatthew G. Knepley   PetscFunctionBegin;
91918c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
91928c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
91938c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
91942c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfieldlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
91958c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
91968c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
91978c6c5593SMatthew G. Knepley }
91988c6c5593SMatthew G. Knepley 
9199a6e0b375SMatthew G. Knepley /*@C
9200a6e0b375SMatthew 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.
9201a6e0b375SMatthew G. Knepley 
9202a6e0b375SMatthew G. Knepley   Not collective
9203a6e0b375SMatthew G. Knepley 
9204a6e0b375SMatthew G. Knepley   Input Parameters:
9205a6e0b375SMatthew G. Knepley + dm      - The DM
9206a6e0b375SMatthew G. Knepley . time    - The time
9207a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
9208a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
9209a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
9210a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9211a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9212a6e0b375SMatthew G. Knepley . localU  - The input field vector
9213a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9214a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9215a6e0b375SMatthew G. Knepley 
9216a6e0b375SMatthew G. Knepley   Output Parameter:
9217a6e0b375SMatthew G. Knepley . localX  - The output vector
9218a6e0b375SMatthew G. Knepley 
9219a6e0b375SMatthew G. Knepley    Calling sequence of func:
9220a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9221a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9222a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9223a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9224a6e0b375SMatthew G. Knepley 
9225a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
9226a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
9227a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9228a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
9229a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9230a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
9231a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9232a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9233a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9234a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9235a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9236a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9237a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9238a6e0b375SMatthew G. Knepley .  t            - The current time
9239a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
9240a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
9241a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
9242a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
9243a6e0b375SMatthew G. Knepley 
9244a6e0b375SMatthew 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.
9245a6e0b375SMatthew 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
9246a6e0b375SMatthew 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
9247a6e0b375SMatthew 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.
9248a6e0b375SMatthew G. Knepley 
9249a6e0b375SMatthew G. Knepley   Level: intermediate
9250a6e0b375SMatthew G. Knepley 
9251a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9252a6e0b375SMatthew G. Knepley @*/
92531c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
92548c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
92558c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
92568c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9257191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
92588c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
92598c6c5593SMatthew G. Knepley {
92608c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
92618c6c5593SMatthew G. Knepley 
92628c6c5593SMatthew G. Knepley   PetscFunctionBegin;
92638c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9264064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9265064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
92662c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
92671c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
92688c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
92698c6c5593SMatthew G. Knepley }
92708c6c5593SMatthew G. Knepley 
92712716604bSToby Isaac /*@C
9272ece3a9fcSMatthew 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.
9273ece3a9fcSMatthew G. Knepley 
9274ece3a9fcSMatthew G. Knepley   Not collective
9275ece3a9fcSMatthew G. Knepley 
9276ece3a9fcSMatthew G. Knepley   Input Parameters:
9277ece3a9fcSMatthew G. Knepley + dm      - The DM
9278ece3a9fcSMatthew G. Knepley . time    - The time
9279ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
9280ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
9281ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
9282ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9283ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9284ece3a9fcSMatthew G. Knepley . localU  - The input field vector
9285ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9286ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
9287ece3a9fcSMatthew G. Knepley 
9288ece3a9fcSMatthew G. Knepley   Output Parameter:
9289ece3a9fcSMatthew G. Knepley . localX  - The output vector
9290ece3a9fcSMatthew G. Knepley 
9291ece3a9fcSMatthew G. Knepley    Calling sequence of func:
9292ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9293ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9294ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9295ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9296ece3a9fcSMatthew G. Knepley 
9297ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
9298ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
9299ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9300ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
9301ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9302ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
9303ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9304ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9305ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9306ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9307ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9308ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9309ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9310ece3a9fcSMatthew G. Knepley .  t            - The current time
9311ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
9312ece3a9fcSMatthew G. Knepley .  n            - The face normal
9313ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
9314ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
9315ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
9316ece3a9fcSMatthew G. Knepley 
9317ece3a9fcSMatthew G. Knepley   Note:
9318ece3a9fcSMatthew 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.
9319ece3a9fcSMatthew 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
9320ece3a9fcSMatthew 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
9321ece3a9fcSMatthew 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.
9322ece3a9fcSMatthew G. Knepley 
9323ece3a9fcSMatthew G. Knepley   Level: intermediate
9324ece3a9fcSMatthew G. Knepley 
9325ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9326ece3a9fcSMatthew G. Knepley @*/
9327ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
9328ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
9329ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9330ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9331ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
9332ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
9333ece3a9fcSMatthew G. Knepley {
9334ece3a9fcSMatthew G. Knepley   PetscErrorCode ierr;
9335ece3a9fcSMatthew G. Knepley 
9336ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
9337ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9338064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9339064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
93402c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectbdfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
9341ece3a9fcSMatthew G. Knepley   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
9342ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
9343ece3a9fcSMatthew G. Knepley }
9344ece3a9fcSMatthew G. Knepley 
9345ece3a9fcSMatthew G. Knepley /*@C
93462716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
93472716604bSToby Isaac 
93482716604bSToby Isaac   Input Parameters:
93492716604bSToby Isaac + dm    - The DM
93500709b2feSToby Isaac . time  - The time
93512716604bSToby Isaac . funcs - The functions to evaluate for each field component
93522716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9353574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
93542716604bSToby Isaac 
93552716604bSToby Isaac   Output Parameter:
93562716604bSToby Isaac . diff - The diff ||u - u_h||_2
93572716604bSToby Isaac 
93582716604bSToby Isaac   Level: developer
93592716604bSToby Isaac 
93601189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
93612716604bSToby Isaac @*/
93620709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
93632716604bSToby Isaac {
93642716604bSToby Isaac   PetscErrorCode ierr;
93652716604bSToby Isaac 
93662716604bSToby Isaac   PetscFunctionBegin;
93672716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9368b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
93692c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computel2diff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
93700709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
93712716604bSToby Isaac   PetscFunctionReturn(0);
93722716604bSToby Isaac }
9373b698f381SToby Isaac 
9374b698f381SToby Isaac /*@C
9375b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
9376b698f381SToby Isaac 
9377d083f849SBarry Smith   Collective on dm
9378d083f849SBarry Smith 
9379b698f381SToby Isaac   Input Parameters:
9380b698f381SToby Isaac + dm    - The DM
9381b698f381SToby Isaac , time  - The time
9382b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
9383b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9384574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
9385b698f381SToby Isaac - n     - The vector to project along
9386b698f381SToby Isaac 
9387b698f381SToby Isaac   Output Parameter:
9388b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
9389b698f381SToby Isaac 
9390b698f381SToby Isaac   Level: developer
9391b698f381SToby Isaac 
9392b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
9393b698f381SToby Isaac @*/
9394b698f381SToby 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)
9395b698f381SToby Isaac {
9396b698f381SToby Isaac   PetscErrorCode ierr;
9397b698f381SToby Isaac 
9398b698f381SToby Isaac   PetscFunctionBegin;
9399b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9400b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
94012c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computel2gradientdiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
9402b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
9403b698f381SToby Isaac   PetscFunctionReturn(0);
9404b698f381SToby Isaac }
9405b698f381SToby Isaac 
94062a16baeaSToby Isaac /*@C
94072a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
94082a16baeaSToby Isaac 
9409d083f849SBarry Smith   Collective on dm
9410d083f849SBarry Smith 
94112a16baeaSToby Isaac   Input Parameters:
94122a16baeaSToby Isaac + dm    - The DM
94132a16baeaSToby Isaac . time  - The time
94142a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
94152a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9416574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
94172a16baeaSToby Isaac 
94182a16baeaSToby Isaac   Output Parameter:
94192a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
94202a16baeaSToby Isaac 
94212a16baeaSToby Isaac   Level: developer
94222a16baeaSToby Isaac 
94231189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
94242a16baeaSToby Isaac @*/
94251189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
94262a16baeaSToby Isaac {
94272a16baeaSToby Isaac   PetscErrorCode ierr;
94282a16baeaSToby Isaac 
94292a16baeaSToby Isaac   PetscFunctionBegin;
94302a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
94312a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
94322c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computel2fielddiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
94332a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
94342a16baeaSToby Isaac   PetscFunctionReturn(0);
94352a16baeaSToby Isaac }
94362a16baeaSToby Isaac 
9437df0b854cSToby Isaac /*@C
9438502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
9439502a2867SDave May 
9440502a2867SDave May  Not Collective
9441502a2867SDave May 
9442502a2867SDave May  Input Parameter:
9443502a2867SDave May .  dm    - The DM
9444502a2867SDave May 
94450a19bb7dSprj-  Output Parameters:
94460a19bb7dSprj- +  nranks - the number of neighbours
94470a19bb7dSprj- -  ranks - the neighbors ranks
9448502a2867SDave May 
9449502a2867SDave May  Notes:
9450502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
9451502a2867SDave May 
9452502a2867SDave May  Level: beginner
9453502a2867SDave May 
9454dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
9455502a2867SDave May @*/
9456502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
9457502a2867SDave May {
9458502a2867SDave May   PetscErrorCode ierr;
9459502a2867SDave May 
9460502a2867SDave May   PetscFunctionBegin;
9461502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
94622c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->getneighbors,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
9463502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
9464502a2867SDave May   PetscFunctionReturn(0);
9465502a2867SDave May }
9466502a2867SDave May 
9467531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
9468531c7667SBarry Smith 
9469531c7667SBarry Smith /*
9470531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
9471531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
9472531c7667SBarry Smith */
9473531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
9474531c7667SBarry Smith {
9475531c7667SBarry Smith   PetscErrorCode ierr;
9476531c7667SBarry Smith 
9477531c7667SBarry Smith   PetscFunctionBegin;
9478531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9479531c7667SBarry Smith     Vec x1local;
9480531c7667SBarry Smith     DM  dm;
9481531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
94822c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm,PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
9483531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
9484531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9485531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9486531c7667SBarry Smith     x1   = x1local;
9487531c7667SBarry Smith   }
9488531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
9489531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9490531c7667SBarry Smith     DM  dm;
9491531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9492531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
9493531c7667SBarry Smith   }
9494531c7667SBarry Smith   PetscFunctionReturn(0);
9495531c7667SBarry Smith }
9496531c7667SBarry Smith 
9497531c7667SBarry Smith /*@
9498531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
9499531c7667SBarry Smith 
9500531c7667SBarry Smith     Input Parameter:
9501531c7667SBarry Smith .    coloring - the MatFDColoring object
9502531c7667SBarry Smith 
950395452b02SPatrick Sanan     Developer Notes:
950495452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
9505531c7667SBarry Smith 
95061b266c99SBarry Smith     Level: advanced
95071b266c99SBarry Smith 
9508531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
9509531c7667SBarry Smith @*/
9510531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
9511531c7667SBarry Smith {
9512531c7667SBarry Smith   PetscFunctionBegin;
9513531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
9514531c7667SBarry Smith   PetscFunctionReturn(0);
9515531c7667SBarry Smith }
95168320bc6fSPatrick Sanan 
95178320bc6fSPatrick Sanan /*@
95188320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
95198320bc6fSPatrick Sanan 
95208320bc6fSPatrick Sanan     Collective
95218320bc6fSPatrick Sanan 
95228320bc6fSPatrick Sanan     Input Parameters:
9523a5bc1bf3SBarry Smith +    dm1 - the first DM
95248320bc6fSPatrick Sanan -    dm2 - the second DM
95258320bc6fSPatrick Sanan 
95268320bc6fSPatrick Sanan     Output Parameters:
95278320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
95288320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
95298320bc6fSPatrick Sanan 
95308320bc6fSPatrick Sanan     Notes:
95318320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
95323d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
95338320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
95343d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
95353d862458SPatrick Sanan     decomposition, but hold different data.
95368320bc6fSPatrick Sanan 
95378320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
95388320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
95398320bc6fSPatrick Sanan 
95408320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
95418320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
95428320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
95438320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
95448320bc6fSPatrick Sanan 
95458320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
95468320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
95478320bc6fSPatrick Sanan .vb
95488320bc6fSPatrick Sanan   ...
95498320bc6fSPatrick Sanan   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
95508320bc6fSPatrick Sanan   if (set && compatible)  {
95518320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
95528320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
95533d862458SPatrick Sanan     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
95548320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
95558320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
95568320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
95578320bc6fSPatrick Sanan       }
95588320bc6fSPatrick Sanan     }
95598320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
95608320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
95618320bc6fSPatrick Sanan   } else {
95628320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
95638320bc6fSPatrick Sanan   }
95648320bc6fSPatrick Sanan   ...
95658320bc6fSPatrick Sanan .ve
95668320bc6fSPatrick Sanan 
95678320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
95688320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
95698320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
95708320bc6fSPatrick Sanan     always check the "set" output parameter.
95718320bc6fSPatrick Sanan 
95728320bc6fSPatrick Sanan     A DM is always compatible with itself.
95738320bc6fSPatrick Sanan 
95748320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
95758320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
95768320bc6fSPatrick Sanan     incompatible.
95778320bc6fSPatrick Sanan 
95788320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
95798320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
95808320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
95818320bc6fSPatrick Sanan 
95828320bc6fSPatrick Sanan     Developer Notes:
95833d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
95843d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
9585a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
95868320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
95878320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
95883d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
95893d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
95908320bc6fSPatrick Sanan 
95918320bc6fSPatrick Sanan     Level: advanced
95928320bc6fSPatrick Sanan 
95933d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
95948320bc6fSPatrick Sanan @*/
95958320bc6fSPatrick Sanan 
9596a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
95978320bc6fSPatrick Sanan {
95988320bc6fSPatrick Sanan   PetscErrorCode ierr;
95998320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
96008320bc6fSPatrick Sanan   DMType         type,type2;
96018320bc6fSPatrick Sanan   PetscBool      sameType;
96028320bc6fSPatrick Sanan 
96038320bc6fSPatrick Sanan   PetscFunctionBegin;
9604a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
96058320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
96068320bc6fSPatrick Sanan 
96078320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
9608a5bc1bf3SBarry Smith   if (dm1 == dm2) {
96098320bc6fSPatrick Sanan     *set = PETSC_TRUE;
96108320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
96118320bc6fSPatrick Sanan     PetscFunctionReturn(0);
96128320bc6fSPatrick Sanan   }
96138320bc6fSPatrick Sanan 
96148320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
96158320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
96168320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
96178320bc6fSPatrick Sanan      determined by the implementation-specific logic */
9618ffc4695bSBarry Smith   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr);
96198320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
96208320bc6fSPatrick Sanan     *set = PETSC_TRUE;
96218320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
96228320bc6fSPatrick Sanan     PetscFunctionReturn(0);
96238320bc6fSPatrick Sanan   }
96248320bc6fSPatrick Sanan 
96258320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
9626a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
9627a5bc1bf3SBarry Smith     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
9628b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
96298320bc6fSPatrick Sanan   }
96308320bc6fSPatrick Sanan 
9631a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
96328320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
9633a5bc1bf3SBarry Smith   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
96348320bc6fSPatrick Sanan   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
96358320bc6fSPatrick Sanan   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
96368320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
9637a5bc1bf3SBarry Smith     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
96388320bc6fSPatrick Sanan   } else {
96398320bc6fSPatrick Sanan     *set = PETSC_FALSE;
96408320bc6fSPatrick Sanan   }
96418320bc6fSPatrick Sanan   PetscFunctionReturn(0);
96428320bc6fSPatrick Sanan }
9643c0f0dcc3SMatthew G. Knepley 
9644c0f0dcc3SMatthew G. Knepley /*@C
9645c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
9646c0f0dcc3SMatthew G. Knepley 
9647c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9648c0f0dcc3SMatthew G. Knepley 
9649c0f0dcc3SMatthew G. Knepley   Input Parameters:
9650c0f0dcc3SMatthew G. Knepley + DM - the DM
9651c0f0dcc3SMatthew G. Knepley . f - the monitor function
9652c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
9653c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
9654c0f0dcc3SMatthew G. Knepley 
9655c0f0dcc3SMatthew G. Knepley   Options Database Keys:
9656c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
9657c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
9658c0f0dcc3SMatthew G. Knepley 
9659c0f0dcc3SMatthew G. Knepley   Notes:
9660c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
9661c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
9662c0f0dcc3SMatthew G. Knepley   order in which they were set.
9663c0f0dcc3SMatthew G. Knepley 
9664c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9665c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9666c0f0dcc3SMatthew G. Knepley 
9667c0f0dcc3SMatthew G. Knepley   Level: intermediate
9668c0f0dcc3SMatthew G. Knepley 
9669c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9670c0f0dcc3SMatthew G. Knepley @*/
9671c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9672c0f0dcc3SMatthew G. Knepley {
9673c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9674c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9675c0f0dcc3SMatthew G. Knepley 
9676c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9677c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9678c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9679c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9680c0f0dcc3SMatthew G. Knepley 
9681c0f0dcc3SMatthew G. Knepley     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
9682c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9683c0f0dcc3SMatthew G. Knepley   }
96842c71b3e2SJacob Faibussowitsch   PetscCheckFalse(dm->numbermonitors >= MAXDMMONITORS,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9685c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9686c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9687c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9688c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9689c0f0dcc3SMatthew G. Knepley }
9690c0f0dcc3SMatthew G. Knepley 
9691c0f0dcc3SMatthew G. Knepley /*@
9692c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9693c0f0dcc3SMatthew G. Knepley 
9694c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9695c0f0dcc3SMatthew G. Knepley 
9696c0f0dcc3SMatthew G. Knepley   Input Parameter:
9697c0f0dcc3SMatthew G. Knepley . dm - the DM
9698c0f0dcc3SMatthew G. Knepley 
9699c0f0dcc3SMatthew G. Knepley   Options Database Key:
9700c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9701c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9702c0f0dcc3SMatthew G. Knepley   set via the options database
9703c0f0dcc3SMatthew G. Knepley 
9704c0f0dcc3SMatthew G. Knepley   Notes:
9705c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9706c0f0dcc3SMatthew G. Knepley 
9707c0f0dcc3SMatthew G. Knepley   Level: intermediate
9708c0f0dcc3SMatthew G. Knepley 
9709c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9710c0f0dcc3SMatthew G. Knepley @*/
9711c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9712c0f0dcc3SMatthew G. Knepley {
9713c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9714c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9715c0f0dcc3SMatthew G. Knepley 
9716c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9717c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9718c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9719c0f0dcc3SMatthew G. Knepley     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
9720c0f0dcc3SMatthew G. Knepley   }
9721c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9722c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9723c0f0dcc3SMatthew G. Knepley }
9724c0f0dcc3SMatthew G. Knepley 
9725c0f0dcc3SMatthew G. Knepley /*@C
9726c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9727c0f0dcc3SMatthew G. Knepley 
9728c0f0dcc3SMatthew G. Knepley   Collective on DM
9729c0f0dcc3SMatthew G. Knepley 
9730c0f0dcc3SMatthew G. Knepley   Input Parameters:
9731c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9732c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9733c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9734c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9735c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9736c0f0dcc3SMatthew 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
9737c0f0dcc3SMatthew G. Knepley 
9738c0f0dcc3SMatthew G. Knepley   Output Parameter:
9739c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9740c0f0dcc3SMatthew G. Knepley 
9741c0f0dcc3SMatthew G. Knepley   Level: developer
9742c0f0dcc3SMatthew G. Knepley 
9743c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9744c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9745c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9746c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9747c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9748c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9749c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9750c0f0dcc3SMatthew G. Knepley @*/
9751c0f0dcc3SMatthew 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)
9752c0f0dcc3SMatthew G. Knepley {
9753c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9754c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9755c0f0dcc3SMatthew G. Knepley   PetscErrorCode    ierr;
9756c0f0dcc3SMatthew G. Knepley 
9757c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9758c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9759c0f0dcc3SMatthew G. Knepley   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
9760c0f0dcc3SMatthew G. Knepley   if (*flg) {
9761c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9762c0f0dcc3SMatthew G. Knepley 
9763c0f0dcc3SMatthew G. Knepley     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
9764c0f0dcc3SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
9765c0f0dcc3SMatthew G. Knepley     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
9766c0f0dcc3SMatthew G. Knepley     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
9767c0f0dcc3SMatthew G. Knepley   }
9768c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9769c0f0dcc3SMatthew G. Knepley }
9770c0f0dcc3SMatthew G. Knepley 
9771c0f0dcc3SMatthew G. Knepley /*@
9772c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9773c0f0dcc3SMatthew G. Knepley 
9774c0f0dcc3SMatthew G. Knepley    Collective on DM
9775c0f0dcc3SMatthew G. Knepley 
9776c0f0dcc3SMatthew G. Knepley    Input Parameters:
9777c0f0dcc3SMatthew G. Knepley .  dm - The DM
9778c0f0dcc3SMatthew G. Knepley 
9779c0f0dcc3SMatthew G. Knepley    Level: developer
9780c0f0dcc3SMatthew G. Knepley 
9781c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9782c0f0dcc3SMatthew G. Knepley @*/
9783c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9784c0f0dcc3SMatthew G. Knepley {
9785c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9786c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9787c0f0dcc3SMatthew G. Knepley 
9788c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9789c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9790c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9791c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9792c0f0dcc3SMatthew G. Knepley     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
9793c0f0dcc3SMatthew G. Knepley   }
9794c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9795c0f0dcc3SMatthew G. Knepley }
97962e4af2aeSMatthew G. Knepley 
97972e4af2aeSMatthew G. Knepley /*@
97982e4af2aeSMatthew G. Knepley   DMComputeError - Computes the error assuming the user has given exact solution functions
97992e4af2aeSMatthew G. Knepley 
98002e4af2aeSMatthew G. Knepley   Collective on DM
98012e4af2aeSMatthew G. Knepley 
98022e4af2aeSMatthew G. Knepley   Input Parameters:
98032e4af2aeSMatthew G. Knepley + dm     - The DM
98046b867d5aSJose E. Roman - sol    - The solution vector
98052e4af2aeSMatthew G. Knepley 
98066b867d5aSJose E. Roman   Input/Output Parameter:
98076b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output
98086b867d5aSJose E. Roman            contains the error in each field
98096b867d5aSJose E. Roman 
98106b867d5aSJose E. Roman   Output Parameter:
98116b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL)
98122e4af2aeSMatthew G. Knepley 
98132e4af2aeSMatthew G. Knepley   Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber().
98142e4af2aeSMatthew G. Knepley 
98152e4af2aeSMatthew G. Knepley   Level: developer
98162e4af2aeSMatthew G. Knepley 
98172e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber()
98182e4af2aeSMatthew G. Knepley @*/
98192e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec)
98202e4af2aeSMatthew G. Knepley {
98212e4af2aeSMatthew G. Knepley   PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *);
98222e4af2aeSMatthew G. Knepley   void            **ctxs;
98232e4af2aeSMatthew G. Knepley   PetscReal         time;
98242e4af2aeSMatthew G. Knepley   PetscInt          Nf, f, Nds, s;
98252e4af2aeSMatthew G. Knepley   PetscErrorCode    ierr;
98262e4af2aeSMatthew G. Knepley 
98272e4af2aeSMatthew G. Knepley   PetscFunctionBegin;
98282e4af2aeSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
98292e4af2aeSMatthew G. Knepley   ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr);
98302e4af2aeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
98312e4af2aeSMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
98322e4af2aeSMatthew G. Knepley     PetscDS         ds;
98332e4af2aeSMatthew G. Knepley     DMLabel         label;
98342e4af2aeSMatthew G. Knepley     IS              fieldIS;
98352e4af2aeSMatthew G. Knepley     const PetscInt *fields;
98362e4af2aeSMatthew G. Knepley     PetscInt        dsNf;
98372e4af2aeSMatthew G. Knepley 
98382e4af2aeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
98392e4af2aeSMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
98402e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);}
98412e4af2aeSMatthew G. Knepley     for (f = 0; f < dsNf; ++f) {
98422e4af2aeSMatthew G. Knepley       const PetscInt field = fields[f];
98432e4af2aeSMatthew G. Knepley       ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr);
98442e4af2aeSMatthew G. Knepley     }
98452e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);}
98462e4af2aeSMatthew G. Knepley   }
98472e4af2aeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
98482c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!exactSol[f],PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f);
98492e4af2aeSMatthew G. Knepley   }
98502e4af2aeSMatthew G. Knepley   ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr);
98512e4af2aeSMatthew G. Knepley   if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);}
98522e4af2aeSMatthew G. Knepley   if (errorVec) {
98532e4af2aeSMatthew G. Knepley     DM             edm;
98542e4af2aeSMatthew G. Knepley     DMPolytopeType ct;
98552e4af2aeSMatthew G. Knepley     PetscBool      simplex;
98562e4af2aeSMatthew G. Knepley     PetscInt       dim, cStart, Nf;
98572e4af2aeSMatthew G. Knepley 
98582e4af2aeSMatthew G. Knepley     ierr = DMClone(dm, &edm);CHKERRQ(ierr);
98592e4af2aeSMatthew G. Knepley     ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr);
98602e4af2aeSMatthew G. Knepley     ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
98612e4af2aeSMatthew G. Knepley     ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
98622e4af2aeSMatthew G. Knepley     simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
98632e4af2aeSMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
98642e4af2aeSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
98652e4af2aeSMatthew G. Knepley       PetscFE         fe, efe;
98662e4af2aeSMatthew G. Knepley       PetscQuadrature q;
98672e4af2aeSMatthew G. Knepley       const char     *name;
98682e4af2aeSMatthew G. Knepley 
98692e4af2aeSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr);
98702e4af2aeSMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr);
98712e4af2aeSMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr);
98722e4af2aeSMatthew G. Knepley       ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr);
98732e4af2aeSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
98742e4af2aeSMatthew G. Knepley       ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr);
98752e4af2aeSMatthew G. Knepley       ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr);
98762e4af2aeSMatthew G. Knepley       ierr = PetscFEDestroy(&efe);CHKERRQ(ierr);
98772e4af2aeSMatthew G. Knepley     }
98782e4af2aeSMatthew G. Knepley     ierr = DMCreateDS(edm);CHKERRQ(ierr);
98792e4af2aeSMatthew G. Knepley 
98801e1ea65dSPierre Jolivet     ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr);
98812e4af2aeSMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr);
98822e4af2aeSMatthew G. Knepley     ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr);
98832e4af2aeSMatthew G. Knepley     ierr = DMDestroy(&edm);CHKERRQ(ierr);
98842e4af2aeSMatthew G. Knepley   }
98852e4af2aeSMatthew G. Knepley   ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr);
98862e4af2aeSMatthew G. Knepley   PetscFunctionReturn(0);
98872e4af2aeSMatthew G. Knepley }
98889a2a23afSMatthew G. Knepley 
98899a2a23afSMatthew G. Knepley /*@
98909a2a23afSMatthew G. Knepley   DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM
98919a2a23afSMatthew G. Knepley 
98929a2a23afSMatthew G. Knepley   Not collective
98939a2a23afSMatthew G. Knepley 
98949a2a23afSMatthew G. Knepley   Input Parameter:
98959a2a23afSMatthew G. Knepley . dm     - The DM
98969a2a23afSMatthew G. Knepley 
98979a2a23afSMatthew G. Knepley   Output Parameter:
9898a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors
98999a2a23afSMatthew G. Knepley 
99009a2a23afSMatthew G. Knepley   Level: advanced
99019a2a23afSMatthew G. Knepley 
99029a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
99039a2a23afSMatthew G. Knepley @*/
99049a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux)
99059a2a23afSMatthew G. Knepley {
99069a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
99079a2a23afSMatthew G. Knepley 
99089a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99099a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99109a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr);
99119a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99129a2a23afSMatthew G. Knepley }
99139a2a23afSMatthew G. Knepley 
99149a2a23afSMatthew G. Knepley /*@
99159a2a23afSMatthew G. Knepley   DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value
99169a2a23afSMatthew G. Knepley 
99179a2a23afSMatthew G. Knepley   Not collective
99189a2a23afSMatthew G. Knepley 
99199a2a23afSMatthew G. Knepley   Input Parameters:
99209a2a23afSMatthew G. Knepley + dm     - The DM
99219a2a23afSMatthew G. Knepley . label  - The DMLabel
99229a2a23afSMatthew G. Knepley - value  - The label value indicating the region
99239a2a23afSMatthew G. Knepley 
99249a2a23afSMatthew G. Knepley   Output Parameter:
99259a2a23afSMatthew G. Knepley . aux    - The Vec holding auxiliary field data
99269a2a23afSMatthew G. Knepley 
992704c51a94SMatthew G. Knepley   Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well.
992804c51a94SMatthew G. Knepley 
99299a2a23afSMatthew G. Knepley   Level: advanced
99309a2a23afSMatthew G. Knepley 
99319a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec()
99329a2a23afSMatthew G. Knepley @*/
99339a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux)
99349a2a23afSMatthew G. Knepley {
993504c51a94SMatthew G. Knepley   PetscHashAuxKey key, wild = {NULL, 0};
993604c51a94SMatthew G. Knepley   PetscBool       has;
99379a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
99389a2a23afSMatthew G. Knepley 
99399a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99409a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99419a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
99429a2a23afSMatthew G. Knepley   key.label = label;
99439a2a23afSMatthew G. Knepley   key.value = value;
994404c51a94SMatthew G. Knepley   ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr);
994504c51a94SMatthew G. Knepley   if (has) {ierr = PetscHMapAuxGet(dm->auxData, key,  aux);CHKERRQ(ierr);}
994604c51a94SMatthew G. Knepley   else     {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);}
99479a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99489a2a23afSMatthew G. Knepley }
99499a2a23afSMatthew G. Knepley 
99509a2a23afSMatthew G. Knepley /*@
99519a2a23afSMatthew G. Knepley   DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value
99529a2a23afSMatthew G. Knepley 
99539a2a23afSMatthew G. Knepley   Not collective
99549a2a23afSMatthew G. Knepley 
99559a2a23afSMatthew G. Knepley   Input Parameters:
99569a2a23afSMatthew G. Knepley + dm     - The DM
99579a2a23afSMatthew G. Knepley . label  - The DMLabel
99589a2a23afSMatthew G. Knepley . value  - The label value indicating the region
99599a2a23afSMatthew G. Knepley - aux    - The Vec holding auxiliary field data
99609a2a23afSMatthew G. Knepley 
99619a2a23afSMatthew G. Knepley   Level: advanced
99629a2a23afSMatthew G. Knepley 
99639a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec()
99649a2a23afSMatthew G. Knepley @*/
99659a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux)
99669a2a23afSMatthew G. Knepley {
99679a2a23afSMatthew G. Knepley   Vec             old;
99689a2a23afSMatthew G. Knepley   PetscHashAuxKey key;
99699a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
99709a2a23afSMatthew G. Knepley 
99719a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99729a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99739a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
99749a2a23afSMatthew G. Knepley   key.label = label;
99759a2a23afSMatthew G. Knepley   key.value = value;
99769a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr);
99779a2a23afSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr);
99789a2a23afSMatthew G. Knepley   ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr);
99799a2a23afSMatthew G. Knepley   if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);}
99809a2a23afSMatthew G. Knepley   else      {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);}
99819a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99829a2a23afSMatthew G. Knepley }
99839a2a23afSMatthew G. Knepley 
99849a2a23afSMatthew G. Knepley /*@C
99859a2a23afSMatthew G. Knepley   DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM
99869a2a23afSMatthew G. Knepley 
99879a2a23afSMatthew G. Knepley   Not collective
99889a2a23afSMatthew G. Knepley 
99899a2a23afSMatthew G. Knepley   Input Parameter:
99909a2a23afSMatthew G. Knepley . dm      - The DM
99919a2a23afSMatthew G. Knepley 
99929a2a23afSMatthew G. Knepley   Output Parameters:
99939a2a23afSMatthew G. Knepley + labels  - The DMLabels for each Vec
99949a2a23afSMatthew G. Knepley - values  - The label values for each Vec
99959a2a23afSMatthew G. Knepley 
99969a2a23afSMatthew G. Knepley   Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec().
99979a2a23afSMatthew G. Knepley 
99989a2a23afSMatthew G. Knepley   Level: advanced
99999a2a23afSMatthew G. Knepley 
100009a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
100019a2a23afSMatthew G. Knepley @*/
100029a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[])
100039a2a23afSMatthew G. Knepley {
100049a2a23afSMatthew G. Knepley   PetscHashAuxKey *keys;
100059a2a23afSMatthew G. Knepley   PetscInt         n, i, off = 0;
100069a2a23afSMatthew G. Knepley   PetscErrorCode   ierr;
100079a2a23afSMatthew G. Knepley 
100089a2a23afSMatthew G. Knepley   PetscFunctionBegin;
100099a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
100109a2a23afSMatthew G. Knepley   PetscValidPointer(labels, 2);
100119a2a23afSMatthew G. Knepley   PetscValidPointer(values, 3);
100129a2a23afSMatthew G. Knepley   ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr);
100139a2a23afSMatthew G. Knepley   ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr);
100149a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr);
100159a2a23afSMatthew G. Knepley   for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;}
100169a2a23afSMatthew G. Knepley   ierr = PetscFree(keys);CHKERRQ(ierr);
100179a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
100189a2a23afSMatthew G. Knepley }
100199a2a23afSMatthew G. Knepley 
100209a2a23afSMatthew G. Knepley /*@
100219a2a23afSMatthew G. Knepley   DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM
100229a2a23afSMatthew G. Knepley 
100239a2a23afSMatthew G. Knepley   Not collective
100249a2a23afSMatthew G. Knepley 
100259a2a23afSMatthew G. Knepley   Input Parameter:
100269a2a23afSMatthew G. Knepley . dm    - The DM
100279a2a23afSMatthew G. Knepley 
100289a2a23afSMatthew G. Knepley   Output Parameter:
100299a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data
100309a2a23afSMatthew G. Knepley 
100319a2a23afSMatthew G. Knepley   Level: advanced
100329a2a23afSMatthew G. Knepley 
100339a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
100349a2a23afSMatthew G. Knepley @*/
100359a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew)
100369a2a23afSMatthew G. Knepley {
100379a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
100389a2a23afSMatthew G. Knepley 
100399a2a23afSMatthew G. Knepley   PetscFunctionBegin;
100409a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
100419a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr);
100429a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr);
100439a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
100449a2a23afSMatthew G. Knepley }
10045b5a892a1SMatthew G. Knepley 
10046b5a892a1SMatthew G. Knepley /*@C
10047b5a892a1SMatthew G. Knepley   DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
10048b5a892a1SMatthew G. Knepley 
10049b5a892a1SMatthew G. Knepley   Not collective
10050b5a892a1SMatthew G. Knepley 
10051b5a892a1SMatthew G. Knepley   Input Parameters:
10052b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10053b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
10054b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
10055b5a892a1SMatthew G. Knepley 
10056b5a892a1SMatthew G. Knepley   Output Parameters:
10057b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
10058b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
10059b5a892a1SMatthew G. Knepley 
10060b5a892a1SMatthew G. Knepley   Level: advanced
10061b5a892a1SMatthew G. Knepley 
10062b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation()
10063b5a892a1SMatthew G. Knepley @*/
10064b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found)
10065b5a892a1SMatthew G. Knepley {
10066b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetConeSize(ct);
10067b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
10068b5a892a1SMatthew G. Knepley   PetscInt       o, c;
10069b5a892a1SMatthew G. Knepley 
10070b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10071b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
10072b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
10073b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o);
10074b5a892a1SMatthew G. Knepley 
10075b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break;
10076b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
10077b5a892a1SMatthew G. Knepley   }
10078b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
10079b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10080b5a892a1SMatthew G. Knepley }
10081b5a892a1SMatthew G. Knepley 
10082b5a892a1SMatthew G. Knepley /*@C
10083b5a892a1SMatthew G. Knepley   DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
10084b5a892a1SMatthew G. Knepley 
10085b5a892a1SMatthew G. Knepley   Not collective
10086b5a892a1SMatthew G. Knepley 
10087b5a892a1SMatthew G. Knepley   Input Parameters:
10088b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10089b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
10090b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
10091b5a892a1SMatthew G. Knepley 
10092b5a892a1SMatthew G. Knepley   Output Parameters:
10093b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
10094b5a892a1SMatthew G. Knepley 
10095b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
10096b5a892a1SMatthew G. Knepley 
10097b5a892a1SMatthew G. Knepley   Level: advanced
10098b5a892a1SMatthew G. Knepley 
10099b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation()
10100b5a892a1SMatthew G. Knepley @*/
10101b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
10102b5a892a1SMatthew G. Knepley {
10103b5a892a1SMatthew G. Knepley   PetscBool      found;
10104b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
10105b5a892a1SMatthew G. Knepley 
10106b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10107b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
101082c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
10109b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10110b5a892a1SMatthew G. Knepley }
10111b5a892a1SMatthew G. Knepley 
10112b5a892a1SMatthew G. Knepley /*@C
10113b5a892a1SMatthew G. Knepley   DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
10114b5a892a1SMatthew G. Knepley 
10115b5a892a1SMatthew G. Knepley   Not collective
10116b5a892a1SMatthew G. Knepley 
10117b5a892a1SMatthew G. Knepley   Input Parameters:
10118b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10119b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices
10120b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices
10121b5a892a1SMatthew G. Knepley 
10122b5a892a1SMatthew G. Knepley   Output Parameters:
10123b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
10124b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
10125b5a892a1SMatthew G. Knepley 
10126b5a892a1SMatthew G. Knepley   Level: advanced
10127b5a892a1SMatthew G. Knepley 
10128b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation()
10129b5a892a1SMatthew G. Knepley @*/
10130b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found)
10131b5a892a1SMatthew G. Knepley {
10132b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetNumVertices(ct);
10133b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
10134b5a892a1SMatthew G. Knepley   PetscInt       o, c;
10135b5a892a1SMatthew G. Knepley 
10136b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10137b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
10138b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
10139b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o);
10140b5a892a1SMatthew G. Knepley 
10141b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break;
10142b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
10143b5a892a1SMatthew G. Knepley   }
10144b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
10145b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10146b5a892a1SMatthew G. Knepley }
10147b5a892a1SMatthew G. Knepley 
10148b5a892a1SMatthew G. Knepley /*@C
10149b5a892a1SMatthew G. Knepley   DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
10150b5a892a1SMatthew G. Knepley 
10151b5a892a1SMatthew G. Knepley   Not collective
10152b5a892a1SMatthew G. Knepley 
10153b5a892a1SMatthew G. Knepley   Input Parameters:
10154b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10155b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices
10156b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices
10157b5a892a1SMatthew G. Knepley 
10158b5a892a1SMatthew G. Knepley   Output Parameters:
10159b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
10160b5a892a1SMatthew G. Knepley 
10161b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
10162b5a892a1SMatthew G. Knepley 
10163b5a892a1SMatthew G. Knepley   Level: advanced
10164b5a892a1SMatthew G. Knepley 
10165b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation()
10166b5a892a1SMatthew G. Knepley @*/
10167b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
10168b5a892a1SMatthew G. Knepley {
10169b5a892a1SMatthew G. Knepley   PetscBool      found;
10170b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
10171b5a892a1SMatthew G. Knepley 
10172b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10173b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
101742c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
10175b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10176b5a892a1SMatthew G. Knepley }
10177012bc364SMatthew G. Knepley 
10178012bc364SMatthew G. Knepley /*@C
10179012bc364SMatthew G. Knepley   DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type
10180012bc364SMatthew G. Knepley 
10181012bc364SMatthew G. Knepley   Not collective
10182012bc364SMatthew G. Knepley 
10183012bc364SMatthew G. Knepley   Input Parameters:
10184012bc364SMatthew G. Knepley + ct    - The DMPolytopeType
10185012bc364SMatthew G. Knepley - point - Coordinates of the point
10186012bc364SMatthew G. Knepley 
10187012bc364SMatthew G. Knepley   Output Parameters:
10188012bc364SMatthew G. Knepley . inside  - Flag indicating whether the point is inside the reference cell of given type
10189012bc364SMatthew G. Knepley 
10190012bc364SMatthew G. Knepley   Level: advanced
10191012bc364SMatthew G. Knepley 
10192012bc364SMatthew G. Knepley .seealso: DMLocatePoints()
10193012bc364SMatthew G. Knepley @*/
10194012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside)
10195012bc364SMatthew G. Knepley {
10196012bc364SMatthew G. Knepley   PetscReal sum = 0.0;
10197012bc364SMatthew G. Knepley   PetscInt  d;
10198012bc364SMatthew G. Knepley 
10199012bc364SMatthew G. Knepley   PetscFunctionBegin;
10200012bc364SMatthew G. Knepley   *inside = PETSC_TRUE;
10201012bc364SMatthew G. Knepley   switch (ct) {
10202012bc364SMatthew G. Knepley   case DM_POLYTOPE_TRIANGLE:
10203012bc364SMatthew G. Knepley   case DM_POLYTOPE_TETRAHEDRON:
10204012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) {
10205012bc364SMatthew G. Knepley       if (point[d] < -1.0) {*inside = PETSC_FALSE; break;}
10206012bc364SMatthew G. Knepley       sum += point[d];
10207012bc364SMatthew G. Knepley     }
10208012bc364SMatthew G. Knepley     if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10209012bc364SMatthew G. Knepley     break;
10210012bc364SMatthew G. Knepley   case DM_POLYTOPE_QUADRILATERAL:
10211012bc364SMatthew G. Knepley   case DM_POLYTOPE_HEXAHEDRON:
10212012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d)
10213012bc364SMatthew G. Knepley       if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10214012bc364SMatthew G. Knepley     break;
10215012bc364SMatthew G. Knepley   default:
1021698921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]);
10217012bc364SMatthew G. Knepley   }
10218012bc364SMatthew G. Knepley   PetscFunctionReturn(0);
10219012bc364SMatthew G. Knepley }
10220