xref: /petsc/src/dm/interface/dm.c (revision 83aa49f4c9b1ab2a0b1e1662e9e4f72eb0961d4d)
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;
6372348bcf4SPeter Brune     if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
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;
646f490541aSPeter Brune     if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
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;
696aa1993deSMatthew G Knepley     if ((*dm)->workout) SETERRQ(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
785f918ec44SMatthew G. Knepley   ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ(ierr);
786f918ec44SMatthew G. Knepley   ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ(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
8389318fe57SMatthew G. Knepley . -dm_plex_shape <shape>            - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc.
8399318fe57SMatthew G. Knepley . -dm_plex_cell <ct>                - Cell shape
8409318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain
8419318fe57SMatthew G. Knepley . -dm_plex_dim <dim>                - Set the topological dimension
8429318fe57SMatthew G. Knepley . -dm_plex_simplex <bool>           - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements
8439318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool>       - PETSC_TRUE turns on topological interpolation (creating edges and faces)
8449318fe57SMatthew G. Knepley . -dm_plex_scale <sc>               - Scale factor for mesh coordinates
8459318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p>        - Number of faces along each dimension
8469318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z>        - Specify lower-left-bottom coordinates for the box
8479318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z>        - Specify upper-right-top coordinates for the box
8489318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz>        - Specify the DMBoundaryType for each direction
8499318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r>        - The sphere radius
8509318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r>          - Radius of the ball
8519318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz>         - Boundary type in the z direction
8529318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n>  - Number of wedges around the cylinder
8539318fe57SMatthew G. Knepley . -dm_refine_pre <n>                - The number of refinements before distribution
8549318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool>     - Flag for uniform refinement before distribution
8559318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v>   - The maximum cell volume after refinement before distribution
8569318fe57SMatthew G. Knepley . -dm_refine <n>                    - The number of refinements after distribution
857d410b0cfSMatthew G. Knepley . -dm_extrude <l>                   - Acticate extrusion and apecify the number of layers to extrude
858d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thickness <t>           - The total thickness of extruded layers
859d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_use_tensor <bool>       - Use tensor cells when extruding
860d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_symmetric <bool>        - Extrude layers symmetrically about the surface
861d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_normal <n0,...,nd>      - Specify the extrusion direction
862d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thicknesses <t0,...,tl> - Specify thickness of each layer
863909dfd52SMatthew G. Knepley . -dm_plex_create_fv_ghost_cells    - Flag to create finite volume ghost cells on the boundary
864909dfd52SMatthew G. Knepley . -dm_plex_fv_ghost_cells_label <name> - Label name for ghost cells boundary
8659318fe57SMatthew G. Knepley . -dm_distribute <bool>             - Flag to redistribute a mesh among processes
8669318fe57SMatthew G. Knepley . -dm_distribute_overlap <n>        - The size of the overlap halo
8679318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool>          - Set adjacency direction
8689318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool>       - Set adjacency size
8699318fe57SMatthew G. Knepley 
870384a6580SVaclav Hapla     DMPLEX Specific Checks
871384a6580SVaclav Hapla +   -dm_plex_check_symmetry        - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry()
872384a6580SVaclav Hapla .   -dm_plex_check_skeleton        - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton()
873384a6580SVaclav 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()
874384a6580SVaclav Hapla .   -dm_plex_check_geometry        - Check that cells have positive volume - DMPlexCheckGeometry()
875384a6580SVaclav Hapla .   -dm_plex_check_pointsf         - Check some necessary conditions for PointSF - DMPlexCheckPointSF()
876384a6580SVaclav Hapla .   -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones()
877384a6580SVaclav Hapla -   -dm_plex_check_all             - Perform all the checks above
878d7bf68aeSBarry Smith 
87995eb5ee5SVaclav Hapla     Level: intermediate
88095eb5ee5SVaclav Hapla 
88195eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(),
88295eb5ee5SVaclav Hapla     DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones()
883d7bf68aeSBarry Smith 
884d7bf68aeSBarry Smith @*/
8857087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm)
886d7bf68aeSBarry Smith {
8877781c08eSBarry Smith   char           typeName[256];
888ca266f36SBarry Smith   PetscBool      flg;
889d7bf68aeSBarry Smith   PetscErrorCode ierr;
890d7bf68aeSBarry Smith 
891d7bf68aeSBarry Smith   PetscFunctionBegin;
892171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
89349be4549SMatthew G. Knepley   dm->setfromoptionscalled = PETSC_TRUE;
89449be4549SMatthew G. Knepley   if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);}
8951bb6d2a8SBarry Smith   if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);}
8963194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
8970298fd71SBarry 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);
898a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
899f9ba7244SBarry Smith   if (flg) {
900f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
901f9ba7244SBarry Smith   }
902a264d7a6SBarry 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);
903073dac72SJed Brown   if (flg) {
904521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
905073dac72SJed Brown   }
9068f1509bcSBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
907a4ea9b21SRichard 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);
908f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
909e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
910f9ba7244SBarry Smith   }
911f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
9120633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
91382fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
914d7bf68aeSBarry Smith   PetscFunctionReturn(0);
915d7bf68aeSBarry Smith }
916d7bf68aeSBarry Smith 
917fc9bc008SSatish Balay /*@C
918fe2efc57SMark    DMViewFromOptions - View from Options
919fe2efc57SMark 
920fe2efc57SMark    Collective on DM
921fe2efc57SMark 
922fe2efc57SMark    Input Parameters:
923fe2efc57SMark +  dm - the DM object
924736c3998SJose E. Roman .  obj - Optional object
925736c3998SJose E. Roman -  name - command line option
926fe2efc57SMark 
927fe2efc57SMark    Level: intermediate
928fe2efc57SMark .seealso:  DM, DMView, PetscObjectViewFromOptions(), DMCreate()
929fe2efc57SMark @*/
930fe2efc57SMark PetscErrorCode  DMViewFromOptions(DM dm,PetscObject obj,const char name[])
931fe2efc57SMark {
932fe2efc57SMark   PetscErrorCode ierr;
933fe2efc57SMark 
934fe2efc57SMark   PetscFunctionBegin;
935fe2efc57SMark   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
936fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr);
937fe2efc57SMark   PetscFunctionReturn(0);
938fe2efc57SMark }
939fe2efc57SMark 
940fe2efc57SMark /*@C
941224748a4SBarry Smith     DMView - Views a DM
94247c6ae99SBarry Smith 
943d083f849SBarry Smith     Collective on dm
94447c6ae99SBarry Smith 
945d8d19677SJose E. Roman     Input Parameters:
94647c6ae99SBarry Smith +   dm - the DM object to view
94747c6ae99SBarry Smith -   v - the viewer
94847c6ae99SBarry Smith 
949224748a4SBarry Smith     Level: beginner
95047c6ae99SBarry Smith 
951e727c939SJed Brown .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
95247c6ae99SBarry Smith 
95347c6ae99SBarry Smith @*/
9547087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
95547c6ae99SBarry Smith {
95647c6ae99SBarry Smith   PetscErrorCode    ierr;
95732c0f0efSBarry Smith   PetscBool         isbinary;
95876a8abe0SBarry Smith   PetscMPIInt       size;
95976a8abe0SBarry Smith   PetscViewerFormat format;
96047c6ae99SBarry Smith 
96147c6ae99SBarry Smith   PetscFunctionBegin;
962171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9633014e516SBarry Smith   if (!v) {
964ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
9653014e516SBarry Smith   }
966b1b135c8SBarry Smith   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2);
96774903a4fSStefano Zampini   /* Ideally, we would like to have this test on.
96874903a4fSStefano Zampini      However, it currently breaks socket viz via GLVis.
96974903a4fSStefano Zampini      During DMView(parallel_mesh,glvis_viewer), each
97074903a4fSStefano Zampini      process opens a sequential ASCII socket to visualize
97174903a4fSStefano Zampini      the local mesh, and PetscObjectView(dm,local_socket)
97274903a4fSStefano Zampini      is internally called inside VecView_GLVis, incurring
97374903a4fSStefano Zampini      in an error here */
97474903a4fSStefano Zampini   /* PetscCheckSameComm(dm,1,v,2); */
9758bfd1ab9SVaclav Hapla   ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr);
976b1b135c8SBarry Smith 
97776a8abe0SBarry Smith   ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr);
978ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRMPI(ierr);
97976a8abe0SBarry Smith   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0);
98098c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
98132c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
98232c0f0efSBarry Smith   if (isbinary) {
98355849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
98432c0f0efSBarry Smith     char     type[256];
98532c0f0efSBarry Smith 
986f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr);
98732c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
988f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr);
98932c0f0efSBarry Smith   }
9900c010503SBarry Smith   if (dm->ops->view) {
9910c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
99247c6ae99SBarry Smith   }
99347c6ae99SBarry Smith   PetscFunctionReturn(0);
99447c6ae99SBarry Smith }
99547c6ae99SBarry Smith 
99647c6ae99SBarry Smith /*@
9978472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
99847c6ae99SBarry Smith 
999d083f849SBarry Smith     Collective on dm
100047c6ae99SBarry Smith 
100147c6ae99SBarry Smith     Input Parameter:
100247c6ae99SBarry Smith .   dm - the DM object
100347c6ae99SBarry Smith 
100447c6ae99SBarry Smith     Output Parameter:
100547c6ae99SBarry Smith .   vec - the global vector
100647c6ae99SBarry Smith 
1007073dac72SJed Brown     Level: beginner
100847c6ae99SBarry Smith 
1009ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
101047c6ae99SBarry Smith 
101147c6ae99SBarry Smith @*/
10127087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
101347c6ae99SBarry Smith {
101447c6ae99SBarry Smith   PetscErrorCode ierr;
101547c6ae99SBarry Smith 
101647c6ae99SBarry Smith   PetscFunctionBegin;
1017171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1018b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
1019b9d85ea2SLisandro Dalcin   if (!dm->ops->createglobalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name);
102047c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
102176bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1022c6b011d8SStefano Zampini     DM vdm;
1023c6b011d8SStefano Zampini 
1024c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
1025c6b011d8SStefano Zampini     if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name);
1026c6b011d8SStefano Zampini   }
102747c6ae99SBarry Smith   PetscFunctionReturn(0);
102847c6ae99SBarry Smith }
102947c6ae99SBarry Smith 
103047c6ae99SBarry Smith /*@
10318472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
103247c6ae99SBarry Smith 
103347c6ae99SBarry Smith     Not Collective
103447c6ae99SBarry Smith 
103547c6ae99SBarry Smith     Input Parameter:
103647c6ae99SBarry Smith .   dm - the DM object
103747c6ae99SBarry Smith 
103847c6ae99SBarry Smith     Output Parameter:
103947c6ae99SBarry Smith .   vec - the local vector
104047c6ae99SBarry Smith 
1041073dac72SJed Brown     Level: beginner
104247c6ae99SBarry Smith 
1043ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
104447c6ae99SBarry Smith 
104547c6ae99SBarry Smith @*/
10467087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
104747c6ae99SBarry Smith {
104847c6ae99SBarry Smith   PetscErrorCode ierr;
104947c6ae99SBarry Smith 
105047c6ae99SBarry Smith   PetscFunctionBegin;
1051171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1052b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
1053b9d85ea2SLisandro Dalcin   if (!dm->ops->createlocalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name);
105447c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
105576bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1056c6b011d8SStefano Zampini     DM vdm;
1057c6b011d8SStefano Zampini 
1058c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
1059c6b011d8SStefano Zampini     if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name);
1060c6b011d8SStefano Zampini   }
106147c6ae99SBarry Smith   PetscFunctionReturn(0);
106247c6ae99SBarry Smith }
106347c6ae99SBarry Smith 
10641411c6eeSJed Brown /*@
10651411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
10661411c6eeSJed Brown 
1067d083f849SBarry Smith    Collective on dm
10681411c6eeSJed Brown 
10691411c6eeSJed Brown    Input Parameter:
10701411c6eeSJed Brown .  dm - the DM that provides the mapping
10711411c6eeSJed Brown 
10721411c6eeSJed Brown    Output Parameter:
10731411c6eeSJed Brown .  ltog - the mapping
10741411c6eeSJed Brown 
10751411c6eeSJed Brown    Level: intermediate
10761411c6eeSJed Brown 
10771411c6eeSJed Brown    Notes:
10781411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
10791411c6eeSJed Brown    MatSetLocalToGlobalMapping().
10801411c6eeSJed Brown 
1081fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
10821411c6eeSJed Brown @*/
10837087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
10841411c6eeSJed Brown {
10850be3e97aSMatthew G. Knepley   PetscInt       bs = -1, bsLocal[2], bsMinMax[2];
10861411c6eeSJed Brown   PetscErrorCode ierr;
10871411c6eeSJed Brown 
10881411c6eeSJed Brown   PetscFunctionBegin;
10891411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
10901411c6eeSJed Brown   PetscValidPointer(ltog,2);
10911411c6eeSJed Brown   if (!dm->ltogmap) {
109237d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
109337d0c07bSMatthew G Knepley 
109492fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
109537d0c07bSMatthew G Knepley     if (section) {
1096a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
109737d0c07bSMatthew G Knepley       PetscInt       *ltog;
1098ccf3bd66SMatthew G. Knepley       PetscInt        pStart, pEnd, n, p, k, l;
109937d0c07bSMatthew G Knepley 
1100e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
110137d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
1102ccf3bd66SMatthew G. Knepley       ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr);
1103ccf3bd66SMatthew G. Knepley       ierr = PetscMalloc1(n, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
110437d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
1105a974ec88SMatthew G. Knepley         PetscInt bdof, cdof, dof, off, c, cind = 0;
110637d0c07bSMatthew G Knepley 
110737d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
110837d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
1109a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
1110a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
111137d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
11121a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
11131a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
11141a7dc684SMatthew G. Knepley         if (dof) {
1115b190aa46SMatthew G. Knepley           if (bs < 0)          {bs = bdof;}
1116b190aa46SMatthew G. Knepley           else if (bs != bdof) {bs = 1;}
11171a7dc684SMatthew G. Knepley         }
111837d0c07bSMatthew G Knepley         for (c = 0; c < dof; ++c, ++l) {
1119a974ec88SMatthew G. Knepley           if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c;
1120a974ec88SMatthew G. Knepley           else                                     ltog[l] = (off < 0 ? -(off+1) : off) + c;
112137d0c07bSMatthew G Knepley         }
112237d0c07bSMatthew G Knepley       }
1123bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
11240be3e97aSMatthew G. Knepley       bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs;
11250be3e97aSMatthew G. Knepley       ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr);
11260be3e97aSMatthew G. Knepley       if (bsMinMax[0] != bsMinMax[1]) {bs = 1;}
11270be3e97aSMatthew G. Knepley       else                            {bs = bsMinMax[0];}
11287591dbb2SMatthew G. Knepley       bs = bs < 0 ? 1 : bs;
11297591dbb2SMatthew G. Knepley       /* Must reduce indices by blocksize */
1130ccf3bd66SMatthew G. Knepley       if (bs > 1) {
1131ccf3bd66SMatthew G. Knepley         for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs;
1132ccf3bd66SMatthew G. Knepley         n /= bs;
1133ccf3bd66SMatthew G. Knepley       }
1134ccf3bd66SMatthew G. Knepley       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
11353bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
113637d0c07bSMatthew G Knepley     } else {
1137b9d85ea2SLisandro Dalcin       if (!dm->ops->getlocaltoglobalmapping) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name);
1138184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
11391411c6eeSJed Brown     }
114037d0c07bSMatthew G Knepley   }
11411411c6eeSJed Brown   *ltog = dm->ltogmap;
11421411c6eeSJed Brown   PetscFunctionReturn(0);
11431411c6eeSJed Brown }
11441411c6eeSJed Brown 
11451411c6eeSJed Brown /*@
11461411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
11471411c6eeSJed Brown 
11481411c6eeSJed Brown    Not Collective
11491411c6eeSJed Brown 
11501411c6eeSJed Brown    Input Parameter:
11511411c6eeSJed Brown .  dm - the DM with block structure
11521411c6eeSJed Brown 
11531411c6eeSJed Brown    Output Parameter:
11541411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
11551411c6eeSJed Brown 
11561411c6eeSJed Brown    Level: intermediate
11571411c6eeSJed Brown 
1158fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
11591411c6eeSJed Brown @*/
11607087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
11611411c6eeSJed Brown {
11621411c6eeSJed Brown   PetscFunctionBegin;
11631411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1164534a8f05SLisandro Dalcin   PetscValidIntPointer(bs,2);
11651411c6eeSJed Brown   if (dm->bs < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet");
11661411c6eeSJed Brown   *bs = dm->bs;
11671411c6eeSJed Brown   PetscFunctionReturn(0);
11681411c6eeSJed Brown }
11691411c6eeSJed Brown 
117048eeb7c8SBarry Smith /*@C
11718472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
117247c6ae99SBarry Smith 
1173a5bc1bf3SBarry Smith     Collective on dmc
117447c6ae99SBarry Smith 
1175d8d19677SJose E. Roman     Input Parameters:
1176a5bc1bf3SBarry Smith +   dmc - the DM object
1177a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
117847c6ae99SBarry Smith 
1179d8d19677SJose E. Roman     Output Parameters:
118047c6ae99SBarry Smith +  mat - the interpolation
118147c6ae99SBarry Smith -  vec - the scaling (optional)
118247c6ae99SBarry Smith 
118347c6ae99SBarry Smith     Level: developer
118447c6ae99SBarry Smith 
118595452b02SPatrick Sanan     Notes:
118695452b02SPatrick 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
118785afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1188d52bd9f3SBarry Smith 
11891f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1190d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
119185afcc9aSBarry Smith 
11922ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale()
119347c6ae99SBarry Smith 
119447c6ae99SBarry Smith @*/
1195a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec)
119647c6ae99SBarry Smith {
119747c6ae99SBarry Smith   PetscErrorCode ierr;
119847c6ae99SBarry Smith 
119947c6ae99SBarry Smith   PetscFunctionBegin;
1200a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1201a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1202c7d20fa0SStefano Zampini   PetscValidPointer(mat,3);
1203a5bc1bf3SBarry Smith   if (!dmc->ops->createinterpolation) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name);
1204a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
1205a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr);
1206a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
120747c6ae99SBarry Smith   PetscFunctionReturn(0);
120847c6ae99SBarry Smith }
120947c6ae99SBarry Smith 
12103ad4599aSBarry Smith /*@
1211d3e313eaSPatrick Sanan     DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction.
12122ed6491fSPatrick Sanan 
12132ed6491fSPatrick Sanan   Input Parameters:
12142ed6491fSPatrick Sanan +      dac - DM that defines a coarse mesh
12152ed6491fSPatrick Sanan .      daf - DM that defines a fine mesh
12162ed6491fSPatrick Sanan -      mat - the restriction (or interpolation operator) from fine to coarse
12172ed6491fSPatrick Sanan 
12182ed6491fSPatrick Sanan   Output Parameter:
12192ed6491fSPatrick Sanan .    scale - the scaled vector
12202ed6491fSPatrick Sanan 
12212ed6491fSPatrick Sanan   Level: developer
12222ed6491fSPatrick Sanan 
12232ed6491fSPatrick Sanan .seealso: DMCreateInterpolation()
12242ed6491fSPatrick Sanan 
12252ed6491fSPatrick Sanan @*/
12262ed6491fSPatrick Sanan PetscErrorCode  DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale)
12272ed6491fSPatrick Sanan {
12282ed6491fSPatrick Sanan   PetscErrorCode ierr;
12292ed6491fSPatrick Sanan   Vec            fine;
12302ed6491fSPatrick Sanan   PetscScalar    one = 1.0;
12319704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
12329704db99SRichard Tran Mills   PetscBool      flg;
12339704db99SRichard Tran Mills #endif
12342ed6491fSPatrick Sanan 
12352ed6491fSPatrick Sanan   PetscFunctionBegin;
12362ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr);
12372ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr);
12382ed6491fSPatrick Sanan   ierr = VecSet(fine,one);CHKERRQ(ierr);
12399704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
12409704db99SRichard Tran Mills   /* If the 'fine' Vec is bound to the CPU, it makes sense to bind 'mat' as well.
12419704db99SRichard Tran Mills    * Note that we only do this for the CUDA case, right now, but if we add support for MatMultTranspose() via ViennaCL,
12429704db99SRichard Tran Mills    * we'll need to do it for that case, too.*/
1243*83aa49f4SRichard Tran Mills   if (fine->bindingpropagates) {
12449704db99SRichard Tran Mills     ierr = VecBoundToCPU(fine,&flg);CHKERRQ(ierr);
1245*83aa49f4SRichard Tran Mills     ierr = MatBindToCPU(mat,flg);CHKERRQ(ierr);
1246*83aa49f4SRichard Tran Mills   }
12479704db99SRichard Tran Mills #endif
12482ed6491fSPatrick Sanan   ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr);
12492ed6491fSPatrick Sanan   ierr = VecDestroy(&fine);CHKERRQ(ierr);
12502ed6491fSPatrick Sanan   ierr = VecReciprocal(*scale);CHKERRQ(ierr);
12512ed6491fSPatrick Sanan   PetscFunctionReturn(0);
12522ed6491fSPatrick Sanan }
12532ed6491fSPatrick Sanan 
12542ed6491fSPatrick Sanan /*@
12553ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
12563ad4599aSBarry Smith 
1257a5bc1bf3SBarry Smith     Collective on dmc
12583ad4599aSBarry Smith 
1259d8d19677SJose E. Roman     Input Parameters:
1260a5bc1bf3SBarry Smith +   dmc - the DM object
1261a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
12623ad4599aSBarry Smith 
12633ad4599aSBarry Smith     Output Parameter:
12643ad4599aSBarry Smith .  mat - the restriction
12653ad4599aSBarry Smith 
12663ad4599aSBarry Smith     Level: developer
12673ad4599aSBarry Smith 
126895452b02SPatrick Sanan     Notes:
126995452b02SPatrick 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
12703ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
12713ad4599aSBarry Smith 
12723ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
12733ad4599aSBarry Smith 
12743ad4599aSBarry Smith @*/
1275a5bc1bf3SBarry Smith PetscErrorCode  DMCreateRestriction(DM dmc,DM dmf,Mat *mat)
12763ad4599aSBarry Smith {
12773ad4599aSBarry Smith   PetscErrorCode ierr;
12783ad4599aSBarry Smith 
12793ad4599aSBarry Smith   PetscFunctionBegin;
1280a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1281a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
12825a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1283a5bc1bf3SBarry Smith   if (!dmc->ops->createrestriction) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name);
1284a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
1285a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr);
1286a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
12873ad4599aSBarry Smith   PetscFunctionReturn(0);
12883ad4599aSBarry Smith }
12893ad4599aSBarry Smith 
129047c6ae99SBarry Smith /*@
12918472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
129247c6ae99SBarry Smith 
1293a5bc1bf3SBarry Smith     Collective on dac
129447c6ae99SBarry Smith 
1295d8d19677SJose E. Roman     Input Parameters:
1296a5bc1bf3SBarry Smith +   dac - the DM object
1297a5bc1bf3SBarry Smith -   daf - the second, finer DM object
129847c6ae99SBarry Smith 
129947c6ae99SBarry Smith     Output Parameter:
13006dbf9973SLawrence Mitchell .   mat - the injection
130147c6ae99SBarry Smith 
130247c6ae99SBarry Smith     Level: developer
130347c6ae99SBarry Smith 
130495452b02SPatrick Sanan    Notes:
130595452b02SPatrick 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
130685afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
130785afcc9aSBarry Smith 
1308e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
130947c6ae99SBarry Smith 
131047c6ae99SBarry Smith @*/
1311a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInjection(DM dac,DM daf,Mat *mat)
131247c6ae99SBarry Smith {
131347c6ae99SBarry Smith   PetscErrorCode ierr;
131447c6ae99SBarry Smith 
131547c6ae99SBarry Smith   PetscFunctionBegin;
1316a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac,DM_CLASSID,1);
1317a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf,DM_CLASSID,2);
13185a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1319a5bc1bf3SBarry Smith   if (!dac->ops->createinjection) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name);
1320a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
1321a5bc1bf3SBarry Smith   ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr);
1322a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
132347c6ae99SBarry Smith   PetscFunctionReturn(0);
132447c6ae99SBarry Smith }
132547c6ae99SBarry Smith 
1326b412c318SBarry Smith /*@
1327bd041c0cSMatthew G. Knepley   DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j
1328bd041c0cSMatthew G. Knepley 
1329a5bc1bf3SBarry Smith   Collective on dac
1330bd041c0cSMatthew G. Knepley 
1331d8d19677SJose E. Roman   Input Parameters:
1332a5bc1bf3SBarry Smith + dac - the DM object
1333a5bc1bf3SBarry Smith - daf - the second, finer DM object
1334bd041c0cSMatthew G. Knepley 
1335bd041c0cSMatthew G. Knepley   Output Parameter:
1336bd041c0cSMatthew G. Knepley . mat - the interpolation
1337bd041c0cSMatthew G. Knepley 
1338bd041c0cSMatthew G. Knepley   Level: developer
1339bd041c0cSMatthew G. Knepley 
1340bd041c0cSMatthew G. Knepley .seealso DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1341bd041c0cSMatthew G. Knepley @*/
1342a5bc1bf3SBarry Smith PetscErrorCode DMCreateMassMatrix(DM dac, DM daf, Mat *mat)
1343bd041c0cSMatthew G. Knepley {
1344bd041c0cSMatthew G. Knepley   PetscErrorCode ierr;
1345bd041c0cSMatthew G. Knepley 
1346bd041c0cSMatthew G. Knepley   PetscFunctionBegin;
1347a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac, DM_CLASSID, 1);
1348a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf, DM_CLASSID, 2);
13495a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
1350a5bc1bf3SBarry Smith   if (!dac->ops->createmassmatrix) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dac)->type_name);
1351a5bc1bf3SBarry Smith   ierr = (*dac->ops->createmassmatrix)(dac, daf, mat);CHKERRQ(ierr);
1352bd041c0cSMatthew G. Knepley   PetscFunctionReturn(0);
1353bd041c0cSMatthew G. Knepley }
1354bd041c0cSMatthew G. Knepley 
1355bd041c0cSMatthew G. Knepley /*@
1356b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
135747c6ae99SBarry Smith 
1358d083f849SBarry Smith     Collective on dm
135947c6ae99SBarry Smith 
1360d8d19677SJose E. Roman     Input Parameters:
136147c6ae99SBarry Smith +   dm - the DM object
13625bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
136347c6ae99SBarry Smith 
136447c6ae99SBarry Smith     Output Parameter:
136547c6ae99SBarry Smith .   coloring - the coloring
136647c6ae99SBarry Smith 
1367ec5066bdSBarry Smith     Notes:
1368ec5066bdSBarry 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
1369ec5066bdSBarry Smith        matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors).
1370ec5066bdSBarry Smith 
1371ec5066bdSBarry Smith        This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate()
1372ec5066bdSBarry Smith 
137347c6ae99SBarry Smith     Level: developer
137447c6ae99SBarry Smith 
1375ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate()
137647c6ae99SBarry Smith 
1377aab9d709SJed Brown @*/
1378b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
137947c6ae99SBarry Smith {
138047c6ae99SBarry Smith   PetscErrorCode ierr;
138147c6ae99SBarry Smith 
138247c6ae99SBarry Smith   PetscFunctionBegin;
1383171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
13845a84ad33SLisandro Dalcin   PetscValidPointer(coloring,3);
1385b9d85ea2SLisandro Dalcin   if (!dm->ops->getcoloring) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name);
1386b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
138747c6ae99SBarry Smith   PetscFunctionReturn(0);
138847c6ae99SBarry Smith }
138947c6ae99SBarry Smith 
1390b412c318SBarry Smith /*@
13918472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
139247c6ae99SBarry Smith 
1393d083f849SBarry Smith     Collective on dm
139447c6ae99SBarry Smith 
139547c6ae99SBarry Smith     Input Parameter:
1396b412c318SBarry Smith .   dm - the DM object
139747c6ae99SBarry Smith 
139847c6ae99SBarry Smith     Output Parameter:
139947c6ae99SBarry Smith .   mat - the empty Jacobian
140047c6ae99SBarry Smith 
1401073dac72SJed Brown     Level: beginner
140247c6ae99SBarry Smith 
1403f27dd7c6SMatthew G. Knepley     Options Database Keys:
1404f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1405f27dd7c6SMatthew G. Knepley 
140695452b02SPatrick Sanan     Notes:
140795452b02SPatrick Sanan     This properly preallocates the number of nonzeros in the sparse matrix so you
140894013140SBarry Smith        do not need to do it yourself.
140994013140SBarry Smith 
141094013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
14117889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
141294013140SBarry Smith 
141394013140SBarry 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
141494013140SBarry Smith        internally by PETSc.
141594013140SBarry Smith 
141694013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1417aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
141894013140SBarry Smith 
1419b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
142047c6ae99SBarry Smith 
1421aab9d709SJed Brown @*/
1422b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
142347c6ae99SBarry Smith {
142447c6ae99SBarry Smith   PetscErrorCode ierr;
142547c6ae99SBarry Smith 
142647c6ae99SBarry Smith   PetscFunctionBegin;
1427171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1428064a246eSJacob Faibussowitsch   PetscValidPointer(mat,2);
1429b9d85ea2SLisandro Dalcin   if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
14305a84ad33SLisandro Dalcin   ierr = MatInitializePackage();CHKERRQ(ierr);
1431fdc842d1SBarry Smith   ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1432b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
143376bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1434c6b011d8SStefano Zampini     DM mdm;
1435c6b011d8SStefano Zampini 
1436c6b011d8SStefano Zampini     ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr);
1437c6b011d8SStefano Zampini     if (!mdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix\n",((PetscObject)dm)->type_name);
1438c6b011d8SStefano Zampini   }
1439e571a35bSMatthew G. Knepley   /* Handle nullspace and near nullspace */
1440e5e52638SMatthew G. Knepley   if (dm->Nf) {
1441e571a35bSMatthew G. Knepley     MatNullSpace nullSpace;
1442649ef022SMatthew Knepley     PetscInt     Nf, f;
1443e571a35bSMatthew G. Knepley 
1444e5e52638SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
1445649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1446649ef022SMatthew Knepley       if (dm->nullspaceConstructors[f]) {
1447649ef022SMatthew Knepley         ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1448e571a35bSMatthew G. Knepley         ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1449e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1450649ef022SMatthew Knepley         break;
1451e571a35bSMatthew G. Knepley       }
1452649ef022SMatthew Knepley     }
1453649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1454649ef022SMatthew Knepley       if (dm->nearnullspaceConstructors[f]) {
1455649ef022SMatthew Knepley         ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1456e571a35bSMatthew G. Knepley         ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1457e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1458e571a35bSMatthew G. Knepley       }
1459e571a35bSMatthew G. Knepley     }
1460e571a35bSMatthew G. Knepley   }
1461fdc842d1SBarry Smith   ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
146247c6ae99SBarry Smith   PetscFunctionReturn(0);
146347c6ae99SBarry Smith }
146447c6ae99SBarry Smith 
1465732e2eb9SMatthew G Knepley /*@
1466950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1467732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1468732e2eb9SMatthew G Knepley 
1469d083f849SBarry Smith   Logically Collective on dm
1470732e2eb9SMatthew G Knepley 
1471d8d19677SJose E. Roman   Input Parameters:
1472732e2eb9SMatthew G Knepley + dm - the DM
1473732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1474732e2eb9SMatthew G Knepley 
1475732e2eb9SMatthew G Knepley   Level: developer
1476f27dd7c6SMatthew G. Knepley 
1477f27dd7c6SMatthew G. Knepley   Options Database Keys:
1478f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1479f27dd7c6SMatthew G. Knepley 
1480b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1481732e2eb9SMatthew G Knepley @*/
1482732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1483732e2eb9SMatthew G Knepley {
1484732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1485732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1486732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1487732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1488732e2eb9SMatthew G Knepley }
1489732e2eb9SMatthew G Knepley 
1490b06ff27eSHong Zhang /*@
1491b06ff27eSHong Zhang   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1492b06ff27eSHong Zhang     but the array for values will not be allocated.
1493b06ff27eSHong Zhang 
1494d083f849SBarry Smith   Logically Collective on dm
1495b06ff27eSHong Zhang 
1496d8d19677SJose E. Roman   Input Parameters:
1497b06ff27eSHong Zhang + dm - the DM
1498b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture
1499b06ff27eSHong Zhang 
1500b06ff27eSHong Zhang   Level: developer
1501b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1502b06ff27eSHong Zhang @*/
1503b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1504b06ff27eSHong Zhang {
1505b06ff27eSHong Zhang   PetscFunctionBegin;
1506b06ff27eSHong Zhang   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1507b06ff27eSHong Zhang   dm->structure_only = only;
1508b06ff27eSHong Zhang   PetscFunctionReturn(0);
1509b06ff27eSHong Zhang }
1510b06ff27eSHong Zhang 
1511a89ea682SMatthew G Knepley /*@C
1512aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1513a89ea682SMatthew G Knepley 
1514a89ea682SMatthew G Knepley   Not Collective
1515a89ea682SMatthew G Knepley 
1516a89ea682SMatthew G Knepley   Input Parameters:
1517a89ea682SMatthew G Knepley + dm - the DM object
1518a5b23f4aSJose E. Roman . count - The minimum size
151969291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1520a89ea682SMatthew G Knepley 
1521a89ea682SMatthew G Knepley   Output Parameter:
1522a89ea682SMatthew G Knepley . array - the work array
1523a89ea682SMatthew G Knepley 
1524a89ea682SMatthew G Knepley   Level: developer
1525a89ea682SMatthew G Knepley 
1526a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1527a89ea682SMatthew G Knepley @*/
152869291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1529a89ea682SMatthew G Knepley {
1530a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1531aa1993deSMatthew G Knepley   DMWorkLink     link;
153269291d52SBarry Smith   PetscMPIInt    dsize;
1533a89ea682SMatthew G Knepley 
1534a89ea682SMatthew G Knepley   PetscFunctionBegin;
1535a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1536aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1537aa1993deSMatthew G Knepley   if (dm->workin) {
1538aa1993deSMatthew G Knepley     link       = dm->workin;
1539aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1540aa1993deSMatthew G Knepley   } else {
1541b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1542a89ea682SMatthew G Knepley   }
1543ffc4695bSBarry Smith   ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr);
15445056fcd2SBarry Smith   if (((size_t)dsize*count) > link->bytes) {
1545aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1546854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1547854ce69bSBarry Smith     link->bytes = dsize*count;
1548aa1993deSMatthew G Knepley   }
1549aa1993deSMatthew G Knepley   link->next   = dm->workout;
1550aa1993deSMatthew G Knepley   dm->workout  = link;
155100d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
155200d952a4SJed Brown   VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count);
155300d952a4SJed Brown   VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count);
155400d952a4SJed Brown #endif
1555aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1556a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1557a89ea682SMatthew G Knepley }
1558a89ea682SMatthew G Knepley 
1559aa1993deSMatthew G Knepley /*@C
1560aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1561aa1993deSMatthew G Knepley 
1562aa1993deSMatthew G Knepley   Not Collective
1563aa1993deSMatthew G Knepley 
1564aa1993deSMatthew G Knepley   Input Parameters:
1565aa1993deSMatthew 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
1568aa1993deSMatthew G Knepley 
1569aa1993deSMatthew G Knepley   Output Parameter:
1570aa1993deSMatthew G Knepley . array - the work array
1571aa1993deSMatthew G Knepley 
1572aa1993deSMatthew G Knepley   Level: developer
1573aa1993deSMatthew G Knepley 
157495452b02SPatrick Sanan   Developer Notes:
157595452b02SPatrick Sanan     count and dtype are ignored, they are only needed for DMGetWorkArray()
1576aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1577aa1993deSMatthew G Knepley @*/
157869291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1579aa1993deSMatthew G Knepley {
1580aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1581aa1993deSMatthew G Knepley 
1582aa1993deSMatthew G Knepley   PetscFunctionBegin;
1583aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1584aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1585aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1586aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1587aa1993deSMatthew G Knepley       *p           = link->next;
1588aa1993deSMatthew G Knepley       link->next   = dm->workin;
1589aa1993deSMatthew G Knepley       dm->workin   = link;
15900298fd71SBarry Smith       *(void**)mem = NULL;
1591aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1592aa1993deSMatthew G Knepley     }
1593aa1993deSMatthew G Knepley   }
1594aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1595aa1993deSMatthew G Knepley }
1596e7c4fc90SDmitry Karpeev 
15978cda7954SMatthew G. Knepley /*@C
15988cda7954SMatthew G. Knepley   DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field
15998cda7954SMatthew G. Knepley 
16008cda7954SMatthew G. Knepley   Logically collective on DM
16018cda7954SMatthew G. Knepley 
16028cda7954SMatthew G. Knepley   Input Parameters:
16038cda7954SMatthew G. Knepley + dm     - The DM
16048cda7954SMatthew G. Knepley . field  - The field number for the nullspace
16058cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace
16068cda7954SMatthew G. Knepley 
16078cda7954SMatthew G. Knepley   Notes:
16088cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16098cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16108cda7954SMatthew G. Knepley $ dm        - The present DM
16118cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16128cda7954SMatthew G. Knepley $ field     - The field number in dm
16138cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16148cda7954SMatthew G. Knepley 
16158cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16168cda7954SMatthew G. Knepley 
16178cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16188cda7954SMatthew G. Knepley */
16198cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1620435a35e8SMatthew G Knepley {
1621435a35e8SMatthew G Knepley   PetscFunctionBegin;
1622435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
162382f516ccSBarry Smith   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1624435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1625435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1626435a35e8SMatthew G Knepley }
1627435a35e8SMatthew G Knepley 
16288cda7954SMatthew G. Knepley /*@C
16298cda7954SMatthew G. Knepley   DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL
16308cda7954SMatthew G. Knepley 
16318cda7954SMatthew G. Knepley   Not collective
16328cda7954SMatthew G. Knepley 
16338cda7954SMatthew G. Knepley   Input Parameters:
16348cda7954SMatthew G. Knepley + dm     - The DM
16358cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16368cda7954SMatthew G. Knepley 
16378cda7954SMatthew G. Knepley   Output Parameter:
16388cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace
16398cda7954SMatthew G. Knepley 
16408cda7954SMatthew G. Knepley   Notes:
16418cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16428cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16438cda7954SMatthew G. Knepley $ dm        - The present DM
16448cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16458cda7954SMatthew G. Knepley $ field     - The field number in dm
16468cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16478cda7954SMatthew G. Knepley 
16488cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16498cda7954SMatthew G. Knepley 
16508cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16518cda7954SMatthew G. Knepley */
16528cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
16530a50eb56SMatthew G. Knepley {
16540a50eb56SMatthew G. Knepley   PetscFunctionBegin;
16550a50eb56SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1656f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
16570a50eb56SMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
16580a50eb56SMatthew G. Knepley   *nullsp = dm->nullspaceConstructors[field];
16590a50eb56SMatthew G. Knepley   PetscFunctionReturn(0);
16600a50eb56SMatthew G. Knepley }
16610a50eb56SMatthew G. Knepley 
16628cda7954SMatthew G. Knepley /*@C
16638cda7954SMatthew G. Knepley   DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field
16648cda7954SMatthew G. Knepley 
16658cda7954SMatthew G. Knepley   Logically collective on DM
16668cda7954SMatthew G. Knepley 
16678cda7954SMatthew G. Knepley   Input Parameters:
16688cda7954SMatthew G. Knepley + dm     - The DM
16698cda7954SMatthew G. Knepley . field  - The field number for the nullspace
16708cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace
16718cda7954SMatthew G. Knepley 
16728cda7954SMatthew G. Knepley   Notes:
16738cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16748cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16758cda7954SMatthew G. Knepley $ dm        - The present DM
16768cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16778cda7954SMatthew G. Knepley $ field     - The field number in dm
16788cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16798cda7954SMatthew G. Knepley 
16808cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16818cda7954SMatthew G. Knepley 
16828cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16838cda7954SMatthew G. Knepley */
16848cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1685f9d4088aSMatthew G. Knepley {
1686f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1687f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1688f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1689f9d4088aSMatthew G. Knepley   dm->nearnullspaceConstructors[field] = nullsp;
1690f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1691f9d4088aSMatthew G. Knepley }
1692f9d4088aSMatthew G. Knepley 
16938cda7954SMatthew G. Knepley /*@C
16948cda7954SMatthew G. Knepley   DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL
16958cda7954SMatthew G. Knepley 
16968cda7954SMatthew G. Knepley   Not collective
16978cda7954SMatthew G. Knepley 
16988cda7954SMatthew G. Knepley   Input Parameters:
16998cda7954SMatthew G. Knepley + dm     - The DM
17008cda7954SMatthew G. Knepley - field  - The field number for the nullspace
17018cda7954SMatthew G. Knepley 
17028cda7954SMatthew G. Knepley   Output Parameter:
17038cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace
17048cda7954SMatthew G. Knepley 
17058cda7954SMatthew G. Knepley   Notes:
17068cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
17078cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
17088cda7954SMatthew G. Knepley $ dm        - The present DM
17098cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
17108cda7954SMatthew G. Knepley $ field     - The field number in dm
17118cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
17128cda7954SMatthew G. Knepley 
17138cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
17148cda7954SMatthew G. Knepley 
17158cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
17168cda7954SMatthew G. Knepley */
17178cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1718f9d4088aSMatthew G. Knepley {
1719f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1720f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1721f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
1722f9d4088aSMatthew G. Knepley   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1723f9d4088aSMatthew G. Knepley   *nullsp = dm->nearnullspaceConstructors[field];
1724f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1725f9d4088aSMatthew G. Knepley }
1726f9d4088aSMatthew G. Knepley 
17274f3b5142SJed Brown /*@C
17284d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
17294d343eeaSMatthew G Knepley 
17304d343eeaSMatthew G Knepley   Not collective
17314d343eeaSMatthew G Knepley 
17324d343eeaSMatthew G Knepley   Input Parameter:
17334d343eeaSMatthew G Knepley . dm - the DM object
17344d343eeaSMatthew G Knepley 
17354d343eeaSMatthew G Knepley   Output Parameters:
17360298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
17370298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
17380298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
17394d343eeaSMatthew G Knepley 
17404d343eeaSMatthew G Knepley   Level: intermediate
17414d343eeaSMatthew G Knepley 
174221c9b008SJed Brown   Notes:
174321c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
174421c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
174521c9b008SJed Brown   PetscFree().
174621c9b008SJed Brown 
17474d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
17484d343eeaSMatthew G Knepley @*/
174937d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
17504d343eeaSMatthew G Knepley {
175137d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
17524d343eeaSMatthew G Knepley   PetscErrorCode ierr;
17534d343eeaSMatthew G Knepley 
17544d343eeaSMatthew G Knepley   PetscFunctionBegin;
17554d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
175669ca1f37SDmitry Karpeev   if (numFields) {
1757534a8f05SLisandro Dalcin     PetscValidIntPointer(numFields,2);
175869ca1f37SDmitry Karpeev     *numFields = 0;
175969ca1f37SDmitry Karpeev   }
176037d0c07bSMatthew G Knepley   if (fieldNames) {
176137d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
17620298fd71SBarry Smith     *fieldNames = NULL;
176369ca1f37SDmitry Karpeev   }
176469ca1f37SDmitry Karpeev   if (fields) {
176569ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
17660298fd71SBarry Smith     *fields = NULL;
176769ca1f37SDmitry Karpeev   }
176892fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
176937d0c07bSMatthew G Knepley   if (section) {
17703a544194SStefano Zampini     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
177137d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
177237d0c07bSMatthew G Knepley 
1773e87a4003SBarry Smith     ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
177437d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
17753a544194SStefano Zampini     ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr);
177637d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
177737d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
177837d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
17793a544194SStefano Zampini       ierr          = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr);
178037d0c07bSMatthew G Knepley     }
178137d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
178237d0c07bSMatthew G Knepley       PetscInt gdof;
178337d0c07bSMatthew G Knepley 
178437d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
178537d0c07bSMatthew G Knepley       if (gdof > 0) {
178637d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
17873a544194SStefano Zampini           PetscInt fdof, fcdof, fpdof;
178837d0c07bSMatthew G Knepley 
178937d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
179037d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
17913a544194SStefano Zampini           fpdof = fdof-fcdof;
17923a544194SStefano Zampini           if (fpdof && fpdof != fieldNc[f]) {
17933a544194SStefano Zampini             /* Layout does not admit a pointwise block size */
17943a544194SStefano Zampini             fieldNc[f] = 1;
17953a544194SStefano Zampini           }
17963a544194SStefano Zampini           fieldSizes[f] += fpdof;
179737d0c07bSMatthew G Knepley         }
179837d0c07bSMatthew G Knepley       }
179937d0c07bSMatthew G Knepley     }
180037d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1801785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
180237d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
180337d0c07bSMatthew G Knepley     }
180437d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
180537d0c07bSMatthew G Knepley       PetscInt gdof, goff;
180637d0c07bSMatthew G Knepley 
180737d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
180837d0c07bSMatthew G Knepley       if (gdof > 0) {
180937d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
181037d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
181137d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
181237d0c07bSMatthew G Knepley 
181337d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
181437d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
181537d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
181637d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
181737d0c07bSMatthew G Knepley           }
181837d0c07bSMatthew G Knepley         }
181937d0c07bSMatthew G Knepley       }
182037d0c07bSMatthew G Knepley     }
18218865f1eaSKarl Rupp     if (numFields) *numFields = nF;
182237d0c07bSMatthew G Knepley     if (fieldNames) {
1823785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
182437d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
182537d0c07bSMatthew G Knepley         const char *fieldName;
182637d0c07bSMatthew G Knepley 
182737d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
182837d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
182937d0c07bSMatthew G Knepley       }
183037d0c07bSMatthew G Knepley     }
183137d0c07bSMatthew G Knepley     if (fields) {
1832785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
183337d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
18343a544194SStefano Zampini         PetscInt bs, in[2], out[2];
18353a544194SStefano Zampini 
183682f516ccSBarry Smith         ierr  = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
18373a544194SStefano Zampini         in[0] = -fieldNc[f];
18383a544194SStefano Zampini         in[1] = fieldNc[f];
1839820f2d46SBarry Smith         ierr  = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
18403a544194SStefano Zampini         bs    = (-out[0] == out[1]) ? out[1] : 1;
18413a544194SStefano Zampini         ierr  = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr);
184237d0c07bSMatthew G Knepley       }
184337d0c07bSMatthew G Knepley     }
18443a544194SStefano Zampini     ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr);
18458865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
18468865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
184769ca1f37SDmitry Karpeev   }
18484d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
18494d343eeaSMatthew G Knepley }
18504d343eeaSMatthew G Knepley 
185116621825SDmitry Karpeev /*@C
185216621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
185316621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
185416621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1855e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1856e7c4fc90SDmitry Karpeev 
1857e7c4fc90SDmitry Karpeev   Not collective
1858e7c4fc90SDmitry Karpeev 
1859e7c4fc90SDmitry Karpeev   Input Parameter:
1860e7c4fc90SDmitry Karpeev . dm - the DM object
1861e7c4fc90SDmitry Karpeev 
1862e7c4fc90SDmitry Karpeev   Output Parameters:
18630298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
18640298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
18650298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
18660298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1867e7c4fc90SDmitry Karpeev 
1868e7c4fc90SDmitry Karpeev   Level: intermediate
1869e7c4fc90SDmitry Karpeev 
1870e7c4fc90SDmitry Karpeev   Notes:
1871e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1872e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1873e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1874e7c4fc90SDmitry Karpeev 
1875e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1876e7c4fc90SDmitry Karpeev @*/
187716621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1878e7c4fc90SDmitry Karpeev {
1879e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1880e7c4fc90SDmitry Karpeev 
1881e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1882e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
18838865f1eaSKarl Rupp   if (len) {
1884534a8f05SLisandro Dalcin     PetscValidIntPointer(len,2);
18858865f1eaSKarl Rupp     *len = 0;
18868865f1eaSKarl Rupp   }
18878865f1eaSKarl Rupp   if (namelist) {
18888865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
1889ea78f98cSLisandro Dalcin     *namelist = NULL;
18908865f1eaSKarl Rupp   }
18918865f1eaSKarl Rupp   if (islist) {
18928865f1eaSKarl Rupp     PetscValidPointer(islist,4);
1893ea78f98cSLisandro Dalcin     *islist = NULL;
18948865f1eaSKarl Rupp   }
18958865f1eaSKarl Rupp   if (dmlist) {
18968865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
1897ea78f98cSLisandro Dalcin     *dmlist = NULL;
18988865f1eaSKarl Rupp   }
1899f3f0edfdSDmitry Karpeev   /*
1900f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1901f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1902f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1903f3f0edfdSDmitry Karpeev    */
1904ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
190516621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1906435a35e8SMatthew G Knepley     PetscSection section;
1907435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1908435a35e8SMatthew G Knepley 
190992fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1910435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1911435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1912f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
191303dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
191403dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
191503dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1916435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1917435a35e8SMatthew G Knepley         const char *fieldName;
1918435a35e8SMatthew G Knepley 
191903dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
192003dc3394SMatthew G. Knepley         if (namelist) {
1921435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1922435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1923435a35e8SMatthew G Knepley         }
192403dc3394SMatthew G. Knepley       }
1925435a35e8SMatthew G Knepley     } else {
192669ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1927e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
19280298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1929e7c4fc90SDmitry Karpeev     }
19308865f1eaSKarl Rupp   } else {
193116621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
193216621825SDmitry Karpeev   }
193316621825SDmitry Karpeev   PetscFunctionReturn(0);
193416621825SDmitry Karpeev }
193516621825SDmitry Karpeev 
1936564cec59SMatthew G. Knepley /*@
1937435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1938435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1939435a35e8SMatthew G Knepley 
1940435a35e8SMatthew G Knepley   Not collective
1941435a35e8SMatthew G Knepley 
1942435a35e8SMatthew G Knepley   Input Parameters:
19432adcc780SMatthew G. Knepley + dm        - The DM object
19442adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem
19452adcc780SMatthew G. Knepley - fields    - The field numbers of the selected fields
1946435a35e8SMatthew G Knepley 
1947435a35e8SMatthew G Knepley   Output Parameters:
19482adcc780SMatthew G. Knepley + is - The global indices for the subproblem
19492adcc780SMatthew G. Knepley - subdm - The DM for the subproblem
1950435a35e8SMatthew G Knepley 
19515d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19525d3b26e6SMatthew G. Knepley 
1953435a35e8SMatthew G Knepley   Level: intermediate
1954435a35e8SMatthew G Knepley 
19555d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1956435a35e8SMatthew G Knepley @*/
195737bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
1958435a35e8SMatthew G Knepley {
1959435a35e8SMatthew G Knepley   PetscErrorCode ierr;
1960435a35e8SMatthew G Knepley 
1961435a35e8SMatthew G Knepley   PetscFunctionBegin;
1962435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1963435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
19648865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
19658865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
1966b9d85ea2SLisandro Dalcin   if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
1967435a35e8SMatthew G Knepley   ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
1968435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1969435a35e8SMatthew G Knepley }
1970435a35e8SMatthew G Knepley 
19712adcc780SMatthew G. Knepley /*@C
19722adcc780SMatthew G. Knepley   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
19732adcc780SMatthew G. Knepley 
19742adcc780SMatthew G. Knepley   Not collective
19752adcc780SMatthew G. Knepley 
1976d8d19677SJose E. Roman   Input Parameters:
19772adcc780SMatthew G. Knepley + dms - The DM objects
19782adcc780SMatthew G. Knepley - len - The number of DMs
19792adcc780SMatthew G. Knepley 
19802adcc780SMatthew G. Knepley   Output Parameters:
1981a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL
19822adcc780SMatthew G. Knepley - superdm - The DM for the superproblem
19832adcc780SMatthew G. Knepley 
19845d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19855d3b26e6SMatthew G. Knepley 
19862adcc780SMatthew G. Knepley   Level: intermediate
19872adcc780SMatthew G. Knepley 
19885d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
19892adcc780SMatthew G. Knepley @*/
19902adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
19912adcc780SMatthew G. Knepley {
19922adcc780SMatthew G. Knepley   PetscInt       i;
19932adcc780SMatthew G. Knepley   PetscErrorCode ierr;
19942adcc780SMatthew G. Knepley 
19952adcc780SMatthew G. Knepley   PetscFunctionBegin;
19962adcc780SMatthew G. Knepley   PetscValidPointer(dms,1);
19972adcc780SMatthew G. Knepley   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
19982adcc780SMatthew G. Knepley   if (is) PetscValidPointer(is,3);
1999a42bd24dSMatthew G. Knepley   PetscValidPointer(superdm,4);
20002adcc780SMatthew G. Knepley   if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
20012adcc780SMatthew G. Knepley   if (len) {
2002b9d85ea2SLisandro Dalcin     DM dm = dms[0];
2003b9d85ea2SLisandro Dalcin     if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
2004b9d85ea2SLisandro Dalcin     ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr);
20052adcc780SMatthew G. Knepley   }
20062adcc780SMatthew G. Knepley   PetscFunctionReturn(0);
20072adcc780SMatthew G. Knepley }
20082adcc780SMatthew G. Knepley 
200916621825SDmitry Karpeev /*@C
20108d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
20118d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
20128d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
20138d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
20148d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
201516621825SDmitry Karpeev 
201616621825SDmitry Karpeev   Not collective
201716621825SDmitry Karpeev 
201816621825SDmitry Karpeev   Input Parameter:
201916621825SDmitry Karpeev . dm - the DM object
202016621825SDmitry Karpeev 
202116621825SDmitry Karpeev   Output Parameters:
20220298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
20230298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
20240298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
20250298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
20260298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
202716621825SDmitry Karpeev 
202816621825SDmitry Karpeev   Level: intermediate
202916621825SDmitry Karpeev 
203016621825SDmitry Karpeev   Notes:
203116621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
203216621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
203316621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
203416621825SDmitry Karpeev 
2035245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition()
203616621825SDmitry Karpeev @*/
20378d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
203816621825SDmitry Karpeev {
203916621825SDmitry Karpeev   PetscErrorCode      ierr;
2040be081cd6SPeter Brune   DMSubDomainHookLink link;
2041be081cd6SPeter Brune   PetscInt            i,l;
204216621825SDmitry Karpeev 
204316621825SDmitry Karpeev   PetscFunctionBegin;
204416621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
204514a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
20460298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
20470298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
20480298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
20490298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
2050f3f0edfdSDmitry Karpeev   /*
2051f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
2052f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
2053f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
2054f3f0edfdSDmitry Karpeev    */
2055ce94432eSBarry Smith   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
205616621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
2057be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
205814a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
2059f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
2060be081cd6SPeter Brune       for (i = 0; i < l; i++) {
2061be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
2062be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
2063be081cd6SPeter Brune         }
2064648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
2065e7c4fc90SDmitry Karpeev       }
206614a18fd3SPeter Brune     }
206714a18fd3SPeter Brune     if (len) *len = l;
206814a18fd3SPeter Brune   }
2069e30e807fSPeter Brune   PetscFunctionReturn(0);
2070e30e807fSPeter Brune }
2071e30e807fSPeter Brune 
2072e30e807fSPeter Brune /*@C
2073e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
2074e30e807fSPeter Brune 
2075e30e807fSPeter Brune   Not collective
2076e30e807fSPeter Brune 
2077e30e807fSPeter Brune   Input Parameters:
2078e30e807fSPeter Brune + dm - the DM object
2079e30e807fSPeter Brune . n  - the number of subdomain scatters
2080e30e807fSPeter Brune - subdms - the local subdomains
2081e30e807fSPeter Brune 
2082e30e807fSPeter Brune   Output Parameters:
20836b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2084e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2085e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2086e30e807fSPeter Brune 
208795452b02SPatrick Sanan   Notes:
208895452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2089e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2090e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2091e30e807fSPeter Brune   solution and residual data.
2092e30e807fSPeter Brune 
2093e30e807fSPeter Brune   Level: developer
2094e30e807fSPeter Brune 
2095e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2096e30e807fSPeter Brune @*/
2097e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2098e30e807fSPeter Brune {
2099e30e807fSPeter Brune   PetscErrorCode ierr;
2100e30e807fSPeter Brune 
2101e30e807fSPeter Brune   PetscFunctionBegin;
2102e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2103e30e807fSPeter Brune   PetscValidPointer(subdms,3);
2104b9d85ea2SLisandro Dalcin   if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
2105e30e807fSPeter Brune   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
2106e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2107e7c4fc90SDmitry Karpeev }
2108e7c4fc90SDmitry Karpeev 
210947c6ae99SBarry Smith /*@
211047c6ae99SBarry Smith   DMRefine - Refines a DM object
211147c6ae99SBarry Smith 
2112d083f849SBarry Smith   Collective on dm
211347c6ae99SBarry Smith 
2114d8d19677SJose E. Roman   Input Parameters:
211547c6ae99SBarry Smith + dm   - the DM object
211691d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
211747c6ae99SBarry Smith 
211847c6ae99SBarry Smith   Output Parameter:
21190298fd71SBarry Smith . dmf - the refined DM, or NULL
2120ae0a1c52SMatthew G Knepley 
2121f27dd7c6SMatthew G. Knepley   Options Database Keys:
2122412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2123412e9a14SMatthew G. Knepley 
21240298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
212547c6ae99SBarry Smith 
212647c6ae99SBarry Smith   Level: developer
212747c6ae99SBarry Smith 
2128e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
212947c6ae99SBarry Smith @*/
21307087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
213147c6ae99SBarry Smith {
213247c6ae99SBarry Smith   PetscErrorCode   ierr;
2133c833c3b5SJed Brown   DMRefineHookLink link;
213447c6ae99SBarry Smith 
213547c6ae99SBarry Smith   PetscFunctionBegin;
2136732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2137b9d85ea2SLisandro Dalcin   if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
21381ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
213947c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
21404057135bSMatthew G Knepley   if (*dmf) {
214143842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
21428865f1eaSKarl Rupp 
21438cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
21448865f1eaSKarl Rupp 
2145644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
21460598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2147656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
21488865f1eaSKarl Rupp 
2149e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
2150c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
21518865f1eaSKarl Rupp       if (link->refinehook) {
21528865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
21538865f1eaSKarl Rupp       }
2154c833c3b5SJed Brown     }
2155c833c3b5SJed Brown   }
21561ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
2157c833c3b5SJed Brown   PetscFunctionReturn(0);
2158c833c3b5SJed Brown }
2159c833c3b5SJed Brown 
2160bb9467b5SJed Brown /*@C
2161c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2162c833c3b5SJed Brown 
2163c833c3b5SJed Brown    Logically Collective
2164c833c3b5SJed Brown 
21654165533cSJose E. Roman    Input Parameters:
2166c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2167c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2168c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
21690298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2170c833c3b5SJed Brown 
2171c833c3b5SJed Brown    Calling sequence of refinehook:
2172c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2173c833c3b5SJed Brown 
2174c833c3b5SJed Brown +  coarse - coarse level DM
2175c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2176c833c3b5SJed Brown -  ctx - optional user-defined function context
2177c833c3b5SJed Brown 
2178c833c3b5SJed Brown    Calling sequence for interphook:
2179c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2180c833c3b5SJed Brown 
2181c833c3b5SJed Brown +  coarse - coarse level DM
2182c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2183c833c3b5SJed Brown .  fine - fine level DM to update
2184c833c3b5SJed Brown -  ctx - optional user-defined function context
2185c833c3b5SJed Brown 
2186c833c3b5SJed Brown    Level: advanced
2187c833c3b5SJed Brown 
2188c833c3b5SJed Brown    Notes:
2189c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2190c833c3b5SJed Brown 
2191c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2192c833c3b5SJed Brown 
2193bb9467b5SJed Brown    This function is currently not available from Fortran.
2194bb9467b5SJed Brown 
2195c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2196c833c3b5SJed Brown @*/
2197c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2198c833c3b5SJed Brown {
2199c833c3b5SJed Brown   PetscErrorCode   ierr;
2200c833c3b5SJed Brown   DMRefineHookLink link,*p;
2201c833c3b5SJed Brown 
2202c833c3b5SJed Brown   PetscFunctionBegin;
2203c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22043d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
22053d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
22063d8e3701SJed Brown   }
220795dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
2208c833c3b5SJed Brown   link->refinehook = refinehook;
2209c833c3b5SJed Brown   link->interphook = interphook;
2210c833c3b5SJed Brown   link->ctx        = ctx;
22110298fd71SBarry Smith   link->next       = NULL;
2212c833c3b5SJed Brown   *p               = link;
2213c833c3b5SJed Brown   PetscFunctionReturn(0);
2214c833c3b5SJed Brown }
2215c833c3b5SJed Brown 
22163d8e3701SJed Brown /*@C
22173d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
22183d8e3701SJed Brown 
22193d8e3701SJed Brown    Logically Collective
22203d8e3701SJed Brown 
22214165533cSJose E. Roman    Input Parameters:
22223d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
22233d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
22243d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22253d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
22263d8e3701SJed Brown 
22273d8e3701SJed Brown    Level: advanced
22283d8e3701SJed Brown 
22293d8e3701SJed Brown    Notes:
22303d8e3701SJed Brown    This function does nothing if the hook is not in the list.
22313d8e3701SJed Brown 
22323d8e3701SJed Brown    This function is currently not available from Fortran.
22333d8e3701SJed Brown 
22343d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
22353d8e3701SJed Brown @*/
22363d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
22373d8e3701SJed Brown {
22383d8e3701SJed Brown   PetscErrorCode   ierr;
22393d8e3701SJed Brown   DMRefineHookLink link,*p;
22403d8e3701SJed Brown 
22413d8e3701SJed Brown   PetscFunctionBegin;
22423d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22433d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
22443d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
22453d8e3701SJed Brown       link = *p;
22463d8e3701SJed Brown       *p = link->next;
22473d8e3701SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
22483d8e3701SJed Brown       break;
22493d8e3701SJed Brown     }
22503d8e3701SJed Brown   }
22513d8e3701SJed Brown   PetscFunctionReturn(0);
22523d8e3701SJed Brown }
22533d8e3701SJed Brown 
2254c833c3b5SJed Brown /*@
2255c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2256c833c3b5SJed Brown 
2257c833c3b5SJed Brown    Collective if any hooks are
2258c833c3b5SJed Brown 
22594165533cSJose E. Roman    Input Parameters:
2260c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2261e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2262c833c3b5SJed Brown -  fine - finer DM to update
2263c833c3b5SJed Brown 
2264c833c3b5SJed Brown    Level: developer
2265c833c3b5SJed Brown 
2266c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2267c833c3b5SJed Brown @*/
2268c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2269c833c3b5SJed Brown {
2270c833c3b5SJed Brown   PetscErrorCode   ierr;
2271c833c3b5SJed Brown   DMRefineHookLink link;
2272c833c3b5SJed Brown 
2273c833c3b5SJed Brown   PetscFunctionBegin;
2274c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
22758865f1eaSKarl Rupp     if (link->interphook) {
22768865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
22778865f1eaSKarl Rupp     }
22784057135bSMatthew G Knepley   }
227947c6ae99SBarry Smith   PetscFunctionReturn(0);
228047c6ae99SBarry Smith }
228147c6ae99SBarry Smith 
2282eb3f98d2SBarry Smith /*@
22831f3379b2SToby Isaac    DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh.
22841f3379b2SToby Isaac 
22851f3379b2SToby Isaac    Collective on DM
22861f3379b2SToby Isaac 
22874165533cSJose E. Roman    Input Parameters:
22881f3379b2SToby Isaac +  coarse - coarse DM
22891f3379b2SToby Isaac .  fine   - fine DM
22901f3379b2SToby Isaac .  interp - (optional) the matrix computed by DMCreateInterpolation().  Implementations may not need this, but if it
22911f3379b2SToby Isaac             is available it can avoid some recomputation.  If it is provided, MatInterpolate() will be used if
22921f3379b2SToby Isaac             the coarse DM does not have a specialized implementation.
22931f3379b2SToby Isaac -  coarseSol - solution on the coarse mesh
22941f3379b2SToby Isaac 
22954165533cSJose E. Roman    Output Parameter:
22961f3379b2SToby Isaac .  fineSol - the interpolation of coarseSol to the fine mesh
22971f3379b2SToby Isaac 
22981f3379b2SToby Isaac    Level: developer
22991f3379b2SToby Isaac 
23001f3379b2SToby Isaac    Note: This function exists because the interpolation of a solution vector between meshes is not always a linear
23011f3379b2SToby Isaac    map.  For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed
23021f3379b2SToby Isaac    out of the solution vector.  Or if interpolation is inherently a nonlinear operation, such as a method using
23031f3379b2SToby Isaac    slope-limiting reconstruction.
23041f3379b2SToby Isaac 
23051f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation()
23061f3379b2SToby Isaac @*/
23071f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol)
23081f3379b2SToby Isaac {
23091f3379b2SToby Isaac   PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL;
23101f3379b2SToby Isaac   PetscErrorCode ierr;
23111f3379b2SToby Isaac 
23121f3379b2SToby Isaac   PetscFunctionBegin;
23131f3379b2SToby Isaac   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
23141f3379b2SToby Isaac   if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3);
23151f3379b2SToby Isaac   PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4);
23161f3379b2SToby Isaac   PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5);
23171f3379b2SToby Isaac 
23181f3379b2SToby Isaac   ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr);
23191f3379b2SToby Isaac   if (interpsol) {
23201f3379b2SToby Isaac     ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr);
23211f3379b2SToby Isaac   } else if (interp) {
23221f3379b2SToby Isaac     ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr);
23231f3379b2SToby Isaac   } else SETERRQ1(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name);
23241f3379b2SToby Isaac   PetscFunctionReturn(0);
23251f3379b2SToby Isaac }
23261f3379b2SToby Isaac 
23271f3379b2SToby Isaac /*@
2328aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2329eb3f98d2SBarry Smith 
2330eb3f98d2SBarry Smith     Not Collective
2331eb3f98d2SBarry Smith 
2332eb3f98d2SBarry Smith     Input Parameter:
2333eb3f98d2SBarry Smith .   dm - the DM object
2334eb3f98d2SBarry Smith 
2335eb3f98d2SBarry Smith     Output Parameter:
2336eb3f98d2SBarry Smith .   level - number of refinements
2337eb3f98d2SBarry Smith 
2338eb3f98d2SBarry Smith     Level: developer
2339eb3f98d2SBarry Smith 
23406a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2341eb3f98d2SBarry Smith 
2342eb3f98d2SBarry Smith @*/
2343eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2344eb3f98d2SBarry Smith {
2345eb3f98d2SBarry Smith   PetscFunctionBegin;
2346eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2347eb3f98d2SBarry Smith   *level = dm->levelup;
2348eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2349eb3f98d2SBarry Smith }
2350eb3f98d2SBarry Smith 
2351fef3a512SBarry Smith /*@
2352aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2353fef3a512SBarry Smith 
2354fef3a512SBarry Smith     Not Collective
2355fef3a512SBarry Smith 
2356d8d19677SJose E. Roman     Input Parameters:
2357fef3a512SBarry Smith +   dm - the DM object
2358fef3a512SBarry Smith -   level - number of refinements
2359fef3a512SBarry Smith 
2360fef3a512SBarry Smith     Level: advanced
2361fef3a512SBarry Smith 
236295452b02SPatrick Sanan     Notes:
236395452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2364fef3a512SBarry Smith 
2365fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2366fef3a512SBarry Smith 
2367fef3a512SBarry Smith @*/
2368fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2369fef3a512SBarry Smith {
2370fef3a512SBarry Smith   PetscFunctionBegin;
2371fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2372fef3a512SBarry Smith   dm->levelup = level;
2373fef3a512SBarry Smith   PetscFunctionReturn(0);
2374fef3a512SBarry Smith }
2375fef3a512SBarry Smith 
2376d410b0cfSMatthew G. Knepley /*@
2377d410b0cfSMatthew G. Knepley   DMExtrude - Extrude a DM object from a surface
2378d410b0cfSMatthew G. Knepley 
2379d410b0cfSMatthew G. Knepley   Collective on dm
2380d410b0cfSMatthew G. Knepley 
2381d410b0cfSMatthew G. Knepley   Input Parameter:
2382d410b0cfSMatthew G. Knepley + dm     - the DM object
2383d410b0cfSMatthew G. Knepley - layers - the number of extruded cell layers
2384d410b0cfSMatthew G. Knepley 
2385d410b0cfSMatthew G. Knepley   Output Parameter:
2386d410b0cfSMatthew G. Knepley . dme - the extruded DM, or NULL
2387d410b0cfSMatthew G. Knepley 
2388d410b0cfSMatthew G. Knepley   Note: If no extrusion was done, the return value is NULL
2389d410b0cfSMatthew G. Knepley 
2390d410b0cfSMatthew G. Knepley   Level: developer
2391d410b0cfSMatthew G. Knepley 
2392d410b0cfSMatthew G. Knepley .seealso DMRefine(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector()
2393d410b0cfSMatthew G. Knepley @*/
2394d410b0cfSMatthew G. Knepley PetscErrorCode DMExtrude(DM dm, PetscInt layers, DM *dme)
2395d410b0cfSMatthew G. Knepley {
2396d410b0cfSMatthew G. Knepley   PetscErrorCode ierr;
2397d410b0cfSMatthew G. Knepley 
2398d410b0cfSMatthew G. Knepley   PetscFunctionBegin;
2399d410b0cfSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2400d410b0cfSMatthew G. Knepley   if (!dm->ops->extrude) SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_SUP, "DM type %s does not implement DMExtrude", ((PetscObject) dm)->type_name);
2401d410b0cfSMatthew G. Knepley   ierr = (*dm->ops->extrude)(dm, layers, dme);CHKERRQ(ierr);
2402d410b0cfSMatthew G. Knepley   if (*dme) {
2403d410b0cfSMatthew G. Knepley     (*dme)->ops->creatematrix = dm->ops->creatematrix;
2404d410b0cfSMatthew G. Knepley     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject) dm, (PetscObject) *dme);CHKERRQ(ierr);
2405d410b0cfSMatthew G. Knepley     (*dme)->ctx = dm->ctx;
2406d410b0cfSMatthew G. Knepley     ierr = DMSetMatType(*dme, dm->mattype);CHKERRQ(ierr);
2407d410b0cfSMatthew G. Knepley   }
2408d410b0cfSMatthew G. Knepley   PetscFunctionReturn(0);
2409d410b0cfSMatthew G. Knepley }
2410d410b0cfSMatthew G. Knepley 
2411ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2412ca3d3a14SMatthew G. Knepley {
2413ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2414ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2415ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2416ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2417ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2418ca3d3a14SMatthew G. Knepley }
2419ca3d3a14SMatthew G. Knepley 
2420ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2421ca3d3a14SMatthew G. Knepley {
2422ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2423ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2424ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2425ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2426ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2427ca3d3a14SMatthew G. Knepley }
2428ca3d3a14SMatthew G. Knepley 
2429ca3d3a14SMatthew G. Knepley /*@
2430c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2431ca3d3a14SMatthew G. Knepley 
2432ca3d3a14SMatthew G. Knepley   Input Parameter:
2433ca3d3a14SMatthew G. Knepley . dm - The DM
2434ca3d3a14SMatthew G. Knepley 
2435ca3d3a14SMatthew G. Knepley   Output Parameter:
2436ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2437ca3d3a14SMatthew G. Knepley 
2438ca3d3a14SMatthew G. Knepley   Level: developer
2439ca3d3a14SMatthew G. Knepley 
2440436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2441ca3d3a14SMatthew G. Knepley @*/
2442ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2443ca3d3a14SMatthew G. Knepley {
2444ca3d3a14SMatthew G. Knepley   Vec            tv;
2445ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2446ca3d3a14SMatthew G. Knepley 
2447ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2448ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2449534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
2450ca3d3a14SMatthew G. Knepley   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2451ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2452ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2453ca3d3a14SMatthew G. Knepley }
2454ca3d3a14SMatthew G. Knepley 
2455ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2456ca3d3a14SMatthew G. Knepley {
2457ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2458ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2459ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2460ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2461ca3d3a14SMatthew G. Knepley 
2462ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2463ca3d3a14SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
246492fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2465ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2466ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2467ca3d3a14SMatthew G. Knepley   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
246892fd8e1eSJed Brown   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2469ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2470ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2471ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2472ca3d3a14SMatthew G. Knepley     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2473ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2474ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2475ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2476ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2477ca3d3a14SMatthew G. Knepley       if (!dof) continue;
2478ca3d3a14SMatthew G. Knepley       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2479ca3d3a14SMatthew G. Knepley       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2480ca3d3a14SMatthew G. Knepley     }
2481ca3d3a14SMatthew G. Knepley   }
2482ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2483ca3d3a14SMatthew G. Knepley   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2484ca3d3a14SMatthew G. Knepley   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2485ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2486ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2487ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2488ca3d3a14SMatthew G. Knepley       if (dof) {
2489ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2490ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2491ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2492ca3d3a14SMatthew G. Knepley 
2493ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
2494ca3d3a14SMatthew G. Knepley         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2495ca3d3a14SMatthew G. Knepley         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2496580bdb30SBarry Smith         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2497ca3d3a14SMatthew G. Knepley       }
2498ca3d3a14SMatthew G. Knepley     }
2499ca3d3a14SMatthew G. Knepley   }
2500ca3d3a14SMatthew G. Knepley   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2501ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2502ca3d3a14SMatthew G. Knepley }
2503ca3d3a14SMatthew G. Knepley 
2504ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2505ca3d3a14SMatthew G. Knepley {
2506ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2507ca3d3a14SMatthew G. Knepley 
2508ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2509ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2510ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2511ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2512ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2513ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2514ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
2515ca3d3a14SMatthew G. Knepley   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2516ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2517ca3d3a14SMatthew G. Knepley }
2518ca3d3a14SMatthew G. Knepley 
2519bb9467b5SJed Brown /*@C
2520baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2521baf369e7SPeter Brune 
2522baf369e7SPeter Brune    Logically Collective
2523baf369e7SPeter Brune 
25244165533cSJose E. Roman    Input Parameters:
2525baf369e7SPeter Brune +  dm - the DM
2526baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2527baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
25280298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2529baf369e7SPeter Brune 
2530baf369e7SPeter Brune    Calling sequence for beginhook:
2531baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2532baf369e7SPeter Brune 
2533baf369e7SPeter Brune +  dm - global DM
2534baf369e7SPeter Brune .  g - global vector
2535baf369e7SPeter Brune .  mode - mode
2536baf369e7SPeter Brune .  l - local vector
2537baf369e7SPeter Brune -  ctx - optional user-defined function context
2538baf369e7SPeter Brune 
2539baf369e7SPeter Brune    Calling sequence for endhook:
2540ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2541baf369e7SPeter Brune 
2542baf369e7SPeter Brune +  global - global DM
2543baf369e7SPeter Brune -  ctx - optional user-defined function context
2544baf369e7SPeter Brune 
2545baf369e7SPeter Brune    Level: advanced
2546baf369e7SPeter Brune 
2547baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2548baf369e7SPeter Brune @*/
2549baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2550baf369e7SPeter Brune {
2551baf369e7SPeter Brune   PetscErrorCode          ierr;
2552baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2553baf369e7SPeter Brune 
2554baf369e7SPeter Brune   PetscFunctionBegin;
2555baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2556baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
255795dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2558baf369e7SPeter Brune   link->beginhook = beginhook;
2559baf369e7SPeter Brune   link->endhook   = endhook;
2560baf369e7SPeter Brune   link->ctx       = ctx;
25610298fd71SBarry Smith   link->next      = NULL;
2562baf369e7SPeter Brune   *p              = link;
2563baf369e7SPeter Brune   PetscFunctionReturn(0);
2564baf369e7SPeter Brune }
2565baf369e7SPeter Brune 
25664c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
25674c274da1SToby Isaac {
25684c274da1SToby Isaac   Mat cMat;
25694c274da1SToby Isaac   Vec cVec;
25704c274da1SToby Isaac   PetscSection section, cSec;
25714c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
25724c274da1SToby Isaac   PetscErrorCode ierr;
25734c274da1SToby Isaac 
25744c274da1SToby Isaac   PetscFunctionBegin;
25754c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
25764c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
25774c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
25785db9a05bSToby Isaac     PetscInt nRows;
25795db9a05bSToby Isaac 
25805db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
25815db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
258292fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
25837711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
25844c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
25854c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
25864c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
25874c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
25884c274da1SToby Isaac       if (dof) {
25894c274da1SToby Isaac         PetscScalar *vals;
25904c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
25914c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
25924c274da1SToby Isaac       }
25934c274da1SToby Isaac     }
25944c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
25954c274da1SToby Isaac   }
25964c274da1SToby Isaac   PetscFunctionReturn(0);
25974c274da1SToby Isaac }
25984c274da1SToby Isaac 
259947c6ae99SBarry Smith /*@
260001729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
260101729b5cSPatrick Sanan 
2602d083f849SBarry Smith     Neighbor-wise Collective on dm
260301729b5cSPatrick Sanan 
260401729b5cSPatrick Sanan     Input Parameters:
260501729b5cSPatrick Sanan +   dm - the DM object
260601729b5cSPatrick Sanan .   g - the global vector
260701729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
260801729b5cSPatrick Sanan -   l - the local vector
260901729b5cSPatrick Sanan 
261001729b5cSPatrick Sanan     Notes:
261101729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
261201729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
261301729b5cSPatrick Sanan 
261401729b5cSPatrick Sanan     Level: beginner
261501729b5cSPatrick Sanan 
261601729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
261701729b5cSPatrick Sanan 
261801729b5cSPatrick Sanan @*/
261901729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
262001729b5cSPatrick Sanan {
262101729b5cSPatrick Sanan   PetscErrorCode ierr;
262201729b5cSPatrick Sanan 
262301729b5cSPatrick Sanan   PetscFunctionBegin;
262401729b5cSPatrick Sanan   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
262501729b5cSPatrick Sanan   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
262601729b5cSPatrick Sanan   PetscFunctionReturn(0);
262701729b5cSPatrick Sanan }
262801729b5cSPatrick Sanan 
262901729b5cSPatrick Sanan /*@
263047c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
263147c6ae99SBarry Smith 
2632d083f849SBarry Smith     Neighbor-wise Collective on dm
263347c6ae99SBarry Smith 
263447c6ae99SBarry Smith     Input Parameters:
263547c6ae99SBarry Smith +   dm - the DM object
263647c6ae99SBarry Smith .   g - the global vector
263747c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
263847c6ae99SBarry Smith -   l - the local vector
263947c6ae99SBarry Smith 
264001729b5cSPatrick Sanan     Level: intermediate
264147c6ae99SBarry Smith 
264201729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
264347c6ae99SBarry Smith 
264447c6ae99SBarry Smith @*/
26457087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
264647c6ae99SBarry Smith {
26477128ae9fSMatthew G Knepley   PetscSF                 sf;
264847c6ae99SBarry Smith   PetscErrorCode          ierr;
2649baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
265047c6ae99SBarry Smith 
265147c6ae99SBarry Smith   PetscFunctionBegin;
2652171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2653baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
26548865f1eaSKarl Rupp     if (link->beginhook) {
26558865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
26568865f1eaSKarl Rupp     }
2657baf369e7SPeter Brune   }
26581bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
26597128ae9fSMatthew G Knepley   if (sf) {
2660ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2661ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
2662d0295fc0SJunchao Zhang     PetscMemType      lmtype,gmtype;
26637128ae9fSMatthew G Knepley 
266482f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2665a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2666a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2667ad227feaSJunchao Zhang     ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr);
2668a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2669a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
26707128ae9fSMatthew G Knepley   } else {
267133907cc2SStefano Zampini     if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2672843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
26737128ae9fSMatthew G Knepley   }
267447c6ae99SBarry Smith   PetscFunctionReturn(0);
267547c6ae99SBarry Smith }
267647c6ae99SBarry Smith 
267747c6ae99SBarry Smith /*@
267847c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends 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(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
269147c6ae99SBarry Smith 
269247c6ae99SBarry Smith @*/
26937087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
269447c6ae99SBarry Smith {
26957128ae9fSMatthew G Knepley   PetscSF                 sf;
269647c6ae99SBarry Smith   PetscErrorCode          ierr;
2697ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2698ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2699ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2700baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
2701d0295fc0SJunchao Zhang   PetscMemType            lmtype,gmtype;
270247c6ae99SBarry Smith 
270347c6ae99SBarry Smith   PetscFunctionBegin;
2704171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27051bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2706ca3d3a14SMatthew G. Knepley   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
27077128ae9fSMatthew G Knepley   if (sf) {
270882f516ccSBarry Smith     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
27097128ae9fSMatthew G Knepley 
2710a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2711a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2712ad227feaSJunchao Zhang     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr);
2713a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2714a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
2715ca3d3a14SMatthew G. Knepley     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
27167128ae9fSMatthew G Knepley   } else {
271733907cc2SStefano Zampini     if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2718843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
27197128ae9fSMatthew G Knepley   }
27204c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2721baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2722baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2723baf369e7SPeter Brune   }
272447c6ae99SBarry Smith   PetscFunctionReturn(0);
272547c6ae99SBarry Smith }
272647c6ae99SBarry Smith 
2727d4d07f1eSToby Isaac /*@C
2728d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2729d4d07f1eSToby Isaac 
2730d4d07f1eSToby Isaac    Logically Collective
2731d4d07f1eSToby Isaac 
27324165533cSJose E. Roman    Input Parameters:
2733d4d07f1eSToby Isaac +  dm - the DM
2734d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2735d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2736d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2737d4d07f1eSToby Isaac 
2738d4d07f1eSToby Isaac    Calling sequence for beginhook:
2739d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2740d4d07f1eSToby Isaac 
2741d4d07f1eSToby Isaac +  dm - global DM
2742d4d07f1eSToby Isaac .  l - local vector
2743d4d07f1eSToby Isaac .  mode - mode
2744d4d07f1eSToby Isaac .  g - global vector
2745d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2746d4d07f1eSToby Isaac 
2747d4d07f1eSToby Isaac    Calling sequence for endhook:
2748d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2749d4d07f1eSToby Isaac 
2750d4d07f1eSToby Isaac +  global - global DM
2751d4d07f1eSToby Isaac .  l - local vector
2752d4d07f1eSToby Isaac .  mode - mode
2753d4d07f1eSToby Isaac .  g - global vector
2754d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2755d4d07f1eSToby Isaac 
2756d4d07f1eSToby Isaac    Level: advanced
2757d4d07f1eSToby Isaac 
2758d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2759d4d07f1eSToby Isaac @*/
2760d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2761d4d07f1eSToby Isaac {
2762d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2763d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2764d4d07f1eSToby Isaac 
2765d4d07f1eSToby Isaac   PetscFunctionBegin;
2766d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2767d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
276895dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2769d4d07f1eSToby Isaac   link->beginhook = beginhook;
2770d4d07f1eSToby Isaac   link->endhook   = endhook;
2771d4d07f1eSToby Isaac   link->ctx       = ctx;
2772d4d07f1eSToby Isaac   link->next      = NULL;
2773d4d07f1eSToby Isaac   *p              = link;
2774d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2775d4d07f1eSToby Isaac }
2776d4d07f1eSToby Isaac 
27774c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
27784c274da1SToby Isaac {
27794c274da1SToby Isaac   Mat cMat;
27804c274da1SToby Isaac   Vec cVec;
27814c274da1SToby Isaac   PetscSection section, cSec;
27824c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
27834c274da1SToby Isaac   PetscErrorCode ierr;
27844c274da1SToby Isaac 
27854c274da1SToby Isaac   PetscFunctionBegin;
27864c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
27874c274da1SToby Isaac   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
27884c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
27895db9a05bSToby Isaac     PetscInt nRows;
27905db9a05bSToby Isaac 
27915db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
27925db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
279392fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
27947711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
27954c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
27964c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
27974c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
27984c274da1SToby Isaac       if (dof) {
27994c274da1SToby Isaac         PetscInt d;
28004c274da1SToby Isaac         PetscScalar *vals;
28014c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
28024c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
28034c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
28044c274da1SToby Isaac          * we just extracted */
28054c274da1SToby Isaac         for (d = 0; d < dof; d++) {
28064c274da1SToby Isaac           vals[d] = 0.;
28074c274da1SToby Isaac         }
28084c274da1SToby Isaac       }
28094c274da1SToby Isaac     }
28104c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
28114c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
28124c274da1SToby Isaac   }
28134c274da1SToby Isaac   PetscFunctionReturn(0);
28144c274da1SToby Isaac }
281501729b5cSPatrick Sanan /*@
281601729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
281701729b5cSPatrick Sanan 
2818d083f849SBarry Smith     Neighbor-wise Collective on dm
281901729b5cSPatrick Sanan 
282001729b5cSPatrick Sanan     Input Parameters:
282101729b5cSPatrick Sanan +   dm - the DM object
282201729b5cSPatrick Sanan .   l - the local vector
282301729b5cSPatrick 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.
282401729b5cSPatrick Sanan -   g - the global vector
282501729b5cSPatrick Sanan 
282601729b5cSPatrick Sanan     Notes:
282701729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
282801729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
282901729b5cSPatrick Sanan 
283001729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
283101729b5cSPatrick 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.
283201729b5cSPatrick Sanan 
283301729b5cSPatrick Sanan     Level: beginner
283401729b5cSPatrick Sanan 
283501729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
283601729b5cSPatrick Sanan 
283701729b5cSPatrick Sanan @*/
283801729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
283901729b5cSPatrick Sanan {
284001729b5cSPatrick Sanan   PetscErrorCode ierr;
284101729b5cSPatrick Sanan 
284201729b5cSPatrick Sanan   PetscFunctionBegin;
284301729b5cSPatrick Sanan   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
284401729b5cSPatrick Sanan   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
284501729b5cSPatrick Sanan   PetscFunctionReturn(0);
284601729b5cSPatrick Sanan }
28474c274da1SToby Isaac 
284847c6ae99SBarry Smith /*@
284901729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
28509a42bb27SBarry Smith 
2851d083f849SBarry Smith     Neighbor-wise Collective on dm
28529a42bb27SBarry Smith 
28539a42bb27SBarry Smith     Input Parameters:
28549a42bb27SBarry Smith +   dm - the DM object
2855f6813fd5SJed Brown .   l - the local vector
28561eb28f2eSBarry 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.
28571eb28f2eSBarry Smith -   g - the global vector
28589a42bb27SBarry Smith 
285995452b02SPatrick Sanan     Notes:
286095452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
286184330215SMatthew 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.
28629a42bb27SBarry Smith 
286301729b5cSPatrick Sanan     Level: intermediate
28649a42bb27SBarry Smith 
286501729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
28669a42bb27SBarry Smith 
28679a42bb27SBarry Smith @*/
28687087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
28699a42bb27SBarry Smith {
28707128ae9fSMatthew G Knepley   PetscSF                 sf;
287184330215SMatthew G. Knepley   PetscSection            s, gs;
2872d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2873ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2874ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2875ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2876fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
287784330215SMatthew G. Knepley   PetscErrorCode          ierr;
2878d0295fc0SJunchao Zhang   PetscMemType            lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST;
28799a42bb27SBarry Smith 
28809a42bb27SBarry Smith   PetscFunctionBegin;
2881171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2882d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2883d4d07f1eSToby Isaac     if (link->beginhook) {
2884d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2885d4d07f1eSToby Isaac     }
2886d4d07f1eSToby Isaac   }
28874c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
28881bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
288992fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
28907128ae9fSMatthew G Knepley   switch (mode) {
28917128ae9fSMatthew G Knepley   case INSERT_VALUES:
28927128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2893304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
289484330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
28957128ae9fSMatthew G Knepley   case ADD_VALUES:
28967128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2897304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
289884330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
28997128ae9fSMatthew G Knepley   default:
290082f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
29017128ae9fSMatthew G Knepley   }
2902ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
2903ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2904ca3d3a14SMatthew G. Knepley     if (transform) {
2905ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2906ca3d3a14SMatthew G. Knepley       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2907ca3d3a14SMatthew G. Knepley       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2908ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2909fa88e482SJed Brown     } else if (isInsert) {
2910ae5cfb4aSMatthew G. Knepley       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2911fa88e482SJed Brown     } else {
2912a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2913fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2914ca3d3a14SMatthew G. Knepley     }
2915fa88e482SJed Brown     if (s && isInsert) {
29167128ae9fSMatthew G Knepley       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2917fa88e482SJed Brown     } else {
2918a256111fSJunchao Zhang       ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2919fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2920fa88e482SJed Brown     }
2921ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
2922d0295fc0SJunchao Zhang       ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr);
292384330215SMatthew G. Knepley     } else if (s && isInsert) {
292484330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
292584330215SMatthew G. Knepley 
2926e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
292784330215SMatthew G. Knepley       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
292884330215SMatthew G. Knepley       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
292984330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2930b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
293184330215SMatthew G. Knepley 
293284330215SMatthew G. Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
293303442857SMatthew G. Knepley         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
293484330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2935b3b16f48SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
293684330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
293784330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2938b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
293903442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
2940b3b16f48SMatthew G. Knepley         if (dof != gdof) SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
2941b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2942b3b16f48SMatthew G. Knepley         if (!gcdof) {
294384330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2944b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2945b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
294684330215SMatthew G. Knepley           const PetscInt *cdofs;
294784330215SMatthew G. Knepley           PetscInt        cind = 0;
294884330215SMatthew G. Knepley 
294984330215SMatthew G. Knepley           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2950b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
295184330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2952b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
295384330215SMatthew G. Knepley           }
2954b3b16f48SMatthew G. Knepley         } else SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
295584330215SMatthew G. Knepley       }
2956ca3d3a14SMatthew G. Knepley     }
2957fa88e482SJed Brown     if (g_inplace) {
2958a256111fSJunchao Zhang       ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
2959fa88e482SJed Brown     } else {
29607128ae9fSMatthew G Knepley       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
2961fa88e482SJed Brown     }
2962ca3d3a14SMatthew G. Knepley     if (transform) {
2963ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2964ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2965fa88e482SJed Brown     } else if (l_inplace) {
2966a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
2967ca3d3a14SMatthew G. Knepley     } else {
2968ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
2969ca3d3a14SMatthew G. Knepley     }
29707128ae9fSMatthew G Knepley   } else {
2971b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
2972843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
29737128ae9fSMatthew G Knepley   }
29749a42bb27SBarry Smith   PetscFunctionReturn(0);
29759a42bb27SBarry Smith }
29769a42bb27SBarry Smith 
29779a42bb27SBarry Smith /*@
29789a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
297947c6ae99SBarry Smith 
2980d083f849SBarry Smith     Neighbor-wise Collective on dm
298147c6ae99SBarry Smith 
298247c6ae99SBarry Smith     Input Parameters:
298347c6ae99SBarry Smith +   dm - the DM object
2984f6813fd5SJed Brown .   l - the local vector
298547c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2986f6813fd5SJed Brown -   g - the global vector
298747c6ae99SBarry Smith 
298801729b5cSPatrick Sanan     Level: intermediate
298947c6ae99SBarry Smith 
2990e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
299147c6ae99SBarry Smith 
299247c6ae99SBarry Smith @*/
29937087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
299447c6ae99SBarry Smith {
29957128ae9fSMatthew G Knepley   PetscSF                 sf;
299684330215SMatthew G. Knepley   PetscSection            s;
2997d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2998ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
299984330215SMatthew G. Knepley   PetscErrorCode          ierr;
300047c6ae99SBarry Smith 
300147c6ae99SBarry Smith   PetscFunctionBegin;
3002171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
30031bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
300492fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
30057128ae9fSMatthew G Knepley   switch (mode) {
30067128ae9fSMatthew G Knepley   case INSERT_VALUES:
30077128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
300884330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
30097128ae9fSMatthew G Knepley   case ADD_VALUES:
30107128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
301184330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
30127128ae9fSMatthew G Knepley   default:
301382f516ccSBarry Smith     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
30147128ae9fSMatthew G Knepley   }
301584330215SMatthew G. Knepley   if (sf && !isInsert) {
3016ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
3017ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
3018ca3d3a14SMatthew G. Knepley     Vec                tmpl;
301984330215SMatthew G. Knepley 
3020ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
3021ca3d3a14SMatthew G. Knepley     if (transform) {
3022ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3023ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3024ca3d3a14SMatthew G. Knepley     } else {
3025a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr);
3026ca3d3a14SMatthew G. Knepley     }
3027a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr);
3028a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
3029ca3d3a14SMatthew G. Knepley     if (transform) {
3030ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3031ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3032ca3d3a14SMatthew G. Knepley     } else {
3033a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
3034ca3d3a14SMatthew G. Knepley     }
3035a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
303684330215SMatthew G. Knepley   } else if (s && isInsert) {
30377128ae9fSMatthew G Knepley   } else {
3038b9d85ea2SLisandro Dalcin     if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
3039843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
30407128ae9fSMatthew G Knepley   }
3041d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
3042d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
3043d4d07f1eSToby Isaac   }
304447c6ae99SBarry Smith   PetscFunctionReturn(0);
304547c6ae99SBarry Smith }
304647c6ae99SBarry Smith 
3047f089877aSRichard Tran Mills /*@
3048bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
3049bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3050d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
3051f089877aSRichard Tran Mills 
3052d083f849SBarry Smith    Neighbor-wise Collective on dm
3053f089877aSRichard Tran Mills 
3054f089877aSRichard Tran Mills    Input Parameters:
3055f089877aSRichard Tran Mills +  dm - the DM object
3056bc0a1609SRichard Tran Mills .  g - the original local vector
3057bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3058f089877aSRichard Tran Mills 
3059bc0a1609SRichard Tran Mills    Output Parameter:
3060bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3061f089877aSRichard Tran Mills 
3062f089877aSRichard Tran Mills    Level: intermediate
3063f089877aSRichard Tran Mills 
3064bc0a1609SRichard Tran Mills    Notes:
3065bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3066bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3067bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3068bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3069bc0a1609SRichard Tran Mills 
3070bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3071f089877aSRichard Tran Mills 
3072f089877aSRichard Tran Mills @*/
3073f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
3074f089877aSRichard Tran Mills {
3075f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3076f089877aSRichard Tran Mills 
3077f089877aSRichard Tran Mills   PetscFunctionBegin;
3078f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3079bb358533SPatrick Sanan   if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3080f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3081f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3082f089877aSRichard Tran Mills }
3083f089877aSRichard Tran Mills 
3084f089877aSRichard Tran Mills /*@
3085bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
3086bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3087d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
3088f089877aSRichard Tran Mills 
3089d083f849SBarry Smith    Neighbor-wise Collective on dm
3090f089877aSRichard Tran Mills 
3091f089877aSRichard Tran Mills    Input Parameters:
3092bc0a1609SRichard Tran Mills +  da - the DM object
3093bc0a1609SRichard Tran Mills .  g - the original local vector
3094bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3095f089877aSRichard Tran Mills 
3096bc0a1609SRichard Tran Mills    Output Parameter:
3097bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3098f089877aSRichard Tran Mills 
3099f089877aSRichard Tran Mills    Level: intermediate
3100f089877aSRichard Tran Mills 
3101bc0a1609SRichard Tran Mills    Notes:
3102bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3103bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3104bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3105bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3106bc0a1609SRichard Tran Mills 
3107bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3108f089877aSRichard Tran Mills 
3109f089877aSRichard Tran Mills @*/
3110f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
3111f089877aSRichard Tran Mills {
3112f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3113f089877aSRichard Tran Mills 
3114f089877aSRichard Tran Mills   PetscFunctionBegin;
3115f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3116bb358533SPatrick Sanan   if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3117f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3118f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3119f089877aSRichard Tran Mills }
3120f089877aSRichard Tran Mills 
312147c6ae99SBarry Smith /*@
312247c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
312347c6ae99SBarry Smith 
3124d083f849SBarry Smith     Collective on dm
312547c6ae99SBarry Smith 
3126d8d19677SJose E. Roman     Input Parameters:
312747c6ae99SBarry Smith +   dm - the DM object
312891d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
312947c6ae99SBarry Smith 
313047c6ae99SBarry Smith     Output Parameter:
313147c6ae99SBarry Smith .   dmc - the coarsened DM
313247c6ae99SBarry Smith 
313347c6ae99SBarry Smith     Level: developer
313447c6ae99SBarry Smith 
3135e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
313647c6ae99SBarry Smith 
313747c6ae99SBarry Smith @*/
31387087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
313947c6ae99SBarry Smith {
314047c6ae99SBarry Smith   PetscErrorCode    ierr;
3141b17ce1afSJed Brown   DMCoarsenHookLink link;
314247c6ae99SBarry Smith 
314347c6ae99SBarry Smith   PetscFunctionBegin;
3144171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3145b9d85ea2SLisandro Dalcin   if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
314647a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
314747c6ae99SBarry Smith   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
3148b9d85ea2SLisandro Dalcin   if (*dmc) {
3149a3574896SRichard Tran Mills     (*dmc)->bind_below = dm->bind_below; /* Propagate this from parent DM; otherwise -dm_bind_below will be useless for multigrid cases. */
3150a8fb8f29SToby Isaac     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
315143842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
31528cd211a4SJed Brown     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
3153644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
31540598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
3155656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
3156e4b4b23bSJed Brown     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
3157b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
3158b17ce1afSJed Brown       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
3159b17ce1afSJed Brown     }
3160b9d85ea2SLisandro Dalcin   }
316147a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
3162b9d85ea2SLisandro Dalcin   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3163b17ce1afSJed Brown   PetscFunctionReturn(0);
3164b17ce1afSJed Brown }
3165b17ce1afSJed Brown 
3166bb9467b5SJed Brown /*@C
3167b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3168b17ce1afSJed Brown 
3169b17ce1afSJed Brown    Logically Collective
3170b17ce1afSJed Brown 
31714165533cSJose E. Roman    Input Parameters:
3172b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3173b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3174b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
31750298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3176b17ce1afSJed Brown 
3177b17ce1afSJed Brown    Calling sequence of coarsenhook:
3178b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3179b17ce1afSJed Brown 
3180b17ce1afSJed Brown +  fine - fine level DM
3181b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3182b17ce1afSJed Brown -  ctx - optional user-defined function context
3183b17ce1afSJed Brown 
3184b17ce1afSJed Brown    Calling sequence for restricthook:
3185c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3186b17ce1afSJed Brown 
3187b17ce1afSJed Brown +  fine - fine level DM
3188b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3189c833c3b5SJed Brown .  rscale - scaling vector for restriction
3190c833c3b5SJed Brown .  inject - matrix restricting by injection
3191b17ce1afSJed Brown .  coarse - coarse level DM to update
3192b17ce1afSJed Brown -  ctx - optional user-defined function context
3193b17ce1afSJed Brown 
3194b17ce1afSJed Brown    Level: advanced
3195b17ce1afSJed Brown 
3196b17ce1afSJed Brown    Notes:
3197b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3198b17ce1afSJed Brown 
3199b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3200b17ce1afSJed Brown 
3201b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3202b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3203b17ce1afSJed Brown 
3204bb9467b5SJed Brown    This function is currently not available from Fortran.
3205bb9467b5SJed Brown 
3206dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3207b17ce1afSJed Brown @*/
3208b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3209b17ce1afSJed Brown {
3210b17ce1afSJed Brown   PetscErrorCode    ierr;
3211b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3212b17ce1afSJed Brown 
3213b17ce1afSJed Brown   PetscFunctionBegin;
3214b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
32151e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
32161e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
32171e3d8eccSJed Brown   }
321895dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
3219b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3220b17ce1afSJed Brown   link->restricthook = restricthook;
3221b17ce1afSJed Brown   link->ctx          = ctx;
32220298fd71SBarry Smith   link->next         = NULL;
3223b17ce1afSJed Brown   *p                 = link;
3224b17ce1afSJed Brown   PetscFunctionReturn(0);
3225b17ce1afSJed Brown }
3226b17ce1afSJed Brown 
3227dc822a44SJed Brown /*@C
3228dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3229dc822a44SJed Brown 
3230dc822a44SJed Brown    Logically Collective
3231dc822a44SJed Brown 
32324165533cSJose E. Roman    Input Parameters:
3233dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3234dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3235dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3236dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3237dc822a44SJed Brown 
3238dc822a44SJed Brown    Level: advanced
3239dc822a44SJed Brown 
3240dc822a44SJed Brown    Notes:
3241dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3242dc822a44SJed Brown 
3243dc822a44SJed Brown    This function is currently not available from Fortran.
3244dc822a44SJed Brown 
3245dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3246dc822a44SJed Brown @*/
3247dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3248dc822a44SJed Brown {
3249dc822a44SJed Brown   PetscErrorCode    ierr;
3250dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3251dc822a44SJed Brown 
3252dc822a44SJed Brown   PetscFunctionBegin;
3253dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3254dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3255dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3256dc822a44SJed Brown       link = *p;
3257dc822a44SJed Brown       *p = link->next;
3258dc822a44SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3259dc822a44SJed Brown       break;
3260dc822a44SJed Brown     }
3261dc822a44SJed Brown   }
3262dc822a44SJed Brown   PetscFunctionReturn(0);
3263dc822a44SJed Brown }
3264dc822a44SJed Brown 
3265b17ce1afSJed Brown /*@
3266b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3267b17ce1afSJed Brown 
3268b17ce1afSJed Brown    Collective if any hooks are
3269b17ce1afSJed Brown 
32704165533cSJose E. Roman    Input Parameters:
3271b17ce1afSJed Brown +  fine - finer DM to use as a base
3272b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3273e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3274b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3275e91eccc2SStefano Zampini -  coarse - coarser DM to update
3276b17ce1afSJed Brown 
3277b17ce1afSJed Brown    Level: developer
3278b17ce1afSJed Brown 
3279b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3280b17ce1afSJed Brown @*/
3281b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3282b17ce1afSJed Brown {
3283b17ce1afSJed Brown   PetscErrorCode    ierr;
3284b17ce1afSJed Brown   DMCoarsenHookLink link;
3285b17ce1afSJed Brown 
3286b17ce1afSJed Brown   PetscFunctionBegin;
3287b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
32888865f1eaSKarl Rupp     if (link->restricthook) {
32898865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
32908865f1eaSKarl Rupp     }
3291b17ce1afSJed Brown   }
329247c6ae99SBarry Smith   PetscFunctionReturn(0);
329347c6ae99SBarry Smith }
329447c6ae99SBarry Smith 
3295bb9467b5SJed Brown /*@C
3296be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
32975dbd56e3SPeter Brune 
3298d083f849SBarry Smith    Logically Collective on global
32995dbd56e3SPeter Brune 
33004165533cSJose E. Roman    Input Parameters:
33015dbd56e3SPeter Brune +  global - global DM
3302ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
33035dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
33040298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
33055dbd56e3SPeter Brune 
3306ec4806b8SPeter Brune    Calling sequence for ddhook:
3307ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3308ec4806b8SPeter Brune 
3309ec4806b8SPeter Brune +  global - global DM
3310ec4806b8SPeter Brune .  block  - block DM
3311ec4806b8SPeter Brune -  ctx - optional user-defined function context
3312ec4806b8SPeter Brune 
33135dbd56e3SPeter Brune    Calling sequence for restricthook:
3314ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
33155dbd56e3SPeter Brune 
33165dbd56e3SPeter Brune +  global - global DM
33175dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
33185dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3319ec4806b8SPeter Brune .  block  - block DM
33205dbd56e3SPeter Brune -  ctx - optional user-defined function context
33215dbd56e3SPeter Brune 
33225dbd56e3SPeter Brune    Level: advanced
33235dbd56e3SPeter Brune 
33245dbd56e3SPeter Brune    Notes:
3325ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
33265dbd56e3SPeter Brune 
33275dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
33285dbd56e3SPeter Brune 
33295dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3330ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
33315dbd56e3SPeter Brune 
3332bb9467b5SJed Brown    This function is currently not available from Fortran.
3333bb9467b5SJed Brown 
33345dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
33355dbd56e3SPeter Brune @*/
3336be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
33375dbd56e3SPeter Brune {
33385dbd56e3SPeter Brune   PetscErrorCode      ierr;
3339be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
33405dbd56e3SPeter Brune 
33415dbd56e3SPeter Brune   PetscFunctionBegin;
33425dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3343b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3344b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3345b3a6b972SJed Brown   }
334695dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
33475dbd56e3SPeter Brune   link->restricthook = restricthook;
3348be081cd6SPeter Brune   link->ddhook       = ddhook;
33495dbd56e3SPeter Brune   link->ctx          = ctx;
33500298fd71SBarry Smith   link->next         = NULL;
33515dbd56e3SPeter Brune   *p                 = link;
33525dbd56e3SPeter Brune   PetscFunctionReturn(0);
33535dbd56e3SPeter Brune }
33545dbd56e3SPeter Brune 
3355b3a6b972SJed Brown /*@C
3356b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3357b3a6b972SJed Brown 
3358b3a6b972SJed Brown    Logically Collective
3359b3a6b972SJed Brown 
33604165533cSJose E. Roman    Input Parameters:
3361b3a6b972SJed Brown +  global - global DM
3362b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3363b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3364b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3365b3a6b972SJed Brown 
3366b3a6b972SJed Brown    Level: advanced
3367b3a6b972SJed Brown 
3368b3a6b972SJed Brown    Notes:
3369b3a6b972SJed Brown 
3370b3a6b972SJed Brown    This function is currently not available from Fortran.
3371b3a6b972SJed Brown 
3372b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3373b3a6b972SJed Brown @*/
3374b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3375b3a6b972SJed Brown {
3376b3a6b972SJed Brown   PetscErrorCode      ierr;
3377b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3378b3a6b972SJed Brown 
3379b3a6b972SJed Brown   PetscFunctionBegin;
3380b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3381b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3382b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3383b3a6b972SJed Brown       link = *p;
3384b3a6b972SJed Brown       *p = link->next;
3385b3a6b972SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3386b3a6b972SJed Brown       break;
3387b3a6b972SJed Brown     }
3388b3a6b972SJed Brown   }
3389b3a6b972SJed Brown   PetscFunctionReturn(0);
3390b3a6b972SJed Brown }
3391b3a6b972SJed Brown 
33925dbd56e3SPeter Brune /*@
3393be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
33945dbd56e3SPeter Brune 
33955dbd56e3SPeter Brune    Collective if any hooks are
33965dbd56e3SPeter Brune 
33974165533cSJose E. Roman    Input Parameters:
33985dbd56e3SPeter Brune +  fine - finer DM to use as a base
3399be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3400be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
34015dbd56e3SPeter Brune -  coarse - coarer DM to update
34025dbd56e3SPeter Brune 
34035dbd56e3SPeter Brune    Level: developer
34045dbd56e3SPeter Brune 
34055dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
34065dbd56e3SPeter Brune @*/
3407be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
34085dbd56e3SPeter Brune {
34095dbd56e3SPeter Brune   PetscErrorCode      ierr;
3410be081cd6SPeter Brune   DMSubDomainHookLink link;
34115dbd56e3SPeter Brune 
34125dbd56e3SPeter Brune   PetscFunctionBegin;
3413be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
34148865f1eaSKarl Rupp     if (link->restricthook) {
34158865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
34168865f1eaSKarl Rupp     }
34175dbd56e3SPeter Brune   }
34185dbd56e3SPeter Brune   PetscFunctionReturn(0);
34195dbd56e3SPeter Brune }
34205dbd56e3SPeter Brune 
34215fe1f584SPeter Brune /*@
34226a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
34235fe1f584SPeter Brune 
34245fe1f584SPeter Brune     Not Collective
34255fe1f584SPeter Brune 
34265fe1f584SPeter Brune     Input Parameter:
34275fe1f584SPeter Brune .   dm - the DM object
34285fe1f584SPeter Brune 
34295fe1f584SPeter Brune     Output Parameter:
34306a7d9d85SPeter Brune .   level - number of coarsenings
34315fe1f584SPeter Brune 
34325fe1f584SPeter Brune     Level: developer
34335fe1f584SPeter Brune 
34346a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34355fe1f584SPeter Brune 
34365fe1f584SPeter Brune @*/
34375fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
34385fe1f584SPeter Brune {
34395fe1f584SPeter Brune   PetscFunctionBegin;
34405fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3441b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
34425fe1f584SPeter Brune   *level = dm->leveldown;
34435fe1f584SPeter Brune   PetscFunctionReturn(0);
34445fe1f584SPeter Brune }
34455fe1f584SPeter Brune 
34469a64c4a8SMatthew G. Knepley /*@
34479a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
34489a64c4a8SMatthew G. Knepley 
34499a64c4a8SMatthew G. Knepley     Not Collective
34509a64c4a8SMatthew G. Knepley 
34519a64c4a8SMatthew G. Knepley     Input Parameters:
34529a64c4a8SMatthew G. Knepley +   dm - the DM object
34539a64c4a8SMatthew G. Knepley -   level - number of coarsenings
34549a64c4a8SMatthew G. Knepley 
34559a64c4a8SMatthew G. Knepley     Level: developer
34569a64c4a8SMatthew G. Knepley 
34579a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34589a64c4a8SMatthew G. Knepley @*/
34599a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
34609a64c4a8SMatthew G. Knepley {
34619a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
34629a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34639a64c4a8SMatthew G. Knepley   dm->leveldown = level;
34649a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
34659a64c4a8SMatthew G. Knepley }
34669a64c4a8SMatthew G. Knepley 
346747c6ae99SBarry Smith /*@C
346847c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
346947c6ae99SBarry Smith 
3470d083f849SBarry Smith     Collective on dm
347147c6ae99SBarry Smith 
3472d8d19677SJose E. Roman     Input Parameters:
347347c6ae99SBarry Smith +   dm - the DM object
347447c6ae99SBarry Smith -   nlevels - the number of levels of refinement
347547c6ae99SBarry Smith 
347647c6ae99SBarry Smith     Output Parameter:
347747c6ae99SBarry Smith .   dmf - the refined DM hierarchy
347847c6ae99SBarry Smith 
347947c6ae99SBarry Smith     Level: developer
348047c6ae99SBarry Smith 
3481e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
348247c6ae99SBarry Smith 
348347c6ae99SBarry Smith @*/
34847087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
348547c6ae99SBarry Smith {
348647c6ae99SBarry Smith   PetscErrorCode ierr;
348747c6ae99SBarry Smith 
348847c6ae99SBarry Smith   PetscFunctionBegin;
3489171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3490ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
349147c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3492b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
349347c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
349447c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
349547c6ae99SBarry Smith   } else if (dm->ops->refine) {
349647c6ae99SBarry Smith     PetscInt i;
349747c6ae99SBarry Smith 
3498ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
349947c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3500ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
350147c6ae99SBarry Smith     }
3502ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
350347c6ae99SBarry Smith   PetscFunctionReturn(0);
350447c6ae99SBarry Smith }
350547c6ae99SBarry Smith 
350647c6ae99SBarry Smith /*@C
350747c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
350847c6ae99SBarry Smith 
3509d083f849SBarry Smith     Collective on dm
351047c6ae99SBarry Smith 
3511d8d19677SJose E. Roman     Input Parameters:
351247c6ae99SBarry Smith +   dm - the DM object
351347c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
351447c6ae99SBarry Smith 
351547c6ae99SBarry Smith     Output Parameter:
351647c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
351747c6ae99SBarry Smith 
351847c6ae99SBarry Smith     Level: developer
351947c6ae99SBarry Smith 
3520e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
352147c6ae99SBarry Smith 
352247c6ae99SBarry Smith @*/
35237087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
352447c6ae99SBarry Smith {
352547c6ae99SBarry Smith   PetscErrorCode ierr;
352647c6ae99SBarry Smith 
352747c6ae99SBarry Smith   PetscFunctionBegin;
3528171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3529ce94432eSBarry Smith   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
353047c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
353147c6ae99SBarry Smith   PetscValidPointer(dmc,3);
353247c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
353347c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
353447c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
353547c6ae99SBarry Smith     PetscInt i;
353647c6ae99SBarry Smith 
3537ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
353847c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3539ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
354047c6ae99SBarry Smith     }
3541ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
354247c6ae99SBarry Smith   PetscFunctionReturn(0);
354347c6ae99SBarry Smith }
354447c6ae99SBarry Smith 
35451a266240SBarry Smith /*@C
35461a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
35471a266240SBarry Smith 
35481a266240SBarry Smith     Not Collective
35491a266240SBarry Smith 
35501a266240SBarry Smith     Input Parameters:
35511a266240SBarry Smith +   dm - the DM object
35521a266240SBarry Smith -   destroy - the destroy function
35531a266240SBarry Smith 
35541a266240SBarry Smith     Level: intermediate
35551a266240SBarry Smith 
3556e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
35571a266240SBarry Smith 
3558f07f9ceaSJed Brown @*/
35591a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
35601a266240SBarry Smith {
35611a266240SBarry Smith   PetscFunctionBegin;
3562171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35631a266240SBarry Smith   dm->ctxdestroy = destroy;
35641a266240SBarry Smith   PetscFunctionReturn(0);
35651a266240SBarry Smith }
35661a266240SBarry Smith 
3567b07ff414SBarry Smith /*@
35681b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
356947c6ae99SBarry Smith 
357047c6ae99SBarry Smith     Not Collective
357147c6ae99SBarry Smith 
357247c6ae99SBarry Smith     Input Parameters:
357347c6ae99SBarry Smith +   dm - the DM object
357447c6ae99SBarry Smith -   ctx - the user context
357547c6ae99SBarry Smith 
357647c6ae99SBarry Smith     Level: intermediate
357747c6ae99SBarry Smith 
3578e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
357947c6ae99SBarry Smith 
358047c6ae99SBarry Smith @*/
35811b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
358247c6ae99SBarry Smith {
358347c6ae99SBarry Smith   PetscFunctionBegin;
3584171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
358547c6ae99SBarry Smith   dm->ctx = ctx;
358647c6ae99SBarry Smith   PetscFunctionReturn(0);
358747c6ae99SBarry Smith }
358847c6ae99SBarry Smith 
358947c6ae99SBarry Smith /*@
35901b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
359147c6ae99SBarry Smith 
359247c6ae99SBarry Smith     Not Collective
359347c6ae99SBarry Smith 
359447c6ae99SBarry Smith     Input Parameter:
359547c6ae99SBarry Smith .   dm - the DM object
359647c6ae99SBarry Smith 
359747c6ae99SBarry Smith     Output Parameter:
359847c6ae99SBarry Smith .   ctx - the user context
359947c6ae99SBarry Smith 
360047c6ae99SBarry Smith     Level: intermediate
360147c6ae99SBarry Smith 
3602e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
360347c6ae99SBarry Smith 
360447c6ae99SBarry Smith @*/
36051b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
360647c6ae99SBarry Smith {
360747c6ae99SBarry Smith   PetscFunctionBegin;
3608171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
36091b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
361047c6ae99SBarry Smith   PetscFunctionReturn(0);
361147c6ae99SBarry Smith }
361247c6ae99SBarry Smith 
361308da532bSDmitry Karpeev /*@C
3614df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
361508da532bSDmitry Karpeev 
3616d083f849SBarry Smith     Logically Collective on dm
361708da532bSDmitry Karpeev 
3618d8d19677SJose E. Roman     Input Parameters:
361908da532bSDmitry Karpeev +   dm - the DM object
36200298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
362108da532bSDmitry Karpeev 
362208da532bSDmitry Karpeev     Level: intermediate
362308da532bSDmitry Karpeev 
3624835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
362508da532bSDmitry Karpeev          DMSetJacobian()
362608da532bSDmitry Karpeev 
362708da532bSDmitry Karpeev @*/
362808da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
362908da532bSDmitry Karpeev {
363008da532bSDmitry Karpeev   PetscFunctionBegin;
36315a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
363208da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
363308da532bSDmitry Karpeev   PetscFunctionReturn(0);
363408da532bSDmitry Karpeev }
363508da532bSDmitry Karpeev 
363608da532bSDmitry Karpeev /*@
363708da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
363808da532bSDmitry Karpeev 
363908da532bSDmitry Karpeev     Not Collective
364008da532bSDmitry Karpeev 
364108da532bSDmitry Karpeev     Input Parameter:
364208da532bSDmitry Karpeev .   dm - the DM object to destroy
364308da532bSDmitry Karpeev 
364408da532bSDmitry Karpeev     Output Parameter:
364508da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
364608da532bSDmitry Karpeev 
364708da532bSDmitry Karpeev     Level: developer
364808da532bSDmitry Karpeev 
364974e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
365008da532bSDmitry Karpeev 
365108da532bSDmitry Karpeev @*/
365208da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
365308da532bSDmitry Karpeev {
365408da532bSDmitry Karpeev   PetscFunctionBegin;
36555a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3656534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
365708da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
365808da532bSDmitry Karpeev   PetscFunctionReturn(0);
365908da532bSDmitry Karpeev }
366008da532bSDmitry Karpeev 
366108da532bSDmitry Karpeev /*@C
366208da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
366308da532bSDmitry Karpeev 
3664d083f849SBarry Smith     Logically Collective on dm
366508da532bSDmitry Karpeev 
3666f899ff85SJose E. Roman     Input Parameter:
3667907376e6SBarry Smith .   dm - the DM object
366808da532bSDmitry Karpeev 
366908da532bSDmitry Karpeev     Output parameters:
367008da532bSDmitry Karpeev +   xl - lower bound
367108da532bSDmitry Karpeev -   xu - upper bound
367208da532bSDmitry Karpeev 
3673907376e6SBarry Smith     Level: advanced
3674907376e6SBarry Smith 
367595452b02SPatrick Sanan     Notes:
367695452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
367708da532bSDmitry Karpeev 
367874e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
367908da532bSDmitry Karpeev 
368008da532bSDmitry Karpeev @*/
368108da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
368208da532bSDmitry Karpeev {
368308da532bSDmitry Karpeev   PetscErrorCode ierr;
36845fd66863SKarl Rupp 
368508da532bSDmitry Karpeev   PetscFunctionBegin;
36865a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
368708da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
36885a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
3689b9d85ea2SLisandro Dalcin   if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
369008da532bSDmitry Karpeev   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
369108da532bSDmitry Karpeev   PetscFunctionReturn(0);
369208da532bSDmitry Karpeev }
369308da532bSDmitry Karpeev 
3694b0ae01b7SPeter Brune /*@
3695b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3696b0ae01b7SPeter Brune 
3697b0ae01b7SPeter Brune     Not Collective
3698b0ae01b7SPeter Brune 
3699b0ae01b7SPeter Brune     Input Parameter:
3700b0ae01b7SPeter Brune .   dm - the DM object
3701b0ae01b7SPeter Brune 
3702b0ae01b7SPeter Brune     Output Parameter:
3703b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3704b0ae01b7SPeter Brune 
3705b0ae01b7SPeter Brune     Level: developer
3706b0ae01b7SPeter Brune 
37071565f0a7SPatrick Sanan .seealso DMCreateColoring()
3708b0ae01b7SPeter Brune 
3709b0ae01b7SPeter Brune @*/
3710b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3711b0ae01b7SPeter Brune {
3712b0ae01b7SPeter Brune   PetscFunctionBegin;
37135a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3714534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3715b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3716b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3717b0ae01b7SPeter Brune }
3718b0ae01b7SPeter Brune 
37193ad4599aSBarry Smith /*@
37203ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
37213ad4599aSBarry Smith 
37223ad4599aSBarry Smith     Not Collective
37233ad4599aSBarry Smith 
37243ad4599aSBarry Smith     Input Parameter:
37253ad4599aSBarry Smith .   dm - the DM object
37263ad4599aSBarry Smith 
37273ad4599aSBarry Smith     Output Parameter:
37283ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
37293ad4599aSBarry Smith 
37303ad4599aSBarry Smith     Level: developer
37313ad4599aSBarry Smith 
37321565f0a7SPatrick Sanan .seealso DMCreateRestriction()
37333ad4599aSBarry Smith 
37343ad4599aSBarry Smith @*/
37353ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
37363ad4599aSBarry Smith {
37373ad4599aSBarry Smith   PetscFunctionBegin;
37385a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3739534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37403ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
37413ad4599aSBarry Smith   PetscFunctionReturn(0);
37423ad4599aSBarry Smith }
37433ad4599aSBarry Smith 
3744a7058e45SLawrence Mitchell /*@
3745a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3746a7058e45SLawrence Mitchell 
3747a7058e45SLawrence Mitchell     Not Collective
3748a7058e45SLawrence Mitchell 
3749a7058e45SLawrence Mitchell     Input Parameter:
3750a7058e45SLawrence Mitchell .   dm - the DM object
3751a7058e45SLawrence Mitchell 
3752a7058e45SLawrence Mitchell     Output Parameter:
3753a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3754a7058e45SLawrence Mitchell 
3755a7058e45SLawrence Mitchell     Level: developer
3756a7058e45SLawrence Mitchell 
37571565f0a7SPatrick Sanan .seealso DMCreateInjection()
3758a7058e45SLawrence Mitchell 
3759a7058e45SLawrence Mitchell @*/
3760a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3761a7058e45SLawrence Mitchell {
37624a7a4c06SLawrence Mitchell   PetscErrorCode ierr;
37635a84ad33SLisandro Dalcin 
3764a7058e45SLawrence Mitchell   PetscFunctionBegin;
37655a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3766534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37675a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
37684a7a4c06SLawrence Mitchell     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
37695a84ad33SLisandro Dalcin   } else {
37705a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
37715a84ad33SLisandro Dalcin   }
3772a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3773a7058e45SLawrence Mitchell }
3774a7058e45SLawrence Mitchell 
37750298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3776264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3777264ace61SBarry Smith 
3778264ace61SBarry Smith /*@C
3779264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3780264ace61SBarry Smith 
3781d083f849SBarry Smith   Collective on dm
3782264ace61SBarry Smith 
3783264ace61SBarry Smith   Input Parameters:
3784264ace61SBarry Smith + dm     - The DM object
3785264ace61SBarry Smith - method - The name of the DM type
3786264ace61SBarry Smith 
3787264ace61SBarry Smith   Options Database Key:
3788264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3789264ace61SBarry Smith 
3790264ace61SBarry Smith   Notes:
3791e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3792264ace61SBarry Smith 
3793264ace61SBarry Smith   Level: intermediate
3794264ace61SBarry Smith 
3795264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3796264ace61SBarry Smith @*/
379719fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3798264ace61SBarry Smith {
3799264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3800264ace61SBarry Smith   PetscBool      match;
3801264ace61SBarry Smith   PetscErrorCode ierr;
3802264ace61SBarry Smith 
3803264ace61SBarry Smith   PetscFunctionBegin;
3804264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3805251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3806264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3807264ace61SBarry Smith 
38080f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
38091c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
3810ce94432eSBarry Smith   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3811264ace61SBarry Smith 
3812264ace61SBarry Smith   if (dm->ops->destroy) {
3813264ace61SBarry Smith     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3814264ace61SBarry Smith   }
3815d57f96a3SLisandro Dalcin   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3816264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3817d57f96a3SLisandro Dalcin   ierr = (*r)(dm);CHKERRQ(ierr);
3818264ace61SBarry Smith   PetscFunctionReturn(0);
3819264ace61SBarry Smith }
3820264ace61SBarry Smith 
3821264ace61SBarry Smith /*@C
3822264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3823264ace61SBarry Smith 
3824264ace61SBarry Smith   Not Collective
3825264ace61SBarry Smith 
3826264ace61SBarry Smith   Input Parameter:
3827264ace61SBarry Smith . dm  - The DM
3828264ace61SBarry Smith 
3829264ace61SBarry Smith   Output Parameter:
3830264ace61SBarry Smith . type - The DM type name
3831264ace61SBarry Smith 
3832264ace61SBarry Smith   Level: intermediate
3833264ace61SBarry Smith 
3834264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3835264ace61SBarry Smith @*/
383619fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3837264ace61SBarry Smith {
3838264ace61SBarry Smith   PetscErrorCode ierr;
3839264ace61SBarry Smith 
3840264ace61SBarry Smith   PetscFunctionBegin;
3841264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3842c959eef4SJed Brown   PetscValidPointer(type,2);
3843607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3844264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3845264ace61SBarry Smith   PetscFunctionReturn(0);
3846264ace61SBarry Smith }
3847264ace61SBarry Smith 
384867a56275SMatthew G Knepley /*@C
384967a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
385067a56275SMatthew G Knepley 
3851d083f849SBarry Smith   Collective on dm
385267a56275SMatthew G Knepley 
385367a56275SMatthew G Knepley   Input Parameters:
385467a56275SMatthew G Knepley + dm - the DM
385567a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
385667a56275SMatthew G Knepley 
385767a56275SMatthew G Knepley   Output Parameter:
385867a56275SMatthew G Knepley . M - pointer to new DM
385967a56275SMatthew G Knepley 
386067a56275SMatthew G Knepley   Notes:
386167a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
386267a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
386367a56275SMatthew G Knepley   of the input DM.
386467a56275SMatthew G Knepley 
386567a56275SMatthew G Knepley   Level: intermediate
386667a56275SMatthew G Knepley 
386767a56275SMatthew G Knepley .seealso: DMCreate()
386867a56275SMatthew G Knepley @*/
386919fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
387067a56275SMatthew G Knepley {
387167a56275SMatthew G Knepley   DM             B;
387267a56275SMatthew G Knepley   char           convname[256];
3873c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
387467a56275SMatthew G Knepley   PetscErrorCode ierr;
387567a56275SMatthew G Knepley 
387667a56275SMatthew G Knepley   PetscFunctionBegin;
387767a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
387867a56275SMatthew G Knepley   PetscValidType(dm,1);
387967a56275SMatthew G Knepley   PetscValidPointer(M,3);
3880251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3881c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3882c067b6caSMatthew G. Knepley   if (sametype) {
3883c067b6caSMatthew G. Knepley     *M   = dm;
3884c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3885c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3886c067b6caSMatthew G. Knepley   } else {
38870298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
388867a56275SMatthew G Knepley 
388967a56275SMatthew G Knepley     /*
389067a56275SMatthew G Knepley        Order of precedence:
389167a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
389267a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
389367a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
389467a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
389567a56275SMatthew G Knepley        5) Use a really basic converter.
389667a56275SMatthew G Knepley     */
389767a56275SMatthew G Knepley 
389867a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
3899a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3900a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3901a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3902a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3903a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
39040005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
390567a56275SMatthew G Knepley     if (conv) goto foundconv;
390667a56275SMatthew G Knepley 
390767a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
390882f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
390967a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3910a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3911a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3912a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3913a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3914a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
39150005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
391667a56275SMatthew G Knepley     if (conv) {
3917fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
391867a56275SMatthew G Knepley       goto foundconv;
391967a56275SMatthew G Knepley     }
392067a56275SMatthew G Knepley 
392167a56275SMatthew G Knepley #if 0
392267a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
392367a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3924fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
392567a56275SMatthew G Knepley     if (conv) goto foundconv;
392667a56275SMatthew G Knepley 
392767a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
392867a56275SMatthew G Knepley     if (dm->ops->convert) {
392967a56275SMatthew G Knepley       conv = dm->ops->convert;
393067a56275SMatthew G Knepley     }
393167a56275SMatthew G Knepley     if (conv) goto foundconv;
393267a56275SMatthew G Knepley #endif
393367a56275SMatthew G Knepley 
393467a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
393582f516ccSBarry Smith     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
393667a56275SMatthew G Knepley 
393767a56275SMatthew G Knepley foundconv:
393867a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
393967a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
394012fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
394190b157c4SStefano Zampini     {
394290b157c4SStefano Zampini       PetscBool             isper;
394312fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
394412fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
394590b157c4SStefano Zampini       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
394690b157c4SStefano Zampini       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
3947c8a6034eSMark       (*M)->prealloc_only = dm->prealloc_only;
3948a587d139SMark       ierr = PetscFree((*M)->vectype);CHKERRQ(ierr);
3949a587d139SMark       ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr);
3950a587d139SMark       ierr = PetscFree((*M)->mattype);CHKERRQ(ierr);
3951a587d139SMark       ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr);
395212fa691eSMatthew G. Knepley     }
395367a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
395467a56275SMatthew G Knepley   }
395567a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
395667a56275SMatthew G Knepley   PetscFunctionReturn(0);
395767a56275SMatthew G Knepley }
3958264ace61SBarry Smith 
3959264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3960264ace61SBarry Smith 
3961264ace61SBarry Smith /*@C
39621c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
39631c84c290SBarry Smith 
39641c84c290SBarry Smith   Not Collective
39651c84c290SBarry Smith 
39661c84c290SBarry Smith   Input Parameters:
39671c84c290SBarry Smith + name        - The name of a new user-defined creation routine
39681c84c290SBarry Smith - create_func - The creation routine itself
39691c84c290SBarry Smith 
39701c84c290SBarry Smith   Notes:
39711c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
39721c84c290SBarry Smith 
39731c84c290SBarry Smith   Sample usage:
39741c84c290SBarry Smith .vb
3975bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
39761c84c290SBarry Smith .ve
39771c84c290SBarry Smith 
39781c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
39791c84c290SBarry Smith .vb
39801c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
39811c84c290SBarry Smith     DMSetType(DM,"my_da");
39821c84c290SBarry Smith .ve
39831c84c290SBarry Smith    or at runtime via the option
39841c84c290SBarry Smith .vb
39851c84c290SBarry Smith     -da_type my_da
39861c84c290SBarry Smith .ve
3987264ace61SBarry Smith 
3988264ace61SBarry Smith   Level: advanced
39891c84c290SBarry Smith 
3990bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
39911c84c290SBarry Smith 
3992264ace61SBarry Smith @*/
3993bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3994264ace61SBarry Smith {
3995264ace61SBarry Smith   PetscErrorCode ierr;
3996264ace61SBarry Smith 
3997264ace61SBarry Smith   PetscFunctionBegin;
39981d36bdfdSBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
3999a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
4000264ace61SBarry Smith   PetscFunctionReturn(0);
4001264ace61SBarry Smith }
4002264ace61SBarry Smith 
4003b859378eSBarry Smith /*@C
400455849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
4005b859378eSBarry Smith 
4006d083f849SBarry Smith   Collective on viewer
4007b859378eSBarry Smith 
4008b859378eSBarry Smith   Input Parameters:
4009b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
4010b859378eSBarry Smith            some related function before a call to DMLoad().
4011b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
4012b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
4013b859378eSBarry Smith 
4014b859378eSBarry Smith    Level: intermediate
4015b859378eSBarry Smith 
4016b859378eSBarry Smith   Notes:
401755849f57SBarry Smith    The type is determined by the data in the file, any type set into the DM before this call is ignored.
4018b859378eSBarry Smith 
4019b859378eSBarry Smith   Notes for advanced users:
4020b859378eSBarry Smith   Most users should not need to know the details of the binary storage
4021b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
4022b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
4023b859378eSBarry Smith   format is
4024b859378eSBarry Smith .vb
4025b859378eSBarry Smith      has not yet been determined
4026b859378eSBarry Smith .ve
4027b859378eSBarry Smith 
4028b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
4029b859378eSBarry Smith @*/
4030b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
4031b859378eSBarry Smith {
40329331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
4033b859378eSBarry Smith   PetscErrorCode ierr;
4034b859378eSBarry Smith 
4035b859378eSBarry Smith   PetscFunctionBegin;
4036b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
4037b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
4038fb694a9eSVaclav Hapla   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
403932c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
40409331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
404158cd63d5SVaclav Hapla   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
40429331c7a4SMatthew G. Knepley   if (isbinary) {
40439331c7a4SMatthew G. Knepley     PetscInt classid;
40449331c7a4SMatthew G. Knepley     char     type[256];
4045b859378eSBarry Smith 
4046060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
40479200755eSBarry Smith     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
4048060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
404932c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
40509331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
40519331c7a4SMatthew G. Knepley   } else if (ishdf5) {
40529331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
40539331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
405458cd63d5SVaclav Hapla   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
4055b859378eSBarry Smith   PetscFunctionReturn(0);
4056b859378eSBarry Smith }
4057b859378eSBarry Smith 
4058b2e4378dSMatthew G. Knepley /*@
4059b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
4060b2e4378dSMatthew G. Knepley 
4061b2e4378dSMatthew G. Knepley   Not collective
4062b2e4378dSMatthew G. Knepley 
4063b2e4378dSMatthew G. Knepley   Input Parameter:
4064b2e4378dSMatthew G. Knepley . dm - the DM
4065b2e4378dSMatthew G. Knepley 
4066b2e4378dSMatthew G. Knepley   Output Parameters:
4067b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
4068b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
4069b2e4378dSMatthew G. Knepley 
4070b2e4378dSMatthew G. Knepley   Level: beginner
4071b2e4378dSMatthew G. Knepley 
4072b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
4073b2e4378dSMatthew G. Knepley 
4074b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
4075b2e4378dSMatthew G. Knepley @*/
4076b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
4077b2e4378dSMatthew G. Knepley {
4078b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
4079b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
4080b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
4081b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
4082b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
4083b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
4084b2e4378dSMatthew G. Knepley   PetscErrorCode     ierr;
4085b2e4378dSMatthew G. Knepley 
4086b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4087b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4088b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4089b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
4090b2e4378dSMatthew G. Knepley   if (coords) {
4091b2e4378dSMatthew G. Knepley     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
4092b2e4378dSMatthew G. Knepley     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
4093b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
4094b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
4095b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
4096b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4097b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4098b2e4378dSMatthew G. Knepley       }
4099b2e4378dSMatthew G. Knepley     }
4100b2e4378dSMatthew G. Knepley     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
4101b2e4378dSMatthew G. Knepley   } else {
4102b2e4378dSMatthew G. Knepley     PetscBool isda;
4103b2e4378dSMatthew G. Knepley 
4104b2e4378dSMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
4105b2e4378dSMatthew G. Knepley     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
4106b2e4378dSMatthew G. Knepley   }
4107b2e4378dSMatthew G. Knepley   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
4108b2e4378dSMatthew G. Knepley   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
4109b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4110b2e4378dSMatthew G. Knepley }
4111b2e4378dSMatthew G. Knepley 
4112b2e4378dSMatthew G. Knepley /*@
4113b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
4114b2e4378dSMatthew G. Knepley 
4115b2e4378dSMatthew G. Knepley   Collective
4116b2e4378dSMatthew G. Knepley 
4117b2e4378dSMatthew G. Knepley   Input Parameter:
4118b2e4378dSMatthew G. Knepley . dm - the DM
4119b2e4378dSMatthew G. Knepley 
4120b2e4378dSMatthew G. Knepley   Output Parameters:
4121b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
4122b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
4123b2e4378dSMatthew G. Knepley 
4124b2e4378dSMatthew G. Knepley   Level: beginner
4125b2e4378dSMatthew G. Knepley 
4126b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
4127b2e4378dSMatthew G. Knepley @*/
4128b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
4129b2e4378dSMatthew G. Knepley {
4130b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
41316ce308c4SMatthew G. Knepley   PetscInt       cdim;
41326ce308c4SMatthew G. Knepley   PetscMPIInt    count;
4133b2e4378dSMatthew G. Knepley   PetscErrorCode ierr;
4134b2e4378dSMatthew G. Knepley 
4135b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4136b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4137b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4138b2e4378dSMatthew G. Knepley   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
4139b2e4378dSMatthew G. Knepley   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
4140820f2d46SBarry Smith   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4141820f2d46SBarry Smith   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4142b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4143b2e4378dSMatthew G. Knepley }
4144b2e4378dSMatthew G. Knepley 
41457da65231SMatthew G Knepley /******************************** FEM Support **********************************/
41467da65231SMatthew G Knepley 
4147a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
4148a6dfd86eSKarl Rupp {
41491d47ebbbSSatish Balay   PetscInt       f;
41501b30c384SMatthew G Knepley   PetscErrorCode ierr;
41511b30c384SMatthew G Knepley 
41527da65231SMatthew G Knepley   PetscFunctionBegin;
415374778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
41541d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
415557622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
41567da65231SMatthew G Knepley   }
41577da65231SMatthew G Knepley   PetscFunctionReturn(0);
41587da65231SMatthew G Knepley }
41597da65231SMatthew G Knepley 
4160a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4161a6dfd86eSKarl Rupp {
41621b30c384SMatthew G Knepley   PetscInt       f, g;
41637da65231SMatthew G Knepley   PetscErrorCode ierr;
41647da65231SMatthew G Knepley 
41657da65231SMatthew G Knepley   PetscFunctionBegin;
416674778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
41671d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
416874778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
41691d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
4170e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
41717da65231SMatthew G Knepley     }
417274778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
41737da65231SMatthew G Knepley   }
41747da65231SMatthew G Knepley   PetscFunctionReturn(0);
41757da65231SMatthew G Knepley }
4176e7c4fc90SDmitry Karpeev 
41776113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4178e759306cSMatthew G. Knepley {
41790c5b8624SToby Isaac   PetscInt          localSize, bs;
41800c5b8624SToby Isaac   PetscMPIInt       size;
41810c5b8624SToby Isaac   Vec               x, xglob;
41820c5b8624SToby Isaac   const PetscScalar *xarray;
4183e759306cSMatthew G. Knepley   PetscErrorCode    ierr;
4184e759306cSMatthew G. Knepley 
4185e759306cSMatthew G. Knepley   PetscFunctionBegin;
4186ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr);
4187e759306cSMatthew G. Knepley   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
4188e759306cSMatthew G. Knepley   ierr = VecCopy(X, x);CHKERRQ(ierr);
41896113b454SMatthew G. Knepley   ierr = VecChop(x, tol);CHKERRQ(ierr);
41900c5b8624SToby Isaac   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
41910c5b8624SToby Isaac   if (size > 1) {
41920c5b8624SToby Isaac     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
41930c5b8624SToby Isaac     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
41940c5b8624SToby Isaac     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
41950c5b8624SToby Isaac     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
41960c5b8624SToby Isaac   } else {
41970c5b8624SToby Isaac     xglob = x;
41980c5b8624SToby Isaac   }
41990c5b8624SToby Isaac   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
42000c5b8624SToby Isaac   if (size > 1) {
42010c5b8624SToby Isaac     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
42020c5b8624SToby Isaac     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
42030c5b8624SToby Isaac   }
4204e759306cSMatthew G. Knepley   ierr = VecDestroy(&x);CHKERRQ(ierr);
4205e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4206e759306cSMatthew G. Knepley }
4207e759306cSMatthew G. Knepley 
420888ed4aceSMatthew G Knepley /*@
42091bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4210061576a5SJed Brown 
4211061576a5SJed Brown   Input Parameter:
4212061576a5SJed Brown . dm - The DM
4213061576a5SJed Brown 
4214061576a5SJed Brown   Output Parameter:
4215061576a5SJed Brown . section - The PetscSection
4216061576a5SJed Brown 
4217061576a5SJed Brown   Options Database Keys:
4218061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4219061576a5SJed Brown 
4220061576a5SJed Brown   Level: advanced
4221061576a5SJed Brown 
4222061576a5SJed Brown   Notes:
4223061576a5SJed Brown   Use DMGetLocalSection() in new code.
4224061576a5SJed Brown 
4225061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4226061576a5SJed Brown 
4227061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4228061576a5SJed Brown @*/
4229061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4230061576a5SJed Brown {
4231061576a5SJed Brown   PetscErrorCode ierr;
4232061576a5SJed Brown 
4233061576a5SJed Brown   PetscFunctionBegin;
4234061576a5SJed Brown   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
4235061576a5SJed Brown   PetscFunctionReturn(0);
4236061576a5SJed Brown }
4237061576a5SJed Brown 
4238061576a5SJed Brown /*@
4239061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
424088ed4aceSMatthew G Knepley 
424188ed4aceSMatthew G Knepley   Input Parameter:
424288ed4aceSMatthew G Knepley . dm - The DM
424388ed4aceSMatthew G Knepley 
424488ed4aceSMatthew G Knepley   Output Parameter:
424588ed4aceSMatthew G Knepley . section - The PetscSection
424688ed4aceSMatthew G Knepley 
4247e5893cccSMatthew G. Knepley   Options Database Keys:
4248e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4249e5893cccSMatthew G. Knepley 
425088ed4aceSMatthew G Knepley   Level: intermediate
425188ed4aceSMatthew G Knepley 
425288ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
425388ed4aceSMatthew G Knepley 
4254061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
425588ed4aceSMatthew G Knepley @*/
4256061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
42570adebc6cSBarry Smith {
4258fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
4259fd59a867SMatthew G. Knepley 
426088ed4aceSMatthew G Knepley   PetscFunctionBegin;
426188ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
426288ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
42631bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4264e5e52638SMatthew G. Knepley     PetscInt d;
4265e5e52638SMatthew G. Knepley 
426645480ffeSMatthew G. Knepley     if (dm->setfromoptionscalled) {
426745480ffeSMatthew G. Knepley       PetscObject       obj = (PetscObject) dm;
426845480ffeSMatthew G. Knepley       PetscViewer       viewer;
426945480ffeSMatthew G. Knepley       PetscViewerFormat format;
427045480ffeSMatthew G. Knepley       PetscBool         flg;
427145480ffeSMatthew G. Knepley 
427245480ffeSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr);
427345480ffeSMatthew G. Knepley       if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);}
427445480ffeSMatthew G. Knepley       for (d = 0; d < dm->Nds; ++d) {
427545480ffeSMatthew G. Knepley         ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);
427645480ffeSMatthew G. Knepley         if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);}
427745480ffeSMatthew G. Knepley       }
427845480ffeSMatthew G. Knepley       if (flg) {
427945480ffeSMatthew G. Knepley         ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
428045480ffeSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
428145480ffeSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
428245480ffeSMatthew G. Knepley       }
428345480ffeSMatthew G. Knepley     }
42841bb6d2a8SBarry Smith     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
42851bb6d2a8SBarry Smith     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
42862f0f8703SMatthew G. Knepley   }
42871bb6d2a8SBarry Smith   *section = dm->localSection;
428888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
428988ed4aceSMatthew G Knepley }
429088ed4aceSMatthew G Knepley 
429188ed4aceSMatthew G Knepley /*@
42921bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4293061576a5SJed Brown 
4294061576a5SJed Brown   Input Parameters:
4295061576a5SJed Brown + dm - The DM
4296061576a5SJed Brown - section - The PetscSection
4297061576a5SJed Brown 
4298061576a5SJed Brown   Level: advanced
4299061576a5SJed Brown 
4300061576a5SJed Brown   Notes:
4301061576a5SJed Brown   Use DMSetLocalSection() in new code.
4302061576a5SJed Brown 
4303061576a5SJed Brown   Any existing Section will be destroyed
4304061576a5SJed Brown 
4305061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4306061576a5SJed Brown @*/
4307061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4308061576a5SJed Brown {
4309061576a5SJed Brown   PetscErrorCode ierr;
4310061576a5SJed Brown 
4311061576a5SJed Brown   PetscFunctionBegin;
4312061576a5SJed Brown   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4313061576a5SJed Brown   PetscFunctionReturn(0);
4314061576a5SJed Brown }
4315061576a5SJed Brown 
4316061576a5SJed Brown /*@
4317061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
431888ed4aceSMatthew G Knepley 
431988ed4aceSMatthew G Knepley   Input Parameters:
432088ed4aceSMatthew G Knepley + dm - The DM
432188ed4aceSMatthew G Knepley - section - The PetscSection
432288ed4aceSMatthew G Knepley 
432388ed4aceSMatthew G Knepley   Level: intermediate
432488ed4aceSMatthew G Knepley 
432588ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
432688ed4aceSMatthew G Knepley 
4327061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
432888ed4aceSMatthew G Knepley @*/
4329061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
43300adebc6cSBarry Smith {
4331c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4332af122d2aSMatthew G Knepley   PetscInt       f;
433388ed4aceSMatthew G Knepley   PetscErrorCode ierr;
433488ed4aceSMatthew G Knepley 
433588ed4aceSMatthew G Knepley   PetscFunctionBegin;
433688ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4337b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
43381d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
43391bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
43401bb6d2a8SBarry Smith   dm->localSection = section;
43411bb6d2a8SBarry Smith   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4342af122d2aSMatthew G Knepley   if (numFields) {
4343af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4344af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
43450f21e855SMatthew G. Knepley       PetscObject disc;
4346af122d2aSMatthew G Knepley       const char *name;
4347af122d2aSMatthew G Knepley 
43481bb6d2a8SBarry Smith       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
434944a7f3ddSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
43500f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4351af122d2aSMatthew G Knepley     }
4352af122d2aSMatthew G Knepley   }
4353e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
43541bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
435588ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
435688ed4aceSMatthew G Knepley }
435788ed4aceSMatthew G Knepley 
43589435951eSToby Isaac /*@
4359b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
43609435951eSToby Isaac 
4361e228b242SToby Isaac   not collective
4362e228b242SToby Isaac 
43639435951eSToby Isaac   Input Parameter:
43649435951eSToby Isaac . dm - The DM
43659435951eSToby Isaac 
4366d8d19677SJose E. Roman   Output Parameters:
43679435951eSToby 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.
43689435951eSToby 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.
43699435951eSToby Isaac 
43709435951eSToby Isaac   Level: advanced
43719435951eSToby Isaac 
43729435951eSToby Isaac   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
43739435951eSToby Isaac 
43749435951eSToby Isaac .seealso: DMSetDefaultConstraints()
43759435951eSToby Isaac @*/
43769435951eSToby Isaac PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
43779435951eSToby Isaac {
43789435951eSToby Isaac   PetscErrorCode ierr;
43799435951eSToby Isaac 
43809435951eSToby Isaac   PetscFunctionBegin;
43819435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
43829435951eSToby Isaac   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
438345a75d81SToby Isaac   if (section) {*section = dm->defaultConstraintSection;}
438445a75d81SToby Isaac   if (mat) {*mat = dm->defaultConstraintMat;}
43859435951eSToby Isaac   PetscFunctionReturn(0);
43869435951eSToby Isaac }
43879435951eSToby Isaac 
43889435951eSToby Isaac /*@
4389b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
43909435951eSToby Isaac 
43919435951eSToby 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().
43929435951eSToby Isaac 
43939435951eSToby 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.
43949435951eSToby Isaac 
4395e228b242SToby Isaac   collective on dm
4396e228b242SToby Isaac 
43979435951eSToby Isaac   Input Parameters:
43989435951eSToby Isaac + dm - The DM
4399e228b242SToby 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).
4400e228b242SToby 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).
44019435951eSToby Isaac 
44029435951eSToby Isaac   Level: advanced
44039435951eSToby Isaac 
44049435951eSToby Isaac   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
44059435951eSToby Isaac 
44069435951eSToby Isaac .seealso: DMGetDefaultConstraints()
44079435951eSToby Isaac @*/
44089435951eSToby Isaac PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
44099435951eSToby Isaac {
4410e228b242SToby Isaac   PetscMPIInt result;
44119435951eSToby Isaac   PetscErrorCode ierr;
44129435951eSToby Isaac 
44139435951eSToby Isaac   PetscFunctionBegin;
44149435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4415e228b242SToby Isaac   if (section) {
4416e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4417ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr);
4418f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4419e228b242SToby Isaac   }
4420e228b242SToby Isaac   if (mat) {
4421e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4422ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr);
4423f60917d2SBarry Smith     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4424e228b242SToby Isaac   }
44259435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
44269435951eSToby Isaac   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
44279435951eSToby Isaac   dm->defaultConstraintSection = section;
44289435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
44299435951eSToby Isaac   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
44309435951eSToby Isaac   dm->defaultConstraintMat = mat;
44319435951eSToby Isaac   PetscFunctionReturn(0);
44329435951eSToby Isaac }
44339435951eSToby Isaac 
4434497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4435507e4973SMatthew G. Knepley /*
4436507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4437507e4973SMatthew G. Knepley 
4438507e4973SMatthew G. Knepley   Input Parameters:
4439507e4973SMatthew G. Knepley + dm - The DM
4440507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4441507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4442507e4973SMatthew G. Knepley 
4443507e4973SMatthew G. Knepley   Level: intermediate
4444507e4973SMatthew G. Knepley 
44451bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4446507e4973SMatthew G. Knepley */
4447f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4448507e4973SMatthew G. Knepley {
4449507e4973SMatthew G. Knepley   MPI_Comm        comm;
4450507e4973SMatthew G. Knepley   PetscLayout     layout;
4451507e4973SMatthew G. Knepley   const PetscInt *ranges;
4452507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4453507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4454507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4455507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
4456507e4973SMatthew G. Knepley 
4457507e4973SMatthew G. Knepley   PetscFunctionBegin;
4458507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4459507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4460ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
4461ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
4462507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4463507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4464507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4465507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4466507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4467507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4468507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4469507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4470f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4471507e4973SMatthew G. Knepley 
4472507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4473507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4474507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4475507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4476507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4477507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4478507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
4479507e4973SMatthew 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;}
4480507e4973SMatthew 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;}
4481507e4973SMatthew G. Knepley     if (gdof < 0) {
4482507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4483507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4484507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4485507e4973SMatthew G. Knepley 
4486507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4487507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
4488507e4973SMatthew 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;}
4489507e4973SMatthew G. Knepley       }
4490507e4973SMatthew G. Knepley     }
4491507e4973SMatthew G. Knepley   }
4492507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4493507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4494820f2d46SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
4495507e4973SMatthew G. Knepley   if (!gvalid) {
4496507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4497507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4498507e4973SMatthew G. Knepley   }
4499507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4500507e4973SMatthew G. Knepley }
4501f741bcd2SMatthew G. Knepley #endif
4502507e4973SMatthew G. Knepley 
450388ed4aceSMatthew G Knepley /*@
4504e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
450588ed4aceSMatthew G Knepley 
4506d083f849SBarry Smith   Collective on dm
45078b1ab98fSJed Brown 
450888ed4aceSMatthew G Knepley   Input Parameter:
450988ed4aceSMatthew G Knepley . dm - The DM
451088ed4aceSMatthew G Knepley 
451188ed4aceSMatthew G Knepley   Output Parameter:
451288ed4aceSMatthew G Knepley . section - The PetscSection
451388ed4aceSMatthew G Knepley 
451488ed4aceSMatthew G Knepley   Level: intermediate
451588ed4aceSMatthew G Knepley 
451688ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
451788ed4aceSMatthew G Knepley 
451892fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
451988ed4aceSMatthew G Knepley @*/
4520e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
45210adebc6cSBarry Smith {
452288ed4aceSMatthew G Knepley   PetscErrorCode ierr;
452388ed4aceSMatthew G Knepley 
452488ed4aceSMatthew G Knepley   PetscFunctionBegin;
452588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
452688ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
45271bb6d2a8SBarry Smith   if (!dm->globalSection) {
4528fd59a867SMatthew G. Knepley     PetscSection s;
4529fd59a867SMatthew G. Knepley 
453092fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
4531fd59a867SMatthew G. Knepley     if (!s)  SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection");
453233907cc2SStefano Zampini     if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection");
45331bb6d2a8SBarry Smith     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4534cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
45351bb6d2a8SBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
45361bb6d2a8SBarry Smith     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
453788ed4aceSMatthew G Knepley   }
45381bb6d2a8SBarry Smith   *section = dm->globalSection;
453988ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
454088ed4aceSMatthew G Knepley }
454188ed4aceSMatthew G Knepley 
4542b21d0597SMatthew G Knepley /*@
4543e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4544b21d0597SMatthew G Knepley 
4545b21d0597SMatthew G Knepley   Input Parameters:
4546b21d0597SMatthew G Knepley + dm - The DM
45475080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4548b21d0597SMatthew G Knepley 
4549b21d0597SMatthew G Knepley   Level: intermediate
4550b21d0597SMatthew G Knepley 
4551b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4552b21d0597SMatthew G Knepley 
455392fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4554b21d0597SMatthew G Knepley @*/
4555e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
45560adebc6cSBarry Smith {
4557b21d0597SMatthew G Knepley   PetscErrorCode ierr;
4558b21d0597SMatthew G Knepley 
4559b21d0597SMatthew G Knepley   PetscFunctionBegin;
4560b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
45615080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
45621d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
45631bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
45641bb6d2a8SBarry Smith   dm->globalSection = section;
4565497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
45661bb6d2a8SBarry Smith   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4567507e4973SMatthew G. Knepley #endif
4568b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4569b21d0597SMatthew G Knepley }
4570b21d0597SMatthew G Knepley 
457188ed4aceSMatthew G Knepley /*@
45721bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
457388ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
457488ed4aceSMatthew G Knepley 
457588ed4aceSMatthew G Knepley   Input Parameter:
457688ed4aceSMatthew G Knepley . dm - The DM
457788ed4aceSMatthew G Knepley 
457888ed4aceSMatthew G Knepley   Output Parameter:
457988ed4aceSMatthew G Knepley . sf - The PetscSF
458088ed4aceSMatthew G Knepley 
458188ed4aceSMatthew G Knepley   Level: intermediate
458288ed4aceSMatthew G Knepley 
458388ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
458488ed4aceSMatthew G Knepley 
45851bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
458688ed4aceSMatthew G Knepley @*/
45871bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
45880adebc6cSBarry Smith {
458988ed4aceSMatthew G Knepley   PetscInt       nroots;
459088ed4aceSMatthew G Knepley   PetscErrorCode ierr;
459188ed4aceSMatthew G Knepley 
459288ed4aceSMatthew G Knepley   PetscFunctionBegin;
459388ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
459488ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
45951bb6d2a8SBarry Smith   if (!dm->sectionSF) {
45961bb6d2a8SBarry Smith     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
459733907cc2SStefano Zampini   }
45981bb6d2a8SBarry Smith   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
459988ed4aceSMatthew G Knepley   if (nroots < 0) {
460088ed4aceSMatthew G Knepley     PetscSection section, gSection;
460188ed4aceSMatthew G Knepley 
460292fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
460331ea6d37SMatthew G Knepley     if (section) {
4604e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
46051bb6d2a8SBarry Smith       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
460631ea6d37SMatthew G Knepley     } else {
46070298fd71SBarry Smith       *sf = NULL;
460831ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
460931ea6d37SMatthew G Knepley     }
461088ed4aceSMatthew G Knepley   }
46111bb6d2a8SBarry Smith   *sf = dm->sectionSF;
461288ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
461388ed4aceSMatthew G Knepley }
461488ed4aceSMatthew G Knepley 
461588ed4aceSMatthew G Knepley /*@
46161bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
461788ed4aceSMatthew G Knepley 
461888ed4aceSMatthew G Knepley   Input Parameters:
461988ed4aceSMatthew G Knepley + dm - The DM
462088ed4aceSMatthew G Knepley - sf - The PetscSF
462188ed4aceSMatthew G Knepley 
462288ed4aceSMatthew G Knepley   Level: intermediate
462388ed4aceSMatthew G Knepley 
462488ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
462588ed4aceSMatthew G Knepley 
46261bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
462788ed4aceSMatthew G Knepley @*/
46281bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
46290adebc6cSBarry Smith {
463088ed4aceSMatthew G Knepley   PetscErrorCode ierr;
463188ed4aceSMatthew G Knepley 
463288ed4aceSMatthew G Knepley   PetscFunctionBegin;
463388ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4634b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
463533907cc2SStefano Zampini   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
46361bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
46371bb6d2a8SBarry Smith   dm->sectionSF = sf;
463888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
463988ed4aceSMatthew G Knepley }
464088ed4aceSMatthew G Knepley 
464188ed4aceSMatthew G Knepley /*@C
46421bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
464388ed4aceSMatthew G Knepley   describing the data layout.
464488ed4aceSMatthew G Knepley 
464588ed4aceSMatthew G Knepley   Input Parameters:
464688ed4aceSMatthew G Knepley + dm - The DM
464788ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
464888ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
464988ed4aceSMatthew G Knepley 
46501bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
465188ed4aceSMatthew G Knepley 
46521bb6d2a8SBarry Smith   Level: developer
46531bb6d2a8SBarry Smith 
46541bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
46551bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
46561bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
46571bb6d2a8SBarry Smith 
46581bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
465988ed4aceSMatthew G Knepley @*/
46601bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
466188ed4aceSMatthew G Knepley {
466288ed4aceSMatthew G Knepley   PetscErrorCode ierr;
466388ed4aceSMatthew G Knepley 
466488ed4aceSMatthew G Knepley   PetscFunctionBegin;
466588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4666b0c7db22SLisandro Dalcin   ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr);
466788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
466888ed4aceSMatthew G Knepley }
4669af122d2aSMatthew G Knepley 
4670b21d0597SMatthew G Knepley /*@
4671b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4672b21d0597SMatthew G Knepley 
4673b21d0597SMatthew G Knepley   Input Parameter:
4674b21d0597SMatthew G Knepley . dm - The DM
4675b21d0597SMatthew G Knepley 
4676b21d0597SMatthew G Knepley   Output Parameter:
4677b21d0597SMatthew G Knepley . sf - The PetscSF
4678b21d0597SMatthew G Knepley 
4679b21d0597SMatthew G Knepley   Level: intermediate
4680b21d0597SMatthew G Knepley 
4681b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4682b21d0597SMatthew G Knepley 
46831bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4684b21d0597SMatthew G Knepley @*/
46850adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
46860adebc6cSBarry Smith {
4687b21d0597SMatthew G Knepley   PetscFunctionBegin;
4688b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4689b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4690b21d0597SMatthew G Knepley   *sf = dm->sf;
4691b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4692b21d0597SMatthew G Knepley }
4693b21d0597SMatthew G Knepley 
4694057b4bcdSMatthew G Knepley /*@
4695057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4696057b4bcdSMatthew G Knepley 
4697057b4bcdSMatthew G Knepley   Input Parameters:
4698057b4bcdSMatthew G Knepley + dm - The DM
4699057b4bcdSMatthew G Knepley - sf - The PetscSF
4700057b4bcdSMatthew G Knepley 
4701057b4bcdSMatthew G Knepley   Level: intermediate
4702057b4bcdSMatthew G Knepley 
47031bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4704057b4bcdSMatthew G Knepley @*/
47050adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
47060adebc6cSBarry Smith {
4707057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
4708057b4bcdSMatthew G Knepley 
4709057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4710057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4711b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4712057b4bcdSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
471333907cc2SStefano Zampini   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4714057b4bcdSMatthew G Knepley   dm->sf = sf;
4715057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4716057b4bcdSMatthew G Knepley }
4717057b4bcdSMatthew G Knepley 
47184f37162bSMatthew G. Knepley /*@
47194f37162bSMatthew G. Knepley   DMGetNaturalSF - Get the PetscSF encoding the map back to the original mesh ordering
47204f37162bSMatthew G. Knepley 
47214f37162bSMatthew G. Knepley   Input Parameter:
47224f37162bSMatthew G. Knepley . dm - The DM
47234f37162bSMatthew G. Knepley 
47244f37162bSMatthew G. Knepley   Output Parameter:
47254f37162bSMatthew G. Knepley . sf - The PetscSF
47264f37162bSMatthew G. Knepley 
47274f37162bSMatthew G. Knepley   Level: intermediate
47284f37162bSMatthew G. Knepley 
47294f37162bSMatthew G. Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
47304f37162bSMatthew G. Knepley 
47314f37162bSMatthew G. Knepley .seealso: DMSetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
47324f37162bSMatthew G. Knepley @*/
47334f37162bSMatthew G. Knepley PetscErrorCode DMGetNaturalSF(DM dm, PetscSF *sf)
47344f37162bSMatthew G. Knepley {
47354f37162bSMatthew G. Knepley   PetscFunctionBegin;
47364f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
47374f37162bSMatthew G. Knepley   PetscValidPointer(sf, 2);
47384f37162bSMatthew G. Knepley   *sf = dm->sfNatural;
47394f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
47404f37162bSMatthew G. Knepley }
47414f37162bSMatthew G. Knepley 
47424f37162bSMatthew G. Knepley /*@
47434f37162bSMatthew G. Knepley   DMSetNaturalSF - Set the PetscSF encoding the map back to the original mesh ordering
47444f37162bSMatthew G. Knepley 
47454f37162bSMatthew G. Knepley   Input Parameters:
47464f37162bSMatthew G. Knepley + dm - The DM
47474f37162bSMatthew G. Knepley - sf - The PetscSF
47484f37162bSMatthew G. Knepley 
47494f37162bSMatthew G. Knepley   Level: intermediate
47504f37162bSMatthew G. Knepley 
47514f37162bSMatthew G. Knepley .seealso: DMGetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
47524f37162bSMatthew G. Knepley @*/
47534f37162bSMatthew G. Knepley PetscErrorCode DMSetNaturalSF(DM dm, PetscSF sf)
47544f37162bSMatthew G. Knepley {
47554f37162bSMatthew G. Knepley   PetscErrorCode ierr;
47564f37162bSMatthew G. Knepley 
47574f37162bSMatthew G. Knepley   PetscFunctionBegin;
47584f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
47594f37162bSMatthew G. Knepley   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
47604f37162bSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
47614f37162bSMatthew G. Knepley   ierr = PetscSFDestroy(&dm->sfNatural);CHKERRQ(ierr);
47624f37162bSMatthew G. Knepley   dm->sfNatural = sf;
47634f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
47644f37162bSMatthew G. Knepley }
47654f37162bSMatthew G. Knepley 
476634aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
476734aa8a36SMatthew G. Knepley {
476834aa8a36SMatthew G. Knepley   PetscClassId   id;
476934aa8a36SMatthew G. Knepley   PetscErrorCode ierr;
477034aa8a36SMatthew G. Knepley 
477134aa8a36SMatthew G. Knepley   PetscFunctionBegin;
477234aa8a36SMatthew G. Knepley   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
477334aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
477434aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
477534aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
477634aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
477717c1d62eSMatthew G. Knepley   } else {
477817c1d62eSMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
477934aa8a36SMatthew G. Knepley   }
478034aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
478134aa8a36SMatthew G. Knepley }
478234aa8a36SMatthew G. Knepley 
478344a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
478444a7f3ddSMatthew G. Knepley {
478544a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
478644a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
478744a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
478844a7f3ddSMatthew G. Knepley 
478944a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
479044a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
479144a7f3ddSMatthew G. Knepley   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
479244a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4793e0b68406SMatthew Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;}
479444a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
479544a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
479644a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
479744a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
479844a7f3ddSMatthew G. Knepley }
479944a7f3ddSMatthew G. Knepley 
480044a7f3ddSMatthew G. Knepley /*@
480144a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
480244a7f3ddSMatthew G. Knepley 
4803d083f849SBarry Smith   Logically collective on dm
480444a7f3ddSMatthew G. Knepley 
480544a7f3ddSMatthew G. Knepley   Input Parameter:
480644a7f3ddSMatthew G. Knepley . dm - The DM
480744a7f3ddSMatthew G. Knepley 
480844a7f3ddSMatthew G. Knepley   Level: intermediate
480944a7f3ddSMatthew G. Knepley 
481044a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
481144a7f3ddSMatthew G. Knepley @*/
481244a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
481344a7f3ddSMatthew G. Knepley {
481444a7f3ddSMatthew G. Knepley   PetscInt       f;
481544a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
481644a7f3ddSMatthew G. Knepley 
481744a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
481844a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
481944a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
482044a7f3ddSMatthew G. Knepley     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
482144a7f3ddSMatthew G. Knepley     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
482244a7f3ddSMatthew G. Knepley   }
482344a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
482444a7f3ddSMatthew G. Knepley   dm->fields = NULL;
482544a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
482644a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
482744a7f3ddSMatthew G. Knepley }
482844a7f3ddSMatthew G. Knepley 
4829689b5837SMatthew G. Knepley /*@
4830689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4831689b5837SMatthew G. Knepley 
4832689b5837SMatthew G. Knepley   Not collective
4833689b5837SMatthew G. Knepley 
4834689b5837SMatthew G. Knepley   Input Parameter:
4835689b5837SMatthew G. Knepley . dm - The DM
4836689b5837SMatthew G. Knepley 
4837689b5837SMatthew G. Knepley   Output Parameter:
4838689b5837SMatthew G. Knepley . Nf - The number of fields
4839689b5837SMatthew G. Knepley 
4840689b5837SMatthew G. Knepley   Level: intermediate
4841689b5837SMatthew G. Knepley 
4842689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4843689b5837SMatthew G. Knepley @*/
48440f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
48450f21e855SMatthew G. Knepley {
48460f21e855SMatthew G. Knepley   PetscFunctionBegin;
48470f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4848534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
484944a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4850af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4851af122d2aSMatthew G Knepley }
4852af122d2aSMatthew G Knepley 
4853689b5837SMatthew G. Knepley /*@
4854689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4855689b5837SMatthew G. Knepley 
4856d083f849SBarry Smith   Logically collective on dm
4857689b5837SMatthew G. Knepley 
4858689b5837SMatthew G. Knepley   Input Parameters:
4859689b5837SMatthew G. Knepley + dm - The DM
4860689b5837SMatthew G. Knepley - Nf - The number of fields
4861689b5837SMatthew G. Knepley 
4862689b5837SMatthew G. Knepley   Level: intermediate
4863689b5837SMatthew G. Knepley 
4864689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4865689b5837SMatthew G. Knepley @*/
4866af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4867af122d2aSMatthew G Knepley {
48680f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4869af122d2aSMatthew G Knepley   PetscErrorCode ierr;
4870af122d2aSMatthew G Knepley 
4871af122d2aSMatthew G Knepley   PetscFunctionBegin;
4872af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
487344a7f3ddSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
48740f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
48750f21e855SMatthew G. Knepley     PetscContainer obj;
48760f21e855SMatthew G. Knepley 
48770f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
487844a7f3ddSMatthew G. Knepley     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
48790f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4880af122d2aSMatthew G Knepley   }
4881af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4882af122d2aSMatthew G Knepley }
4883af122d2aSMatthew G Knepley 
4884c1929be8SMatthew G. Knepley /*@
4885c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4886c1929be8SMatthew G. Knepley 
4887c1929be8SMatthew G. Knepley   Not collective
4888c1929be8SMatthew G. Knepley 
4889c1929be8SMatthew G. Knepley   Input Parameters:
4890c1929be8SMatthew G. Knepley + dm - The DM
4891c1929be8SMatthew G. Knepley - f  - The field number
4892c1929be8SMatthew G. Knepley 
489344a7f3ddSMatthew G. Knepley   Output Parameters:
489444a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
489544a7f3ddSMatthew G. Knepley - field - The discretization object
4896c1929be8SMatthew G. Knepley 
489744a7f3ddSMatthew G. Knepley   Level: intermediate
4898c1929be8SMatthew G. Knepley 
489944a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4900c1929be8SMatthew G. Knepley @*/
490144a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4902af122d2aSMatthew G Knepley {
4903af122d2aSMatthew G Knepley   PetscFunctionBegin;
4904af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4905064a246eSJacob Faibussowitsch   PetscValidPointer(field, 4);
490644a7f3ddSMatthew G. Knepley   if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf);
490744a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
490844a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4909decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4910decb47aaSMatthew G. Knepley }
4911decb47aaSMatthew G. Knepley 
4912083401c6SMatthew G. Knepley /* Does not clear the DS */
4913083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4914083401c6SMatthew G. Knepley {
4915083401c6SMatthew G. Knepley   PetscErrorCode ierr;
4916083401c6SMatthew G. Knepley 
4917083401c6SMatthew G. Knepley   PetscFunctionBegin;
4918083401c6SMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4919083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4920083401c6SMatthew G. Knepley   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4921083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4922083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
4923083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4924083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4925083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4926083401c6SMatthew G. Knepley }
4927083401c6SMatthew G. Knepley 
4928c1929be8SMatthew G. Knepley /*@
4929c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4930c1929be8SMatthew G. Knepley 
4931d083f849SBarry Smith   Logically collective on dm
4932c1929be8SMatthew G. Knepley 
4933c1929be8SMatthew G. Knepley   Input Parameters:
4934c1929be8SMatthew G. Knepley + dm    - The DM
4935c1929be8SMatthew G. Knepley . f     - The field number
493644a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
4937c1929be8SMatthew G. Knepley - field - The discretization object
4938c1929be8SMatthew G. Knepley 
493944a7f3ddSMatthew G. Knepley   Level: intermediate
4940c1929be8SMatthew G. Knepley 
494144a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
4942c1929be8SMatthew G. Knepley @*/
494344a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4944decb47aaSMatthew G. Knepley {
4945decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
4946decb47aaSMatthew G. Knepley 
4947decb47aaSMatthew G. Knepley   PetscFunctionBegin;
4948decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4949e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
495044a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
4951e5e52638SMatthew G. Knepley   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
4952083401c6SMatthew G. Knepley   ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr);
495334aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
49542df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
495544a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
495644a7f3ddSMatthew G. Knepley }
495744a7f3ddSMatthew G. Knepley 
495844a7f3ddSMatthew G. Knepley /*@
495944a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
496044a7f3ddSMatthew G. Knepley 
4961d083f849SBarry Smith   Logically collective on dm
496244a7f3ddSMatthew G. Knepley 
496344a7f3ddSMatthew G. Knepley   Input Parameters:
496444a7f3ddSMatthew G. Knepley + dm    - The DM
496544a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
496644a7f3ddSMatthew G. Knepley - field - The discretization object
496744a7f3ddSMatthew G. Knepley 
496844a7f3ddSMatthew G. Knepley   Level: intermediate
496944a7f3ddSMatthew G. Knepley 
497044a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
497144a7f3ddSMatthew G. Knepley @*/
497244a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
497344a7f3ddSMatthew G. Knepley {
497444a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
497544a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
497644a7f3ddSMatthew G. Knepley 
497744a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
497844a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4979064a246eSJacob Faibussowitsch   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
498044a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
498144a7f3ddSMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
498244a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
498344a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
498444a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
498544a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
498634aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
49872df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
4988af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4989af122d2aSMatthew G Knepley }
49906636e97aSMatthew G Knepley 
4991e5e52638SMatthew G. Knepley /*@
4992e0b68406SMatthew Knepley   DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells
4993e0b68406SMatthew Knepley 
4994e0b68406SMatthew Knepley   Logically collective on dm
4995e0b68406SMatthew Knepley 
4996e0b68406SMatthew Knepley   Input Parameters:
4997e0b68406SMatthew Knepley + dm          - The DM
4998e0b68406SMatthew Knepley . f           - The field index
4999e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells
5000e0b68406SMatthew Knepley 
5001e0b68406SMatthew Knepley   Level: intermediate
5002e0b68406SMatthew Knepley 
5003e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField()
5004e0b68406SMatthew Knepley @*/
5005e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor)
5006e0b68406SMatthew Knepley {
5007e0b68406SMatthew Knepley   PetscFunctionBegin;
5008e0b68406SMatthew Knepley   if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
5009e0b68406SMatthew Knepley   dm->fields[f].avoidTensor = avoidTensor;
5010e0b68406SMatthew Knepley   PetscFunctionReturn(0);
5011e0b68406SMatthew Knepley }
5012e0b68406SMatthew Knepley 
5013e0b68406SMatthew Knepley /*@
5014e0b68406SMatthew Knepley   DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells
5015e0b68406SMatthew Knepley 
5016e0b68406SMatthew Knepley   Logically collective on dm
5017e0b68406SMatthew Knepley 
5018e0b68406SMatthew Knepley   Input Parameters:
5019e0b68406SMatthew Knepley + dm          - The DM
5020e0b68406SMatthew Knepley - f           - The field index
5021e0b68406SMatthew Knepley 
5022e0b68406SMatthew Knepley   Output Parameter:
5023e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells
5024e0b68406SMatthew Knepley 
5025e0b68406SMatthew Knepley   Level: intermediate
5026e0b68406SMatthew Knepley 
5027e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField()
5028e0b68406SMatthew Knepley @*/
5029e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor)
5030e0b68406SMatthew Knepley {
5031e0b68406SMatthew Knepley   PetscFunctionBegin;
5032e0b68406SMatthew Knepley   if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
5033e0b68406SMatthew Knepley   *avoidTensor = dm->fields[f].avoidTensor;
5034e0b68406SMatthew Knepley   PetscFunctionReturn(0);
5035e0b68406SMatthew Knepley }
5036e0b68406SMatthew Knepley 
5037e0b68406SMatthew Knepley /*@
5038e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
5039e5e52638SMatthew G. Knepley 
5040d083f849SBarry Smith   Collective on dm
5041e5e52638SMatthew G. Knepley 
5042e5e52638SMatthew G. Knepley   Input Parameter:
5043e5e52638SMatthew G. Knepley . dm - The DM
5044e5e52638SMatthew G. Knepley 
5045e5e52638SMatthew G. Knepley   Output Parameter:
5046e5e52638SMatthew G. Knepley . newdm - The DM
5047e5e52638SMatthew G. Knepley 
5048e5e52638SMatthew G. Knepley   Level: advanced
5049e5e52638SMatthew G. Knepley 
5050e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
5051e5e52638SMatthew G. Knepley @*/
5052e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
5053e5e52638SMatthew G. Knepley {
5054e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
5055e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5056e5e52638SMatthew G. Knepley 
5057e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5058e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5059e5e52638SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5060e5e52638SMatthew G. Knepley   ierr = DMClearFields(newdm);CHKERRQ(ierr);
5061e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5062e5e52638SMatthew G. Knepley     DMLabel     label;
5063e5e52638SMatthew G. Knepley     PetscObject field;
506434aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
5065e5e52638SMatthew G. Knepley 
5066e5e52638SMatthew G. Knepley     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
5067e5e52638SMatthew G. Knepley     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
506834aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
506934aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
507034aa8a36SMatthew G. Knepley   }
507134aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
507234aa8a36SMatthew G. Knepley }
507334aa8a36SMatthew G. Knepley 
507434aa8a36SMatthew G. Knepley /*@
507534aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
507634aa8a36SMatthew G. Knepley 
507734aa8a36SMatthew G. Knepley   Not collective
507834aa8a36SMatthew G. Knepley 
507934aa8a36SMatthew G. Knepley   Input Parameters:
508034aa8a36SMatthew G. Knepley + dm - The DM object
508134aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
508234aa8a36SMatthew G. Knepley 
5083d8d19677SJose E. Roman   Output Parameters:
508434aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
508534aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
508634aa8a36SMatthew G. Knepley 
508734aa8a36SMatthew G. Knepley   Notes:
508834aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
508934aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
509034aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5091979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
509234aa8a36SMatthew G. Knepley 
509334aa8a36SMatthew G. Knepley   Level: developer
509434aa8a36SMatthew G. Knepley 
509534aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
509634aa8a36SMatthew G. Knepley @*/
509734aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
509834aa8a36SMatthew G. Knepley {
509934aa8a36SMatthew G. Knepley   PetscFunctionBegin;
510034aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5101534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
5102534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
510334aa8a36SMatthew G. Knepley   if (f < 0) {
510434aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
510534aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
510634aa8a36SMatthew G. Knepley   } else {
510734aa8a36SMatthew G. Knepley     PetscInt       Nf;
510834aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
510934aa8a36SMatthew G. Knepley 
511034aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
511134aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
511234aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
511334aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
511434aa8a36SMatthew G. Knepley   }
511534aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
511634aa8a36SMatthew G. Knepley }
511734aa8a36SMatthew G. Knepley 
511834aa8a36SMatthew G. Knepley /*@
511934aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
512034aa8a36SMatthew G. Knepley 
512134aa8a36SMatthew G. Knepley   Not collective
512234aa8a36SMatthew G. Knepley 
512334aa8a36SMatthew G. Knepley   Input Parameters:
512434aa8a36SMatthew G. Knepley + dm         - The DM object
512534aa8a36SMatthew G. Knepley . f          - The field number
512634aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
512734aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
512834aa8a36SMatthew G. Knepley 
512934aa8a36SMatthew G. Knepley   Notes:
513034aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
513134aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
513234aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5133979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
513434aa8a36SMatthew G. Knepley 
513534aa8a36SMatthew G. Knepley   Level: developer
513634aa8a36SMatthew G. Knepley 
513734aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
513834aa8a36SMatthew G. Knepley @*/
513934aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
514034aa8a36SMatthew G. Knepley {
514134aa8a36SMatthew G. Knepley   PetscFunctionBegin;
514234aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
514334aa8a36SMatthew G. Knepley   if (f < 0) {
514434aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
514534aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
514634aa8a36SMatthew G. Knepley   } else {
514734aa8a36SMatthew G. Knepley     PetscInt       Nf;
514834aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
514934aa8a36SMatthew G. Knepley 
515034aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
515134aa8a36SMatthew G. Knepley     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
515234aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
515334aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
5154e5e52638SMatthew G. Knepley   }
5155e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5156e5e52638SMatthew G. Knepley }
5157e5e52638SMatthew G. Knepley 
5158b0441da4SMatthew G. Knepley /*@
5159b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
5160b0441da4SMatthew G. Knepley 
5161b0441da4SMatthew G. Knepley   Not collective
5162b0441da4SMatthew G. Knepley 
5163f899ff85SJose E. Roman   Input Parameter:
5164b0441da4SMatthew G. Knepley . dm - The DM object
5165b0441da4SMatthew G. Knepley 
5166d8d19677SJose E. Roman   Output Parameters:
5167b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
5168b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5169b0441da4SMatthew G. Knepley 
5170b0441da4SMatthew G. Knepley   Notes:
5171b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5172b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5173b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5174b0441da4SMatthew G. Knepley 
5175b0441da4SMatthew G. Knepley   Level: developer
5176b0441da4SMatthew G. Knepley 
5177b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
5178b0441da4SMatthew G. Knepley @*/
5179b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
5180b0441da4SMatthew G. Knepley {
5181b0441da4SMatthew G. Knepley   PetscInt       Nf;
5182b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5183b0441da4SMatthew G. Knepley 
5184b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5185b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5186064a246eSJacob Faibussowitsch   if (useCone)    PetscValidBoolPointer(useCone, 2);
5187064a246eSJacob Faibussowitsch   if (useClosure) PetscValidBoolPointer(useClosure, 3);
5188b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5189b0441da4SMatthew G. Knepley   if (!Nf) {
5190b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5191b0441da4SMatthew G. Knepley   } else {
5192b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5193b0441da4SMatthew G. Knepley   }
5194b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
5195b0441da4SMatthew G. Knepley }
5196b0441da4SMatthew G. Knepley 
5197b0441da4SMatthew G. Knepley /*@
5198b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
5199b0441da4SMatthew G. Knepley 
5200b0441da4SMatthew G. Knepley   Not collective
5201b0441da4SMatthew G. Knepley 
5202b0441da4SMatthew G. Knepley   Input Parameters:
5203b0441da4SMatthew G. Knepley + dm         - The DM object
5204b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5205b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5206b0441da4SMatthew G. Knepley 
5207b0441da4SMatthew G. Knepley   Notes:
5208b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5209b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5210b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5211b0441da4SMatthew G. Knepley 
5212b0441da4SMatthew G. Knepley   Level: developer
5213b0441da4SMatthew G. Knepley 
5214b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5215b0441da4SMatthew G. Knepley @*/
5216b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5217b0441da4SMatthew G. Knepley {
5218b0441da4SMatthew G. Knepley   PetscInt       Nf;
5219b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5220b0441da4SMatthew G. Knepley 
5221b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5222b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5223b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5224b0441da4SMatthew G. Knepley   if (!Nf) {
5225b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5226b0441da4SMatthew G. Knepley   } else {
5227b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5228e5e52638SMatthew G. Knepley   }
5229e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5230e5e52638SMatthew G. Knepley }
5231e5e52638SMatthew G. Knepley 
5232783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
523345480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label)
5234783e2ec8SMatthew G. Knepley {
5235783e2ec8SMatthew G. Knepley   PetscObject    obj;
5236783e2ec8SMatthew G. Knepley   PetscClassId   id;
5237783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5238783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5239783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5240783e2ec8SMatthew G. Knepley   PetscErrorCode ierr;
5241783e2ec8SMatthew G. Knepley 
5242783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
5243783e2ec8SMatthew G. Knepley   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
5244783e2ec8SMatthew G. Knepley   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5245783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5246783e2ec8SMatthew G. Knepley   if (isFE && label) {
5247783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
5248783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5249783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
525045480ffeSMatthew G. Knepley       DMLabel l;
5251783e2ec8SMatthew G. Knepley 
525245480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
525345480ffeSMatthew G. Knepley       duplicate = l == label ? PETSC_TRUE : PETSC_FALSE;
5254783e2ec8SMatthew G. Knepley       if (duplicate) break;
5255783e2ec8SMatthew G. Knepley     }
5256783e2ec8SMatthew G. Knepley     if (!duplicate) {
5257783e2ec8SMatthew G. Knepley       DM plex;
5258783e2ec8SMatthew G. Knepley 
5259783e2ec8SMatthew G. Knepley       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5260783e2ec8SMatthew G. Knepley       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
5261783e2ec8SMatthew G. Knepley       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5262783e2ec8SMatthew G. Knepley     }
5263783e2ec8SMatthew G. Knepley   }
5264783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5265783e2ec8SMatthew G. Knepley }
5266783e2ec8SMatthew G. Knepley 
5267e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5268e5e52638SMatthew G. Knepley {
5269e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5270e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5271e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5272e5e52638SMatthew G. Knepley 
5273e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5274e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
5275e5e52638SMatthew G. Knepley   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
5276e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5277b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
5278e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5279e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5280e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5281e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5282e5e52638SMatthew G. Knepley }
5283e5e52638SMatthew G. Knepley 
5284e5e52638SMatthew G. Knepley /*@
5285e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5286e5e52638SMatthew G. Knepley 
5287e5e52638SMatthew G. Knepley   Not collective
5288e5e52638SMatthew G. Knepley 
5289e5e52638SMatthew G. Knepley   Input Parameter:
5290e5e52638SMatthew G. Knepley . dm - The DM
5291e5e52638SMatthew G. Knepley 
5292e5e52638SMatthew G. Knepley   Output Parameter:
5293e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5294e5e52638SMatthew G. Knepley 
5295e5e52638SMatthew G. Knepley   Level: intermediate
5296e5e52638SMatthew G. Knepley 
5297e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5298e5e52638SMatthew G. Knepley @*/
5299e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5300e5e52638SMatthew G. Knepley {
5301e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5302e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5303534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5304e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5305e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5306e5e52638SMatthew G. Knepley }
5307e5e52638SMatthew G. Knepley 
5308e5e52638SMatthew G. Knepley /*@
5309e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5310e5e52638SMatthew G. Knepley 
5311d083f849SBarry Smith   Logically collective on dm
5312e5e52638SMatthew G. Knepley 
5313e5e52638SMatthew G. Knepley   Input Parameter:
5314e5e52638SMatthew G. Knepley . dm - The DM
5315e5e52638SMatthew G. Knepley 
5316e5e52638SMatthew G. Knepley   Level: intermediate
5317e5e52638SMatthew G. Knepley 
5318e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5319e5e52638SMatthew G. Knepley @*/
5320e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5321e5e52638SMatthew G. Knepley {
5322e5e52638SMatthew G. Knepley   PetscInt       s;
5323e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5324e5e52638SMatthew G. Knepley 
5325e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5326e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5327e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5328e5e52638SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5329e5e52638SMatthew G. Knepley     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5330b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5331e5e52638SMatthew G. Knepley   }
5332e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5333e5e52638SMatthew G. Knepley   dm->probs = NULL;
5334e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5335e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5336e5e52638SMatthew G. Knepley }
5337e5e52638SMatthew G. Knepley 
5338e5e52638SMatthew G. Knepley /*@
5339e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5340e5e52638SMatthew G. Knepley 
5341e5e52638SMatthew G. Knepley   Not collective
5342e5e52638SMatthew G. Knepley 
5343e5e52638SMatthew G. Knepley   Input Parameter:
5344e5e52638SMatthew G. Knepley . dm    - The DM
5345e5e52638SMatthew G. Knepley 
5346e5e52638SMatthew G. Knepley   Output Parameter:
5347e5e52638SMatthew G. Knepley . prob - The default PetscDS
5348e5e52638SMatthew G. Knepley 
5349e5e52638SMatthew G. Knepley   Level: intermediate
5350e5e52638SMatthew G. Knepley 
5351e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5352e5e52638SMatthew G. Knepley @*/
5353e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5354e5e52638SMatthew G. Knepley {
5355b0143b4dSMatthew G. Knepley   PetscErrorCode ierr;
5356b0143b4dSMatthew G. Knepley 
5357e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5358e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5359e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5360b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5361b0143b4dSMatthew G. Knepley     PetscDS ds;
5362b0143b4dSMatthew G. Knepley 
536345480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5364b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5365b0143b4dSMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5366b0143b4dSMatthew G. Knepley   }
5367b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5368e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5369e5e52638SMatthew G. Knepley }
5370e5e52638SMatthew G. Knepley 
5371e5e52638SMatthew G. Knepley /*@
5372e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5373e5e52638SMatthew G. Knepley 
5374e5e52638SMatthew G. Knepley   Not collective
5375e5e52638SMatthew G. Knepley 
5376e5e52638SMatthew G. Knepley   Input Parameters:
5377e5e52638SMatthew G. Knepley + dm    - The DM
5378e5e52638SMatthew G. Knepley - point - Cell for the DS
5379e5e52638SMatthew G. Knepley 
5380e5e52638SMatthew G. Knepley   Output Parameter:
5381e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5382e5e52638SMatthew G. Knepley 
5383e5e52638SMatthew G. Knepley   Level: developer
5384e5e52638SMatthew G. Knepley 
5385b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5386e5e52638SMatthew G. Knepley @*/
5387e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5388e5e52638SMatthew G. Knepley {
5389e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5390e5e52638SMatthew G. Knepley   PetscInt       s;
5391e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5392e5e52638SMatthew G. Knepley 
5393e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5394e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5395e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
5396360cf244SMatthew G. Knepley   if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5397e5e52638SMatthew G. Knepley   *prob = NULL;
5398e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5399e5e52638SMatthew G. Knepley     PetscInt val;
5400e5e52638SMatthew G. Knepley 
5401e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5402e5e52638SMatthew G. Knepley     else {
5403e5e52638SMatthew G. Knepley       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5404e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5405e5e52638SMatthew G. Knepley     }
5406e5e52638SMatthew G. Knepley   }
5407e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5408e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5409e5e52638SMatthew G. Knepley }
5410e5e52638SMatthew G. Knepley 
5411e5e52638SMatthew G. Knepley /*@
5412e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5413e5e52638SMatthew G. Knepley 
5414e5e52638SMatthew G. Knepley   Not collective
5415e5e52638SMatthew G. Knepley 
5416e5e52638SMatthew G. Knepley   Input Parameters:
5417e5e52638SMatthew G. Knepley + dm    - The DM
5418e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5419e5e52638SMatthew G. Knepley 
5420b3cf3223SMatthew G. Knepley   Output Parameters:
5421b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5422b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5423e5e52638SMatthew G. Knepley 
5424e5e52638SMatthew G. Knepley   Note: If the label is missing, this function returns an error
5425e5e52638SMatthew G. Knepley 
5426e5e52638SMatthew G. Knepley   Level: advanced
5427e5e52638SMatthew G. Knepley 
5428e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5429e5e52638SMatthew G. Knepley @*/
5430b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5431e5e52638SMatthew G. Knepley {
5432e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5433e5e52638SMatthew G. Knepley 
5434e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5435e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5436e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5437b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5438b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5439e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5440b3cf3223SMatthew G. Knepley     if (dm->probs[s].label == label) {
5441b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5442b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5443b3cf3223SMatthew G. Knepley       PetscFunctionReturn(0);
5444b3cf3223SMatthew G. Knepley     }
5445e5e52638SMatthew G. Knepley   }
54462df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5447e5e52638SMatthew G. Knepley }
5448e5e52638SMatthew G. Knepley 
5449e5e52638SMatthew G. Knepley /*@
5450083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5451083401c6SMatthew G. Knepley 
5452083401c6SMatthew G. Knepley   Collective on dm
5453083401c6SMatthew G. Knepley 
5454083401c6SMatthew G. Knepley   Input Parameters:
5455083401c6SMatthew G. Knepley + dm     - The DM
5456083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5457083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5458083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5459083401c6SMatthew G. Knepley 
5460083401c6SMatthew 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,
5461083401c6SMatthew G. Knepley   the fields argument is ignored.
5462083401c6SMatthew G. Knepley 
5463083401c6SMatthew G. Knepley   Level: advanced
5464083401c6SMatthew G. Knepley 
5465083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5466083401c6SMatthew G. Knepley @*/
5467083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5468083401c6SMatthew G. Knepley {
5469083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5470083401c6SMatthew G. Knepley   PetscErrorCode ierr;
5471083401c6SMatthew G. Knepley 
5472083401c6SMatthew G. Knepley   PetscFunctionBegin;
5473083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5474083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5475064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4);
5476083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5477083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
5478083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5479083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5480083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5481083401c6SMatthew G. Knepley     }
5482083401c6SMatthew G. Knepley   }
5483083401c6SMatthew G. Knepley   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5484083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5485083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5486083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5487083401c6SMatthew G. Knepley   if (!label) {
5488083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5489083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5490083401c6SMatthew G. Knepley     Nds = 0;
5491083401c6SMatthew G. Knepley   }
5492083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5493083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5494083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5495083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5496083401c6SMatthew G. Knepley }
5497083401c6SMatthew G. Knepley 
5498083401c6SMatthew G. Knepley /*@
5499e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5500e5e52638SMatthew G. Knepley 
5501e5e52638SMatthew G. Knepley   Not collective
5502e5e52638SMatthew G. Knepley 
5503e5e52638SMatthew G. Knepley   Input Parameters:
5504e5e52638SMatthew G. Knepley + dm  - The DM
5505e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5506e5e52638SMatthew G. Knepley 
5507e5e52638SMatthew G. Knepley   Output Parameters:
5508b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5509b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5510083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5511e5e52638SMatthew G. Knepley 
5512e5e52638SMatthew G. Knepley   Level: advanced
5513e5e52638SMatthew G. Knepley 
5514e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5515e5e52638SMatthew G. Knepley @*/
5516b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5517e5e52638SMatthew G. Knepley {
5518e5e52638SMatthew G. Knepley   PetscInt       Nds;
5519e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5520e5e52638SMatthew G. Knepley 
5521e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5522e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5523e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5524e5e52638SMatthew G. Knepley   if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5525e5e52638SMatthew G. Knepley   if (label) {
5526e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5527e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5528e5e52638SMatthew G. Knepley   }
5529b3cf3223SMatthew G. Knepley   if (fields) {
5530b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5531b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5532b3cf3223SMatthew G. Knepley   }
5533e5e52638SMatthew G. Knepley   if (ds) {
5534b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5535e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5536e5e52638SMatthew G. Knepley   }
5537e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5538e5e52638SMatthew G. Knepley }
5539e5e52638SMatthew G. Knepley 
5540e5e52638SMatthew G. Knepley /*@
5541083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5542e5e52638SMatthew G. Knepley 
5543083401c6SMatthew G. Knepley   Not collective
5544e5e52638SMatthew G. Knepley 
5545e5e52638SMatthew G. Knepley   Input Parameters:
5546e5e52638SMatthew G. Knepley + dm     - The DM
5547083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5548083401c6SMatthew G. Knepley . label  - The region label, or NULL
5549083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5550083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5551e5e52638SMatthew G. Knepley 
5552e5e52638SMatthew G. Knepley   Level: advanced
5553e5e52638SMatthew G. Knepley 
5554083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5555e5e52638SMatthew G. Knepley @*/
5556083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5557e5e52638SMatthew G. Knepley {
5558083401c6SMatthew G. Knepley   PetscInt       Nds;
5559e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5560e5e52638SMatthew G. Knepley 
5561e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5562e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5563083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
5564083401c6SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5565083401c6SMatthew G. Knepley   if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5566e5e52638SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5567083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr);
5568083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5569083401c6SMatthew G. Knepley   if (fields) {
5570083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
5571b3cf3223SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5572083401c6SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr);
5573083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5574e5e52638SMatthew G. Knepley   }
5575083401c6SMatthew G. Knepley   if (ds) {
5576083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
5577083401c6SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5578083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr);
5579083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5580083401c6SMatthew G. Knepley   }
5581e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5582e5e52638SMatthew G. Knepley }
5583e5e52638SMatthew G. Knepley 
5584e5e52638SMatthew G. Knepley /*@
55851d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
55861d3af9e0SMatthew G. Knepley 
55871d3af9e0SMatthew G. Knepley   Not collective
55881d3af9e0SMatthew G. Knepley 
55891d3af9e0SMatthew G. Knepley   Input Parameters:
55901d3af9e0SMatthew G. Knepley + dm  - The DM
55911d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
55921d3af9e0SMatthew G. Knepley 
55931d3af9e0SMatthew G. Knepley   Output Parameter:
55941d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
55951d3af9e0SMatthew G. Knepley 
55961d3af9e0SMatthew G. Knepley   Level: advanced
55971d3af9e0SMatthew G. Knepley 
55981d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
55991d3af9e0SMatthew G. Knepley @*/
56001d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
56011d3af9e0SMatthew G. Knepley {
56021d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
56031d3af9e0SMatthew G. Knepley   PetscErrorCode ierr;
56041d3af9e0SMatthew G. Knepley 
56051d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
56061d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
56071d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
56081d3af9e0SMatthew G. Knepley   PetscValidPointer(num, 3);
56091d3af9e0SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
56101d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
56111d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
56121d3af9e0SMatthew G. Knepley   else          *num = n;
56131d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
56141d3af9e0SMatthew G. Knepley }
56151d3af9e0SMatthew G. Knepley 
56161d3af9e0SMatthew G. Knepley /*@
5617e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5618e5e52638SMatthew G. Knepley 
5619d083f849SBarry Smith   Collective on dm
5620e5e52638SMatthew G. Knepley 
5621e5e52638SMatthew G. Knepley   Input Parameter:
5622e5e52638SMatthew G. Knepley . dm - The DM
5623e5e52638SMatthew G. Knepley 
562445480ffeSMatthew G. Knepley   Options Database Keys:
562545480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM
562645480ffeSMatthew G. Knepley 
5627e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5628e5e52638SMatthew G. Knepley 
5629e5e52638SMatthew G. Knepley   Level: intermediate
5630e5e52638SMatthew G. Knepley 
5631e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5632e5e52638SMatthew G. Knepley @*/
5633e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5634e5e52638SMatthew G. Knepley {
5635e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5636083401c6SMatthew G. Knepley   PetscDS        dsDef;
5637083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5638f9244615SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k;
5639f9244615SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE, flg;
5640e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5641e5e52638SMatthew G. Knepley 
5642e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5643e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5644e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
5645e5e52638SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5646083401c6SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
5647083401c6SMatthew G. Knepley   /* Determine how many regions we have */
5648083401c6SMatthew G. Knepley   ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr);
5649083401c6SMatthew G. Knepley   Nl   = 0;
5650083401c6SMatthew G. Knepley   Ndef = 0;
5651083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5652083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5653083401c6SMatthew G. Knepley     PetscInt l;
5654083401c6SMatthew G. Knepley 
5655f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
5656f918ec44SMatthew G. Knepley     /* Move CEED context to discretizations */
5657f918ec44SMatthew G. Knepley     {
5658f918ec44SMatthew G. Knepley       PetscClassId id;
5659f918ec44SMatthew G. Knepley 
5660f918ec44SMatthew G. Knepley       ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr);
5661f918ec44SMatthew G. Knepley       if (id == PETSCFE_CLASSID) {
5662f918ec44SMatthew G. Knepley         Ceed ceed;
5663f918ec44SMatthew G. Knepley 
5664f918ec44SMatthew G. Knepley         ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr);
5665f918ec44SMatthew G. Knepley         ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr);
5666f918ec44SMatthew G. Knepley       }
5667f918ec44SMatthew G. Knepley     }
5668f918ec44SMatthew G. Knepley #endif
5669083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5670083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5671083401c6SMatthew G. Knepley     if (l < Nl) continue;
5672083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5673083401c6SMatthew G. Knepley   }
5674083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
5675083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5676083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5677b3cf3223SMatthew G. Knepley     IS        fields;
5678b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5679b3cf3223SMatthew G. Knepley 
5680b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
5681083401c6SMatthew G. Knepley     if (nf) {
5682b3cf3223SMatthew G. Knepley       ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5683b3cf3223SMatthew G. Knepley       for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
568488f0c812SMatthew G. Knepley       ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
568588f0c812SMatthew G. Knepley       ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
568688f0c812SMatthew G. Knepley       ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
568788f0c812SMatthew G. Knepley       ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
568888f0c812SMatthew G. Knepley 
568945480ffeSMatthew G. Knepley       ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5690083401c6SMatthew G. Knepley       ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr);
5691083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5692b3cf3223SMatthew G. Knepley       ierr = ISDestroy(&fields);CHKERRQ(ierr);
56932df9ee95SMatthew G. Knepley     }
5694083401c6SMatthew G. Knepley   }
5695083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5696083401c6SMatthew G. Knepley   if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);}
5697083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5698083401c6SMatthew G. Knepley   if (Ndef && Nl) {
56990122748bSMatthew G. Knepley     DM              plex;
5700083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5701083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5702083401c6SMatthew G. Knepley     PetscInt       *fields;
5703083401c6SMatthew G. Knepley     const PetscInt *cells;
5704083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
57050122748bSMatthew G. Knepley 
57060122748bSMatthew G. Knepley     ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
57070122748bSMatthew G. Knepley     ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5708083401c6SMatthew G. Knepley     ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr);
5709083401c6SMatthew G. Knepley     if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);}
5710083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5711083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5712083401c6SMatthew G. Knepley       IS      pointIS;
5713083401c6SMatthew G. Knepley 
5714083401c6SMatthew G. Knepley       ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5715083401c6SMatthew G. Knepley       ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr);
5716083401c6SMatthew G. Knepley       ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr);
5717083401c6SMatthew G. Knepley       ierr = ISDestroy(&pointIS);CHKERRQ(ierr);
5718083401c6SMatthew G. Knepley     }
5719083401c6SMatthew G. Knepley     ierr = ISDestroy(&allcellIS);CHKERRQ(ierr);
5720083401c6SMatthew G. Knepley 
5721083401c6SMatthew G. Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr);
5722083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr);
5723083401c6SMatthew G. Knepley     ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr);
5724083401c6SMatthew G. Knepley     for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);}
5725083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr);
5726083401c6SMatthew G. Knepley     ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5727083401c6SMatthew G. Knepley     ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr);
5728083401c6SMatthew G. Knepley 
5729083401c6SMatthew G. Knepley     ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr);
5730083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
5731083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr);
5732083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr);
5733083401c6SMatthew G. Knepley     ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr);
5734083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr);
5735083401c6SMatthew G. Knepley 
573645480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5737083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr);
5738083401c6SMatthew G. Knepley     ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr);
5739083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);
5740083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5741083401c6SMatthew G. Knepley     ierr = ISDestroy(&fieldIS);CHKERRQ(ierr);
57420122748bSMatthew G. Knepley     ierr = DMDestroy(&plex);CHKERRQ(ierr);
5743083401c6SMatthew G. Knepley   }
5744083401c6SMatthew G. Knepley   /* Create label DSes
5745083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5746083401c6SMatthew G. Knepley   */
5747083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5748083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5749083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5750083401c6SMatthew G. Knepley     PetscDS   ds;
5751083401c6SMatthew G. Knepley     IS        fields;
5752083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5753083401c6SMatthew G. Knepley 
575445480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5755083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
5756083401c6SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5757083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
5758083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5759083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5760083401c6SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5761083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5762083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr);
5763083401c6SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5764083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr);
5765083401c6SMatthew G. Knepley     {
5766083401c6SMatthew G. Knepley       DMPolytopeType ct;
5767083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
5768083401c6SMatthew G. Knepley       PetscBool      isHybridLocal = PETSC_FALSE, isHybrid;
57690122748bSMatthew G. Knepley 
5770e5e52638SMatthew G. Knepley       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5771665f567fSMatthew G. Knepley       if (lStart >= 0) {
5772412e9a14SMatthew G. Knepley         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5773412e9a14SMatthew G. Knepley         switch (ct) {
5774412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5775412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5776412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5777412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
5778083401c6SMatthew G. Knepley             isHybridLocal = PETSC_TRUE;break;
5779083401c6SMatthew G. Knepley           default: break;
5780412e9a14SMatthew G. Knepley         }
5781665f567fSMatthew G. Knepley       }
5782ffc4695bSBarry Smith       ierr = MPI_Allreduce(&isHybridLocal, &isHybrid, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr);
5783083401c6SMatthew G. Knepley       ierr = PetscDSSetHybrid(ds, isHybrid);CHKERRQ(ierr);
5784e5e52638SMatthew G. Knepley     }
5785083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5786e5e52638SMatthew G. Knepley   }
5787083401c6SMatthew G. Knepley   ierr = PetscFree(labelSet);CHKERRQ(ierr);
5788e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5789083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5790083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5791083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5792083401c6SMatthew G. Knepley     const PetscInt *fld;
5793083401c6SMatthew G. Knepley     PetscInt        nf;
5794e5e52638SMatthew G. Knepley 
5795083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr);
5796083401c6SMatthew G. Knepley     ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr);
5797083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5798083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
5799083401c6SMatthew G. Knepley       PetscBool    isHybrid;
5800e5e52638SMatthew G. Knepley       PetscClassId id;
5801e5e52638SMatthew G. Knepley 
5802083401c6SMatthew G. Knepley       ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5803083401c6SMatthew G. Knepley       /* If this is a cohesive cell, then it needs the lower dimensional discretization */
5804083401c6SMatthew G. Knepley       if (isHybrid && f < nf-1) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);}
5805083401c6SMatthew G. Knepley       ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr);
5806083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
5807e5e52638SMatthew G. Knepley       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5808e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5809e5e52638SMatthew G. Knepley     }
5810083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr);
5811e5e52638SMatthew G. Knepley   }
5812f9244615SMatthew G. Knepley   /* Allow k-jet tabulation */
5813f9244615SMatthew G. Knepley   ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr);
5814f9244615SMatthew G. Knepley   if (flg) {
58153b4aee56SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {
58163b4aee56SMatthew G. Knepley       PetscDS  ds = dm->probs[s].ds;
58173b4aee56SMatthew G. Knepley       PetscInt Nf, f;
58183b4aee56SMatthew G. Knepley 
58193b4aee56SMatthew G. Knepley       ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
58203b4aee56SMatthew G. Knepley       for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);}
58213b4aee56SMatthew G. Knepley     }
5822f9244615SMatthew G. Knepley   }
5823e5e52638SMatthew G. Knepley   /* Setup DSes */
5824e5e52638SMatthew G. Knepley   if (doSetup) {
5825e5e52638SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5826e5e52638SMatthew G. Knepley   }
5827e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5828e5e52638SMatthew G. Knepley }
5829e5e52638SMatthew G. Knepley 
5830e5e52638SMatthew G. Knepley /*@
58317f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
58327f96f943SMatthew G. Knepley 
5833f2cacb80SMatthew G. Knepley   Collective on DM
5834f2cacb80SMatthew G. Knepley 
58357f96f943SMatthew G. Knepley   Input Parameters:
58367f96f943SMatthew G. Knepley + dm   - The DM
58377f96f943SMatthew G. Knepley - time - The time
58387f96f943SMatthew G. Knepley 
58397f96f943SMatthew G. Knepley   Output Parameters:
5840f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5841f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
58427f96f943SMatthew G. Knepley 
58437f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
58447f96f943SMatthew G. Knepley 
58457f96f943SMatthew G. Knepley   Level: developer
58467f96f943SMatthew G. Knepley 
58477f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
58487f96f943SMatthew G. Knepley @*/
5849f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
58507f96f943SMatthew G. Knepley {
58517f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
58527f96f943SMatthew G. Knepley   void            **ectxs;
58537f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
58547f96f943SMatthew G. Knepley   PetscErrorCode    ierr;
58557f96f943SMatthew G. Knepley 
58567f96f943SMatthew G. Knepley   PetscFunctionBegin;
5857f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5858f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5859f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
58607f96f943SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
58617f96f943SMatthew G. Knepley   ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr);
58627f96f943SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
58637f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
58647f96f943SMatthew G. Knepley     PetscDS         ds;
58657f96f943SMatthew G. Knepley     DMLabel         label;
58667f96f943SMatthew G. Knepley     IS              fieldIS;
58677f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
58687f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
58697f96f943SMatthew G. Knepley 
58707f96f943SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
58717f96f943SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
58727f96f943SMatthew G. Knepley     ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);
58737f96f943SMatthew G. Knepley     ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
58747f96f943SMatthew G. Knepley     ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5875f2cacb80SMatthew G. Knepley     if (u) {
58767f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
58777f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
58787f96f943SMatthew G. Knepley         ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
58797f96f943SMatthew G. Knepley       }
58807f96f943SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
58817f96f943SMatthew G. Knepley       if (label) {
58827f96f943SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
58837f96f943SMatthew G. Knepley       } else {
58847f96f943SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
58857f96f943SMatthew G. Knepley       }
58867f96f943SMatthew G. Knepley     }
5887f2cacb80SMatthew G. Knepley     if (u_t) {
5888f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
5889f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5890f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
5891f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
5892f2cacb80SMatthew G. Knepley         ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
5893f2cacb80SMatthew G. Knepley       }
5894f2cacb80SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
5895f2cacb80SMatthew G. Knepley       if (label) {
5896f2cacb80SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5897f2cacb80SMatthew G. Knepley       } else {
5898f2cacb80SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
5899f2cacb80SMatthew G. Knepley       }
5900f2cacb80SMatthew G. Knepley     }
5901f2cacb80SMatthew G. Knepley   }
5902f2cacb80SMatthew G. Knepley   if (u) {
59037f96f943SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr);
59047f96f943SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr);
5905f2cacb80SMatthew G. Knepley   }
5906f2cacb80SMatthew G. Knepley   if (u_t) {
5907f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr);
5908f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr);
5909f2cacb80SMatthew G. Knepley   }
59107f96f943SMatthew G. Knepley   ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr);
59117f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
59127f96f943SMatthew G. Knepley }
59137f96f943SMatthew G. Knepley 
591445480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds)
591545480ffeSMatthew G. Knepley {
591645480ffeSMatthew G. Knepley   PetscDS        dsNew;
591745480ffeSMatthew G. Knepley   DSBoundary     b;
591845480ffeSMatthew G. Knepley   PetscInt       cdim, Nf, f;
5919df911668SMatthew G. Knepley   PetscBool      isHybrid;
592045480ffeSMatthew G. Knepley   void          *ctx;
592145480ffeSMatthew G. Knepley   PetscErrorCode ierr;
592245480ffeSMatthew G. Knepley 
592345480ffeSMatthew G. Knepley   PetscFunctionBegin;
592445480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr);
592545480ffeSMatthew G. Knepley   ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr);
592645480ffeSMatthew G. Knepley   ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr);
592745480ffeSMatthew G. Knepley   ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
592845480ffeSMatthew G. Knepley   ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr);
592945480ffeSMatthew G. Knepley   ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
593045480ffeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
593145480ffeSMatthew G. Knepley     ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr);
593245480ffeSMatthew G. Knepley     ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr);
593345480ffeSMatthew G. Knepley   }
593445480ffeSMatthew G. Knepley   if (Nf) {
593545480ffeSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr);
593645480ffeSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr);
593745480ffeSMatthew G. Knepley   }
593845480ffeSMatthew G. Knepley   ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
593945480ffeSMatthew G. Knepley   for (b = dsNew->boundary; b; b = b->next) {
594045480ffeSMatthew G. Knepley     ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr);
594145480ffeSMatthew G. Knepley     /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
594245480ffeSMatthew G. Knepley     //if (!b->label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name);
594345480ffeSMatthew G. Knepley   }
5944df911668SMatthew G. Knepley   ierr = PetscDSGetHybrid(ds, &isHybrid);CHKERRQ(ierr);
5945df911668SMatthew G. Knepley   ierr = PetscDSSetHybrid(dsNew, isHybrid);CHKERRQ(ierr);
594645480ffeSMatthew G. Knepley 
594745480ffeSMatthew G. Knepley   ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr);
594845480ffeSMatthew G. Knepley   ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr);
594945480ffeSMatthew G. Knepley   PetscFunctionReturn(0);
595045480ffeSMatthew G. Knepley }
595145480ffeSMatthew G. Knepley 
59527f96f943SMatthew G. Knepley /*@
5953e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
5954e5e52638SMatthew G. Knepley 
5955d083f849SBarry Smith   Collective on dm
5956e5e52638SMatthew G. Knepley 
5957e5e52638SMatthew G. Knepley   Input Parameter:
5958e5e52638SMatthew G. Knepley . dm - The DM
5959e5e52638SMatthew G. Knepley 
5960e5e52638SMatthew G. Knepley   Output Parameter:
5961e5e52638SMatthew G. Knepley . newdm - The DM
5962e5e52638SMatthew G. Knepley 
5963e5e52638SMatthew G. Knepley   Level: advanced
5964e5e52638SMatthew G. Knepley 
5965e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5966e5e52638SMatthew G. Knepley @*/
5967e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
5968e5e52638SMatthew G. Knepley {
5969e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
5970e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5971e5e52638SMatthew G. Knepley 
5972e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5973e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5974e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5975e5e52638SMatthew G. Knepley   ierr = DMClearDS(newdm);CHKERRQ(ierr);
5976e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5977e5e52638SMatthew G. Knepley     DMLabel  label;
5978b3cf3223SMatthew G. Knepley     IS       fields;
597945480ffeSMatthew G. Knepley     PetscDS  ds, newds;
5980783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
5981e5e52638SMatthew G. Knepley 
5982b3cf3223SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
5983b8025e53SMatthew G. Knepley     /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */
598445480ffeSMatthew G. Knepley     ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr);
598545480ffeSMatthew G. Knepley     /* Commplete new labels in the new DS */
598645480ffeSMatthew G. Knepley     ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr);
598745480ffeSMatthew G. Knepley     ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr);
5988783e2ec8SMatthew G. Knepley     for (bd = 0; bd < Nbd; ++bd) {
5989b8025e53SMatthew G. Knepley       PetscWeakForm wf;
599045480ffeSMatthew G. Knepley       DMLabel       label;
5991783e2ec8SMatthew G. Knepley       PetscInt      field;
5992783e2ec8SMatthew G. Knepley 
5993b8025e53SMatthew G. Knepley       ierr = PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
599445480ffeSMatthew G. Knepley       ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr);
5995b8025e53SMatthew G. Knepley       ierr = PetscWeakFormReplaceLabel(wf, label);CHKERRQ(ierr);
5996783e2ec8SMatthew G. Knepley     }
5997e5e52638SMatthew G. Knepley   }
5998e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5999e5e52638SMatthew G. Knepley }
6000e5e52638SMatthew G. Knepley 
6001e5e52638SMatthew G. Knepley /*@
6002e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
6003e5e52638SMatthew G. Knepley 
6004d083f849SBarry Smith   Collective on dm
6005e5e52638SMatthew G. Knepley 
6006e5e52638SMatthew G. Knepley   Input Parameter:
6007e5e52638SMatthew G. Knepley . dm - The DM
6008e5e52638SMatthew G. Knepley 
6009e5e52638SMatthew G. Knepley   Output Parameter:
6010e5e52638SMatthew G. Knepley . newdm - The DM
6011e5e52638SMatthew G. Knepley 
6012e5e52638SMatthew G. Knepley   Level: advanced
6013e5e52638SMatthew G. Knepley 
6014e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
6015e5e52638SMatthew G. Knepley @*/
6016e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
6017e5e52638SMatthew G. Knepley {
6018e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
6019e5e52638SMatthew G. Knepley 
6020e5e52638SMatthew G. Knepley   PetscFunctionBegin;
6021e5e52638SMatthew G. Knepley   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
6022e5e52638SMatthew G. Knepley   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
6023e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
6024e5e52638SMatthew G. Knepley }
6025e5e52638SMatthew G. Knepley 
6026b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
6027b64e0483SPeter Brune {
6028b64e0483SPeter Brune   DM dm_coord,dmc_coord;
6029b64e0483SPeter Brune   PetscErrorCode ierr;
6030b64e0483SPeter Brune   Vec coords,ccoords;
60316dbf9973SLawrence Mitchell   Mat inject;
6032b64e0483SPeter Brune   PetscFunctionBegin;
6033b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
6034b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
6035b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
6036b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
6037b64e0483SPeter Brune   if (coords && !ccoords) {
6038b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
60396668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
60406dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
60412adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
60426dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
6043b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
6044b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
6045b64e0483SPeter Brune   }
6046b64e0483SPeter Brune   PetscFunctionReturn(0);
6047b64e0483SPeter Brune }
6048b64e0483SPeter Brune 
604903dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
605003dadc2fSPeter Brune {
605103dadc2fSPeter Brune   DM dm_coord,subdm_coord;
605203dadc2fSPeter Brune   PetscErrorCode ierr;
605303dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
605403dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
605503dadc2fSPeter Brune   PetscFunctionBegin;
605603dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
605703dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
605803dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
605903dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
606003dadc2fSPeter Brune   if (coords && !ccoords) {
606103dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
60626668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
606303dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
606424640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
606503dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
606603dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
606703dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
60681ed9ada7SJunchao Zhang     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
606903dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
607003dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
607103dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
607203dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
607303dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
607403dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
607503dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
607603dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
607703dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
607803dadc2fSPeter Brune   }
607903dadc2fSPeter Brune   PetscFunctionReturn(0);
608003dadc2fSPeter Brune }
608103dadc2fSPeter Brune 
6082c73cfb54SMatthew G. Knepley /*@
6083c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
6084c73cfb54SMatthew G. Knepley 
6085c73cfb54SMatthew G. Knepley   Not collective
6086c73cfb54SMatthew G. Knepley 
6087c73cfb54SMatthew G. Knepley   Input Parameter:
6088c73cfb54SMatthew G. Knepley . dm - The DM
6089c73cfb54SMatthew G. Knepley 
6090c73cfb54SMatthew G. Knepley   Output Parameter:
6091c73cfb54SMatthew G. Knepley . dim - The topological dimension
6092c73cfb54SMatthew G. Knepley 
6093c73cfb54SMatthew G. Knepley   Level: beginner
6094c73cfb54SMatthew G. Knepley 
6095c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
6096c73cfb54SMatthew G. Knepley @*/
6097c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
6098c73cfb54SMatthew G. Knepley {
6099c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6100c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6101534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
6102c73cfb54SMatthew G. Knepley   *dim = dm->dim;
6103c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6104c73cfb54SMatthew G. Knepley }
6105c73cfb54SMatthew G. Knepley 
6106c73cfb54SMatthew G. Knepley /*@
6107c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
6108c73cfb54SMatthew G. Knepley 
6109c73cfb54SMatthew G. Knepley   Collective on dm
6110c73cfb54SMatthew G. Knepley 
6111c73cfb54SMatthew G. Knepley   Input Parameters:
6112c73cfb54SMatthew G. Knepley + dm - The DM
6113c73cfb54SMatthew G. Knepley - dim - The topological dimension
6114c73cfb54SMatthew G. Knepley 
6115c73cfb54SMatthew G. Knepley   Level: beginner
6116c73cfb54SMatthew G. Knepley 
6117c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
6118c73cfb54SMatthew G. Knepley @*/
6119c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
6120c73cfb54SMatthew G. Knepley {
6121e5e52638SMatthew G. Knepley   PetscDS        ds;
612245480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6123f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6124f17e8794SMatthew G. Knepley 
6125c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6126c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6127c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
6128c73cfb54SMatthew G. Knepley   dm->dim = dim;
612945480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
613045480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
613145480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
613245480ffeSMatthew G. Knepley     if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);}
613345480ffeSMatthew G. Knepley   }
6134c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6135c73cfb54SMatthew G. Knepley }
6136c73cfb54SMatthew G. Knepley 
6137793f3fe5SMatthew G. Knepley /*@
6138793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
6139793f3fe5SMatthew G. Knepley 
6140d083f849SBarry Smith   Collective on dm
6141793f3fe5SMatthew G. Knepley 
6142793f3fe5SMatthew G. Knepley   Input Parameters:
6143793f3fe5SMatthew G. Knepley + dm - the DM
6144793f3fe5SMatthew G. Knepley - dim - the dimension
6145793f3fe5SMatthew G. Knepley 
6146793f3fe5SMatthew G. Knepley   Output Parameters:
6147793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
6148aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
6149793f3fe5SMatthew G. Knepley 
6150793f3fe5SMatthew G. Knepley   Note:
6151793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
6152a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
6153793f3fe5SMatthew G. Knepley   then the interval is empty.
6154793f3fe5SMatthew G. Knepley 
6155793f3fe5SMatthew G. Knepley   Level: intermediate
6156793f3fe5SMatthew G. Knepley 
6157793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
6158793f3fe5SMatthew G. Knepley @*/
6159793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
6160793f3fe5SMatthew G. Knepley {
6161793f3fe5SMatthew G. Knepley   PetscInt       d;
6162793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
6163793f3fe5SMatthew G. Knepley 
6164793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
6165793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6166793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
6167793f3fe5SMatthew G. Knepley   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
6168b9d85ea2SLisandro Dalcin   if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
6169793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
6170793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
6171793f3fe5SMatthew G. Knepley }
6172793f3fe5SMatthew G. Knepley 
61736636e97aSMatthew G Knepley /*@
61746636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
61756636e97aSMatthew G Knepley 
6176d083f849SBarry Smith   Collective on dm
61776636e97aSMatthew G Knepley 
61786636e97aSMatthew G Knepley   Input Parameters:
61796636e97aSMatthew G Knepley + dm - the DM
61806636e97aSMatthew G Knepley - c - coordinate vector
61816636e97aSMatthew G Knepley 
61822dd40e9bSPatrick Sanan   Notes:
61832dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
61842dd40e9bSPatrick Sanan 
61852dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
61866636e97aSMatthew G Knepley 
61876636e97aSMatthew G Knepley   Level: intermediate
61886636e97aSMatthew G Knepley 
618960c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
61906636e97aSMatthew G Knepley @*/
61916636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
61926636e97aSMatthew G Knepley {
61936636e97aSMatthew G Knepley   PetscErrorCode ierr;
61946636e97aSMatthew G Knepley 
61956636e97aSMatthew G Knepley   PetscFunctionBegin;
61966636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61976636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
61986636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
61996636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
62006636e97aSMatthew G Knepley   dm->coordinates = c;
62016636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
6202b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
620303dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
62046636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62056636e97aSMatthew G Knepley }
62066636e97aSMatthew G Knepley 
62076636e97aSMatthew G Knepley /*@
62086636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
62096636e97aSMatthew G Knepley 
62107058e716SVaclav Hapla   Not collective
62116636e97aSMatthew G Knepley 
62126636e97aSMatthew G Knepley    Input Parameters:
62136636e97aSMatthew G Knepley +  dm - the DM
62146636e97aSMatthew G Knepley -  c - coordinate vector
62156636e97aSMatthew G Knepley 
62162dd40e9bSPatrick Sanan   Notes:
62176636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
62186636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
62196636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
62206636e97aSMatthew G Knepley 
62212dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
62222dd40e9bSPatrick Sanan 
62236636e97aSMatthew G Knepley   Level: intermediate
62246636e97aSMatthew G Knepley 
62256636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
62266636e97aSMatthew G Knepley @*/
62276636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
62286636e97aSMatthew G Knepley {
62296636e97aSMatthew G Knepley   PetscErrorCode ierr;
62306636e97aSMatthew G Knepley 
62316636e97aSMatthew G Knepley   PetscFunctionBegin;
62326636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62336636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
62346636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
62356636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
62368865f1eaSKarl Rupp 
62376636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
62388865f1eaSKarl Rupp 
62396636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
62406636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62416636e97aSMatthew G Knepley }
62426636e97aSMatthew G Knepley 
62436636e97aSMatthew G Knepley /*@
62446636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
62456636e97aSMatthew G Knepley 
6246d083f849SBarry Smith   Collective on dm
62476636e97aSMatthew G Knepley 
62486636e97aSMatthew G Knepley   Input Parameter:
62496636e97aSMatthew G Knepley . dm - the DM
62506636e97aSMatthew G Knepley 
62516636e97aSMatthew G Knepley   Output Parameter:
62526636e97aSMatthew G Knepley . c - global coordinate vector
62536636e97aSMatthew G Knepley 
62546636e97aSMatthew G Knepley   Note:
625560c22052SBarry Smith   This is a borrowed reference, so the user should NOT destroy this vector. When the DM is
625660c22052SBarry Smith   destroyed the array will no longer be valid.
62576636e97aSMatthew G Knepley 
6258959c7569SPatrick Sanan   Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates).
62596636e97aSMatthew G Knepley 
62606636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
62616636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
62626636e97aSMatthew G Knepley 
62636636e97aSMatthew G Knepley   Level: intermediate
62646636e97aSMatthew G Knepley 
626560c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
62666636e97aSMatthew G Knepley @*/
62676636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
62686636e97aSMatthew G Knepley {
62696636e97aSMatthew G Knepley   PetscErrorCode ierr;
62706636e97aSMatthew G Knepley 
62716636e97aSMatthew G Knepley   PetscFunctionBegin;
62726636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62736636e97aSMatthew G Knepley   PetscValidPointer(c,2);
62741f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
62750298fd71SBarry Smith     DM        cdm = NULL;
62761970a576SMatthew G. Knepley     PetscBool localized;
62776636e97aSMatthew G Knepley 
62786636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
62796636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
62801970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
62811970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
62821970a576SMatthew G. Knepley     if (localized) {
62831970a576SMatthew G. Knepley       PetscInt cdim;
62841970a576SMatthew G. Knepley 
62851970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
62861970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
62871970a576SMatthew G. Knepley     }
62886636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
62896636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
62906636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
62916636e97aSMatthew G Knepley   }
62926636e97aSMatthew G Knepley   *c = dm->coordinates;
62936636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62946636e97aSMatthew G Knepley }
62956636e97aSMatthew G Knepley 
62966636e97aSMatthew G Knepley /*@
629781e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
629881e9a530SVaclav Hapla 
6299d083f849SBarry Smith   Collective on dm
630081e9a530SVaclav Hapla 
630181e9a530SVaclav Hapla   Input Parameter:
630281e9a530SVaclav Hapla . dm - the DM
630381e9a530SVaclav Hapla 
630481e9a530SVaclav Hapla   Level: advanced
630581e9a530SVaclav Hapla 
630681e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
630781e9a530SVaclav Hapla @*/
630881e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
630981e9a530SVaclav Hapla {
631081e9a530SVaclav Hapla   PetscErrorCode ierr;
631181e9a530SVaclav Hapla 
631281e9a530SVaclav Hapla   PetscFunctionBegin;
631381e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
631481e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
63151970a576SMatthew G. Knepley     DM        cdm = NULL;
63161970a576SMatthew G. Knepley     PetscBool localized;
63171970a576SMatthew G. Knepley 
631881e9a530SVaclav Hapla     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
631981e9a530SVaclav Hapla     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
63201970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
63211970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
63221970a576SMatthew G. Knepley     if (localized) {
63231970a576SMatthew G. Knepley       PetscInt cdim;
63241970a576SMatthew G. Knepley 
63251970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
63261970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
63271970a576SMatthew G. Knepley     }
632881e9a530SVaclav Hapla     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
632981e9a530SVaclav Hapla     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
633081e9a530SVaclav Hapla     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
633181e9a530SVaclav Hapla   }
633281e9a530SVaclav Hapla   PetscFunctionReturn(0);
633381e9a530SVaclav Hapla }
633481e9a530SVaclav Hapla 
633581e9a530SVaclav Hapla /*@
63366636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
63376636e97aSMatthew G Knepley 
6338d083f849SBarry Smith   Collective on dm
63396636e97aSMatthew G Knepley 
63406636e97aSMatthew G Knepley   Input Parameter:
63416636e97aSMatthew G Knepley . dm - the DM
63426636e97aSMatthew G Knepley 
63436636e97aSMatthew G Knepley   Output Parameter:
63446636e97aSMatthew G Knepley . c - coordinate vector
63456636e97aSMatthew G Knepley 
63466636e97aSMatthew G Knepley   Note:
63476636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
63486636e97aSMatthew G Knepley 
63496636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
63506636e97aSMatthew G Knepley 
63516636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63526636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63536636e97aSMatthew G Knepley 
63546636e97aSMatthew G Knepley   Level: intermediate
63556636e97aSMatthew G Knepley 
635681e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
63576636e97aSMatthew G Knepley @*/
63586636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
63596636e97aSMatthew G Knepley {
63606636e97aSMatthew G Knepley   PetscErrorCode ierr;
63616636e97aSMatthew G Knepley 
63626636e97aSMatthew G Knepley   PetscFunctionBegin;
63636636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63646636e97aSMatthew G Knepley   PetscValidPointer(c,2);
636581e9a530SVaclav Hapla   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
63666636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
63676636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63686636e97aSMatthew G Knepley }
63696636e97aSMatthew G Knepley 
637081e9a530SVaclav Hapla /*@
637181e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
637281e9a530SVaclav Hapla 
637381e9a530SVaclav Hapla   Not collective
637481e9a530SVaclav Hapla 
637581e9a530SVaclav Hapla   Input Parameter:
637681e9a530SVaclav Hapla . dm - the DM
637781e9a530SVaclav Hapla 
637881e9a530SVaclav Hapla   Output Parameter:
637981e9a530SVaclav Hapla . c - coordinate vector
638081e9a530SVaclav Hapla 
638181e9a530SVaclav Hapla   Level: advanced
638281e9a530SVaclav Hapla 
638381e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
638481e9a530SVaclav Hapla @*/
638581e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
638681e9a530SVaclav Hapla {
638781e9a530SVaclav Hapla   PetscFunctionBegin;
638881e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
638981e9a530SVaclav Hapla   PetscValidPointer(c,2);
639081e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
63916636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
63926636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63936636e97aSMatthew G Knepley }
63946636e97aSMatthew G Knepley 
63952db98f8dSVaclav Hapla /*@
63962db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
63972db98f8dSVaclav Hapla 
63982db98f8dSVaclav Hapla   Not collective
63992db98f8dSVaclav Hapla 
6400d8d19677SJose E. Roman   Input Parameters:
64012db98f8dSVaclav Hapla + dm - the DM
64022db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
64032db98f8dSVaclav Hapla 
6404d8d19677SJose E. Roman   Output Parameters:
64052db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
64062db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
64072db98f8dSVaclav Hapla 
64082db98f8dSVaclav Hapla   Note:
64092db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
64102db98f8dSVaclav Hapla 
64112db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
64122db98f8dSVaclav Hapla 
64132db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
64142db98f8dSVaclav Hapla 
64152db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
64162db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
64172db98f8dSVaclav Hapla 
64182db98f8dSVaclav Hapla   Level: advanced
64192db98f8dSVaclav Hapla 
64202db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
64212db98f8dSVaclav Hapla @*/
64222db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
64232db98f8dSVaclav Hapla {
64242db98f8dSVaclav Hapla   PetscSection        cs, newcs;
64252db98f8dSVaclav Hapla   Vec                 coords;
64262db98f8dSVaclav Hapla   const PetscScalar   *arr;
64272db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
64282db98f8dSVaclav Hapla   PetscInt            n;
64292db98f8dSVaclav Hapla   PetscErrorCode      ierr;
64302db98f8dSVaclav Hapla 
64312db98f8dSVaclav Hapla   PetscFunctionBegin;
64322db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
64332db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
64342db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
64352db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
64362db98f8dSVaclav Hapla   if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
64371bb6d2a8SBarry Smith   if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
64381bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
64392db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
64402db98f8dSVaclav Hapla   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
64412db98f8dSVaclav Hapla   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
64422db98f8dSVaclav Hapla   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
64432db98f8dSVaclav Hapla   if (pCoord) {
64442db98f8dSVaclav Hapla     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
64452db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
64462db98f8dSVaclav Hapla     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
64472db98f8dSVaclav Hapla     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
6448ad9ac99dSVaclav Hapla   } else {
6449ad9ac99dSVaclav Hapla     ierr = PetscFree(newarr);CHKERRQ(ierr);
64502db98f8dSVaclav Hapla   }
6451ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
6452ad9ac99dSVaclav Hapla   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
64532db98f8dSVaclav Hapla   PetscFunctionReturn(0);
64542db98f8dSVaclav Hapla }
64552db98f8dSVaclav Hapla 
6456f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6457f19dbd58SToby Isaac {
6458f19dbd58SToby Isaac   PetscErrorCode ierr;
6459f19dbd58SToby Isaac 
6460f19dbd58SToby Isaac   PetscFunctionBegin;
6461f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6462f19dbd58SToby Isaac   PetscValidPointer(field,2);
6463f19dbd58SToby Isaac   if (!dm->coordinateField) {
6464f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
6465f19dbd58SToby Isaac       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
6466f19dbd58SToby Isaac     }
6467f19dbd58SToby Isaac   }
6468f19dbd58SToby Isaac   *field = dm->coordinateField;
6469f19dbd58SToby Isaac   PetscFunctionReturn(0);
6470f19dbd58SToby Isaac }
6471f19dbd58SToby Isaac 
6472f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6473f19dbd58SToby Isaac {
6474f19dbd58SToby Isaac   PetscErrorCode ierr;
6475f19dbd58SToby Isaac 
6476f19dbd58SToby Isaac   PetscFunctionBegin;
6477f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6478f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
6479c4e6da2cSBarry Smith   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
6480f19dbd58SToby Isaac   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
6481f19dbd58SToby Isaac   dm->coordinateField = field;
6482f19dbd58SToby Isaac   PetscFunctionReturn(0);
6483f19dbd58SToby Isaac }
6484f19dbd58SToby Isaac 
64856636e97aSMatthew G Knepley /*@
64861cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
64876636e97aSMatthew G Knepley 
6488d083f849SBarry Smith   Collective on dm
64896636e97aSMatthew G Knepley 
64906636e97aSMatthew G Knepley   Input Parameter:
64916636e97aSMatthew G Knepley . dm - the DM
64926636e97aSMatthew G Knepley 
64936636e97aSMatthew G Knepley   Output Parameter:
64946636e97aSMatthew G Knepley . cdm - coordinate DM
64956636e97aSMatthew G Knepley 
64966636e97aSMatthew G Knepley   Level: intermediate
64976636e97aSMatthew G Knepley 
64981cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
64996636e97aSMatthew G Knepley @*/
65006636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
65016636e97aSMatthew G Knepley {
65026636e97aSMatthew G Knepley   PetscErrorCode ierr;
65036636e97aSMatthew G Knepley 
65046636e97aSMatthew G Knepley   PetscFunctionBegin;
65056636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
65066636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
65076636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6508308f8a94SToby Isaac     DM cdm;
6509308f8a94SToby Isaac 
651082f516ccSBarry Smith     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
6511308f8a94SToby Isaac     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
6512308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6513308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
6514308f8a94SToby Isaac     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
6515308f8a94SToby Isaac     dm->coordinateDM = cdm;
65166636e97aSMatthew G Knepley   }
65176636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
65186636e97aSMatthew G Knepley   PetscFunctionReturn(0);
65196636e97aSMatthew G Knepley }
6520e87bb0d3SMatthew G Knepley 
65211cfe2091SMatthew G. Knepley /*@
65221cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
65231cfe2091SMatthew G. Knepley 
6524d083f849SBarry Smith   Logically Collective on dm
65251cfe2091SMatthew G. Knepley 
65261cfe2091SMatthew G. Knepley   Input Parameters:
65271cfe2091SMatthew G. Knepley + dm - the DM
65281cfe2091SMatthew G. Knepley - cdm - coordinate DM
65291cfe2091SMatthew G. Knepley 
65301cfe2091SMatthew G. Knepley   Level: intermediate
65311cfe2091SMatthew G. Knepley 
65321cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
65331cfe2091SMatthew G. Knepley @*/
65341cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
65351cfe2091SMatthew G. Knepley {
65361cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
65371cfe2091SMatthew G. Knepley 
65381cfe2091SMatthew G. Knepley   PetscFunctionBegin;
65391cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
65401cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
6541f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
65421cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
65431cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
65441cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
65451cfe2091SMatthew G. Knepley }
65461cfe2091SMatthew G. Knepley 
654746e270d4SMatthew G. Knepley /*@
654846e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
654946e270d4SMatthew G. Knepley 
655046e270d4SMatthew G. Knepley   Not Collective
655146e270d4SMatthew G. Knepley 
655246e270d4SMatthew G. Knepley   Input Parameter:
655346e270d4SMatthew G. Knepley . dm - The DM object
655446e270d4SMatthew G. Knepley 
655546e270d4SMatthew G. Knepley   Output Parameter:
655646e270d4SMatthew G. Knepley . dim - The embedding dimension
655746e270d4SMatthew G. Knepley 
655846e270d4SMatthew G. Knepley   Level: intermediate
655946e270d4SMatthew G. Knepley 
656092fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
656146e270d4SMatthew G. Knepley @*/
656246e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
656346e270d4SMatthew G. Knepley {
656446e270d4SMatthew G. Knepley   PetscFunctionBegin;
656546e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6566534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
65679a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
65689a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
65699a9a41abSToby Isaac   }
657046e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
657146e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
657246e270d4SMatthew G. Knepley }
657346e270d4SMatthew G. Knepley 
657446e270d4SMatthew G. Knepley /*@
657546e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
657646e270d4SMatthew G. Knepley 
657746e270d4SMatthew G. Knepley   Not Collective
657846e270d4SMatthew G. Knepley 
657946e270d4SMatthew G. Knepley   Input Parameters:
658046e270d4SMatthew G. Knepley + dm  - The DM object
658146e270d4SMatthew G. Knepley - dim - The embedding dimension
658246e270d4SMatthew G. Knepley 
658346e270d4SMatthew G. Knepley   Level: intermediate
658446e270d4SMatthew G. Knepley 
658592fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
658646e270d4SMatthew G. Knepley @*/
658746e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
658846e270d4SMatthew G. Knepley {
6589e5e52638SMatthew G. Knepley   PetscDS        ds;
659045480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6591f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6592f17e8794SMatthew G. Knepley 
659346e270d4SMatthew G. Knepley   PetscFunctionBegin;
659446e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
659546e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
659645480ffeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
659745480ffeSMatthew G. Knepley   for (n = 0; n < Nds; ++n) {
659845480ffeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
6599e5e52638SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
660045480ffeSMatthew G. Knepley   }
660146e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
660246e270d4SMatthew G. Knepley }
660346e270d4SMatthew G. Knepley 
6604e8abe2deSMatthew G. Knepley /*@
6605e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6606e8abe2deSMatthew G. Knepley 
6607d083f849SBarry Smith   Collective on dm
6608e8abe2deSMatthew G. Knepley 
6609e8abe2deSMatthew G. Knepley   Input Parameter:
6610e8abe2deSMatthew G. Knepley . dm - The DM object
6611e8abe2deSMatthew G. Knepley 
6612e8abe2deSMatthew G. Knepley   Output Parameter:
6613e8abe2deSMatthew G. Knepley . section - The PetscSection object
6614e8abe2deSMatthew G. Knepley 
6615e8abe2deSMatthew G. Knepley   Level: intermediate
6616e8abe2deSMatthew G. Knepley 
661792fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6618e8abe2deSMatthew G. Knepley @*/
6619e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6620e8abe2deSMatthew G. Knepley {
6621e8abe2deSMatthew G. Knepley   DM             cdm;
6622e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6623e8abe2deSMatthew G. Knepley 
6624e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6625e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6626e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
6627e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
662892fd8e1eSJed Brown   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6629e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6630e8abe2deSMatthew G. Knepley }
6631e8abe2deSMatthew G. Knepley 
6632e8abe2deSMatthew G. Knepley /*@
6633e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6634e8abe2deSMatthew G. Knepley 
6635e8abe2deSMatthew G. Knepley   Not Collective
6636e8abe2deSMatthew G. Knepley 
6637e8abe2deSMatthew G. Knepley   Input Parameters:
6638e8abe2deSMatthew G. Knepley + dm      - The DM object
663946e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6640e8abe2deSMatthew G. Knepley - section - The PetscSection object
6641e8abe2deSMatthew G. Knepley 
6642e8abe2deSMatthew G. Knepley   Level: intermediate
6643e8abe2deSMatthew G. Knepley 
664492fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6645e8abe2deSMatthew G. Knepley @*/
664646e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6647e8abe2deSMatthew G. Knepley {
6648e8abe2deSMatthew G. Knepley   DM             cdm;
6649e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6650e8abe2deSMatthew G. Knepley 
6651e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6652e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
665346e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6654e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
665592fd8e1eSJed Brown   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
665646e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
66574c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
665846e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
665946e270d4SMatthew G. Knepley 
666046e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
666146e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
666246e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
666346e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
666446e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
666546e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
666646e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
666746e270d4SMatthew G. Knepley     }
6668ebfe4b0dSMatthew G. Knepley     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
666946e270d4SMatthew G. Knepley   }
6670e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6671e8abe2deSMatthew G. Knepley }
6672e8abe2deSMatthew G. Knepley 
6673d864a3eaSLisandro Dalcin /*@
6674d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6675d864a3eaSLisandro Dalcin 
6676d864a3eaSLisandro Dalcin   Input Parameters:
6677d864a3eaSLisandro Dalcin + dm      - The DM object
6678d864a3eaSLisandro Dalcin - disc    - The new coordinate discretization
6679d864a3eaSLisandro Dalcin 
6680d864a3eaSLisandro Dalcin   Level: intermediate
6681d864a3eaSLisandro Dalcin 
6682d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6683d864a3eaSLisandro Dalcin @*/
6684d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6685d864a3eaSLisandro Dalcin {
6686d864a3eaSLisandro Dalcin   PetscObject    discOld;
6687d864a3eaSLisandro Dalcin   PetscClassId   classid;
6688d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6689d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6690d864a3eaSLisandro Dalcin   Mat            matInterp;
6691d864a3eaSLisandro Dalcin   PetscErrorCode ierr;
6692d864a3eaSLisandro Dalcin 
6693d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6694d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6695d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6696d864a3eaSLisandro Dalcin 
6697d864a3eaSLisandro Dalcin   ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr);
6698d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
6699d864a3eaSLisandro Dalcin   ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr);
6700d864a3eaSLisandro Dalcin   ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr);
670129ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
670229ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
670329ad44c5SMatthew G. Knepley       PetscFE        feLinear;
670429ad44c5SMatthew G. Knepley       DMPolytopeType ct;
670529ad44c5SMatthew G. Knepley       PetscInt       dim, dE, cStart;
670629ad44c5SMatthew G. Knepley       PetscBool      simplex;
670729ad44c5SMatthew G. Knepley 
670829ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
670929ad44c5SMatthew G. Knepley       ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
671029ad44c5SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
671129ad44c5SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr);
671229ad44c5SMatthew G. Knepley       ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
671329ad44c5SMatthew G. Knepley       switch (ct) {
671429ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM:
671529ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM_TENSOR:
671629ad44c5SMatthew G. Knepley           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
671729ad44c5SMatthew G. Knepley         default: break;
671829ad44c5SMatthew G. Knepley       }
671929ad44c5SMatthew G. Knepley       simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
672029ad44c5SMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr);
672129ad44c5SMatthew G. Knepley       ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr);
672229ad44c5SMatthew G. Knepley       ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr);
672329ad44c5SMatthew G. Knepley       ierr = DMCreateDS(cdmOld);CHKERRQ(ierr);
672429ad44c5SMatthew G. Knepley     } else {
672529ad44c5SMatthew G. Knepley       const char *discname;
672629ad44c5SMatthew G. Knepley 
672729ad44c5SMatthew G. Knepley       ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr);
672829ad44c5SMatthew G. Knepley       SETERRQ1(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
672929ad44c5SMatthew G. Knepley     }
673029ad44c5SMatthew G. Knepley   }
6731d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
6732d864a3eaSLisandro Dalcin   ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr);
6733d864a3eaSLisandro Dalcin   ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr);
6734d864a3eaSLisandro Dalcin   ierr = DMCreateDS(cdmNew);CHKERRQ(ierr);
6735d864a3eaSLisandro Dalcin   /* Project the coordinate vector from old to new space  */
6736d864a3eaSLisandro Dalcin   ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr);
6737d864a3eaSLisandro Dalcin   ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr);
6738d864a3eaSLisandro Dalcin   ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr);
6739d864a3eaSLisandro Dalcin   ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr);
6740d864a3eaSLisandro Dalcin   ierr = MatDestroy(&matInterp);CHKERRQ(ierr);
6741d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
6742d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr);
6743d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr);
6744d864a3eaSLisandro Dalcin   ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr);
6745d864a3eaSLisandro Dalcin   ierr = VecDestroy(&coordsNew);CHKERRQ(ierr);
6746d864a3eaSLisandro Dalcin   ierr = DMDestroy(&cdmNew);CHKERRQ(ierr);
6747d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6748d864a3eaSLisandro Dalcin }
6749d864a3eaSLisandro Dalcin 
67505dc8c3f7SMatthew G. Knepley /*@C
675190b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
67525dc8c3f7SMatthew G. Knepley 
6753f899ff85SJose E. Roman   Input Parameter:
675490b157c4SStefano Zampini . dm      - The DM object
675590b157c4SStefano Zampini 
675690b157c4SStefano Zampini   Output Parameters:
675790b157c4SStefano Zampini + per     - Whether the DM is periodic or not
67585dc8c3f7SMatthew 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
67595dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
67605dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
67615dc8c3f7SMatthew G. Knepley 
67625dc8c3f7SMatthew G. Knepley   Level: developer
67635dc8c3f7SMatthew G. Knepley 
67645dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
67655dc8c3f7SMatthew G. Knepley @*/
676690b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6767c6b900c6SMatthew G. Knepley {
6768c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6769c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
677090b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6771c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6772c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
67735dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6774c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6775c6b900c6SMatthew G. Knepley }
6776c6b900c6SMatthew G. Knepley 
67775dc8c3f7SMatthew G. Knepley /*@C
67785dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
67795dc8c3f7SMatthew G. Knepley 
67805dc8c3f7SMatthew G. Knepley   Input Parameters:
67815dc8c3f7SMatthew G. Knepley + dm      - The DM object
6782db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6783db2bf62eSStefano 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.
67845dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
67855dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
67865dc8c3f7SMatthew G. Knepley 
6787db2bf62eSStefano 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.
6788db2bf62eSStefano Zampini 
67895dc8c3f7SMatthew G. Knepley   Level: developer
67905dc8c3f7SMatthew G. Knepley 
67915dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
67925dc8c3f7SMatthew G. Knepley @*/
679390b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6794c6b900c6SMatthew G. Knepley {
6795c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6796c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
6797c6b900c6SMatthew G. Knepley 
6798c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6799c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
680090b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6801412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6802412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6803412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
68045dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
680590b157c4SStefano Zampini   if (maxCell) {
6806412e9a14SMatthew G. Knepley     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6807412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6808db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
6809db2bf62eSStefano Zampini     ierr = PetscFree(dm->maxCell);CHKERRQ(ierr);
6810412e9a14SMatthew G. Knepley   }
6811db2bf62eSStefano Zampini 
6812412e9a14SMatthew G. Knepley   if (L) {
6813412e9a14SMatthew G. Knepley     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6814412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6815412e9a14SMatthew G. Knepley   }
6816412e9a14SMatthew G. Knepley   if (bd) {
6817412e9a14SMatthew G. Knepley     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6818412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
681990b157c4SStefano Zampini   }
6820072d7d67SStefano Zampini   dm->periodic = per;
6821c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6822c6b900c6SMatthew G. Knepley }
6823c6b900c6SMatthew G. Knepley 
68242e17dfb7SMatthew G. Knepley /*@
68252e17dfb7SMatthew 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.
68262e17dfb7SMatthew G. Knepley 
68272e17dfb7SMatthew G. Knepley   Input Parameters:
68282e17dfb7SMatthew G. Knepley + dm     - The DM
682965da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
683065da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
68312e17dfb7SMatthew G. Knepley 
68322e17dfb7SMatthew G. Knepley   Output Parameter:
68332e17dfb7SMatthew G. Knepley . out - The localized coordinate point
68342e17dfb7SMatthew G. Knepley 
68352e17dfb7SMatthew G. Knepley   Level: developer
68362e17dfb7SMatthew G. Knepley 
68372e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
68382e17dfb7SMatthew G. Knepley @*/
683965da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
68402e17dfb7SMatthew G. Knepley {
68412e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
68422e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
68432e17dfb7SMatthew G. Knepley 
68442e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68452e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
68462e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68472e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
68482e17dfb7SMatthew G. Knepley   } else {
684965da65dcSMatthew G. Knepley     if (endpoint) {
685065da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6851da3333bfSMatthew 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)) {
6852da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
685365da65dcSMatthew G. Knepley         } else {
6854da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
685565da65dcSMatthew G. Knepley         }
685665da65dcSMatthew G. Knepley       }
685765da65dcSMatthew G. Knepley     } else {
68582e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
68591118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
68602e17dfb7SMatthew G. Knepley       }
68612e17dfb7SMatthew G. Knepley     }
686265da65dcSMatthew G. Knepley   }
68632e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68642e17dfb7SMatthew G. Knepley }
68652e17dfb7SMatthew G. Knepley 
68662e17dfb7SMatthew G. Knepley /*
68672e17dfb7SMatthew 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.
68682e17dfb7SMatthew G. Knepley 
68692e17dfb7SMatthew G. Knepley   Input Parameters:
68702e17dfb7SMatthew G. Knepley + dm     - The DM
68712e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
68722e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
68732e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
68742e17dfb7SMatthew G. Knepley 
68752e17dfb7SMatthew G. Knepley   Output Parameter:
68762e17dfb7SMatthew G. Knepley . out - The localized coordinate point
68772e17dfb7SMatthew G. Knepley 
68782e17dfb7SMatthew G. Knepley   Level: developer
68792e17dfb7SMatthew G. Knepley 
68802e17dfb7SMatthew 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
68812e17dfb7SMatthew G. Knepley 
68822e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
68832e17dfb7SMatthew G. Knepley */
68842e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
68852e17dfb7SMatthew G. Knepley {
68862e17dfb7SMatthew G. Knepley   PetscInt d;
68872e17dfb7SMatthew G. Knepley 
68882e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68892e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68902e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
68912e17dfb7SMatthew G. Knepley   } else {
68922e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6893908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
68942e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
68952e17dfb7SMatthew G. Knepley       } else {
68962e17dfb7SMatthew G. Knepley         out[d] = in[d];
68972e17dfb7SMatthew G. Knepley       }
68982e17dfb7SMatthew G. Knepley     }
68992e17dfb7SMatthew G. Knepley   }
69002e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69012e17dfb7SMatthew G. Knepley }
6902a5801f52SStefano Zampini 
69032e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
69042e17dfb7SMatthew G. Knepley {
69052e17dfb7SMatthew G. Knepley   PetscInt d;
69062e17dfb7SMatthew G. Knepley 
69072e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69082e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
69092e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
69102e17dfb7SMatthew G. Knepley   } else {
69112e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6912908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
69132e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
69142e17dfb7SMatthew G. Knepley       } else {
69152e17dfb7SMatthew G. Knepley         out[d] = in[d];
69162e17dfb7SMatthew G. Knepley       }
69172e17dfb7SMatthew G. Knepley     }
69182e17dfb7SMatthew G. Knepley   }
69192e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69202e17dfb7SMatthew G. Knepley }
69212e17dfb7SMatthew G. Knepley 
69222e17dfb7SMatthew G. Knepley /*
69232e17dfb7SMatthew 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.
69242e17dfb7SMatthew G. Knepley 
69252e17dfb7SMatthew G. Knepley   Input Parameters:
69262e17dfb7SMatthew G. Knepley + dm     - The DM
69272e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
69282e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
69292e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
69302e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
69312e17dfb7SMatthew G. Knepley 
69322e17dfb7SMatthew G. Knepley   Output Parameter:
69332e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
69342e17dfb7SMatthew G. Knepley 
69352e17dfb7SMatthew G. Knepley   Level: developer
69362e17dfb7SMatthew G. Knepley 
69372e17dfb7SMatthew 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
69382e17dfb7SMatthew G. Knepley 
69392e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
69402e17dfb7SMatthew G. Knepley */
69412e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
69422e17dfb7SMatthew G. Knepley {
69432e17dfb7SMatthew G. Knepley   PetscInt d;
69442e17dfb7SMatthew G. Knepley 
69452e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69462e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
69472e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
69482e17dfb7SMatthew G. Knepley   } else {
69492e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6950412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
6951412e9a14SMatthew G. Knepley 
6952412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
6953412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6954412e9a14SMatthew G. Knepley 
6955412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
6956412e9a14SMatthew G. Knepley           SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%D-Coordinate %g more than %g away from anchor %g", d, (double) PetscRealPart(in[d]), (double) maxC, (double) PetscRealPart(anchor[d]));
6957412e9a14SMatthew G. Knepley         out[d] += newCoord;
69582e17dfb7SMatthew G. Knepley       } else {
69592e17dfb7SMatthew G. Knepley         out[d] += in[d];
69602e17dfb7SMatthew G. Knepley       }
69612e17dfb7SMatthew G. Knepley     }
69622e17dfb7SMatthew G. Knepley   }
69632e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69642e17dfb7SMatthew G. Knepley }
69652e17dfb7SMatthew G. Knepley 
696636447a5eSToby Isaac /*@
69678f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
69688f700142SStefano Zampini 
69698f700142SStefano Zampini   Not collective
697036447a5eSToby Isaac 
697136447a5eSToby Isaac   Input Parameter:
697236447a5eSToby Isaac . dm - The DM
697336447a5eSToby Isaac 
697436447a5eSToby Isaac   Output Parameter:
697536447a5eSToby Isaac   areLocalized - True if localized
697636447a5eSToby Isaac 
697736447a5eSToby Isaac   Level: developer
697836447a5eSToby Isaac 
69798f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
698036447a5eSToby Isaac @*/
69818f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
698236447a5eSToby Isaac {
698336447a5eSToby Isaac   DM             cdm;
698436447a5eSToby Isaac   PetscSection   coordSection;
69852ccac677SMatthew G. Knepley   PetscInt       depth, cStart, cEnd, sStart, sEnd, c, dof;
698646a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
698736447a5eSToby Isaac   PetscErrorCode ierr;
698836447a5eSToby Isaac 
698936447a5eSToby Isaac   PetscFunctionBegin;
699036447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6991534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
69928b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
699346a3a80fSLisandro Dalcin 
699436447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
699536447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
699646a3a80fSLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
69979f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
69982ccac677SMatthew G. Knepley   ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr);
69992ccac677SMatthew G. Knepley   if (!depth) PetscFunctionReturn(0);
700046a3a80fSLisandro Dalcin 
70019f7230bfSMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
700246a3a80fSLisandro Dalcin   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
700336447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
700436447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
700546a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
700646a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
700736447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
700846a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
700936447a5eSToby Isaac   }
70108f700142SStefano Zampini   *areLocalized = alreadyLocalized;
701136447a5eSToby Isaac   PetscFunctionReturn(0);
701236447a5eSToby Isaac }
701336447a5eSToby Isaac 
70148f700142SStefano Zampini /*@
70158f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
70168f700142SStefano Zampini 
70178f700142SStefano Zampini   Collective on dm
70188f700142SStefano Zampini 
70198f700142SStefano Zampini   Input Parameter:
70208f700142SStefano Zampini . dm - The DM
70218f700142SStefano Zampini 
70228f700142SStefano Zampini   Output Parameter:
70238f700142SStefano Zampini   areLocalized - True if localized
70248f700142SStefano Zampini 
70258f700142SStefano Zampini   Level: developer
70268f700142SStefano Zampini 
70278f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
70288f700142SStefano Zampini @*/
70298f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
70308f700142SStefano Zampini {
70318f700142SStefano Zampini   PetscBool      localized;
70328f700142SStefano Zampini   PetscErrorCode ierr;
70338f700142SStefano Zampini 
70348f700142SStefano Zampini   PetscFunctionBegin;
70358f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7036534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
70378f700142SStefano Zampini   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
7038820f2d46SBarry Smith   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
70398f700142SStefano Zampini   PetscFunctionReturn(0);
70408f700142SStefano Zampini }
704136447a5eSToby Isaac 
70422e17dfb7SMatthew G. Knepley /*@
7043492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
70442e17dfb7SMatthew G. Knepley 
70458f700142SStefano Zampini   Collective on dm
70468f700142SStefano Zampini 
70472e17dfb7SMatthew G. Knepley   Input Parameter:
70482e17dfb7SMatthew G. Knepley . dm - The DM
70492e17dfb7SMatthew G. Knepley 
70502e17dfb7SMatthew G. Knepley   Level: developer
70512e17dfb7SMatthew G. Knepley 
70528f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
70532e17dfb7SMatthew G. Knepley @*/
70542e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
70552e17dfb7SMatthew G. Knepley {
70562e17dfb7SMatthew G. Knepley   DM             cdm;
70572e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
70582e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
70593e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
70603e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
7061e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
70623e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
70633e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
70642e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
70652e17dfb7SMatthew G. Knepley 
70662e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70672e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
706892c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
7069f7cbd40bSStefano Zampini   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
7070f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
7071f7cbd40bSStefano Zampini 
70722e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
70732e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
70742e17dfb7SMatthew G. Knepley   {
70752e17dfb7SMatthew G. Knepley     PetscBool isplex;
70762e17dfb7SMatthew G. Knepley 
70772e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
70782e17dfb7SMatthew G. Knepley     if (isplex) {
70792e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
70803e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
708169291d52SBarry Smith       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
70823e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
70833e922f36SToby Isaac       newStart = vStart;
70843e922f36SToby Isaac       newEnd   = vEnd;
70853e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
70863e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
70873e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
70883e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
70893e922f36SToby Isaac       }
70902e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
70912e17dfb7SMatthew G. Knepley   }
70922e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
709343eeeb2dSStefano Zampini   if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
70942e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
70953e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
7096e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
70973e922f36SToby Isaac 
70982e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
70992e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
71002e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
71012e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
71023e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
71033e922f36SToby Isaac 
710469291d52SBarry Smith   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
71053e922f36SToby Isaac   localized = &anchor[bs];
71063e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
71073e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
71083e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
71093e922f36SToby Isaac 
71103e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
71113e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
71123e922f36SToby Isaac       PetscInt     b;
71133e922f36SToby Isaac 
71143e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
71153e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
71163e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
71173e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
71183e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
71193e922f36SToby Isaac         for (b = 0; b < bs; b++) {
71203e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
71213e922f36SToby Isaac         }
71223e922f36SToby Isaac         if (b < bs) break;
71233e922f36SToby Isaac       }
71243e922f36SToby Isaac       if (d < dof/bs) {
71253e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
71263e922f36SToby Isaac           PetscInt cdof;
71273e922f36SToby Isaac 
71283e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
71293e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
71303e922f36SToby Isaac         }
71313e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
71323e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
71333e922f36SToby Isaac       }
71343e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
71353e922f36SToby Isaac     }
71363e922f36SToby Isaac   }
7137ffc4695bSBarry Smith   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
71383e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
713969291d52SBarry Smith     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
71403e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
714169291d52SBarry Smith     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
71423e922f36SToby Isaac     PetscFunctionReturn(0);
71433e922f36SToby Isaac   }
71442e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
71452e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
71462e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
71472e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
71482e17dfb7SMatthew G. Knepley   }
71492e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
71502e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
7151c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
71522e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
71532e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
71542e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
71552e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
7156c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
71572e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
71582e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
71592e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
71602e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
71612e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
71622e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
71632e17dfb7SMatthew G. Knepley   }
71643e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
71653e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
71663e922f36SToby Isaac 
71672e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
71682e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
71693e922f36SToby Isaac       PetscInt     b, cdof;
71702e17dfb7SMatthew G. Knepley 
71713e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
71723e922f36SToby Isaac       if (!cdof) continue;
71732e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
71742e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
71752e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
71762e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
71772e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
71782e17dfb7SMatthew G. Knepley     }
71793e922f36SToby Isaac   }
718069291d52SBarry Smith   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
718169291d52SBarry Smith   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
7182c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
71832e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
71842e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
71852e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
71862e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
71872e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
71882e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
71892e17dfb7SMatthew G. Knepley }
71902e17dfb7SMatthew G. Knepley 
7191e87bb0d3SMatthew G Knepley /*@
71923a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
7193e87bb0d3SMatthew G Knepley 
7194d083f849SBarry Smith   Collective on v (see explanation below)
7195e87bb0d3SMatthew G Knepley 
7196e87bb0d3SMatthew G Knepley   Input Parameters:
7197e87bb0d3SMatthew G Knepley + dm - The DM
71986b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
7199e87bb0d3SMatthew G Knepley 
72006b867d5aSJose E. Roman   Input/Output Parameters:
72016b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
72026b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point;
72036b867d5aSJose E. Roman            on output, the PetscSF containing the ranks and local indices of the containing points
72043a93e3b7SToby Isaac 
7205e87bb0d3SMatthew G Knepley   Level: developer
720661e3bb9bSMatthew G Knepley 
720762a38674SMatthew G. Knepley   Notes:
72083a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
720962a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
72103a93e3b7SToby Isaac 
72113a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
721262a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
72133a93e3b7SToby Isaac 
72143a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
72153a93e3b7SToby Isaac 
721662a38674SMatthew G. Knepley $    const PetscSFNode *cells;
721762a38674SMatthew G. Knepley $    PetscInt           nFound;
7218a6216909SToby Isaac $    const PetscInt    *found;
721962a38674SMatthew G. Knepley $
7220a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
72213a93e3b7SToby Isaac 
72223a93e3b7SToby 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
72233a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
72243a93e3b7SToby Isaac 
722562a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
722661e3bb9bSMatthew G Knepley @*/
722762a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
7228e87bb0d3SMatthew G Knepley {
7229735aa83eSMatthew G Knepley   PetscErrorCode ierr;
7230735aa83eSMatthew G Knepley 
7231e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
7232e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7233e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
7234e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
72353a93e3b7SToby Isaac   if (*cellSF) {
72363a93e3b7SToby Isaac     PetscMPIInt result;
72373a93e3b7SToby Isaac 
7238e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
7239ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr);
72403a93e3b7SToby Isaac     if (result != MPI_IDENT && result != MPI_CONGRUENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's");
7241e0fc9d1bSMatthew G. Knepley   } else {
72423a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
72433a93e3b7SToby Isaac   }
7244b9d85ea2SLisandro Dalcin   if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
724547a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
724662a38674SMatthew G. Knepley   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
724747a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
7248e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
7249e87bb0d3SMatthew G Knepley }
725014f150ffSMatthew G. Knepley 
7251f4d763aaSMatthew G. Knepley /*@
7252f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
7253f4d763aaSMatthew G. Knepley 
72548f700142SStefano Zampini   Collective on dm
72558f700142SStefano Zampini 
7256f4d763aaSMatthew G. Knepley   Input Parameter:
7257f4d763aaSMatthew G. Knepley . dm - The original DM
7258f4d763aaSMatthew G. Knepley 
7259f4d763aaSMatthew G. Knepley   Output Parameter:
7260f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
7261f4d763aaSMatthew G. Knepley 
7262f4d763aaSMatthew G. Knepley   Level: intermediate
7263f4d763aaSMatthew G. Knepley 
7264e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
7265f4d763aaSMatthew G. Knepley @*/
726614f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
726714f150ffSMatthew G. Knepley {
7268c26acbdeSMatthew G. Knepley   PetscSection   section;
72692d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
727014f150ffSMatthew G. Knepley   PetscErrorCode ierr;
727114f150ffSMatthew G. Knepley 
727214f150ffSMatthew G. Knepley   PetscFunctionBegin;
727314f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
727414f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
727592fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
7276c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
7277ffc4695bSBarry Smith   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);
72782d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7279c26acbdeSMatthew G. Knepley     *odm = dm;
7280c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7281c26acbdeSMatthew G. Knepley   }
728214f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7283c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
728414f150ffSMatthew G. Knepley     PetscSF      sf;
728514f150ffSMatthew G. Knepley 
728614f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
7287e5e52638SMatthew G. Knepley     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
728814f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
728992fd8e1eSJed Brown     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
729014f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
729114f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
729215b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
7293e87a4003SBarry Smith     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
729414f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
729514f150ffSMatthew G. Knepley   }
729614f150ffSMatthew G. Knepley   *odm = dm->dmBC;
729714f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
729814f150ffSMatthew G. Knepley }
7299f4d763aaSMatthew G. Knepley 
7300f4d763aaSMatthew G. Knepley /*@
7301cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7302f4d763aaSMatthew G. Knepley 
7303f4d763aaSMatthew G. Knepley   Input Parameter:
7304f4d763aaSMatthew G. Knepley . dm - The original DM
7305f4d763aaSMatthew G. Knepley 
7306cdb7a50dSMatthew G. Knepley   Output Parameters:
7307cdb7a50dSMatthew G. Knepley + num - The output sequence number
7308cdb7a50dSMatthew G. Knepley - val - The output sequence value
7309f4d763aaSMatthew G. Knepley 
7310f4d763aaSMatthew G. Knepley   Level: intermediate
7311f4d763aaSMatthew G. Knepley 
7312f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7313f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7314f4d763aaSMatthew G. Knepley 
7315f4d763aaSMatthew G. Knepley .seealso: VecView()
7316f4d763aaSMatthew G. Knepley @*/
7317cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7318f4d763aaSMatthew G. Knepley {
7319f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7320f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7321534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7322534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7323f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7324f4d763aaSMatthew G. Knepley }
7325f4d763aaSMatthew G. Knepley 
7326f4d763aaSMatthew G. Knepley /*@
7327cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7328f4d763aaSMatthew G. Knepley 
7329f4d763aaSMatthew G. Knepley   Input Parameters:
7330f4d763aaSMatthew G. Knepley + dm - The original DM
7331cdb7a50dSMatthew G. Knepley . num - The output sequence number
7332cdb7a50dSMatthew G. Knepley - val - The output sequence value
7333f4d763aaSMatthew G. Knepley 
7334f4d763aaSMatthew G. Knepley   Level: intermediate
7335f4d763aaSMatthew G. Knepley 
7336f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7337f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7338f4d763aaSMatthew G. Knepley 
7339f4d763aaSMatthew G. Knepley .seealso: VecView()
7340f4d763aaSMatthew G. Knepley @*/
7341cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7342f4d763aaSMatthew G. Knepley {
7343f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7344f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7345f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7346cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7347cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7348cdb7a50dSMatthew G. Knepley }
7349cdb7a50dSMatthew G. Knepley 
7350cdb7a50dSMatthew G. Knepley /*@C
7351cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7352cdb7a50dSMatthew G. Knepley 
7353cdb7a50dSMatthew G. Knepley   Input Parameters:
7354cdb7a50dSMatthew G. Knepley + dm   - The original DM
7355cdb7a50dSMatthew G. Knepley . name - The sequence name
7356cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7357cdb7a50dSMatthew G. Knepley 
7358cdb7a50dSMatthew G. Knepley   Output Parameter:
7359cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7360cdb7a50dSMatthew G. Knepley 
7361cdb7a50dSMatthew G. Knepley   Level: intermediate
7362cdb7a50dSMatthew G. Knepley 
7363cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7364cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7365cdb7a50dSMatthew G. Knepley 
7366cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7367cdb7a50dSMatthew G. Knepley @*/
7368cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7369cdb7a50dSMatthew G. Knepley {
7370cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7371cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
7372cdb7a50dSMatthew G. Knepley 
7373cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7374cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7375cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7376064a246eSJacob Faibussowitsch   PetscValidRealPointer(val,5);
7377cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
7378cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7379cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7380cdb7a50dSMatthew G. Knepley     PetscScalar value;
7381cdb7a50dSMatthew G. Knepley 
738239d25373SMatthew G. Knepley     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
73834aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7384cdb7a50dSMatthew G. Knepley #endif
7385cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7386f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7387f4d763aaSMatthew G. Knepley }
73888e4ac7eaSMatthew G. Knepley 
73898e4ac7eaSMatthew G. Knepley /*@
73908e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
73918e4ac7eaSMatthew G. Knepley 
73928e4ac7eaSMatthew G. Knepley   Not collective
73938e4ac7eaSMatthew G. Knepley 
73948e4ac7eaSMatthew G. Knepley   Input Parameter:
73958e4ac7eaSMatthew G. Knepley . dm - The DM
73968e4ac7eaSMatthew G. Knepley 
73978e4ac7eaSMatthew G. Knepley   Output Parameter:
73988e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
73998e4ac7eaSMatthew G. Knepley 
74008e4ac7eaSMatthew G. Knepley   Level: beginner
74018e4ac7eaSMatthew G. Knepley 
74028e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
74038e4ac7eaSMatthew G. Knepley @*/
74048e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
74058e4ac7eaSMatthew G. Knepley {
74068e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
74078e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7408534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
74098e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
74108e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
74118e4ac7eaSMatthew G. Knepley }
74128e4ac7eaSMatthew G. Knepley 
74138e4ac7eaSMatthew G. Knepley /*@
74145d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
74158e4ac7eaSMatthew G. Knepley 
74168e4ac7eaSMatthew G. Knepley   Collective on dm
74178e4ac7eaSMatthew G. Knepley 
74188e4ac7eaSMatthew G. Knepley   Input Parameters:
74198e4ac7eaSMatthew G. Knepley + dm - The DM
74208e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
74218e4ac7eaSMatthew G. Knepley 
74225d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
74235d3b26e6SMatthew G. Knepley 
74248e4ac7eaSMatthew G. Knepley   Level: beginner
74258e4ac7eaSMatthew G. Knepley 
74265d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
74278e4ac7eaSMatthew G. Knepley @*/
74288e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
74298e4ac7eaSMatthew G. Knepley {
74308e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
74318e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
74328833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
74338e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
74348e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
74358e4ac7eaSMatthew G. Knepley }
7436c58f1c22SToby Isaac 
7437c58f1c22SToby Isaac /*@C
7438c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7439c58f1c22SToby Isaac 
7440c58f1c22SToby Isaac   Not Collective
7441c58f1c22SToby Isaac 
7442c58f1c22SToby Isaac   Input Parameters:
7443c58f1c22SToby Isaac + dm   - The DM object
7444c58f1c22SToby Isaac - name - The label name
7445c58f1c22SToby Isaac 
7446c58f1c22SToby Isaac   Level: intermediate
7447c58f1c22SToby Isaac 
7448c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7449c58f1c22SToby Isaac @*/
7450c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7451c58f1c22SToby Isaac {
74525d80c0bfSVaclav Hapla   PetscBool      flg;
74535d80c0bfSVaclav Hapla   DMLabel        label;
7454c58f1c22SToby Isaac   PetscErrorCode ierr;
7455c58f1c22SToby Isaac 
7456c58f1c22SToby Isaac   PetscFunctionBegin;
7457c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7458c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
74595d80c0bfSVaclav Hapla   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
7460c58f1c22SToby Isaac   if (!flg) {
74615d80c0bfSVaclav Hapla     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
74625d80c0bfSVaclav Hapla     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
74635d80c0bfSVaclav Hapla     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
7464c58f1c22SToby Isaac   }
7465c58f1c22SToby Isaac   PetscFunctionReturn(0);
7466c58f1c22SToby Isaac }
7467c58f1c22SToby Isaac 
7468c58f1c22SToby Isaac /*@C
74690fdc7489SMatthew Knepley   DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index.
74700fdc7489SMatthew Knepley 
74710fdc7489SMatthew Knepley   Not Collective
74720fdc7489SMatthew Knepley 
74730fdc7489SMatthew Knepley   Input Parameters:
74740fdc7489SMatthew Knepley + dm   - The DM object
74750fdc7489SMatthew Knepley . l    - The index for the label
74760fdc7489SMatthew Knepley - name - The label name
74770fdc7489SMatthew Knepley 
74780fdc7489SMatthew Knepley   Level: intermediate
74790fdc7489SMatthew Knepley 
74800fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
74810fdc7489SMatthew Knepley @*/
74820fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[])
74830fdc7489SMatthew Knepley {
74840fdc7489SMatthew Knepley   DMLabelLink    orig, prev = NULL;
74850fdc7489SMatthew Knepley   DMLabel        label;
74860fdc7489SMatthew Knepley   PetscInt       Nl, m;
74870fdc7489SMatthew Knepley   PetscBool      flg, match;
74880fdc7489SMatthew Knepley   const char    *lname;
74890fdc7489SMatthew Knepley   PetscErrorCode ierr;
74900fdc7489SMatthew Knepley 
74910fdc7489SMatthew Knepley   PetscFunctionBegin;
74920fdc7489SMatthew Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7493064a246eSJacob Faibussowitsch   PetscValidCharPointer(name, 3);
74940fdc7489SMatthew Knepley   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
74950fdc7489SMatthew Knepley   if (!flg) {
74960fdc7489SMatthew Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
74970fdc7489SMatthew Knepley     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
74980fdc7489SMatthew Knepley     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
74990fdc7489SMatthew Knepley   }
75000fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
75010fdc7489SMatthew Knepley   if (l >= Nl) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl);
75020fdc7489SMatthew Knepley   for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) {
75030fdc7489SMatthew Knepley     ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr);
75040fdc7489SMatthew Knepley     ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr);
75050fdc7489SMatthew Knepley     if (match) break;
75060fdc7489SMatthew Knepley   }
75070fdc7489SMatthew Knepley   if (m == l) PetscFunctionReturn(0);
75080fdc7489SMatthew Knepley   if (!m) dm->labels = orig->next;
75090fdc7489SMatthew Knepley   else    prev->next = orig->next;
75100fdc7489SMatthew Knepley   if (!l) {
75110fdc7489SMatthew Knepley     orig->next = dm->labels;
75120fdc7489SMatthew Knepley     dm->labels = orig;
75130fdc7489SMatthew Knepley   } else {
75140fdc7489SMatthew Knepley     for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next);
75150fdc7489SMatthew Knepley     orig->next = prev->next;
75160fdc7489SMatthew Knepley     prev->next = orig;
75170fdc7489SMatthew Knepley   }
75180fdc7489SMatthew Knepley   PetscFunctionReturn(0);
75190fdc7489SMatthew Knepley }
75200fdc7489SMatthew Knepley 
75210fdc7489SMatthew Knepley /*@C
7522c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7523c58f1c22SToby Isaac 
7524c58f1c22SToby Isaac   Not Collective
7525c58f1c22SToby Isaac 
7526c58f1c22SToby Isaac   Input Parameters:
7527c58f1c22SToby Isaac + dm   - The DM object
7528c58f1c22SToby Isaac . name - The label name
7529c58f1c22SToby Isaac - point - The mesh point
7530c58f1c22SToby Isaac 
7531c58f1c22SToby Isaac   Output Parameter:
7532c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7533c58f1c22SToby Isaac 
7534c58f1c22SToby Isaac   Level: beginner
7535c58f1c22SToby Isaac 
7536c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7537c58f1c22SToby Isaac @*/
7538c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7539c58f1c22SToby Isaac {
7540c58f1c22SToby Isaac   DMLabel        label;
7541c58f1c22SToby Isaac   PetscErrorCode ierr;
7542c58f1c22SToby Isaac 
7543c58f1c22SToby Isaac   PetscFunctionBegin;
7544c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7545c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7546c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
754713903a91SSatish Balay   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
7548c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
7549c58f1c22SToby Isaac   PetscFunctionReturn(0);
7550c58f1c22SToby Isaac }
7551c58f1c22SToby Isaac 
7552c58f1c22SToby Isaac /*@C
7553c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7554c58f1c22SToby Isaac 
7555c58f1c22SToby Isaac   Not Collective
7556c58f1c22SToby Isaac 
7557c58f1c22SToby Isaac   Input Parameters:
7558c58f1c22SToby Isaac + dm   - The DM object
7559c58f1c22SToby Isaac . name - The label name
7560c58f1c22SToby Isaac . point - The mesh point
7561c58f1c22SToby Isaac - value - The label value for this point
7562c58f1c22SToby Isaac 
7563c58f1c22SToby Isaac   Output Parameter:
7564c58f1c22SToby Isaac 
7565c58f1c22SToby Isaac   Level: beginner
7566c58f1c22SToby Isaac 
7567c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7568c58f1c22SToby Isaac @*/
7569c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7570c58f1c22SToby Isaac {
7571c58f1c22SToby Isaac   DMLabel        label;
7572c58f1c22SToby Isaac   PetscErrorCode ierr;
7573c58f1c22SToby Isaac 
7574c58f1c22SToby Isaac   PetscFunctionBegin;
7575c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7576c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7577c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7578c58f1c22SToby Isaac   if (!label) {
7579c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
7580c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7581c58f1c22SToby Isaac   }
7582c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
7583c58f1c22SToby Isaac   PetscFunctionReturn(0);
7584c58f1c22SToby Isaac }
7585c58f1c22SToby Isaac 
7586c58f1c22SToby Isaac /*@C
7587c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7588c58f1c22SToby Isaac 
7589c58f1c22SToby Isaac   Not Collective
7590c58f1c22SToby Isaac 
7591c58f1c22SToby Isaac   Input Parameters:
7592c58f1c22SToby Isaac + dm   - The DM object
7593c58f1c22SToby Isaac . name - The label name
7594c58f1c22SToby Isaac . point - The mesh point
7595c58f1c22SToby Isaac - value - The label value for this point
7596c58f1c22SToby Isaac 
7597c58f1c22SToby Isaac   Output Parameter:
7598c58f1c22SToby Isaac 
7599c58f1c22SToby Isaac   Level: beginner
7600c58f1c22SToby Isaac 
7601c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7602c58f1c22SToby Isaac @*/
7603c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7604c58f1c22SToby Isaac {
7605c58f1c22SToby Isaac   DMLabel        label;
7606c58f1c22SToby Isaac   PetscErrorCode ierr;
7607c58f1c22SToby Isaac 
7608c58f1c22SToby Isaac   PetscFunctionBegin;
7609c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7610c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7611c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7612c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7613c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
7614c58f1c22SToby Isaac   PetscFunctionReturn(0);
7615c58f1c22SToby Isaac }
7616c58f1c22SToby Isaac 
7617c58f1c22SToby Isaac /*@C
7618c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7619c58f1c22SToby Isaac 
7620c58f1c22SToby Isaac   Not Collective
7621c58f1c22SToby Isaac 
7622c58f1c22SToby Isaac   Input Parameters:
7623c58f1c22SToby Isaac + dm   - The DM object
7624c58f1c22SToby Isaac - name - The label name
7625c58f1c22SToby Isaac 
7626c58f1c22SToby Isaac   Output Parameter:
7627c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7628c58f1c22SToby Isaac 
7629c58f1c22SToby Isaac   Level: beginner
7630c58f1c22SToby Isaac 
7631df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7632c58f1c22SToby Isaac @*/
7633c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7634c58f1c22SToby Isaac {
7635c58f1c22SToby Isaac   DMLabel        label;
7636c58f1c22SToby Isaac   PetscErrorCode ierr;
7637c58f1c22SToby Isaac 
7638c58f1c22SToby Isaac   PetscFunctionBegin;
7639c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7640c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7641534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
7642c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7643c58f1c22SToby Isaac   *size = 0;
7644c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7645c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
7646c58f1c22SToby Isaac   PetscFunctionReturn(0);
7647c58f1c22SToby Isaac }
7648c58f1c22SToby Isaac 
7649c58f1c22SToby Isaac /*@C
7650c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7651c58f1c22SToby Isaac 
7652c58f1c22SToby Isaac   Not Collective
7653c58f1c22SToby Isaac 
7654c58f1c22SToby Isaac   Input Parameters:
7655c58f1c22SToby Isaac + mesh - The DM object
7656c58f1c22SToby Isaac - name - The label name
7657c58f1c22SToby Isaac 
7658c58f1c22SToby Isaac   Output Parameter:
7659c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7660c58f1c22SToby Isaac 
7661c58f1c22SToby Isaac   Level: beginner
7662c58f1c22SToby Isaac 
7663c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7664c58f1c22SToby Isaac @*/
7665c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7666c58f1c22SToby Isaac {
7667c58f1c22SToby Isaac   DMLabel        label;
7668c58f1c22SToby Isaac   PetscErrorCode ierr;
7669c58f1c22SToby Isaac 
7670c58f1c22SToby Isaac   PetscFunctionBegin;
7671c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7672c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7673c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
7674c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7675c58f1c22SToby Isaac   *ids = NULL;
7676dab2e251SBlaise Bourdin  if (label) {
7677c58f1c22SToby Isaac     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
7678dab2e251SBlaise Bourdin   } else {
7679dab2e251SBlaise Bourdin     /* returning an empty IS */
7680dab2e251SBlaise Bourdin     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
7681dab2e251SBlaise Bourdin   }
7682c58f1c22SToby Isaac   PetscFunctionReturn(0);
7683c58f1c22SToby Isaac }
7684c58f1c22SToby Isaac 
7685c58f1c22SToby Isaac /*@C
7686c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
7687c58f1c22SToby Isaac 
7688c58f1c22SToby Isaac   Not Collective
7689c58f1c22SToby Isaac 
7690c58f1c22SToby Isaac   Input Parameters:
7691c58f1c22SToby Isaac + dm - The DM object
7692c58f1c22SToby Isaac . name - The label name
7693c58f1c22SToby Isaac - value - The stratum value
7694c58f1c22SToby Isaac 
7695c58f1c22SToby Isaac   Output Parameter:
7696c58f1c22SToby Isaac . size - The stratum size
7697c58f1c22SToby Isaac 
7698c58f1c22SToby Isaac   Level: beginner
7699c58f1c22SToby Isaac 
7700c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7701c58f1c22SToby Isaac @*/
7702c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7703c58f1c22SToby Isaac {
7704c58f1c22SToby Isaac   DMLabel        label;
7705c58f1c22SToby Isaac   PetscErrorCode ierr;
7706c58f1c22SToby Isaac 
7707c58f1c22SToby Isaac   PetscFunctionBegin;
7708c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7709c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7710534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
7711c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7712c58f1c22SToby Isaac   *size = 0;
7713c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7714c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
7715c58f1c22SToby Isaac   PetscFunctionReturn(0);
7716c58f1c22SToby Isaac }
7717c58f1c22SToby Isaac 
7718c58f1c22SToby Isaac /*@C
7719c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7720c58f1c22SToby Isaac 
7721c58f1c22SToby Isaac   Not Collective
7722c58f1c22SToby Isaac 
7723c58f1c22SToby Isaac   Input Parameters:
7724c58f1c22SToby Isaac + dm - The DM object
7725c58f1c22SToby Isaac . name - The label name
7726c58f1c22SToby Isaac - value - The stratum value
7727c58f1c22SToby Isaac 
7728c58f1c22SToby Isaac   Output Parameter:
7729c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7730c58f1c22SToby Isaac 
7731c58f1c22SToby Isaac   Level: beginner
7732c58f1c22SToby Isaac 
7733c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7734c58f1c22SToby Isaac @*/
7735c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7736c58f1c22SToby Isaac {
7737c58f1c22SToby Isaac   DMLabel        label;
7738c58f1c22SToby Isaac   PetscErrorCode ierr;
7739c58f1c22SToby Isaac 
7740c58f1c22SToby Isaac   PetscFunctionBegin;
7741c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7742c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7743c58f1c22SToby Isaac   PetscValidPointer(points, 4);
7744c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7745c58f1c22SToby Isaac   *points = NULL;
7746c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7747c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7748c58f1c22SToby Isaac   PetscFunctionReturn(0);
7749c58f1c22SToby Isaac }
7750c58f1c22SToby Isaac 
77514de306b1SToby Isaac /*@C
77529044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
77534de306b1SToby Isaac 
77544de306b1SToby Isaac   Not Collective
77554de306b1SToby Isaac 
77564de306b1SToby Isaac   Input Parameters:
77574de306b1SToby Isaac + dm - The DM object
77584de306b1SToby Isaac . name - The label name
77594de306b1SToby Isaac . value - The stratum value
77604de306b1SToby Isaac - points - The stratum points
77614de306b1SToby Isaac 
77624de306b1SToby Isaac   Level: beginner
77634de306b1SToby Isaac 
77644de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
77654de306b1SToby Isaac @*/
77664de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
77674de306b1SToby Isaac {
77684de306b1SToby Isaac   DMLabel        label;
77694de306b1SToby Isaac   PetscErrorCode ierr;
77704de306b1SToby Isaac 
77714de306b1SToby Isaac   PetscFunctionBegin;
77724de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
77734de306b1SToby Isaac   PetscValidCharPointer(name, 2);
77744de306b1SToby Isaac   PetscValidPointer(points, 4);
77754de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
77764de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
77774de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
77784de306b1SToby Isaac   PetscFunctionReturn(0);
77794de306b1SToby Isaac }
77804de306b1SToby Isaac 
7781c58f1c22SToby Isaac /*@C
7782c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7783c58f1c22SToby Isaac 
7784c58f1c22SToby Isaac   Not Collective
7785c58f1c22SToby Isaac 
7786c58f1c22SToby Isaac   Input Parameters:
7787c58f1c22SToby Isaac + dm   - The DM object
7788c58f1c22SToby Isaac . name - The label name
7789c58f1c22SToby Isaac - value - The label value for this point
7790c58f1c22SToby Isaac 
7791c58f1c22SToby Isaac   Output Parameter:
7792c58f1c22SToby Isaac 
7793c58f1c22SToby Isaac   Level: beginner
7794c58f1c22SToby Isaac 
7795c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7796c58f1c22SToby Isaac @*/
7797c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7798c58f1c22SToby Isaac {
7799c58f1c22SToby Isaac   DMLabel        label;
7800c58f1c22SToby Isaac   PetscErrorCode ierr;
7801c58f1c22SToby Isaac 
7802c58f1c22SToby Isaac   PetscFunctionBegin;
7803c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7804c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7805c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7806c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7807c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7808c58f1c22SToby Isaac   PetscFunctionReturn(0);
7809c58f1c22SToby Isaac }
7810c58f1c22SToby Isaac 
7811c58f1c22SToby Isaac /*@
7812c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7813c58f1c22SToby Isaac 
7814c58f1c22SToby Isaac   Not Collective
7815c58f1c22SToby Isaac 
7816c58f1c22SToby Isaac   Input Parameter:
7817c58f1c22SToby Isaac . dm   - The DM object
7818c58f1c22SToby Isaac 
7819c58f1c22SToby Isaac   Output Parameter:
7820c58f1c22SToby Isaac . numLabels - the number of Labels
7821c58f1c22SToby Isaac 
7822c58f1c22SToby Isaac   Level: intermediate
7823c58f1c22SToby Isaac 
7824c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7825c58f1c22SToby Isaac @*/
7826c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7827c58f1c22SToby Isaac {
78285d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7829c58f1c22SToby Isaac   PetscInt  n    = 0;
7830c58f1c22SToby Isaac 
7831c58f1c22SToby Isaac   PetscFunctionBegin;
7832c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7833534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7834c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7835c58f1c22SToby Isaac   *numLabels = n;
7836c58f1c22SToby Isaac   PetscFunctionReturn(0);
7837c58f1c22SToby Isaac }
7838c58f1c22SToby Isaac 
7839c58f1c22SToby Isaac /*@C
7840c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7841c58f1c22SToby Isaac 
7842c58f1c22SToby Isaac   Not Collective
7843c58f1c22SToby Isaac 
7844c58f1c22SToby Isaac   Input Parameters:
7845c58f1c22SToby Isaac + dm - The DM object
7846c58f1c22SToby Isaac - n  - the label number
7847c58f1c22SToby Isaac 
7848c58f1c22SToby Isaac   Output Parameter:
7849c58f1c22SToby Isaac . name - the label name
7850c58f1c22SToby Isaac 
7851c58f1c22SToby Isaac   Level: intermediate
7852c58f1c22SToby Isaac 
7853c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7854c58f1c22SToby Isaac @*/
7855c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7856c58f1c22SToby Isaac {
78575d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7858c58f1c22SToby Isaac   PetscInt       l    = 0;
7859d67d17b1SMatthew G. Knepley   PetscErrorCode ierr;
7860c58f1c22SToby Isaac 
7861c58f1c22SToby Isaac   PetscFunctionBegin;
7862c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7863c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7864c58f1c22SToby Isaac   while (next) {
7865c58f1c22SToby Isaac     if (l == n) {
7866d67d17b1SMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7867c58f1c22SToby Isaac       PetscFunctionReturn(0);
7868c58f1c22SToby Isaac     }
7869c58f1c22SToby Isaac     ++l;
7870c58f1c22SToby Isaac     next = next->next;
7871c58f1c22SToby Isaac   }
7872c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7873c58f1c22SToby Isaac }
7874c58f1c22SToby Isaac 
7875c58f1c22SToby Isaac /*@C
7876c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
7877c58f1c22SToby Isaac 
7878c58f1c22SToby Isaac   Not Collective
7879c58f1c22SToby Isaac 
7880c58f1c22SToby Isaac   Input Parameters:
7881c58f1c22SToby Isaac + dm   - The DM object
7882c58f1c22SToby Isaac - name - The label name
7883c58f1c22SToby Isaac 
7884c58f1c22SToby Isaac   Output Parameter:
7885c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
7886c58f1c22SToby Isaac 
7887c58f1c22SToby Isaac   Level: intermediate
7888c58f1c22SToby Isaac 
7889c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7890c58f1c22SToby Isaac @*/
7891c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
7892c58f1c22SToby Isaac {
78935d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7894d67d17b1SMatthew G. Knepley   const char    *lname;
7895c58f1c22SToby Isaac   PetscErrorCode ierr;
7896c58f1c22SToby Isaac 
7897c58f1c22SToby Isaac   PetscFunctionBegin;
7898c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7899c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7900534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
7901c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
7902c58f1c22SToby Isaac   while (next) {
7903d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7904d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
7905c58f1c22SToby Isaac     if (*hasLabel) break;
7906c58f1c22SToby Isaac     next = next->next;
7907c58f1c22SToby Isaac   }
7908c58f1c22SToby Isaac   PetscFunctionReturn(0);
7909c58f1c22SToby Isaac }
7910c58f1c22SToby Isaac 
7911c58f1c22SToby Isaac /*@C
7912c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
7913c58f1c22SToby Isaac 
7914c58f1c22SToby Isaac   Not Collective
7915c58f1c22SToby Isaac 
7916c58f1c22SToby Isaac   Input Parameters:
7917c58f1c22SToby Isaac + dm   - The DM object
7918c58f1c22SToby Isaac - name - The label name
7919c58f1c22SToby Isaac 
7920c58f1c22SToby Isaac   Output Parameter:
7921c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7922c58f1c22SToby Isaac 
79236d7c9049SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
79246d7c9049SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
79256d7c9049SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
79266d7c9049SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
79276d7c9049SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
79286d7c9049SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
79296d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
79306d7c9049SMatthew G. Knepley 
7931c58f1c22SToby Isaac   Level: intermediate
7932c58f1c22SToby Isaac 
79336d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
7934c58f1c22SToby Isaac @*/
7935c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
7936c58f1c22SToby Isaac {
79375d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7938c58f1c22SToby Isaac   PetscBool      hasLabel;
7939d67d17b1SMatthew G. Knepley   const char    *lname;
7940c58f1c22SToby Isaac   PetscErrorCode ierr;
7941c58f1c22SToby Isaac 
7942c58f1c22SToby Isaac   PetscFunctionBegin;
7943c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7944c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7945c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7946c58f1c22SToby Isaac   *label = NULL;
7947c58f1c22SToby Isaac   while (next) {
7948d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7949d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7950c58f1c22SToby Isaac     if (hasLabel) {
7951c58f1c22SToby Isaac       *label = next->label;
7952c58f1c22SToby Isaac       break;
7953c58f1c22SToby Isaac     }
7954c58f1c22SToby Isaac     next = next->next;
7955c58f1c22SToby Isaac   }
7956c58f1c22SToby Isaac   PetscFunctionReturn(0);
7957c58f1c22SToby Isaac }
7958c58f1c22SToby Isaac 
7959c58f1c22SToby Isaac /*@C
7960c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
7961c58f1c22SToby Isaac 
7962c58f1c22SToby Isaac   Not Collective
7963c58f1c22SToby Isaac 
7964c58f1c22SToby Isaac   Input Parameters:
7965c58f1c22SToby Isaac + dm - The DM object
7966c58f1c22SToby Isaac - n  - the label number
7967c58f1c22SToby Isaac 
7968c58f1c22SToby Isaac   Output Parameter:
7969c58f1c22SToby Isaac . label - the label
7970c58f1c22SToby Isaac 
7971c58f1c22SToby Isaac   Level: intermediate
7972c58f1c22SToby Isaac 
7973c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7974c58f1c22SToby Isaac @*/
7975c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
7976c58f1c22SToby Isaac {
79775d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7978c58f1c22SToby Isaac   PetscInt    l    = 0;
7979c58f1c22SToby Isaac 
7980c58f1c22SToby Isaac   PetscFunctionBegin;
7981c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7982c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7983c58f1c22SToby Isaac   while (next) {
7984c58f1c22SToby Isaac     if (l == n) {
7985c58f1c22SToby Isaac       *label = next->label;
7986c58f1c22SToby Isaac       PetscFunctionReturn(0);
7987c58f1c22SToby Isaac     }
7988c58f1c22SToby Isaac     ++l;
7989c58f1c22SToby Isaac     next = next->next;
7990c58f1c22SToby Isaac   }
7991c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7992c58f1c22SToby Isaac }
7993c58f1c22SToby Isaac 
7994c58f1c22SToby Isaac /*@C
7995c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
7996c58f1c22SToby Isaac 
7997c58f1c22SToby Isaac   Not Collective
7998c58f1c22SToby Isaac 
7999c58f1c22SToby Isaac   Input Parameters:
8000c58f1c22SToby Isaac + dm   - The DM object
8001c58f1c22SToby Isaac - label - The DMLabel
8002c58f1c22SToby Isaac 
8003c58f1c22SToby Isaac   Level: developer
8004c58f1c22SToby Isaac 
8005c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8006c58f1c22SToby Isaac @*/
8007c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
8008c58f1c22SToby Isaac {
80095d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
8010c58f1c22SToby Isaac   PetscBool      hasLabel;
8011d67d17b1SMatthew G. Knepley   const char    *lname;
80125d80c0bfSVaclav Hapla   PetscBool      flg;
8013c58f1c22SToby Isaac   PetscErrorCode ierr;
8014c58f1c22SToby Isaac 
8015c58f1c22SToby Isaac   PetscFunctionBegin;
8016c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8017d67d17b1SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
8018d67d17b1SMatthew G. Knepley   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
8019d67d17b1SMatthew G. Knepley   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
8020c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
8021c58f1c22SToby Isaac   tmpLabel->label  = label;
8022c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
80235d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
80245d80c0bfSVaclav Hapla   *p = tmpLabel;
802508f633c4SVaclav Hapla   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
80265d80c0bfSVaclav Hapla   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
80275d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
8028ba2698f1SMatthew G. Knepley   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
8029ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
8030c58f1c22SToby Isaac   PetscFunctionReturn(0);
8031c58f1c22SToby Isaac }
8032c58f1c22SToby Isaac 
8033c58f1c22SToby Isaac /*@C
80344a7ee7d0SMatthew G. Knepley   DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present
80354a7ee7d0SMatthew G. Knepley 
80364a7ee7d0SMatthew G. Knepley   Not Collective
80374a7ee7d0SMatthew G. Knepley 
80384a7ee7d0SMatthew G. Knepley   Input Parameters:
80394a7ee7d0SMatthew G. Knepley + dm    - The DM object
80404a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute
80414a7ee7d0SMatthew G. Knepley 
80424a7ee7d0SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
80434a7ee7d0SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
80444a7ee7d0SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
80454a7ee7d0SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
80464a7ee7d0SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
80474a7ee7d0SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
80484a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
80494a7ee7d0SMatthew G. Knepley 
80504a7ee7d0SMatthew G. Knepley   Level: intermediate
80514a7ee7d0SMatthew G. Knepley 
80524a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
80534a7ee7d0SMatthew G. Knepley @*/
80544a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label)
80554a7ee7d0SMatthew G. Knepley {
80564a7ee7d0SMatthew G. Knepley   DMLabelLink    next = dm->labels;
80574a7ee7d0SMatthew G. Knepley   PetscBool      hasLabel, flg;
80584a7ee7d0SMatthew G. Knepley   const char    *name, *lname;
80594a7ee7d0SMatthew G. Knepley   PetscErrorCode ierr;
80604a7ee7d0SMatthew G. Knepley 
80614a7ee7d0SMatthew G. Knepley   PetscFunctionBegin;
80624a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
80634a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
80644a7ee7d0SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr);
80654a7ee7d0SMatthew G. Knepley   while (next) {
80664a7ee7d0SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
80674a7ee7d0SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
80684a7ee7d0SMatthew G. Knepley     if (hasLabel) {
80694a7ee7d0SMatthew G. Knepley       ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
80704a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
80714a7ee7d0SMatthew G. Knepley       if (flg) dm->depthLabel = label;
80724a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
80734a7ee7d0SMatthew G. Knepley       if (flg) dm->celltypeLabel = label;
80744a7ee7d0SMatthew G. Knepley       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
80754a7ee7d0SMatthew G. Knepley       next->label = label;
80764a7ee7d0SMatthew G. Knepley       break;
80774a7ee7d0SMatthew G. Knepley     }
80784a7ee7d0SMatthew G. Knepley     next = next->next;
80794a7ee7d0SMatthew G. Knepley   }
80804a7ee7d0SMatthew G. Knepley   PetscFunctionReturn(0);
80814a7ee7d0SMatthew G. Knepley }
80824a7ee7d0SMatthew G. Knepley 
80834a7ee7d0SMatthew G. Knepley /*@C
8084e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
8085c58f1c22SToby Isaac 
8086c58f1c22SToby Isaac   Not Collective
8087c58f1c22SToby Isaac 
8088c58f1c22SToby Isaac   Input Parameters:
8089c58f1c22SToby Isaac + dm   - The DM object
8090c58f1c22SToby Isaac - name - The label name
8091c58f1c22SToby Isaac 
8092c58f1c22SToby Isaac   Output Parameter:
8093c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
8094c58f1c22SToby Isaac 
8095c58f1c22SToby Isaac   Level: developer
8096c58f1c22SToby Isaac 
8097e5472504SVaclav Hapla   Notes:
8098e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
8099e5472504SVaclav Hapla   DMLabelDestroy() on the label.
8100e5472504SVaclav Hapla 
8101e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
8102e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
8103e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
8104e5472504SVaclav Hapla 
8105e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
8106c58f1c22SToby Isaac @*/
8107c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
8108c58f1c22SToby Isaac {
810995d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
8110c58f1c22SToby Isaac   PetscBool      hasLabel;
8111d67d17b1SMatthew G. Knepley   const char    *lname;
8112c58f1c22SToby Isaac   PetscErrorCode ierr;
8113c58f1c22SToby Isaac 
8114c58f1c22SToby Isaac   PetscFunctionBegin;
8115c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8116e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
8117e5472504SVaclav Hapla   if (label) {
8118e5472504SVaclav Hapla     PetscValidPointer(label, 3);
8119c58f1c22SToby Isaac     *label = NULL;
8120e5472504SVaclav Hapla   }
81215d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
812295d578d6SVaclav Hapla     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
8123d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8124c58f1c22SToby Isaac     if (hasLabel) {
812595d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
8126c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
812795d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
8128ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
8129ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
813095d578d6SVaclav Hapla       if (label) *label = link->label;
813195d578d6SVaclav Hapla       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
813295d578d6SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8133c58f1c22SToby Isaac       break;
8134c58f1c22SToby Isaac     }
8135c58f1c22SToby Isaac   }
8136c58f1c22SToby Isaac   PetscFunctionReturn(0);
8137c58f1c22SToby Isaac }
8138c58f1c22SToby Isaac 
8139306894acSVaclav Hapla /*@
8140306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
8141306894acSVaclav Hapla 
8142306894acSVaclav Hapla   Not Collective
8143306894acSVaclav Hapla 
8144306894acSVaclav Hapla   Input Parameters:
8145306894acSVaclav Hapla + dm   - The DM object
8146876aa926SVaclav Hapla . label - The DMLabel to be removed from the DM
8147306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
8148306894acSVaclav Hapla 
8149306894acSVaclav Hapla   Level: developer
8150306894acSVaclav Hapla 
8151306894acSVaclav Hapla   Notes:
8152306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
8153306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
8154306894acSVaclav Hapla   *label nullified.
8155306894acSVaclav Hapla 
8156306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
8157306894acSVaclav Hapla @*/
8158306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
8159306894acSVaclav Hapla {
816043e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
8161306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
8162306894acSVaclav Hapla   PetscErrorCode ierr;
8163306894acSVaclav Hapla 
8164306894acSVaclav Hapla   PetscFunctionBegin;
8165306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8166306894acSVaclav Hapla   PetscValidPointer(label, 2);
8167f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
8168306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
8169306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
81705d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
817143e45a93SVaclav Hapla     if (*label == link->label) {
8172306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
817343e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
8174306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
8175ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
817643e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
817743e45a93SVaclav Hapla       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
817843e45a93SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8179306894acSVaclav Hapla       break;
8180306894acSVaclav Hapla     }
8181306894acSVaclav Hapla   }
8182306894acSVaclav Hapla   if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
8183306894acSVaclav Hapla   PetscFunctionReturn(0);
8184306894acSVaclav Hapla }
8185306894acSVaclav Hapla 
8186c58f1c22SToby Isaac /*@C
8187c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
8188c58f1c22SToby Isaac 
8189c58f1c22SToby Isaac   Not Collective
8190c58f1c22SToby Isaac 
8191c58f1c22SToby Isaac   Input Parameters:
8192c58f1c22SToby Isaac + dm   - The DM object
8193c58f1c22SToby Isaac - name - The label name
8194c58f1c22SToby Isaac 
8195c58f1c22SToby Isaac   Output Parameter:
8196c58f1c22SToby Isaac . output - The flag for output
8197c58f1c22SToby Isaac 
8198c58f1c22SToby Isaac   Level: developer
8199c58f1c22SToby Isaac 
8200c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8201c58f1c22SToby Isaac @*/
8202c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
8203c58f1c22SToby Isaac {
82045d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8205d67d17b1SMatthew G. Knepley   const char    *lname;
8206c58f1c22SToby Isaac   PetscErrorCode ierr;
8207c58f1c22SToby Isaac 
8208c58f1c22SToby Isaac   PetscFunctionBegin;
8209c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8210c58f1c22SToby Isaac   PetscValidPointer(name, 2);
8211c58f1c22SToby Isaac   PetscValidPointer(output, 3);
8212c58f1c22SToby Isaac   while (next) {
8213c58f1c22SToby Isaac     PetscBool flg;
8214c58f1c22SToby Isaac 
8215d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8216d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8217c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
8218c58f1c22SToby Isaac     next = next->next;
8219c58f1c22SToby Isaac   }
8220c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8221c58f1c22SToby Isaac }
8222c58f1c22SToby Isaac 
8223c58f1c22SToby Isaac /*@C
8224c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
8225c58f1c22SToby Isaac 
8226c58f1c22SToby Isaac   Not Collective
8227c58f1c22SToby Isaac 
8228c58f1c22SToby Isaac   Input Parameters:
8229c58f1c22SToby Isaac + dm     - The DM object
8230c58f1c22SToby Isaac . name   - The label name
8231c58f1c22SToby Isaac - output - The flag for output
8232c58f1c22SToby Isaac 
8233c58f1c22SToby Isaac   Level: developer
8234c58f1c22SToby Isaac 
8235c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8236c58f1c22SToby Isaac @*/
8237c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
8238c58f1c22SToby Isaac {
82395d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8240d67d17b1SMatthew G. Knepley   const char    *lname;
8241c58f1c22SToby Isaac   PetscErrorCode ierr;
8242c58f1c22SToby Isaac 
8243c58f1c22SToby Isaac   PetscFunctionBegin;
8244c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8245534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
8246c58f1c22SToby Isaac   while (next) {
8247c58f1c22SToby Isaac     PetscBool flg;
8248c58f1c22SToby Isaac 
8249d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8250d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8251c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
8252c58f1c22SToby Isaac     next = next->next;
8253c58f1c22SToby Isaac   }
8254c58f1c22SToby Isaac   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8255c58f1c22SToby Isaac }
8256c58f1c22SToby Isaac 
8257c58f1c22SToby Isaac /*@
8258c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
8259c58f1c22SToby Isaac 
8260d083f849SBarry Smith   Collective on dmA
8261c58f1c22SToby Isaac 
8262d8d19677SJose E. Roman   Input Parameters:
82635d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
82642cbb9b06SVaclav Hapla . dmB - The DM object to which labels are copied
82655d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
82662cbb9b06SVaclav Hapla . all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
82672cbb9b06SVaclav Hapla - emode - How to behave when a DMLabel in the source and destination DMs with the same name is encountered (see DMCopyLabelsMode)
8268c58f1c22SToby Isaac 
8269c58f1c22SToby Isaac   Level: intermediate
8270c58f1c22SToby Isaac 
82712cbb9b06SVaclav Hapla   Notes:
82722cbb9b06SVaclav Hapla   This is typically used when interpolating or otherwise adding to a mesh, or testing.
8273c58f1c22SToby Isaac 
82742cbb9b06SVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode
8275c58f1c22SToby Isaac @*/
82762cbb9b06SVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all, DMCopyLabelsMode emode)
8277c58f1c22SToby Isaac {
82782cbb9b06SVaclav Hapla   DMLabel        label, labelNew, labelOld;
8279c58f1c22SToby Isaac   const char    *name;
8280c58f1c22SToby Isaac   PetscBool      flg;
82815d80c0bfSVaclav Hapla   DMLabelLink    link;
82825d80c0bfSVaclav Hapla   PetscErrorCode ierr;
8283c58f1c22SToby Isaac 
82845d80c0bfSVaclav Hapla   PetscFunctionBegin;
82855d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
82865d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
82875d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
82885d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
82895d80c0bfSVaclav Hapla   if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
82905d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
82915d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
82925d80c0bfSVaclav Hapla     label=link->label;
82935d80c0bfSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
82945d80c0bfSVaclav Hapla     if (!all) {
8295c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
8296c58f1c22SToby Isaac       if (flg) continue;
82977d5acc75SStefano Zampini       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
82987d5acc75SStefano Zampini       if (flg) continue;
8299ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
8300ba2698f1SMatthew G. Knepley       if (flg) continue;
83015d80c0bfSVaclav Hapla     }
83022cbb9b06SVaclav Hapla     ierr = DMGetLabel(dmB, name, &labelOld);CHKERRQ(ierr);
83032cbb9b06SVaclav Hapla     if (labelOld) {
83042cbb9b06SVaclav Hapla       switch (emode) {
83052cbb9b06SVaclav Hapla         case DM_COPY_LABELS_KEEP:
83062cbb9b06SVaclav Hapla           continue;
83072cbb9b06SVaclav Hapla         case DM_COPY_LABELS_REPLACE:
83082cbb9b06SVaclav Hapla           ierr = DMRemoveLabelBySelf(dmB, &labelOld, PETSC_TRUE);CHKERRQ(ierr);
83092cbb9b06SVaclav Hapla           break;
83102cbb9b06SVaclav Hapla         case DM_COPY_LABELS_FAIL:
83112cbb9b06SVaclav Hapla           SETERRQ1(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in destination DM", name);
83122cbb9b06SVaclav Hapla         default:
83132cbb9b06SVaclav Hapla           SETERRQ1(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Unhandled DMCopyLabelsMode %d", emode);
83142cbb9b06SVaclav Hapla       }
83152cbb9b06SVaclav Hapla     }
83165d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
8317c58f1c22SToby Isaac       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
83185d80c0bfSVaclav Hapla     } else {
83195d80c0bfSVaclav Hapla       labelNew = label;
83205d80c0bfSVaclav Hapla     }
8321c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
83225d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
8323c58f1c22SToby Isaac   }
8324c58f1c22SToby Isaac   PetscFunctionReturn(0);
8325c58f1c22SToby Isaac }
8326461a15a0SLisandro Dalcin 
8327609dae6eSVaclav Hapla /*@C
8328609dae6eSVaclav Hapla   DMCompareLabels - Compare labels of two DMPlex meshes
8329609dae6eSVaclav Hapla 
8330609dae6eSVaclav Hapla   Collective on dmA
8331609dae6eSVaclav Hapla 
8332609dae6eSVaclav Hapla   Input Parameters:
8333609dae6eSVaclav Hapla + dm0 - First DM object
8334609dae6eSVaclav Hapla - dm1 - Second DM object
8335609dae6eSVaclav Hapla 
8336609dae6eSVaclav Hapla   Output Parameters
8337609dae6eSVaclav Hapla + same    - (Optional) Flag whether labels of dm0 and dm1 are the same
8338609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference
8339609dae6eSVaclav Hapla 
8340609dae6eSVaclav Hapla   Level: intermediate
8341609dae6eSVaclav Hapla 
8342609dae6eSVaclav Hapla   Notes:
8343609dae6eSVaclav Hapla   If both same and message is passed as NULL, and difference is found, an error is thrown with a message describing the difference.
8344609dae6eSVaclav Hapla 
8345609dae6eSVaclav Hapla   Message must be freed by user.
8346609dae6eSVaclav Hapla 
8347609dae6eSVaclav Hapla   Labels are matched by name. If the number of labels and their names are equal,
8348609dae6eSVaclav Hapla   DMLabelCompare() is used to compare each pair of labels with the same name.
8349609dae6eSVaclav Hapla 
8350609dae6eSVaclav Hapla   Fortran Notes:
8351609dae6eSVaclav Hapla   This function is currently not available from Fortran.
8352609dae6eSVaclav Hapla 
8353609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare()
8354609dae6eSVaclav Hapla @*/
8355609dae6eSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *same, char **message)
8356609dae6eSVaclav Hapla {
8357609dae6eSVaclav Hapla   PetscInt        n0, n1, i;
8358609dae6eSVaclav Hapla   char            msg[PETSC_MAX_PATH_LEN] = "";
8359609dae6eSVaclav Hapla   MPI_Comm        comm;
8360609dae6eSVaclav Hapla   PetscErrorCode  ierr;
8361609dae6eSVaclav Hapla 
8362609dae6eSVaclav Hapla   PetscFunctionBegin;
8363609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm0,DM_CLASSID,1);
8364609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm1,DM_CLASSID,2);
8365609dae6eSVaclav Hapla   PetscCheckSameComm(dm0,1,dm1,2);
8366609dae6eSVaclav Hapla   if (same) PetscValidBoolPointer(same,3);
8367609dae6eSVaclav Hapla   if (message) PetscValidPointer(message, 4);
8368609dae6eSVaclav Hapla   ierr = PetscObjectGetComm((PetscObject)dm0, &comm);CHKERRQ(ierr);
8369609dae6eSVaclav Hapla   ierr = DMGetNumLabels(dm0, &n0);CHKERRQ(ierr);
8370609dae6eSVaclav Hapla   ierr = DMGetNumLabels(dm1, &n1);CHKERRQ(ierr);
8371609dae6eSVaclav Hapla   if (n0 != n1) {
8372609dae6eSVaclav Hapla     ierr = PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n0, n1);CHKERRQ(ierr);
8373609dae6eSVaclav Hapla     goto finish;
8374609dae6eSVaclav Hapla   }
8375609dae6eSVaclav Hapla   for (i=0; i<n0; i++) {
8376609dae6eSVaclav Hapla     DMLabel     l0, l1;
8377609dae6eSVaclav Hapla     const char *name;
8378609dae6eSVaclav Hapla     char       *msgInner;
8379609dae6eSVaclav Hapla 
8380609dae6eSVaclav Hapla     /* Ignore label order */
8381609dae6eSVaclav Hapla     ierr = DMGetLabelByNum(dm0, i, &l0);CHKERRQ(ierr);
8382609dae6eSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)l0, &name);CHKERRQ(ierr);
8383609dae6eSVaclav Hapla     ierr = DMGetLabel(dm1, name, &l1);CHKERRQ(ierr);
8384609dae6eSVaclav Hapla     if (!l1) {
8385609dae6eSVaclav Hapla       ierr = PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i);CHKERRQ(ierr);
8386609dae6eSVaclav Hapla       goto finish;
8387609dae6eSVaclav Hapla     }
8388609dae6eSVaclav Hapla     ierr = DMLabelCompare(l0, l1, NULL, &msgInner);CHKERRQ(ierr);
8389609dae6eSVaclav Hapla     ierr = PetscStrncpy(msg, msgInner, sizeof(msg));CHKERRQ(ierr);
8390609dae6eSVaclav Hapla     ierr = PetscFree(msgInner);CHKERRQ(ierr);
8391609dae6eSVaclav Hapla     if (msg[0]) goto finish;
8392609dae6eSVaclav Hapla   }
8393609dae6eSVaclav Hapla finish:
8394609dae6eSVaclav Hapla   if (msg[0] && !same && !message) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_INCOMP, msg);
8395609dae6eSVaclav Hapla   if (same) *same = (PetscBool) !msg[0];
8396609dae6eSVaclav Hapla   if (message) {
8397609dae6eSVaclav Hapla     *message = NULL;
8398609dae6eSVaclav Hapla     if (msg[0]) {
8399609dae6eSVaclav Hapla       ierr = PetscStrallocpy(msg, message);CHKERRQ(ierr);
8400609dae6eSVaclav Hapla     }
8401609dae6eSVaclav Hapla   }
8402609dae6eSVaclav Hapla   PetscFunctionReturn(0);
8403609dae6eSVaclav Hapla }
8404609dae6eSVaclav Hapla 
8405461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value)
8406461a15a0SLisandro Dalcin {
8407461a15a0SLisandro Dalcin   PetscErrorCode ierr;
8408609dae6eSVaclav Hapla 
8409461a15a0SLisandro Dalcin   PetscFunctionBegin;
8410461a15a0SLisandro Dalcin   PetscValidPointer(label,2);
8411461a15a0SLisandro Dalcin   if (!*label) {
8412461a15a0SLisandro Dalcin     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
8413461a15a0SLisandro Dalcin     ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr);
8414461a15a0SLisandro Dalcin   }
8415461a15a0SLisandro Dalcin   ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr);
8416461a15a0SLisandro Dalcin   PetscFunctionReturn(0);
8417461a15a0SLisandro Dalcin }
8418461a15a0SLisandro Dalcin 
84190fdc7489SMatthew Knepley /*
84200fdc7489SMatthew Knepley   Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would
84210fdc7489SMatthew Knepley   like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every
84220fdc7489SMatthew Knepley   (label, id) pair in the DM.
84230fdc7489SMatthew Knepley 
84240fdc7489SMatthew Knepley   However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to
84250fdc7489SMatthew Knepley   each label.
84260fdc7489SMatthew Knepley */
84270fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal)
84280fdc7489SMatthew Knepley {
84290fdc7489SMatthew Knepley   DMUniversalLabel ul;
84300fdc7489SMatthew Knepley   PetscBool       *active;
84310fdc7489SMatthew Knepley   PetscInt         pStart, pEnd, p, Nl, l, m;
84320fdc7489SMatthew Knepley   PetscErrorCode   ierr;
84330fdc7489SMatthew Knepley 
84340fdc7489SMatthew Knepley   PetscFunctionBegin;
84350fdc7489SMatthew Knepley   ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr);
84360fdc7489SMatthew Knepley   ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr);
84370fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
84380fdc7489SMatthew Knepley   ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr);
84390fdc7489SMatthew Knepley   ul->Nl = 0;
84400fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
84410fdc7489SMatthew Knepley     PetscBool   isdepth, iscelltype;
84420fdc7489SMatthew Knepley     const char *name;
84430fdc7489SMatthew Knepley 
84440fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
84450fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr);
84460fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr);
84470fdc7489SMatthew Knepley     active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE;
84480fdc7489SMatthew Knepley     if (active[l]) ++ul->Nl;
84490fdc7489SMatthew Knepley   }
84500fdc7489SMatthew 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);
84510fdc7489SMatthew Knepley   ul->Nv = 0;
84520fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
84530fdc7489SMatthew Knepley     DMLabel     label;
84540fdc7489SMatthew Knepley     PetscInt    nv;
84550fdc7489SMatthew Knepley     const char *name;
84560fdc7489SMatthew Knepley 
84570fdc7489SMatthew Knepley     if (!active[l]) continue;
84580fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
84590fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
84600fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
84610fdc7489SMatthew Knepley     ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr);
84620fdc7489SMatthew Knepley     ul->indices[m]   = l;
84630fdc7489SMatthew Knepley     ul->Nv          += nv;
84640fdc7489SMatthew Knepley     ul->offsets[m+1] = nv;
84650fdc7489SMatthew Knepley     ul->bits[m+1]    = PetscCeilReal(PetscLog2Real(nv+1));
84660fdc7489SMatthew Knepley     ++m;
84670fdc7489SMatthew Knepley   }
84680fdc7489SMatthew Knepley   for (l = 1; l <= ul->Nl; ++l) {
84690fdc7489SMatthew Knepley     ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l];
84700fdc7489SMatthew Knepley     ul->bits[l]    = ul->bits[l-1]    + ul->bits[l];
84710fdc7489SMatthew Knepley   }
84720fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
84730fdc7489SMatthew Knepley     PetscInt b;
84740fdc7489SMatthew Knepley 
84750fdc7489SMatthew Knepley     ul->masks[l] = 0;
84760fdc7489SMatthew Knepley     for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b;
84770fdc7489SMatthew Knepley   }
84780fdc7489SMatthew Knepley   ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr);
84790fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
84800fdc7489SMatthew Knepley     DMLabel         label;
84810fdc7489SMatthew Knepley     IS              valueIS;
84820fdc7489SMatthew Knepley     const PetscInt *varr;
84830fdc7489SMatthew Knepley     PetscInt        nv, v;
84840fdc7489SMatthew Knepley 
84850fdc7489SMatthew Knepley     if (!active[l]) continue;
84860fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
84870fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
84880fdc7489SMatthew Knepley     ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr);
84890fdc7489SMatthew Knepley     ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr);
84900fdc7489SMatthew Knepley     for (v = 0; v < nv; ++v) {
84910fdc7489SMatthew Knepley       ul->values[ul->offsets[m]+v] = varr[v];
84920fdc7489SMatthew Knepley     }
84930fdc7489SMatthew Knepley     ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr);
84940fdc7489SMatthew Knepley     ierr = ISDestroy(&valueIS);CHKERRQ(ierr);
84950fdc7489SMatthew Knepley     ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr);
84960fdc7489SMatthew Knepley     ++m;
84970fdc7489SMatthew Knepley   }
84980fdc7489SMatthew Knepley   ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr);
84990fdc7489SMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
85000fdc7489SMatthew Knepley     PetscInt  uval = 0;
85010fdc7489SMatthew Knepley     PetscBool marked = PETSC_FALSE;
85020fdc7489SMatthew Knepley 
85030fdc7489SMatthew Knepley     for (l = 0, m = 0; l < Nl; ++l) {
85040fdc7489SMatthew Knepley       DMLabel  label;
85050649b39aSStefano Zampini       PetscInt val, defval, loc, nv;
85060fdc7489SMatthew Knepley 
85070fdc7489SMatthew Knepley       if (!active[l]) continue;
85080fdc7489SMatthew Knepley       ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
85090fdc7489SMatthew Knepley       ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr);
85100fdc7489SMatthew Knepley       ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr);
85110fdc7489SMatthew Knepley       if (val == defval) {++m; continue;}
85120649b39aSStefano Zampini       nv = ul->offsets[m+1]-ul->offsets[m];
85130fdc7489SMatthew Knepley       marked = PETSC_TRUE;
85140fdc7489SMatthew Knepley       ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr);
85150fdc7489SMatthew Knepley       if (loc < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val);
85160fdc7489SMatthew Knepley       uval += (loc+1) << ul->bits[m];
85170fdc7489SMatthew Knepley       ++m;
85180fdc7489SMatthew Knepley     }
85190fdc7489SMatthew Knepley     if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);}
85200fdc7489SMatthew Knepley   }
85210fdc7489SMatthew Knepley   ierr = PetscFree(active);CHKERRQ(ierr);
85220fdc7489SMatthew Knepley   *universal = ul;
85230fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85240fdc7489SMatthew Knepley }
85250fdc7489SMatthew Knepley 
85260fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal)
85270fdc7489SMatthew Knepley {
85280fdc7489SMatthew Knepley   PetscInt       l;
85290fdc7489SMatthew Knepley   PetscErrorCode ierr;
85300fdc7489SMatthew Knepley 
85310fdc7489SMatthew Knepley   PetscFunctionBegin;
85320fdc7489SMatthew Knepley   for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);}
85330fdc7489SMatthew Knepley   ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr);
85340fdc7489SMatthew Knepley   ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr);
85350fdc7489SMatthew Knepley   ierr = PetscFree((*universal)->values);CHKERRQ(ierr);
85360fdc7489SMatthew Knepley   ierr = PetscFree(*universal);CHKERRQ(ierr);
85370fdc7489SMatthew Knepley   *universal = NULL;
85380fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85390fdc7489SMatthew Knepley }
85400fdc7489SMatthew Knepley 
85410fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel)
85420fdc7489SMatthew Knepley {
85430fdc7489SMatthew Knepley   PetscFunctionBegin;
85440fdc7489SMatthew Knepley   PetscValidPointer(ulabel, 2);
85450fdc7489SMatthew Knepley   *ulabel = ul->label;
85460fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85470fdc7489SMatthew Knepley }
85480fdc7489SMatthew Knepley 
85490fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm)
85500fdc7489SMatthew Knepley {
85510fdc7489SMatthew Knepley   PetscInt       Nl = ul->Nl, l;
85520fdc7489SMatthew Knepley   PetscErrorCode ierr;
85530fdc7489SMatthew Knepley 
85540fdc7489SMatthew Knepley   PetscFunctionBegin;
8555064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 3);
85560fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
85570fdc7489SMatthew Knepley     if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);}
85580fdc7489SMatthew Knepley     else               {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);}
85590fdc7489SMatthew Knepley   }
85600fdc7489SMatthew Knepley   if (preserveOrder) {
85610fdc7489SMatthew Knepley     for (l = 0; l < ul->Nl; ++l) {
85620fdc7489SMatthew Knepley       const char *name;
85630fdc7489SMatthew Knepley       PetscBool   match;
85640fdc7489SMatthew Knepley 
85650fdc7489SMatthew Knepley       ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr);
85660fdc7489SMatthew Knepley       ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr);
85670fdc7489SMatthew Knepley       if (!match) SETERRQ3(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]);
85680fdc7489SMatthew Knepley     }
85690fdc7489SMatthew Knepley   }
85700fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85710fdc7489SMatthew Knepley }
85720fdc7489SMatthew Knepley 
85730fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value)
85740fdc7489SMatthew Knepley {
85750fdc7489SMatthew Knepley   PetscInt       l;
85760fdc7489SMatthew Knepley   PetscErrorCode ierr;
85770fdc7489SMatthew Knepley 
85780fdc7489SMatthew Knepley   PetscFunctionBegin;
85790fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
85800fdc7489SMatthew Knepley     DMLabel  label;
85810fdc7489SMatthew Knepley     PetscInt lval = (value & ul->masks[l]) >> ul->bits[l];
85820fdc7489SMatthew Knepley 
85830fdc7489SMatthew Knepley     if (lval) {
85840fdc7489SMatthew Knepley       if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);}
85850fdc7489SMatthew Knepley       else          {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);}
85860fdc7489SMatthew Knepley       ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr);
85870fdc7489SMatthew Knepley     }
85880fdc7489SMatthew Knepley   }
85890fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85900fdc7489SMatthew Knepley }
8591a8fb8f29SToby Isaac 
8592a8fb8f29SToby Isaac /*@
8593a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
8594a8fb8f29SToby Isaac 
8595a8fb8f29SToby Isaac   Input Parameter:
8596a8fb8f29SToby Isaac . dm - The DM object
8597a8fb8f29SToby Isaac 
8598a8fb8f29SToby Isaac   Output Parameter:
8599a8fb8f29SToby Isaac . cdm - The coarse DM
8600a8fb8f29SToby Isaac 
8601a8fb8f29SToby Isaac   Level: intermediate
8602a8fb8f29SToby Isaac 
8603a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
8604a8fb8f29SToby Isaac @*/
8605a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
8606a8fb8f29SToby Isaac {
8607a8fb8f29SToby Isaac   PetscFunctionBegin;
8608a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8609a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
8610a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
8611a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8612a8fb8f29SToby Isaac }
8613a8fb8f29SToby Isaac 
8614a8fb8f29SToby Isaac /*@
8615a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
8616a8fb8f29SToby Isaac 
8617a8fb8f29SToby Isaac   Input Parameters:
8618a8fb8f29SToby Isaac + dm - The DM object
8619a8fb8f29SToby Isaac - cdm - The coarse DM
8620a8fb8f29SToby Isaac 
8621a8fb8f29SToby Isaac   Level: intermediate
8622a8fb8f29SToby Isaac 
8623a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
8624a8fb8f29SToby Isaac @*/
8625a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
8626a8fb8f29SToby Isaac {
8627a8fb8f29SToby Isaac   PetscErrorCode ierr;
8628a8fb8f29SToby Isaac 
8629a8fb8f29SToby Isaac   PetscFunctionBegin;
8630a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8631a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
8632a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
8633a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
8634a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
8635a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8636a8fb8f29SToby Isaac }
8637a8fb8f29SToby Isaac 
863888bdff64SToby Isaac /*@
863988bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
864088bdff64SToby Isaac 
864188bdff64SToby Isaac   Input Parameter:
864288bdff64SToby Isaac . dm - The DM object
864388bdff64SToby Isaac 
864488bdff64SToby Isaac   Output Parameter:
864588bdff64SToby Isaac . fdm - The fine DM
864688bdff64SToby Isaac 
864788bdff64SToby Isaac   Level: intermediate
864888bdff64SToby Isaac 
864988bdff64SToby Isaac .seealso: DMSetFineDM()
865088bdff64SToby Isaac @*/
865188bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
865288bdff64SToby Isaac {
865388bdff64SToby Isaac   PetscFunctionBegin;
865488bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
865588bdff64SToby Isaac   PetscValidPointer(fdm, 2);
865688bdff64SToby Isaac   *fdm = dm->fineMesh;
865788bdff64SToby Isaac   PetscFunctionReturn(0);
865888bdff64SToby Isaac }
865988bdff64SToby Isaac 
866088bdff64SToby Isaac /*@
866188bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
866288bdff64SToby Isaac 
866388bdff64SToby Isaac   Input Parameters:
866488bdff64SToby Isaac + dm - The DM object
866588bdff64SToby Isaac - fdm - The fine DM
866688bdff64SToby Isaac 
866788bdff64SToby Isaac   Level: intermediate
866888bdff64SToby Isaac 
866988bdff64SToby Isaac .seealso: DMGetFineDM()
867088bdff64SToby Isaac @*/
867188bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
867288bdff64SToby Isaac {
867388bdff64SToby Isaac   PetscErrorCode ierr;
867488bdff64SToby Isaac 
867588bdff64SToby Isaac   PetscFunctionBegin;
867688bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
867788bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
867888bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
867988bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
868088bdff64SToby Isaac   dm->fineMesh = fdm;
868188bdff64SToby Isaac   PetscFunctionReturn(0);
868288bdff64SToby Isaac }
868388bdff64SToby Isaac 
8684a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8685a6ba4734SToby Isaac 
8686a6ba4734SToby Isaac /*@C
8687a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8688a6ba4734SToby Isaac 
8689783e2ec8SMatthew G. Knepley   Collective on dm
8690783e2ec8SMatthew G. Knepley 
8691a6ba4734SToby Isaac   Input Parameters:
86924c258f51SMatthew G. Knepley + dm       - The DM, with a PetscDS that matches the problem being constrained
8693f971fd6bSMatthew G. Knepley . type     - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8694a6ba4734SToby Isaac . name     - The BC name
869545480ffeSMatthew G. Knepley . label    - The label defining constrained points
869645480ffeSMatthew G. Knepley . Nv       - The number of DMLabel values for constrained points
869745480ffeSMatthew G. Knepley . values   - An array of values for constrained points
8698a6ba4734SToby Isaac . field    - The field to constrain
869945480ffeSMatthew G. Knepley . Nc       - The number of constrained field components (0 will constrain all fields)
8700a6ba4734SToby Isaac . comps    - An array of constrained component numbers
8701a6ba4734SToby Isaac . bcFunc   - A pointwise function giving boundary values
870256cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL
8703a6ba4734SToby Isaac - ctx      - An optional user context for bcFunc
8704a6ba4734SToby Isaac 
870545480ffeSMatthew G. Knepley   Output Parameter:
870645480ffeSMatthew G. Knepley . bd          - (Optional) Boundary number
870745480ffeSMatthew G. Knepley 
8708a6ba4734SToby Isaac   Options Database Keys:
8709a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8710a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8711a6ba4734SToby Isaac 
871256cf3b9cSMatthew G. Knepley   Note:
871356cf3b9cSMatthew 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:
871456cf3b9cSMatthew G. Knepley 
871556cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
871656cf3b9cSMatthew G. Knepley 
871756cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
871856cf3b9cSMatthew G. Knepley 
871956cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
872056cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
872156cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
872256cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
872356cf3b9cSMatthew G. Knepley 
872456cf3b9cSMatthew G. Knepley + dim - the spatial dimension
872556cf3b9cSMatthew G. Knepley . Nf - the number of fields
872656cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
872756cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
872856cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
872956cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
873056cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
873156cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
873256cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
873356cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
873456cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
873556cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
873656cf3b9cSMatthew G. Knepley . t - current time
873756cf3b9cSMatthew G. Knepley . x - coordinates of the current point
873856cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
873956cf3b9cSMatthew G. Knepley . constants - constant parameters
874056cf3b9cSMatthew G. Knepley - bcval - output values at the current point
874156cf3b9cSMatthew G. Knepley 
8742a6ba4734SToby Isaac   Level: developer
8743a6ba4734SToby Isaac 
874445480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary()
8745a6ba4734SToby Isaac @*/
874645480ffeSMatthew 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)
8747a6ba4734SToby Isaac {
8748e5e52638SMatthew G. Knepley   PetscDS        ds;
8749a6ba4734SToby Isaac   PetscErrorCode ierr;
8750a6ba4734SToby Isaac 
8751a6ba4734SToby Isaac   PetscFunctionBegin;
8752a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8753783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
875445480ffeSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
875545480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nv, 5);
875645480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 7);
875745480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 8);
8758e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
875945480ffeSMatthew G. Knepley   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr);
876045480ffeSMatthew G. Knepley   ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr);
8761a6ba4734SToby Isaac   PetscFunctionReturn(0);
8762a6ba4734SToby Isaac }
8763a6ba4734SToby Isaac 
876445480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */
8765e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8766e6f8dbb6SToby Isaac {
8767e5e52638SMatthew G. Knepley   PetscDS        ds;
8768dff059c6SToby Isaac   DMBoundary    *lastnext;
8769e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8770e6f8dbb6SToby Isaac   PetscErrorCode ierr;
8771e6f8dbb6SToby Isaac 
8772e6f8dbb6SToby Isaac   PetscFunctionBegin;
8773e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8774e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
877547a1f5adSToby Isaac   if (dm->boundary) {
877647a1f5adSToby Isaac     DMBoundary next = dm->boundary;
877747a1f5adSToby Isaac 
877847a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
877947a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
878047a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
878147a1f5adSToby Isaac     while (next) {
878247a1f5adSToby Isaac       DMBoundary b = next;
878347a1f5adSToby Isaac 
878447a1f5adSToby Isaac       next = b->next;
878547a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
8786a6ba4734SToby Isaac     }
878747a1f5adSToby Isaac     dm->boundary = NULL;
8788a6ba4734SToby Isaac   }
878947a1f5adSToby Isaac 
8790dff059c6SToby Isaac   lastnext = &(dm->boundary);
8791e6f8dbb6SToby Isaac   while (dsbound) {
8792e6f8dbb6SToby Isaac     DMBoundary dmbound;
8793e6f8dbb6SToby Isaac 
8794e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
8795e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
879645480ffeSMatthew G. Knepley     dmbound->label      = dsbound->label;
879747a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8798dff059c6SToby Isaac     *lastnext = dmbound;
8799dff059c6SToby Isaac     lastnext = &(dmbound->next);
8800dff059c6SToby Isaac     dsbound = dsbound->next;
8801a6ba4734SToby Isaac   }
8802a6ba4734SToby Isaac   PetscFunctionReturn(0);
8803a6ba4734SToby Isaac }
8804a6ba4734SToby Isaac 
8805a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8806a6ba4734SToby Isaac {
8807b95f2879SToby Isaac   DMBoundary     b;
8808a6ba4734SToby Isaac   PetscErrorCode ierr;
8809a6ba4734SToby Isaac 
8810a6ba4734SToby Isaac   PetscFunctionBegin;
8811a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8812534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8813a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
8814e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
8815b95f2879SToby Isaac   b = dm->boundary;
8816a6ba4734SToby Isaac   while (b && !(*isBd)) {
8817e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8818e6f8dbb6SToby Isaac     DSBoundary dsb   = b->dsboundary;
8819a6ba4734SToby Isaac     PetscInt   i;
8820a6ba4734SToby Isaac 
882145480ffeSMatthew G. Knepley     if (label) {
882245480ffeSMatthew G. Knepley       for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);}
8823a6ba4734SToby Isaac     }
8824a6ba4734SToby Isaac     b = b->next;
8825a6ba4734SToby Isaac   }
8826a6ba4734SToby Isaac   PetscFunctionReturn(0);
8827a6ba4734SToby Isaac }
88284d6f44ffSToby Isaac 
88294d6f44ffSToby Isaac /*@C
8830a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8831a6e0b375SMatthew G. Knepley 
8832a6e0b375SMatthew G. Knepley   Collective on DM
88334d6f44ffSToby Isaac 
88344d6f44ffSToby Isaac   Input Parameters:
88354d6f44ffSToby Isaac + dm      - The DM
88360709b2feSToby Isaac . time    - The time
88374d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
88384d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
88394d6f44ffSToby Isaac - mode    - The insertion mode for values
88404d6f44ffSToby Isaac 
88414d6f44ffSToby Isaac   Output Parameter:
88424d6f44ffSToby Isaac . X - vector
88434d6f44ffSToby Isaac 
88444d6f44ffSToby Isaac    Calling sequence of func:
884577b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
88464d6f44ffSToby Isaac 
88474d6f44ffSToby Isaac +  dim - The spatial dimension
88488ec8862eSJed Brown .  time - The time at which to sample
88494d6f44ffSToby Isaac .  x   - The coordinates
885077b739a6SMatthew Knepley .  Nc  - The number of components
88514d6f44ffSToby Isaac .  u   - The output field values
88524d6f44ffSToby Isaac -  ctx - optional user-defined function context
88534d6f44ffSToby Isaac 
88544d6f44ffSToby Isaac   Level: developer
88554d6f44ffSToby Isaac 
8856a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
88574d6f44ffSToby Isaac @*/
88580709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
88594d6f44ffSToby Isaac {
88604d6f44ffSToby Isaac   Vec            localX;
88614d6f44ffSToby Isaac   PetscErrorCode ierr;
88624d6f44ffSToby Isaac 
88634d6f44ffSToby Isaac   PetscFunctionBegin;
88644d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
88654d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
88660709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
88674d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
88684d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
88694d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
88704d6f44ffSToby Isaac   PetscFunctionReturn(0);
88714d6f44ffSToby Isaac }
88724d6f44ffSToby Isaac 
8873a6e0b375SMatthew G. Knepley /*@C
8874a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
8875a6e0b375SMatthew G. Knepley 
8876a6e0b375SMatthew G. Knepley   Not collective
8877a6e0b375SMatthew G. Knepley 
8878a6e0b375SMatthew G. Knepley   Input Parameters:
8879a6e0b375SMatthew G. Knepley + dm      - The DM
8880a6e0b375SMatthew G. Knepley . time    - The time
8881a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8882a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8883a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8884a6e0b375SMatthew G. Knepley 
8885a6e0b375SMatthew G. Knepley   Output Parameter:
8886a6e0b375SMatthew G. Knepley . localX - vector
8887a6e0b375SMatthew G. Knepley 
8888a6e0b375SMatthew G. Knepley    Calling sequence of func:
888977b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
8890a6e0b375SMatthew G. Knepley 
8891a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8892a6e0b375SMatthew G. Knepley .  x   - The coordinates
889377b739a6SMatthew Knepley .  Nc  - The number of components
8894a6e0b375SMatthew G. Knepley .  u   - The output field values
8895a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8896a6e0b375SMatthew G. Knepley 
8897a6e0b375SMatthew G. Knepley   Level: developer
8898a6e0b375SMatthew G. Knepley 
8899a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
8900a6e0b375SMatthew G. Knepley @*/
89010709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
89024d6f44ffSToby Isaac {
89034d6f44ffSToby Isaac   PetscErrorCode ierr;
89044d6f44ffSToby Isaac 
89054d6f44ffSToby Isaac   PetscFunctionBegin;
89064d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8907064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
89080918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
89090709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
89104d6f44ffSToby Isaac   PetscFunctionReturn(0);
89114d6f44ffSToby Isaac }
89124d6f44ffSToby Isaac 
8913a6e0b375SMatthew G. Knepley /*@C
8914a6e0b375SMatthew 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.
8915a6e0b375SMatthew G. Knepley 
8916a6e0b375SMatthew G. Knepley   Collective on DM
8917a6e0b375SMatthew G. Knepley 
8918a6e0b375SMatthew G. Knepley   Input Parameters:
8919a6e0b375SMatthew G. Knepley + dm      - The DM
8920a6e0b375SMatthew G. Knepley . time    - The time
8921a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8922a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8923a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8924a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8925a6e0b375SMatthew G. Knepley 
8926a6e0b375SMatthew G. Knepley   Output Parameter:
8927a6e0b375SMatthew G. Knepley . X - vector
8928a6e0b375SMatthew G. Knepley 
8929a6e0b375SMatthew G. Knepley    Calling sequence of func:
893077b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
8931a6e0b375SMatthew G. Knepley 
8932a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8933a6e0b375SMatthew G. Knepley .  x   - The coordinates
893477b739a6SMatthew Knepley .  Nc  - The number of components
8935a6e0b375SMatthew G. Knepley .  u   - The output field values
8936a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8937a6e0b375SMatthew G. Knepley 
8938a6e0b375SMatthew G. Knepley   Level: developer
8939a6e0b375SMatthew G. Knepley 
8940a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
8941a6e0b375SMatthew G. Knepley @*/
89422c53366bSMatthew 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)
89432c53366bSMatthew G. Knepley {
89442c53366bSMatthew G. Knepley   Vec            localX;
89452c53366bSMatthew G. Knepley   PetscErrorCode ierr;
89462c53366bSMatthew G. Knepley 
89472c53366bSMatthew G. Knepley   PetscFunctionBegin;
89482c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
89492c53366bSMatthew G. Knepley   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
89502c53366bSMatthew G. Knepley   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
89512c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
89522c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
89532c53366bSMatthew G. Knepley   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
89542c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
89552c53366bSMatthew G. Knepley }
89562c53366bSMatthew G. Knepley 
8957a6e0b375SMatthew G. Knepley /*@C
8958a6e0b375SMatthew 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.
8959a6e0b375SMatthew G. Knepley 
8960a6e0b375SMatthew G. Knepley   Not collective
8961a6e0b375SMatthew G. Knepley 
8962a6e0b375SMatthew G. Knepley   Input Parameters:
8963a6e0b375SMatthew G. Knepley + dm      - The DM
8964a6e0b375SMatthew G. Knepley . time    - The time
8965a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8966a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8967a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8968a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8969a6e0b375SMatthew G. Knepley 
8970a6e0b375SMatthew G. Knepley   Output Parameter:
8971a6e0b375SMatthew G. Knepley . localX - vector
8972a6e0b375SMatthew G. Knepley 
8973a6e0b375SMatthew G. Knepley    Calling sequence of func:
897477b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
8975a6e0b375SMatthew G. Knepley 
8976a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8977a6e0b375SMatthew G. Knepley .  x   - The coordinates
897877b739a6SMatthew Knepley .  Nc  - The number of components
8979a6e0b375SMatthew G. Knepley .  u   - The output field values
8980a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8981a6e0b375SMatthew G. Knepley 
8982a6e0b375SMatthew G. Knepley   Level: developer
8983a6e0b375SMatthew G. Knepley 
8984a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
8985a6e0b375SMatthew G. Knepley @*/
89861c531cf8SMatthew 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)
89874d6f44ffSToby Isaac {
89884d6f44ffSToby Isaac   PetscErrorCode ierr;
89894d6f44ffSToby Isaac 
89904d6f44ffSToby Isaac   PetscFunctionBegin;
89914d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8992064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
89930918c465SMatthew G. Knepley   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
89941c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
89954d6f44ffSToby Isaac   PetscFunctionReturn(0);
89964d6f44ffSToby Isaac }
89972716604bSToby Isaac 
8998a6e0b375SMatthew G. Knepley /*@C
8999a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
9000a6e0b375SMatthew G. Knepley 
9001a6e0b375SMatthew G. Knepley   Not collective
9002a6e0b375SMatthew G. Knepley 
9003a6e0b375SMatthew G. Knepley   Input Parameters:
9004a6e0b375SMatthew G. Knepley + dm      - The DM
9005a6e0b375SMatthew G. Knepley . time    - The time
9006a6e0b375SMatthew G. Knepley . localU  - The input field vector
9007a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9008a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9009a6e0b375SMatthew G. Knepley 
9010a6e0b375SMatthew G. Knepley   Output Parameter:
9011a6e0b375SMatthew G. Knepley . localX  - The output vector
9012a6e0b375SMatthew G. Knepley 
9013a6e0b375SMatthew G. Knepley    Calling sequence of func:
9014a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9015a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9016a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9017a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9018a6e0b375SMatthew G. Knepley 
9019a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
9020a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
9021a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9022a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
9023a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9024a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
9025a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9026a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9027a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9028a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9029a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9030a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9031a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9032a6e0b375SMatthew G. Knepley .  t            - The current time
9033a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
9034a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
9035a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
9036a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
9037a6e0b375SMatthew G. Knepley 
9038a6e0b375SMatthew 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.
9039a6e0b375SMatthew 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
9040a6e0b375SMatthew 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
9041a6e0b375SMatthew 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.
9042a6e0b375SMatthew G. Knepley 
9043a6e0b375SMatthew G. Knepley   Level: intermediate
9044a6e0b375SMatthew G. Knepley 
9045a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9046a6e0b375SMatthew G. Knepley @*/
90478c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
90488c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
90498c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
90508c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9051191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
90528c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
90538c6c5593SMatthew G. Knepley {
90548c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
90558c6c5593SMatthew G. Knepley 
90568c6c5593SMatthew G. Knepley   PetscFunctionBegin;
90578c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
90588c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
90598c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
90600918c465SMatthew G. Knepley   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
90618c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
90628c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
90638c6c5593SMatthew G. Knepley }
90648c6c5593SMatthew G. Knepley 
9065a6e0b375SMatthew G. Knepley /*@C
9066a6e0b375SMatthew 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.
9067a6e0b375SMatthew G. Knepley 
9068a6e0b375SMatthew G. Knepley   Not collective
9069a6e0b375SMatthew G. Knepley 
9070a6e0b375SMatthew G. Knepley   Input Parameters:
9071a6e0b375SMatthew G. Knepley + dm      - The DM
9072a6e0b375SMatthew G. Knepley . time    - The time
9073a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
9074a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
9075a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
9076a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9077a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9078a6e0b375SMatthew G. Knepley . localU  - The input field vector
9079a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9080a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9081a6e0b375SMatthew G. Knepley 
9082a6e0b375SMatthew G. Knepley   Output Parameter:
9083a6e0b375SMatthew G. Knepley . localX  - The output vector
9084a6e0b375SMatthew G. Knepley 
9085a6e0b375SMatthew G. Knepley    Calling sequence of func:
9086a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9087a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9088a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9089a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9090a6e0b375SMatthew G. Knepley 
9091a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
9092a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
9093a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9094a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
9095a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9096a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
9097a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9098a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9099a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9100a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9101a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9102a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9103a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9104a6e0b375SMatthew G. Knepley .  t            - The current time
9105a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
9106a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
9107a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
9108a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
9109a6e0b375SMatthew G. Knepley 
9110a6e0b375SMatthew 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.
9111a6e0b375SMatthew 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
9112a6e0b375SMatthew 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
9113a6e0b375SMatthew 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.
9114a6e0b375SMatthew G. Knepley 
9115a6e0b375SMatthew G. Knepley   Level: intermediate
9116a6e0b375SMatthew G. Knepley 
9117a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9118a6e0b375SMatthew G. Knepley @*/
91191c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
91208c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
91218c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
91228c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9123191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
91248c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
91258c6c5593SMatthew G. Knepley {
91268c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
91278c6c5593SMatthew G. Knepley 
91288c6c5593SMatthew G. Knepley   PetscFunctionBegin;
91298c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9130064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9131064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
9132ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
91331c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
91348c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
91358c6c5593SMatthew G. Knepley }
91368c6c5593SMatthew G. Knepley 
91372716604bSToby Isaac /*@C
9138ece3a9fcSMatthew 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.
9139ece3a9fcSMatthew G. Knepley 
9140ece3a9fcSMatthew G. Knepley   Not collective
9141ece3a9fcSMatthew G. Knepley 
9142ece3a9fcSMatthew G. Knepley   Input Parameters:
9143ece3a9fcSMatthew G. Knepley + dm      - The DM
9144ece3a9fcSMatthew G. Knepley . time    - The time
9145ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
9146ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
9147ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
9148ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9149ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9150ece3a9fcSMatthew G. Knepley . localU  - The input field vector
9151ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9152ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
9153ece3a9fcSMatthew G. Knepley 
9154ece3a9fcSMatthew G. Knepley   Output Parameter:
9155ece3a9fcSMatthew G. Knepley . localX  - The output vector
9156ece3a9fcSMatthew G. Knepley 
9157ece3a9fcSMatthew G. Knepley    Calling sequence of func:
9158ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9159ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9160ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9161ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9162ece3a9fcSMatthew G. Knepley 
9163ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
9164ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
9165ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9166ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
9167ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9168ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
9169ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9170ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9171ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9172ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9173ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9174ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9175ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9176ece3a9fcSMatthew G. Knepley .  t            - The current time
9177ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
9178ece3a9fcSMatthew G. Knepley .  n            - The face normal
9179ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
9180ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
9181ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
9182ece3a9fcSMatthew G. Knepley 
9183ece3a9fcSMatthew G. Knepley   Note:
9184ece3a9fcSMatthew 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.
9185ece3a9fcSMatthew 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
9186ece3a9fcSMatthew 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
9187ece3a9fcSMatthew 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.
9188ece3a9fcSMatthew G. Knepley 
9189ece3a9fcSMatthew G. Knepley   Level: intermediate
9190ece3a9fcSMatthew G. Knepley 
9191ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9192ece3a9fcSMatthew G. Knepley @*/
9193ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
9194ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
9195ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9196ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9197ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
9198ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
9199ece3a9fcSMatthew G. Knepley {
9200ece3a9fcSMatthew G. Knepley   PetscErrorCode ierr;
9201ece3a9fcSMatthew G. Knepley 
9202ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
9203ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9204064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9205064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
9206ece3a9fcSMatthew G. Knepley   if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
9207ece3a9fcSMatthew G. Knepley   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
9208ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
9209ece3a9fcSMatthew G. Knepley }
9210ece3a9fcSMatthew G. Knepley 
9211ece3a9fcSMatthew G. Knepley /*@C
92122716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
92132716604bSToby Isaac 
92142716604bSToby Isaac   Input Parameters:
92152716604bSToby Isaac + dm    - The DM
92160709b2feSToby Isaac . time  - The time
92172716604bSToby Isaac . funcs - The functions to evaluate for each field component
92182716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9219574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
92202716604bSToby Isaac 
92212716604bSToby Isaac   Output Parameter:
92222716604bSToby Isaac . diff - The diff ||u - u_h||_2
92232716604bSToby Isaac 
92242716604bSToby Isaac   Level: developer
92252716604bSToby Isaac 
92261189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
92272716604bSToby Isaac @*/
92280709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
92292716604bSToby Isaac {
92302716604bSToby Isaac   PetscErrorCode ierr;
92312716604bSToby Isaac 
92322716604bSToby Isaac   PetscFunctionBegin;
92332716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9234b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
92350918c465SMatthew G. Knepley   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
92360709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
92372716604bSToby Isaac   PetscFunctionReturn(0);
92382716604bSToby Isaac }
9239b698f381SToby Isaac 
9240b698f381SToby Isaac /*@C
9241b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
9242b698f381SToby Isaac 
9243d083f849SBarry Smith   Collective on dm
9244d083f849SBarry Smith 
9245b698f381SToby Isaac   Input Parameters:
9246b698f381SToby Isaac + dm    - The DM
9247b698f381SToby Isaac , time  - The time
9248b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
9249b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9250574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
9251b698f381SToby Isaac - n     - The vector to project along
9252b698f381SToby Isaac 
9253b698f381SToby Isaac   Output Parameter:
9254b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
9255b698f381SToby Isaac 
9256b698f381SToby Isaac   Level: developer
9257b698f381SToby Isaac 
9258b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
9259b698f381SToby Isaac @*/
9260b698f381SToby 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)
9261b698f381SToby Isaac {
9262b698f381SToby Isaac   PetscErrorCode ierr;
9263b698f381SToby Isaac 
9264b698f381SToby Isaac   PetscFunctionBegin;
9265b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9266b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
9267b698f381SToby Isaac   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
9268b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
9269b698f381SToby Isaac   PetscFunctionReturn(0);
9270b698f381SToby Isaac }
9271b698f381SToby Isaac 
92722a16baeaSToby Isaac /*@C
92732a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
92742a16baeaSToby Isaac 
9275d083f849SBarry Smith   Collective on dm
9276d083f849SBarry Smith 
92772a16baeaSToby Isaac   Input Parameters:
92782a16baeaSToby Isaac + dm    - The DM
92792a16baeaSToby Isaac . time  - The time
92802a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
92812a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9282574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
92832a16baeaSToby Isaac 
92842a16baeaSToby Isaac   Output Parameter:
92852a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
92862a16baeaSToby Isaac 
92872a16baeaSToby Isaac   Level: developer
92882a16baeaSToby Isaac 
92891189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
92902a16baeaSToby Isaac @*/
92911189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
92922a16baeaSToby Isaac {
92932a16baeaSToby Isaac   PetscErrorCode ierr;
92942a16baeaSToby Isaac 
92952a16baeaSToby Isaac   PetscFunctionBegin;
92962a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
92972a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
92980918c465SMatthew G. Knepley   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
92992a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
93002a16baeaSToby Isaac   PetscFunctionReturn(0);
93012a16baeaSToby Isaac }
93022a16baeaSToby Isaac 
9303df0b854cSToby Isaac /*@C
9304df0b854cSToby Isaac   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
9305cd3c525cSToby Isaac                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
9306df0b854cSToby Isaac 
9307df0b854cSToby Isaac   Collective on dm
9308df0b854cSToby Isaac 
9309df0b854cSToby Isaac   Input parameters:
9310df0b854cSToby Isaac + dm - the pre-adaptation DM object
9311a1b0c543SToby Isaac - label - label with the flags
9312df0b854cSToby Isaac 
9313df0b854cSToby Isaac   Output parameters:
93140d1cd5e0SMatthew G. Knepley . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced.
9315df0b854cSToby Isaac 
9316df0b854cSToby Isaac   Level: intermediate
93170d1cd5e0SMatthew G. Knepley 
93180d1cd5e0SMatthew G. Knepley .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine()
9319df0b854cSToby Isaac @*/
93200d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt)
9321df0b854cSToby Isaac {
9322df0b854cSToby Isaac   PetscErrorCode ierr;
9323df0b854cSToby Isaac 
9324df0b854cSToby Isaac   PetscFunctionBegin;
9325df0b854cSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9326a1b0c543SToby Isaac   PetscValidPointer(label,2);
93270d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt,3);
93280d1cd5e0SMatthew G. Knepley   *dmAdapt = NULL;
93296f25b0d8SLisandro Dalcin   if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name);
93300d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr);
9331a587d139SMark   if (*dmAdapt) {
9332a587d139SMark     (*dmAdapt)->prealloc_only = dm->prealloc_only;  /* maybe this should go .... */
9333a587d139SMark     ierr = PetscFree((*dmAdapt)->vectype);CHKERRQ(ierr);
9334a587d139SMark     ierr = PetscStrallocpy(dm->vectype,(char**)&(*dmAdapt)->vectype);CHKERRQ(ierr);
9335a587d139SMark     ierr = PetscFree((*dmAdapt)->mattype);CHKERRQ(ierr);
9336a587d139SMark     ierr = PetscStrallocpy(dm->mattype,(char**)&(*dmAdapt)->mattype);CHKERRQ(ierr);
9337a587d139SMark   }
93380d1cd5e0SMatthew G. Knepley   PetscFunctionReturn(0);
93390d1cd5e0SMatthew G. Knepley }
93400d1cd5e0SMatthew G. Knepley 
93410d1cd5e0SMatthew G. Knepley /*@C
93420d1cd5e0SMatthew G. Knepley   DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library.
93430d1cd5e0SMatthew G. Knepley 
93440d1cd5e0SMatthew G. Knepley   Input Parameters:
93450d1cd5e0SMatthew G. Knepley + dm - The DM object
93460d1cd5e0SMatthew G. Knepley . metric - The metric to which the mesh is adapted, defined vertex-wise.
93476f25b0d8SLisandro Dalcin - bdLabel - Label for boundary tags, which will be preserved in the output mesh. bdLabel should be NULL if there is no such label, and should be different from "_boundary_".
93480d1cd5e0SMatthew G. Knepley 
93490d1cd5e0SMatthew G. Knepley   Output Parameter:
93500d1cd5e0SMatthew G. Knepley . dmAdapt  - Pointer to the DM object containing the adapted mesh
93510d1cd5e0SMatthew G. Knepley 
93520d1cd5e0SMatthew G. Knepley   Note: The label in the adapted mesh will be registered under the name of the input DMLabel object
93530d1cd5e0SMatthew G. Knepley 
93540d1cd5e0SMatthew G. Knepley   Level: advanced
93550d1cd5e0SMatthew G. Knepley 
93560d1cd5e0SMatthew G. Knepley .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine()
93570d1cd5e0SMatthew G. Knepley @*/
93580d1cd5e0SMatthew G. Knepley PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt)
93590d1cd5e0SMatthew G. Knepley {
93600d1cd5e0SMatthew G. Knepley   PetscErrorCode ierr;
93610d1cd5e0SMatthew G. Knepley 
93620d1cd5e0SMatthew G. Knepley   PetscFunctionBegin;
93630d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
93640d1cd5e0SMatthew G. Knepley   PetscValidHeaderSpecific(metric, VEC_CLASSID, 2);
93650d1cd5e0SMatthew G. Knepley   if (bdLabel) PetscValidPointer(bdLabel, 3);
93660d1cd5e0SMatthew G. Knepley   PetscValidPointer(dmAdapt, 4);
93676f25b0d8SLisandro Dalcin   *dmAdapt = NULL;
93686f25b0d8SLisandro Dalcin   if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name);
93690d1cd5e0SMatthew G. Knepley   ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr);
9370df0b854cSToby Isaac   PetscFunctionReturn(0);
9371df0b854cSToby Isaac }
9372c4088d22SMatthew G. Knepley 
9373502a2867SDave May /*@C
9374502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
9375502a2867SDave May 
9376502a2867SDave May  Not Collective
9377502a2867SDave May 
9378502a2867SDave May  Input Parameter:
9379502a2867SDave May .  dm    - The DM
9380502a2867SDave May 
93810a19bb7dSprj-  Output Parameters:
93820a19bb7dSprj- +  nranks - the number of neighbours
93830a19bb7dSprj- -  ranks - the neighbors ranks
9384502a2867SDave May 
9385502a2867SDave May  Notes:
9386502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
9387502a2867SDave May 
9388502a2867SDave May  Level: beginner
9389502a2867SDave May 
9390dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
9391502a2867SDave May @*/
9392502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
9393502a2867SDave May {
9394502a2867SDave May   PetscErrorCode ierr;
9395502a2867SDave May 
9396502a2867SDave May   PetscFunctionBegin;
9397502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
93980918c465SMatthew G. Knepley   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
9399502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
9400502a2867SDave May   PetscFunctionReturn(0);
9401502a2867SDave May }
9402502a2867SDave May 
9403531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
9404531c7667SBarry Smith 
9405531c7667SBarry Smith /*
9406531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
9407531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
9408531c7667SBarry Smith */
9409531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
9410531c7667SBarry Smith {
9411531c7667SBarry Smith   PetscErrorCode ierr;
9412531c7667SBarry Smith 
9413531c7667SBarry Smith   PetscFunctionBegin;
9414531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9415531c7667SBarry Smith     Vec x1local;
9416531c7667SBarry Smith     DM  dm;
9417531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9418531c7667SBarry Smith     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
9419531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
9420531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9421531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9422531c7667SBarry Smith     x1   = x1local;
9423531c7667SBarry Smith   }
9424531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
9425531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9426531c7667SBarry Smith     DM  dm;
9427531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9428531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
9429531c7667SBarry Smith   }
9430531c7667SBarry Smith   PetscFunctionReturn(0);
9431531c7667SBarry Smith }
9432531c7667SBarry Smith 
9433531c7667SBarry Smith /*@
9434531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
9435531c7667SBarry Smith 
9436531c7667SBarry Smith     Input Parameter:
9437531c7667SBarry Smith .    coloring - the MatFDColoring object
9438531c7667SBarry Smith 
943995452b02SPatrick Sanan     Developer Notes:
944095452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
9441531c7667SBarry Smith 
94421b266c99SBarry Smith     Level: advanced
94431b266c99SBarry Smith 
9444531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
9445531c7667SBarry Smith @*/
9446531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
9447531c7667SBarry Smith {
9448531c7667SBarry Smith   PetscFunctionBegin;
9449531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
9450531c7667SBarry Smith   PetscFunctionReturn(0);
9451531c7667SBarry Smith }
94528320bc6fSPatrick Sanan 
94538320bc6fSPatrick Sanan /*@
94548320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
94558320bc6fSPatrick Sanan 
94568320bc6fSPatrick Sanan     Collective
94578320bc6fSPatrick Sanan 
94588320bc6fSPatrick Sanan     Input Parameters:
9459a5bc1bf3SBarry Smith +    dm1 - the first DM
94608320bc6fSPatrick Sanan -    dm2 - the second DM
94618320bc6fSPatrick Sanan 
94628320bc6fSPatrick Sanan     Output Parameters:
94638320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
94648320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
94658320bc6fSPatrick Sanan 
94668320bc6fSPatrick Sanan     Notes:
94678320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
94683d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
94698320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
94703d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
94713d862458SPatrick Sanan     decomposition, but hold different data.
94728320bc6fSPatrick Sanan 
94738320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
94748320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
94758320bc6fSPatrick Sanan 
94768320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
94778320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
94788320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
94798320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
94808320bc6fSPatrick Sanan 
94818320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
94828320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
94838320bc6fSPatrick Sanan .vb
94848320bc6fSPatrick Sanan   ...
94858320bc6fSPatrick Sanan   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
94868320bc6fSPatrick Sanan   if (set && compatible)  {
94878320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
94888320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
94893d862458SPatrick Sanan     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
94908320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
94918320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
94928320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
94938320bc6fSPatrick Sanan       }
94948320bc6fSPatrick Sanan     }
94958320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
94968320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
94978320bc6fSPatrick Sanan   } else {
94988320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
94998320bc6fSPatrick Sanan   }
95008320bc6fSPatrick Sanan   ...
95018320bc6fSPatrick Sanan .ve
95028320bc6fSPatrick Sanan 
95038320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
95048320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
95058320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
95068320bc6fSPatrick Sanan     always check the "set" output parameter.
95078320bc6fSPatrick Sanan 
95088320bc6fSPatrick Sanan     A DM is always compatible with itself.
95098320bc6fSPatrick Sanan 
95108320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
95118320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
95128320bc6fSPatrick Sanan     incompatible.
95138320bc6fSPatrick Sanan 
95148320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
95158320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
95168320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
95178320bc6fSPatrick Sanan 
95188320bc6fSPatrick Sanan     Developer Notes:
95193d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
95203d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
9521a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
95228320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
95238320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
95243d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
95253d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
95268320bc6fSPatrick Sanan 
95278320bc6fSPatrick Sanan     Level: advanced
95288320bc6fSPatrick Sanan 
95293d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
95308320bc6fSPatrick Sanan @*/
95318320bc6fSPatrick Sanan 
9532a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
95338320bc6fSPatrick Sanan {
95348320bc6fSPatrick Sanan   PetscErrorCode ierr;
95358320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
95368320bc6fSPatrick Sanan   DMType         type,type2;
95378320bc6fSPatrick Sanan   PetscBool      sameType;
95388320bc6fSPatrick Sanan 
95398320bc6fSPatrick Sanan   PetscFunctionBegin;
9540a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
95418320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
95428320bc6fSPatrick Sanan 
95438320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
9544a5bc1bf3SBarry Smith   if (dm1 == dm2) {
95458320bc6fSPatrick Sanan     *set = PETSC_TRUE;
95468320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
95478320bc6fSPatrick Sanan     PetscFunctionReturn(0);
95488320bc6fSPatrick Sanan   }
95498320bc6fSPatrick Sanan 
95508320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
95518320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
95528320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
95538320bc6fSPatrick Sanan      determined by the implementation-specific logic */
9554ffc4695bSBarry Smith   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr);
95558320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
95568320bc6fSPatrick Sanan     *set = PETSC_TRUE;
95578320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
95588320bc6fSPatrick Sanan     PetscFunctionReturn(0);
95598320bc6fSPatrick Sanan   }
95608320bc6fSPatrick Sanan 
95618320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
9562a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
9563a5bc1bf3SBarry Smith     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
9564b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
95658320bc6fSPatrick Sanan   }
95668320bc6fSPatrick Sanan 
9567a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
95688320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
9569a5bc1bf3SBarry Smith   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
95708320bc6fSPatrick Sanan   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
95718320bc6fSPatrick Sanan   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
95728320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
9573a5bc1bf3SBarry Smith     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
95748320bc6fSPatrick Sanan   } else {
95758320bc6fSPatrick Sanan     *set = PETSC_FALSE;
95768320bc6fSPatrick Sanan   }
95778320bc6fSPatrick Sanan   PetscFunctionReturn(0);
95788320bc6fSPatrick Sanan }
9579c0f0dcc3SMatthew G. Knepley 
9580c0f0dcc3SMatthew G. Knepley /*@C
9581c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
9582c0f0dcc3SMatthew G. Knepley 
9583c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9584c0f0dcc3SMatthew G. Knepley 
9585c0f0dcc3SMatthew G. Knepley   Input Parameters:
9586c0f0dcc3SMatthew G. Knepley + DM - the DM
9587c0f0dcc3SMatthew G. Knepley . f - the monitor function
9588c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
9589c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
9590c0f0dcc3SMatthew G. Knepley 
9591c0f0dcc3SMatthew G. Knepley   Options Database Keys:
9592c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
9593c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
9594c0f0dcc3SMatthew G. Knepley 
9595c0f0dcc3SMatthew G. Knepley   Notes:
9596c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
9597c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
9598c0f0dcc3SMatthew G. Knepley   order in which they were set.
9599c0f0dcc3SMatthew G. Knepley 
9600c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9601c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9602c0f0dcc3SMatthew G. Knepley 
9603c0f0dcc3SMatthew G. Knepley   Level: intermediate
9604c0f0dcc3SMatthew G. Knepley 
9605c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9606c0f0dcc3SMatthew G. Knepley @*/
9607c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9608c0f0dcc3SMatthew G. Knepley {
9609c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9610c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9611c0f0dcc3SMatthew G. Knepley 
9612c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9613c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9614c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9615c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9616c0f0dcc3SMatthew G. Knepley 
9617c0f0dcc3SMatthew G. Knepley     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
9618c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9619c0f0dcc3SMatthew G. Knepley   }
9620c0f0dcc3SMatthew G. Knepley   if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9621c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9622c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9623c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9624c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9625c0f0dcc3SMatthew G. Knepley }
9626c0f0dcc3SMatthew G. Knepley 
9627c0f0dcc3SMatthew G. Knepley /*@
9628c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9629c0f0dcc3SMatthew G. Knepley 
9630c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9631c0f0dcc3SMatthew G. Knepley 
9632c0f0dcc3SMatthew G. Knepley   Input Parameter:
9633c0f0dcc3SMatthew G. Knepley . dm - the DM
9634c0f0dcc3SMatthew G. Knepley 
9635c0f0dcc3SMatthew G. Knepley   Options Database Key:
9636c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9637c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9638c0f0dcc3SMatthew G. Knepley   set via the options database
9639c0f0dcc3SMatthew G. Knepley 
9640c0f0dcc3SMatthew G. Knepley   Notes:
9641c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9642c0f0dcc3SMatthew G. Knepley 
9643c0f0dcc3SMatthew G. Knepley   Level: intermediate
9644c0f0dcc3SMatthew G. Knepley 
9645c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9646c0f0dcc3SMatthew G. Knepley @*/
9647c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9648c0f0dcc3SMatthew G. Knepley {
9649c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9650c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9651c0f0dcc3SMatthew G. Knepley 
9652c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9653c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9654c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9655c0f0dcc3SMatthew G. Knepley     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
9656c0f0dcc3SMatthew G. Knepley   }
9657c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9658c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9659c0f0dcc3SMatthew G. Knepley }
9660c0f0dcc3SMatthew G. Knepley 
9661c0f0dcc3SMatthew G. Knepley /*@C
9662c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9663c0f0dcc3SMatthew G. Knepley 
9664c0f0dcc3SMatthew G. Knepley   Collective on DM
9665c0f0dcc3SMatthew G. Knepley 
9666c0f0dcc3SMatthew G. Knepley   Input Parameters:
9667c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9668c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9669c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9670c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9671c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9672c0f0dcc3SMatthew 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
9673c0f0dcc3SMatthew G. Knepley 
9674c0f0dcc3SMatthew G. Knepley   Output Parameter:
9675c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9676c0f0dcc3SMatthew G. Knepley 
9677c0f0dcc3SMatthew G. Knepley   Level: developer
9678c0f0dcc3SMatthew G. Knepley 
9679c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9680c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9681c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9682c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9683c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9684c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9685c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9686c0f0dcc3SMatthew G. Knepley @*/
9687c0f0dcc3SMatthew 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)
9688c0f0dcc3SMatthew G. Knepley {
9689c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9690c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9691c0f0dcc3SMatthew G. Knepley   PetscErrorCode    ierr;
9692c0f0dcc3SMatthew G. Knepley 
9693c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9694c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9695c0f0dcc3SMatthew G. Knepley   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
9696c0f0dcc3SMatthew G. Knepley   if (*flg) {
9697c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9698c0f0dcc3SMatthew G. Knepley 
9699c0f0dcc3SMatthew G. Knepley     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
9700c0f0dcc3SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
9701c0f0dcc3SMatthew G. Knepley     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
9702c0f0dcc3SMatthew G. Knepley     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
9703c0f0dcc3SMatthew G. Knepley   }
9704c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9705c0f0dcc3SMatthew G. Knepley }
9706c0f0dcc3SMatthew G. Knepley 
9707c0f0dcc3SMatthew G. Knepley /*@
9708c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9709c0f0dcc3SMatthew G. Knepley 
9710c0f0dcc3SMatthew G. Knepley    Collective on DM
9711c0f0dcc3SMatthew G. Knepley 
9712c0f0dcc3SMatthew G. Knepley    Input Parameters:
9713c0f0dcc3SMatthew G. Knepley .  dm - The DM
9714c0f0dcc3SMatthew G. Knepley 
9715c0f0dcc3SMatthew G. Knepley    Level: developer
9716c0f0dcc3SMatthew G. Knepley 
9717c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9718c0f0dcc3SMatthew G. Knepley @*/
9719c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9720c0f0dcc3SMatthew G. Knepley {
9721c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9722c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9723c0f0dcc3SMatthew G. Knepley 
9724c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9725c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9726c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9727c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9728c0f0dcc3SMatthew G. Knepley     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
9729c0f0dcc3SMatthew G. Knepley   }
9730c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9731c0f0dcc3SMatthew G. Knepley }
97322e4af2aeSMatthew G. Knepley 
97332e4af2aeSMatthew G. Knepley /*@
97342e4af2aeSMatthew G. Knepley   DMComputeError - Computes the error assuming the user has given exact solution functions
97352e4af2aeSMatthew G. Knepley 
97362e4af2aeSMatthew G. Knepley   Collective on DM
97372e4af2aeSMatthew G. Knepley 
97382e4af2aeSMatthew G. Knepley   Input Parameters:
97392e4af2aeSMatthew G. Knepley + dm     - The DM
97406b867d5aSJose E. Roman - sol    - The solution vector
97412e4af2aeSMatthew G. Knepley 
97426b867d5aSJose E. Roman   Input/Output Parameter:
97436b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output
97446b867d5aSJose E. Roman            contains the error in each field
97456b867d5aSJose E. Roman 
97466b867d5aSJose E. Roman   Output Parameter:
97476b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL)
97482e4af2aeSMatthew G. Knepley 
97492e4af2aeSMatthew G. Knepley   Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber().
97502e4af2aeSMatthew G. Knepley 
97512e4af2aeSMatthew G. Knepley   Level: developer
97522e4af2aeSMatthew G. Knepley 
97532e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber()
97542e4af2aeSMatthew G. Knepley @*/
97552e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec)
97562e4af2aeSMatthew G. Knepley {
97572e4af2aeSMatthew G. Knepley   PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *);
97582e4af2aeSMatthew G. Knepley   void            **ctxs;
97592e4af2aeSMatthew G. Knepley   PetscReal         time;
97602e4af2aeSMatthew G. Knepley   PetscInt          Nf, f, Nds, s;
97612e4af2aeSMatthew G. Knepley   PetscErrorCode    ierr;
97622e4af2aeSMatthew G. Knepley 
97632e4af2aeSMatthew G. Knepley   PetscFunctionBegin;
97642e4af2aeSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
97652e4af2aeSMatthew G. Knepley   ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr);
97662e4af2aeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
97672e4af2aeSMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
97682e4af2aeSMatthew G. Knepley     PetscDS         ds;
97692e4af2aeSMatthew G. Knepley     DMLabel         label;
97702e4af2aeSMatthew G. Knepley     IS              fieldIS;
97712e4af2aeSMatthew G. Knepley     const PetscInt *fields;
97722e4af2aeSMatthew G. Knepley     PetscInt        dsNf;
97732e4af2aeSMatthew G. Knepley 
97742e4af2aeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
97752e4af2aeSMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
97762e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);}
97772e4af2aeSMatthew G. Knepley     for (f = 0; f < dsNf; ++f) {
97782e4af2aeSMatthew G. Knepley       const PetscInt field = fields[f];
97792e4af2aeSMatthew G. Knepley       ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr);
97802e4af2aeSMatthew G. Knepley     }
97812e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);}
97822e4af2aeSMatthew G. Knepley   }
97832e4af2aeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
97842e4af2aeSMatthew G. Knepley     if (!exactSol[f]) SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f);
97852e4af2aeSMatthew G. Knepley   }
97862e4af2aeSMatthew G. Knepley   ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr);
97872e4af2aeSMatthew G. Knepley   if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);}
97882e4af2aeSMatthew G. Knepley   if (errorVec) {
97892e4af2aeSMatthew G. Knepley     DM             edm;
97902e4af2aeSMatthew G. Knepley     DMPolytopeType ct;
97912e4af2aeSMatthew G. Knepley     PetscBool      simplex;
97922e4af2aeSMatthew G. Knepley     PetscInt       dim, cStart, Nf;
97932e4af2aeSMatthew G. Knepley 
97942e4af2aeSMatthew G. Knepley     ierr = DMClone(dm, &edm);CHKERRQ(ierr);
97952e4af2aeSMatthew G. Knepley     ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr);
97962e4af2aeSMatthew G. Knepley     ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
97972e4af2aeSMatthew G. Knepley     ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
97982e4af2aeSMatthew G. Knepley     simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
97992e4af2aeSMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
98002e4af2aeSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
98012e4af2aeSMatthew G. Knepley       PetscFE         fe, efe;
98022e4af2aeSMatthew G. Knepley       PetscQuadrature q;
98032e4af2aeSMatthew G. Knepley       const char     *name;
98042e4af2aeSMatthew G. Knepley 
98052e4af2aeSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr);
98062e4af2aeSMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr);
98072e4af2aeSMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr);
98082e4af2aeSMatthew G. Knepley       ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr);
98092e4af2aeSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
98102e4af2aeSMatthew G. Knepley       ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr);
98112e4af2aeSMatthew G. Knepley       ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr);
98122e4af2aeSMatthew G. Knepley       ierr = PetscFEDestroy(&efe);CHKERRQ(ierr);
98132e4af2aeSMatthew G. Knepley     }
98142e4af2aeSMatthew G. Knepley     ierr = DMCreateDS(edm);CHKERRQ(ierr);
98152e4af2aeSMatthew G. Knepley 
98161e1ea65dSPierre Jolivet     ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr);
98172e4af2aeSMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr);
98182e4af2aeSMatthew G. Knepley     ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr);
98192e4af2aeSMatthew G. Knepley     ierr = DMDestroy(&edm);CHKERRQ(ierr);
98202e4af2aeSMatthew G. Knepley   }
98212e4af2aeSMatthew G. Knepley   ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr);
98222e4af2aeSMatthew G. Knepley   PetscFunctionReturn(0);
98232e4af2aeSMatthew G. Knepley }
98249a2a23afSMatthew G. Knepley 
98259a2a23afSMatthew G. Knepley /*@
98269a2a23afSMatthew G. Knepley   DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM
98279a2a23afSMatthew G. Knepley 
98289a2a23afSMatthew G. Knepley   Not collective
98299a2a23afSMatthew G. Knepley 
98309a2a23afSMatthew G. Knepley   Input Parameter:
98319a2a23afSMatthew G. Knepley . dm     - The DM
98329a2a23afSMatthew G. Knepley 
98339a2a23afSMatthew G. Knepley   Output Parameter:
9834a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors
98359a2a23afSMatthew G. Knepley 
98369a2a23afSMatthew G. Knepley   Level: advanced
98379a2a23afSMatthew G. Knepley 
98389a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
98399a2a23afSMatthew G. Knepley @*/
98409a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux)
98419a2a23afSMatthew G. Knepley {
98429a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
98439a2a23afSMatthew G. Knepley 
98449a2a23afSMatthew G. Knepley   PetscFunctionBegin;
98459a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
98469a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr);
98479a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
98489a2a23afSMatthew G. Knepley }
98499a2a23afSMatthew G. Knepley 
98509a2a23afSMatthew G. Knepley /*@
98519a2a23afSMatthew G. Knepley   DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value
98529a2a23afSMatthew G. Knepley 
98539a2a23afSMatthew G. Knepley   Not collective
98549a2a23afSMatthew G. Knepley 
98559a2a23afSMatthew G. Knepley   Input Parameters:
98569a2a23afSMatthew G. Knepley + dm     - The DM
98579a2a23afSMatthew G. Knepley . label  - The DMLabel
98589a2a23afSMatthew G. Knepley - value  - The label value indicating the region
98599a2a23afSMatthew G. Knepley 
98609a2a23afSMatthew G. Knepley   Output Parameter:
98619a2a23afSMatthew G. Knepley . aux    - The Vec holding auxiliary field data
98629a2a23afSMatthew G. Knepley 
986304c51a94SMatthew G. Knepley   Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well.
986404c51a94SMatthew G. Knepley 
98659a2a23afSMatthew G. Knepley   Level: advanced
98669a2a23afSMatthew G. Knepley 
98679a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec()
98689a2a23afSMatthew G. Knepley @*/
98699a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux)
98709a2a23afSMatthew G. Knepley {
987104c51a94SMatthew G. Knepley   PetscHashAuxKey key, wild = {NULL, 0};
987204c51a94SMatthew G. Knepley   PetscBool       has;
98739a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
98749a2a23afSMatthew G. Knepley 
98759a2a23afSMatthew G. Knepley   PetscFunctionBegin;
98769a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
98779a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
98789a2a23afSMatthew G. Knepley   key.label = label;
98799a2a23afSMatthew G. Knepley   key.value = value;
988004c51a94SMatthew G. Knepley   ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr);
988104c51a94SMatthew G. Knepley   if (has) {ierr = PetscHMapAuxGet(dm->auxData, key,  aux);CHKERRQ(ierr);}
988204c51a94SMatthew G. Knepley   else     {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);}
98839a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
98849a2a23afSMatthew G. Knepley }
98859a2a23afSMatthew G. Knepley 
98869a2a23afSMatthew G. Knepley /*@
98879a2a23afSMatthew G. Knepley   DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value
98889a2a23afSMatthew G. Knepley 
98899a2a23afSMatthew G. Knepley   Not collective
98909a2a23afSMatthew G. Knepley 
98919a2a23afSMatthew G. Knepley   Input Parameters:
98929a2a23afSMatthew G. Knepley + dm     - The DM
98939a2a23afSMatthew G. Knepley . label  - The DMLabel
98949a2a23afSMatthew G. Knepley . value  - The label value indicating the region
98959a2a23afSMatthew G. Knepley - aux    - The Vec holding auxiliary field data
98969a2a23afSMatthew G. Knepley 
98979a2a23afSMatthew G. Knepley   Level: advanced
98989a2a23afSMatthew G. Knepley 
98999a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec()
99009a2a23afSMatthew G. Knepley @*/
99019a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux)
99029a2a23afSMatthew G. Knepley {
99039a2a23afSMatthew G. Knepley   Vec             old;
99049a2a23afSMatthew G. Knepley   PetscHashAuxKey key;
99059a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
99069a2a23afSMatthew G. Knepley 
99079a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99089a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99099a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
99109a2a23afSMatthew G. Knepley   key.label = label;
99119a2a23afSMatthew G. Knepley   key.value = value;
99129a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr);
99139a2a23afSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr);
99149a2a23afSMatthew G. Knepley   ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr);
99159a2a23afSMatthew G. Knepley   if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);}
99169a2a23afSMatthew G. Knepley   else      {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);}
99179a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99189a2a23afSMatthew G. Knepley }
99199a2a23afSMatthew G. Knepley 
99209a2a23afSMatthew G. Knepley /*@C
99219a2a23afSMatthew G. Knepley   DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM
99229a2a23afSMatthew G. Knepley 
99239a2a23afSMatthew G. Knepley   Not collective
99249a2a23afSMatthew G. Knepley 
99259a2a23afSMatthew G. Knepley   Input Parameter:
99269a2a23afSMatthew G. Knepley . dm      - The DM
99279a2a23afSMatthew G. Knepley 
99289a2a23afSMatthew G. Knepley   Output Parameters:
99299a2a23afSMatthew G. Knepley + labels  - The DMLabels for each Vec
99309a2a23afSMatthew G. Knepley - values  - The label values for each Vec
99319a2a23afSMatthew G. Knepley 
99329a2a23afSMatthew G. Knepley   Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec().
99339a2a23afSMatthew G. Knepley 
99349a2a23afSMatthew G. Knepley   Level: advanced
99359a2a23afSMatthew G. Knepley 
99369a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
99379a2a23afSMatthew G. Knepley @*/
99389a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[])
99399a2a23afSMatthew G. Knepley {
99409a2a23afSMatthew G. Knepley   PetscHashAuxKey *keys;
99419a2a23afSMatthew G. Knepley   PetscInt         n, i, off = 0;
99429a2a23afSMatthew G. Knepley   PetscErrorCode   ierr;
99439a2a23afSMatthew G. Knepley 
99449a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99459a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99469a2a23afSMatthew G. Knepley   PetscValidPointer(labels, 2);
99479a2a23afSMatthew G. Knepley   PetscValidPointer(values, 3);
99489a2a23afSMatthew G. Knepley   ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr);
99499a2a23afSMatthew G. Knepley   ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr);
99509a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr);
99519a2a23afSMatthew G. Knepley   for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;}
99529a2a23afSMatthew G. Knepley   ierr = PetscFree(keys);CHKERRQ(ierr);
99539a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99549a2a23afSMatthew G. Knepley }
99559a2a23afSMatthew G. Knepley 
99569a2a23afSMatthew G. Knepley /*@
99579a2a23afSMatthew G. Knepley   DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM
99589a2a23afSMatthew G. Knepley 
99599a2a23afSMatthew G. Knepley   Not collective
99609a2a23afSMatthew G. Knepley 
99619a2a23afSMatthew G. Knepley   Input Parameter:
99629a2a23afSMatthew G. Knepley . dm    - The DM
99639a2a23afSMatthew G. Knepley 
99649a2a23afSMatthew G. Knepley   Output Parameter:
99659a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data
99669a2a23afSMatthew G. Knepley 
99679a2a23afSMatthew G. Knepley   Level: advanced
99689a2a23afSMatthew G. Knepley 
99699a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
99709a2a23afSMatthew G. Knepley @*/
99719a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew)
99729a2a23afSMatthew G. Knepley {
99739a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
99749a2a23afSMatthew G. Knepley 
99759a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99769a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99779a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr);
99789a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr);
99799a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99809a2a23afSMatthew G. Knepley }
9981b5a892a1SMatthew G. Knepley 
9982b5a892a1SMatthew G. Knepley /*@C
9983b5a892a1SMatthew G. Knepley   DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
9984b5a892a1SMatthew G. Knepley 
9985b5a892a1SMatthew G. Knepley   Not collective
9986b5a892a1SMatthew G. Knepley 
9987b5a892a1SMatthew G. Knepley   Input Parameters:
9988b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9989b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
9990b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
9991b5a892a1SMatthew G. Knepley 
9992b5a892a1SMatthew G. Knepley   Output Parameters:
9993b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
9994b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
9995b5a892a1SMatthew G. Knepley 
9996b5a892a1SMatthew G. Knepley   Level: advanced
9997b5a892a1SMatthew G. Knepley 
9998b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation()
9999b5a892a1SMatthew G. Knepley @*/
10000b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found)
10001b5a892a1SMatthew G. Knepley {
10002b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetConeSize(ct);
10003b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
10004b5a892a1SMatthew G. Knepley   PetscInt       o, c;
10005b5a892a1SMatthew G. Knepley 
10006b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10007b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
10008b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
10009b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o);
10010b5a892a1SMatthew G. Knepley 
10011b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break;
10012b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
10013b5a892a1SMatthew G. Knepley   }
10014b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
10015b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10016b5a892a1SMatthew G. Knepley }
10017b5a892a1SMatthew G. Knepley 
10018b5a892a1SMatthew G. Knepley /*@C
10019b5a892a1SMatthew G. Knepley   DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
10020b5a892a1SMatthew G. Knepley 
10021b5a892a1SMatthew G. Knepley   Not collective
10022b5a892a1SMatthew G. Knepley 
10023b5a892a1SMatthew G. Knepley   Input Parameters:
10024b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10025b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
10026b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
10027b5a892a1SMatthew G. Knepley 
10028b5a892a1SMatthew G. Knepley   Output Parameters:
10029b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
10030b5a892a1SMatthew G. Knepley 
10031b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
10032b5a892a1SMatthew G. Knepley 
10033b5a892a1SMatthew G. Knepley   Level: advanced
10034b5a892a1SMatthew G. Knepley 
10035b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation()
10036b5a892a1SMatthew G. Knepley @*/
10037b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
10038b5a892a1SMatthew G. Knepley {
10039b5a892a1SMatthew G. Knepley   PetscBool      found;
10040b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
10041b5a892a1SMatthew G. Knepley 
10042b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10043b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
10044b5a892a1SMatthew G. Knepley   if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
10045b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10046b5a892a1SMatthew G. Knepley }
10047b5a892a1SMatthew G. Knepley 
10048b5a892a1SMatthew G. Knepley /*@C
10049b5a892a1SMatthew G. Knepley   DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
10050b5a892a1SMatthew G. Knepley 
10051b5a892a1SMatthew G. Knepley   Not collective
10052b5a892a1SMatthew G. Knepley 
10053b5a892a1SMatthew G. Knepley   Input Parameters:
10054b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10055b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices
10056b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices
10057b5a892a1SMatthew G. Knepley 
10058b5a892a1SMatthew G. Knepley   Output Parameters:
10059b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
10060b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
10061b5a892a1SMatthew G. Knepley 
10062b5a892a1SMatthew G. Knepley   Level: advanced
10063b5a892a1SMatthew G. Knepley 
10064b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation()
10065b5a892a1SMatthew G. Knepley @*/
10066b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found)
10067b5a892a1SMatthew G. Knepley {
10068b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetNumVertices(ct);
10069b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
10070b5a892a1SMatthew G. Knepley   PetscInt       o, c;
10071b5a892a1SMatthew G. Knepley 
10072b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10073b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
10074b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
10075b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o);
10076b5a892a1SMatthew G. Knepley 
10077b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break;
10078b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
10079b5a892a1SMatthew G. Knepley   }
10080b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
10081b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10082b5a892a1SMatthew G. Knepley }
10083b5a892a1SMatthew G. Knepley 
10084b5a892a1SMatthew G. Knepley /*@C
10085b5a892a1SMatthew G. Knepley   DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
10086b5a892a1SMatthew G. Knepley 
10087b5a892a1SMatthew G. Knepley   Not collective
10088b5a892a1SMatthew G. Knepley 
10089b5a892a1SMatthew G. Knepley   Input Parameters:
10090b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10091b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices
10092b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices
10093b5a892a1SMatthew G. Knepley 
10094b5a892a1SMatthew G. Knepley   Output Parameters:
10095b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
10096b5a892a1SMatthew G. Knepley 
10097b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
10098b5a892a1SMatthew G. Knepley 
10099b5a892a1SMatthew G. Knepley   Level: advanced
10100b5a892a1SMatthew G. Knepley 
10101b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation()
10102b5a892a1SMatthew G. Knepley @*/
10103b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
10104b5a892a1SMatthew G. Knepley {
10105b5a892a1SMatthew G. Knepley   PetscBool      found;
10106b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
10107b5a892a1SMatthew G. Knepley 
10108b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10109b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
10110b5a892a1SMatthew G. Knepley   if (!found) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
10111b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10112b5a892a1SMatthew G. Knepley }
10113012bc364SMatthew G. Knepley 
10114012bc364SMatthew G. Knepley /*@C
10115012bc364SMatthew G. Knepley   DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type
10116012bc364SMatthew G. Knepley 
10117012bc364SMatthew G. Knepley   Not collective
10118012bc364SMatthew G. Knepley 
10119012bc364SMatthew G. Knepley   Input Parameters:
10120012bc364SMatthew G. Knepley + ct    - The DMPolytopeType
10121012bc364SMatthew G. Knepley - point - Coordinates of the point
10122012bc364SMatthew G. Knepley 
10123012bc364SMatthew G. Knepley   Output Parameters:
10124012bc364SMatthew G. Knepley . inside  - Flag indicating whether the point is inside the reference cell of given type
10125012bc364SMatthew G. Knepley 
10126012bc364SMatthew G. Knepley   Level: advanced
10127012bc364SMatthew G. Knepley 
10128012bc364SMatthew G. Knepley .seealso: DMLocatePoints()
10129012bc364SMatthew G. Knepley @*/
10130012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside)
10131012bc364SMatthew G. Knepley {
10132012bc364SMatthew G. Knepley   PetscReal sum = 0.0;
10133012bc364SMatthew G. Knepley   PetscInt  d;
10134012bc364SMatthew G. Knepley 
10135012bc364SMatthew G. Knepley   PetscFunctionBegin;
10136012bc364SMatthew G. Knepley   *inside = PETSC_TRUE;
10137012bc364SMatthew G. Knepley   switch (ct) {
10138012bc364SMatthew G. Knepley   case DM_POLYTOPE_TRIANGLE:
10139012bc364SMatthew G. Knepley   case DM_POLYTOPE_TETRAHEDRON:
10140012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) {
10141012bc364SMatthew G. Knepley       if (point[d] < -1.0) {*inside = PETSC_FALSE; break;}
10142012bc364SMatthew G. Knepley       sum += point[d];
10143012bc364SMatthew G. Knepley     }
10144012bc364SMatthew G. Knepley     if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10145012bc364SMatthew G. Knepley     break;
10146012bc364SMatthew G. Knepley   case DM_POLYTOPE_QUADRILATERAL:
10147012bc364SMatthew G. Knepley   case DM_POLYTOPE_HEXAHEDRON:
10148012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d)
10149012bc364SMatthew G. Knepley       if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10150012bc364SMatthew G. Knepley     break;
10151012bc364SMatthew G. Knepley   default:
10152012bc364SMatthew G. Knepley     SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]);
10153012bc364SMatthew G. Knepley   }
10154012bc364SMatthew G. Knepley   PetscFunctionReturn(0);
10155012bc364SMatthew G. Knepley }
10156