xref: /petsc/src/dm/interface/dm.c (revision 79769bd57e268fab0efcd52e960f815c00cb84fd)
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;
733b8ba7d1SJed Brown   v->defaultConstraint.section = NULL;
743b8ba7d1SJed Brown   v->defaultConstraint.mat    = NULL;
75*79769bd5SJed Brown   v->defaultConstraint.bias   = NULL;
76c6b900c6SMatthew G. Knepley   v->L                        = NULL;
77c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
785dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
799a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
8096173672SStefano Zampini   v->dim                      = PETSC_DETERMINE;
81435a35e8SMatthew G Knepley   {
82435a35e8SMatthew G Knepley     PetscInt i;
83435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
840298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
85f9d4088aSMatthew G. Knepley       v->nearnullspaceConstructors[i] = NULL;
86435a35e8SMatthew G Knepley     }
87435a35e8SMatthew G Knepley   }
8845480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
89b3cf3223SMatthew G. Knepley   ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr);
90e5e52638SMatthew G. Knepley   ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
919a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxCreate(&v->auxData);CHKERRQ(ierr);
9214f150ffSMatthew G. Knepley   v->dmBC = NULL;
93a8fb8f29SToby Isaac   v->coarseMesh = NULL;
94f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
95cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
96c0dedaeaSBarry Smith   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
97b412c318SBarry Smith   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
984a7a4c06SLawrence Mitchell 
991411c6eeSJed Brown   *dm = v;
100a4121054SBarry Smith   PetscFunctionReturn(0);
101a4121054SBarry Smith }
102a4121054SBarry Smith 
10338221697SMatthew G. Knepley /*@
10438221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
10538221697SMatthew G. Knepley 
106d083f849SBarry Smith   Collective
10738221697SMatthew G. Knepley 
10838221697SMatthew G. Knepley   Input Parameter:
10938221697SMatthew G. Knepley . dm - The original DM object
11038221697SMatthew G. Knepley 
11138221697SMatthew G. Knepley   Output Parameter:
11238221697SMatthew G. Knepley . newdm  - The new DM object
11338221697SMatthew G. Knepley 
11438221697SMatthew G. Knepley   Level: beginner
11538221697SMatthew G. Knepley 
1161cb8cacdSPatrick Sanan   Notes:
1171cb8cacdSPatrick Sanan   For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example,
1181cb8cacdSPatrick Sanan   DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not
1191cb8cacdSPatrick Sanan   share the PetscSection of the original DM.
1201bb6d2a8SBarry Smith 
12189706ed2SPatrick Sanan   The clone is considered set up iff the original is.
12289706ed2SPatrick Sanan 
12392cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection()
1241bb6d2a8SBarry Smith 
12538221697SMatthew G. Knepley @*/
12638221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
12738221697SMatthew G. Knepley {
12838221697SMatthew G. Knepley   PetscSF        sf;
12938221697SMatthew G. Knepley   Vec            coords;
13038221697SMatthew G. Knepley   void          *ctx;
131a3219837SMatthew G. Knepley   PetscInt       dim, cdim;
13238221697SMatthew G. Knepley   PetscErrorCode ierr;
13338221697SMatthew G. Knepley 
13438221697SMatthew G. Knepley   PetscFunctionBegin;
13538221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
13638221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
13738221697SMatthew G. Knepley   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
1382cbb9b06SVaclav Hapla   ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE, DM_COPY_LABELS_FAIL);CHKERRQ(ierr);
139ddf8437dSMatthew G. Knepley   (*newdm)->leveldown  = dm->leveldown;
140ddf8437dSMatthew G. Knepley   (*newdm)->levelup    = dm->levelup;
141c8a6034eSMark   (*newdm)->prealloc_only = dm->prealloc_only;
142a587d139SMark   ierr = PetscFree((*newdm)->vectype);CHKERRQ(ierr);
143a587d139SMark   ierr = PetscStrallocpy(dm->vectype,(char**)&(*newdm)->vectype);CHKERRQ(ierr);
144a587d139SMark   ierr = PetscFree((*newdm)->mattype);CHKERRQ(ierr);
145a587d139SMark   ierr = PetscStrallocpy(dm->mattype,(char**)&(*newdm)->mattype);CHKERRQ(ierr);
1461de53e9aSMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
1471de53e9aSMatthew G. Knepley   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
14838221697SMatthew G. Knepley   if (dm->ops->clone) {
14938221697SMatthew G. Knepley     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
15038221697SMatthew G. Knepley   }
1513f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
15238221697SMatthew G. Knepley   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
15338221697SMatthew G. Knepley   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
15438221697SMatthew G. Knepley   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
15538221697SMatthew G. Knepley   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
156be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
157be4c1c3eSMatthew G. Knepley     DM           ncdm;
158be4c1c3eSMatthew G. Knepley     PetscSection cs;
1595a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
160be4c1c3eSMatthew G. Knepley 
16192fd8e1eSJed Brown     ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
162be4c1c3eSMatthew G. Knepley     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
163ffc4695bSBarry Smith     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
1645a0206caSToby Isaac     if (pEndMax >= 0) {
165be4c1c3eSMatthew G. Knepley       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
16683bfc06fSMatthew Knepley       ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr);
16792fd8e1eSJed Brown       ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr);
168a61e840bSMatthew G. Knepley       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
169be4c1c3eSMatthew G. Knepley       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
170be4c1c3eSMatthew G. Knepley     }
171be4c1c3eSMatthew G. Knepley   }
172a3219837SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
173a3219837SMatthew G. Knepley   ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr);
17438221697SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
17538221697SMatthew G. Knepley   if (coords) {
17638221697SMatthew G. Knepley     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
17738221697SMatthew G. Knepley   } else {
17838221697SMatthew G. Knepley     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
17938221697SMatthew G. Knepley     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
18038221697SMatthew G. Knepley   }
18190b157c4SStefano Zampini   {
18290b157c4SStefano Zampini     PetscBool             isper;
183c6b900c6SMatthew G. Knepley     const PetscReal      *maxCell, *L;
1845dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
18590b157c4SStefano Zampini     ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
18690b157c4SStefano Zampini     ierr = DMSetPeriodicity(*newdm, isper, maxCell,  L,  bd);CHKERRQ(ierr);
187c6b900c6SMatthew G. Knepley   }
18834aa8a36SMatthew G. Knepley   {
18934aa8a36SMatthew G. Knepley     PetscBool useCone, useClosure;
19034aa8a36SMatthew G. Knepley 
19134aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr);
19234aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
19334aa8a36SMatthew G. Knepley   }
19438221697SMatthew G. Knepley   PetscFunctionReturn(0);
19538221697SMatthew G. Knepley }
19638221697SMatthew G. Knepley 
1979a42bb27SBarry Smith /*@C
198564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1999a42bb27SBarry Smith 
200d083f849SBarry Smith    Logically Collective on da
2019a42bb27SBarry Smith 
2029a42bb27SBarry Smith    Input Parameter:
2039a42bb27SBarry Smith +  da - initial distributed array
204e9e886b6SKarl Rupp .  ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL
2059a42bb27SBarry Smith 
2069a42bb27SBarry Smith    Options Database:
207dd85299cSBarry Smith .   -dm_vec_type ctype
2089a42bb27SBarry Smith 
2099a42bb27SBarry Smith    Level: intermediate
2109a42bb27SBarry Smith 
211a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType()
2129a42bb27SBarry Smith @*/
21319fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
2149a42bb27SBarry Smith {
2159a42bb27SBarry Smith   PetscErrorCode ierr;
2169a42bb27SBarry Smith 
2179a42bb27SBarry Smith   PetscFunctionBegin;
2189a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
2199a42bb27SBarry Smith   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
22019fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
2219a42bb27SBarry Smith   PetscFunctionReturn(0);
2229a42bb27SBarry Smith }
2239a42bb27SBarry Smith 
224c0dedaeaSBarry Smith /*@C
225c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
226c0dedaeaSBarry Smith 
227d083f849SBarry Smith    Logically Collective on da
228c0dedaeaSBarry Smith 
229c0dedaeaSBarry Smith    Input Parameter:
230c0dedaeaSBarry Smith .  da - initial distributed array
231c0dedaeaSBarry Smith 
232c0dedaeaSBarry Smith    Output Parameter:
233c0dedaeaSBarry Smith .  ctype - the vector type
234c0dedaeaSBarry Smith 
235c0dedaeaSBarry Smith    Level: intermediate
236c0dedaeaSBarry Smith 
237a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType()
238c0dedaeaSBarry Smith @*/
239c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
240c0dedaeaSBarry Smith {
241c0dedaeaSBarry Smith   PetscFunctionBegin;
242c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
243c0dedaeaSBarry Smith   *ctype = da->vectype;
244c0dedaeaSBarry Smith   PetscFunctionReturn(0);
245c0dedaeaSBarry Smith }
246c0dedaeaSBarry Smith 
2475f1ad066SMatthew G Knepley /*@
24834f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2495f1ad066SMatthew G Knepley 
2505f1ad066SMatthew G Knepley   Not collective
2515f1ad066SMatthew G Knepley 
2525f1ad066SMatthew G Knepley   Input Parameter:
2535f1ad066SMatthew G Knepley . v - The Vec
2545f1ad066SMatthew G Knepley 
2555f1ad066SMatthew G Knepley   Output Parameter:
2565f1ad066SMatthew G Knepley . dm - The DM
2575f1ad066SMatthew G Knepley 
2585f1ad066SMatthew G Knepley   Level: intermediate
2595f1ad066SMatthew G Knepley 
2605f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2615f1ad066SMatthew G Knepley @*/
2625f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2635f1ad066SMatthew G Knepley {
2645f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2655f1ad066SMatthew G Knepley 
2665f1ad066SMatthew G Knepley   PetscFunctionBegin;
2675f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2685f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2695f1ad066SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
2705f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2715f1ad066SMatthew G Knepley }
2725f1ad066SMatthew G Knepley 
2735f1ad066SMatthew G Knepley /*@
274d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2755f1ad066SMatthew G Knepley 
2765f1ad066SMatthew G Knepley   Not collective
2775f1ad066SMatthew G Knepley 
2785f1ad066SMatthew G Knepley   Input Parameters:
2795f1ad066SMatthew G Knepley + v - The Vec
2805f1ad066SMatthew G Knepley - dm - The DM
2815f1ad066SMatthew G Knepley 
282d9805387SMatthew 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.
283d9805387SMatthew G. Knepley 
2845f1ad066SMatthew G Knepley   Level: intermediate
2855f1ad066SMatthew G Knepley 
2865f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2875f1ad066SMatthew G Knepley @*/
2885f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2895f1ad066SMatthew G Knepley {
2905f1ad066SMatthew G Knepley   PetscErrorCode ierr;
2915f1ad066SMatthew G Knepley 
2925f1ad066SMatthew G Knepley   PetscFunctionBegin;
2935f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
294d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2955f1ad066SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
2965f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2975f1ad066SMatthew G Knepley }
2985f1ad066SMatthew G Knepley 
299521d9a4cSLisandro Dalcin /*@C
3008f1509bcSBarry Smith        DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM
3018f1509bcSBarry Smith 
302d083f849SBarry Smith    Logically Collective on dm
3038f1509bcSBarry Smith 
3048f1509bcSBarry Smith    Input Parameters:
3058f1509bcSBarry Smith +  dm - the DM context
3068f1509bcSBarry Smith -  ctype - the matrix type
3078f1509bcSBarry Smith 
3088f1509bcSBarry Smith    Options Database:
3098f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3108f1509bcSBarry Smith 
3118f1509bcSBarry Smith    Level: intermediate
3128f1509bcSBarry Smith 
3138f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3148f1509bcSBarry Smith           DMGetISColoringType()
3158f1509bcSBarry Smith @*/
3168f1509bcSBarry Smith PetscErrorCode  DMSetISColoringType(DM dm,ISColoringType ctype)
3178f1509bcSBarry Smith {
3188f1509bcSBarry Smith   PetscFunctionBegin;
3198f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3208f1509bcSBarry Smith   dm->coloringtype = ctype;
3218f1509bcSBarry Smith   PetscFunctionReturn(0);
3228f1509bcSBarry Smith }
3238f1509bcSBarry Smith 
3248f1509bcSBarry Smith /*@C
3258f1509bcSBarry Smith        DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM
326521d9a4cSLisandro Dalcin 
327d083f849SBarry Smith    Logically Collective on dm
328521d9a4cSLisandro Dalcin 
329521d9a4cSLisandro Dalcin    Input Parameter:
3308f1509bcSBarry Smith .  dm - the DM context
3318f1509bcSBarry Smith 
3328f1509bcSBarry Smith    Output Parameter:
3338f1509bcSBarry Smith .  ctype - the matrix type
3348f1509bcSBarry Smith 
3358f1509bcSBarry Smith    Options Database:
3368f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3378f1509bcSBarry Smith 
3388f1509bcSBarry Smith    Level: intermediate
3398f1509bcSBarry Smith 
3408f1509bcSBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3418f1509bcSBarry Smith           DMGetISColoringType()
3428f1509bcSBarry Smith @*/
3438f1509bcSBarry Smith PetscErrorCode  DMGetISColoringType(DM dm,ISColoringType *ctype)
3448f1509bcSBarry Smith {
3458f1509bcSBarry Smith   PetscFunctionBegin;
3468f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3478f1509bcSBarry Smith   *ctype = dm->coloringtype;
3488f1509bcSBarry Smith   PetscFunctionReturn(0);
3498f1509bcSBarry Smith }
3508f1509bcSBarry Smith 
3518f1509bcSBarry Smith /*@C
3528f1509bcSBarry Smith        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
3538f1509bcSBarry Smith 
354d083f849SBarry Smith    Logically Collective on dm
3558f1509bcSBarry Smith 
3568f1509bcSBarry Smith    Input Parameters:
357521d9a4cSLisandro Dalcin +  dm - the DM context
358a2b5a043SBarry Smith -  ctype - the matrix type
359521d9a4cSLisandro Dalcin 
360521d9a4cSLisandro Dalcin    Options Database:
361521d9a4cSLisandro Dalcin .   -dm_mat_type ctype
362521d9a4cSLisandro Dalcin 
363521d9a4cSLisandro Dalcin    Level: intermediate
364521d9a4cSLisandro Dalcin 
365a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType()
366521d9a4cSLisandro Dalcin @*/
36719fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
368521d9a4cSLisandro Dalcin {
369521d9a4cSLisandro Dalcin   PetscErrorCode ierr;
37088f0584fSBarry Smith 
371521d9a4cSLisandro Dalcin   PetscFunctionBegin;
372521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
373521d9a4cSLisandro Dalcin   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
37419fd82e9SBarry Smith   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
375521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
376521d9a4cSLisandro Dalcin }
377521d9a4cSLisandro Dalcin 
378c0dedaeaSBarry Smith /*@C
379c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
380c0dedaeaSBarry Smith 
381d083f849SBarry Smith    Logically Collective on dm
382c0dedaeaSBarry Smith 
383c0dedaeaSBarry Smith    Input Parameter:
384c0dedaeaSBarry Smith .  dm - the DM context
385c0dedaeaSBarry Smith 
386c0dedaeaSBarry Smith    Output Parameter:
387c0dedaeaSBarry Smith .  ctype - the matrix type
388c0dedaeaSBarry Smith 
389c0dedaeaSBarry Smith    Options Database:
390c0dedaeaSBarry Smith .   -dm_mat_type ctype
391c0dedaeaSBarry Smith 
392c0dedaeaSBarry Smith    Level: intermediate
393c0dedaeaSBarry Smith 
394a2a9ebe5SBarry Smith .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType()
395c0dedaeaSBarry Smith @*/
396c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
397c0dedaeaSBarry Smith {
398c0dedaeaSBarry Smith   PetscFunctionBegin;
399c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
400c0dedaeaSBarry Smith   *ctype = dm->mattype;
401c0dedaeaSBarry Smith   PetscFunctionReturn(0);
402c0dedaeaSBarry Smith }
403c0dedaeaSBarry Smith 
404c688c046SMatthew G Knepley /*@
40534f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
406c688c046SMatthew G Knepley 
407c688c046SMatthew G Knepley   Not collective
408c688c046SMatthew G Knepley 
409c688c046SMatthew G Knepley   Input Parameter:
410c688c046SMatthew G Knepley . A - The Mat
411c688c046SMatthew G Knepley 
412c688c046SMatthew G Knepley   Output Parameter:
413c688c046SMatthew G Knepley . dm - The DM
414c688c046SMatthew G Knepley 
415c688c046SMatthew G Knepley   Level: intermediate
416c688c046SMatthew G Knepley 
4178f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4188f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4198f1509bcSBarry Smith 
420c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
421c688c046SMatthew G Knepley @*/
422c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
423c688c046SMatthew G Knepley {
424c688c046SMatthew G Knepley   PetscErrorCode ierr;
425c688c046SMatthew G Knepley 
426c688c046SMatthew G Knepley   PetscFunctionBegin;
427c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
428c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
429c688c046SMatthew G Knepley   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
430c688c046SMatthew G Knepley   PetscFunctionReturn(0);
431c688c046SMatthew G Knepley }
432c688c046SMatthew G Knepley 
433c688c046SMatthew G Knepley /*@
434c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
435c688c046SMatthew G Knepley 
436c688c046SMatthew G Knepley   Not collective
437c688c046SMatthew G Knepley 
438c688c046SMatthew G Knepley   Input Parameters:
439c688c046SMatthew G Knepley + A - The Mat
440c688c046SMatthew G Knepley - dm - The DM
441c688c046SMatthew G Knepley 
442c688c046SMatthew G Knepley   Level: intermediate
443c688c046SMatthew G Knepley 
4448f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4458f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4468f1509bcSBarry Smith 
447c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
448c688c046SMatthew G Knepley @*/
449c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
450c688c046SMatthew G Knepley {
451c688c046SMatthew G Knepley   PetscErrorCode ierr;
452c688c046SMatthew G Knepley 
453c688c046SMatthew G Knepley   PetscFunctionBegin;
454c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4558865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
456c688c046SMatthew G Knepley   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
457c688c046SMatthew G Knepley   PetscFunctionReturn(0);
458c688c046SMatthew G Knepley }
459c688c046SMatthew G Knepley 
4609a42bb27SBarry Smith /*@C
4619a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
4626757b960SDave May    DM options in the database.
4639a42bb27SBarry Smith 
464d083f849SBarry Smith    Logically Collective on dm
4659a42bb27SBarry Smith 
466d8d19677SJose E. Roman    Input Parameters:
4678353ddbbSDave May +  da - the DM context
4689a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
4699a42bb27SBarry Smith 
4709a42bb27SBarry Smith    Notes:
4719a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4729a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
4739a42bb27SBarry Smith 
4749a42bb27SBarry Smith    Level: advanced
4759a42bb27SBarry Smith 
4769a42bb27SBarry Smith .seealso: DMSetFromOptions()
4779a42bb27SBarry Smith @*/
4787087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
4799a42bb27SBarry Smith {
4809a42bb27SBarry Smith   PetscErrorCode ierr;
4819a42bb27SBarry Smith 
4829a42bb27SBarry Smith   PetscFunctionBegin;
4839a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4849a42bb27SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
485691be533SLawrence Mitchell   if (dm->sf) {
486691be533SLawrence Mitchell     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
487691be533SLawrence Mitchell   }
4881bb6d2a8SBarry Smith   if (dm->sectionSF) {
4891bb6d2a8SBarry Smith     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr);
490691be533SLawrence Mitchell   }
4919a42bb27SBarry Smith   PetscFunctionReturn(0);
4929a42bb27SBarry Smith }
4939a42bb27SBarry Smith 
49431697293SDave May /*@C
49531697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
49631697293SDave May    DM options in the database.
49731697293SDave May 
498d083f849SBarry Smith    Logically Collective on dm
49931697293SDave May 
50031697293SDave May    Input Parameters:
50131697293SDave May +  dm - the DM context
50231697293SDave May -  prefix - the prefix string to prepend to all DM option requests
50331697293SDave May 
50431697293SDave May    Notes:
50531697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
50631697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
50731697293SDave May 
50831697293SDave May    Level: advanced
50931697293SDave May 
51031697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
51131697293SDave May @*/
51231697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
51331697293SDave May {
51431697293SDave May   PetscErrorCode ierr;
51531697293SDave May 
51631697293SDave May   PetscFunctionBegin;
51731697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
51831697293SDave May   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
51931697293SDave May   PetscFunctionReturn(0);
52031697293SDave May }
52131697293SDave May 
52231697293SDave May /*@C
52331697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
52431697293SDave May    DM options in the database.
52531697293SDave May 
52631697293SDave May    Not Collective
52731697293SDave May 
52831697293SDave May    Input Parameters:
52931697293SDave May .  dm - the DM context
53031697293SDave May 
53131697293SDave May    Output Parameters:
53231697293SDave May .  prefix - pointer to the prefix string used is returned
53331697293SDave May 
53495452b02SPatrick Sanan    Notes:
53595452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prefix' of
53631697293SDave May    sufficient length to hold the prefix.
53731697293SDave May 
53831697293SDave May    Level: advanced
53931697293SDave May 
54031697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
54131697293SDave May @*/
54231697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
54331697293SDave May {
54431697293SDave May   PetscErrorCode ierr;
54531697293SDave May 
54631697293SDave May   PetscFunctionBegin;
54731697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
54831697293SDave May   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
54931697293SDave May   PetscFunctionReturn(0);
55031697293SDave May }
55131697293SDave May 
55288bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
55388bdff64SToby Isaac {
5546eb26441SStefano Zampini   PetscInt       refct = ((PetscObject) dm)->refct;
55588bdff64SToby Isaac   PetscErrorCode ierr;
55688bdff64SToby Isaac 
55788bdff64SToby Isaac   PetscFunctionBegin;
558aab5bcd8SJed Brown   *ncrefct = 0;
55988bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
56088bdff64SToby Isaac     refct--;
56188bdff64SToby Isaac     if (recurseCoarse) {
56288bdff64SToby Isaac       PetscInt coarseCount;
56388bdff64SToby Isaac 
56488bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
56588bdff64SToby Isaac       refct += coarseCount;
56688bdff64SToby Isaac     }
56788bdff64SToby Isaac   }
56888bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
56988bdff64SToby Isaac     refct--;
57088bdff64SToby Isaac     if (recurseFine) {
57188bdff64SToby Isaac       PetscInt fineCount;
57288bdff64SToby Isaac 
57388bdff64SToby Isaac       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
57488bdff64SToby Isaac       refct += fineCount;
57588bdff64SToby Isaac     }
57688bdff64SToby Isaac   }
57788bdff64SToby Isaac   *ncrefct = refct;
57888bdff64SToby Isaac   PetscFunctionReturn(0);
57988bdff64SToby Isaac }
58088bdff64SToby Isaac 
581f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm)
582354557abSToby Isaac {
5835d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
584354557abSToby Isaac   PetscErrorCode ierr;
585354557abSToby Isaac 
586354557abSToby Isaac   PetscFunctionBegin;
587354557abSToby Isaac   /* destroy the labels */
588354557abSToby Isaac   while (next) {
589354557abSToby Isaac     DMLabelLink tmp = next->next;
590354557abSToby Isaac 
5915d80c0bfSVaclav Hapla     if (next->label == dm->depthLabel)    dm->depthLabel    = NULL;
592ba2698f1SMatthew G. Knepley     if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL;
593354557abSToby Isaac     ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
594354557abSToby Isaac     ierr = PetscFree(next);CHKERRQ(ierr);
595354557abSToby Isaac     next = tmp;
596354557abSToby Isaac   }
5975d80c0bfSVaclav Hapla   dm->labels = NULL;
598354557abSToby Isaac   PetscFunctionReturn(0);
599354557abSToby Isaac }
600354557abSToby Isaac 
6011fb7b255SJunchao Zhang /*@C
6028472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
60347c6ae99SBarry Smith 
604d083f849SBarry Smith     Collective on dm
60547c6ae99SBarry Smith 
60647c6ae99SBarry Smith     Input Parameter:
60747c6ae99SBarry Smith .   dm - the DM object to destroy
60847c6ae99SBarry Smith 
60947c6ae99SBarry Smith     Level: developer
61047c6ae99SBarry Smith 
611e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
61247c6ae99SBarry Smith 
61347c6ae99SBarry Smith @*/
614fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
61547c6ae99SBarry Smith {
6166eb26441SStefano Zampini   PetscInt       cnt;
617dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
61847c6ae99SBarry Smith   PetscErrorCode ierr;
61947c6ae99SBarry Smith 
62047c6ae99SBarry Smith   PetscFunctionBegin;
6216bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
6226bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
62387e657c6SBarry Smith 
62488bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
62588bdff64SToby Isaac   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
62688bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
627ea78f98cSLisandro Dalcin   if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);}
6286bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
6296bf464f9SBarry Smith   ((PetscObject)(*dm))->refct = 0;
6306eb26441SStefano Zampini 
6316eb26441SStefano Zampini   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
6326eb26441SStefano Zampini   ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr);
6336eb26441SStefano Zampini 
634f490541aSPeter Brune   nnext=(*dm)->namedglobal;
6350298fd71SBarry Smith   (*dm)->namedglobal = NULL;
636f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
6372348bcf4SPeter Brune     nnext = nlink->next;
6382c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
6392348bcf4SPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
6402348bcf4SPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
6412348bcf4SPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
6422348bcf4SPeter Brune   }
643f490541aSPeter Brune   nnext=(*dm)->namedlocal;
6440298fd71SBarry Smith   (*dm)->namedlocal = NULL;
645f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
646f490541aSPeter Brune     nnext = nlink->next;
6472c71b3e2SJacob Faibussowitsch     PetscCheckFalse(nlink->status != DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
648f490541aSPeter Brune     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
649f490541aSPeter Brune     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
650f490541aSPeter Brune     ierr = PetscFree(nlink);CHKERRQ(ierr);
651f490541aSPeter Brune   }
6522348bcf4SPeter Brune 
653b17ce1afSJed Brown   /* Destroy the list of hooks */
654c833c3b5SJed Brown   {
655c833c3b5SJed Brown     DMCoarsenHookLink link,next;
656b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
657b17ce1afSJed Brown       next = link->next;
658b17ce1afSJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
659b17ce1afSJed Brown     }
6600298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
661c833c3b5SJed Brown   }
662c833c3b5SJed Brown   {
663c833c3b5SJed Brown     DMRefineHookLink link,next;
664c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
665c833c3b5SJed Brown       next = link->next;
666c833c3b5SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
667c833c3b5SJed Brown     }
6680298fd71SBarry Smith     (*dm)->refinehook = NULL;
669c833c3b5SJed Brown   }
670be081cd6SPeter Brune   {
671be081cd6SPeter Brune     DMSubDomainHookLink link,next;
672be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
673be081cd6SPeter Brune       next = link->next;
674be081cd6SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
675be081cd6SPeter Brune     }
6760298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
677be081cd6SPeter Brune   }
678baf369e7SPeter Brune   {
679baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
680baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
681baf369e7SPeter Brune       next = link->next;
682baf369e7SPeter Brune       ierr = PetscFree(link);CHKERRQ(ierr);
683baf369e7SPeter Brune     }
6840298fd71SBarry Smith     (*dm)->gtolhook = NULL;
685baf369e7SPeter Brune   }
686d4d07f1eSToby Isaac   {
687d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
688d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
689d4d07f1eSToby Isaac       next = link->next;
690d4d07f1eSToby Isaac       ierr = PetscFree(link);CHKERRQ(ierr);
691d4d07f1eSToby Isaac     }
692d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
693d4d07f1eSToby Isaac   }
694aa1993deSMatthew G Knepley   /* Destroy the work arrays */
695aa1993deSMatthew G Knepley   {
696aa1993deSMatthew G Knepley     DMWorkLink link,next;
6972c71b3e2SJacob Faibussowitsch     PetscCheckFalse((*dm)->workout,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
698aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
699aa1993deSMatthew G Knepley       next = link->next;
700aa1993deSMatthew G Knepley       ierr = PetscFree(link->mem);CHKERRQ(ierr);
701aa1993deSMatthew G Knepley       ierr = PetscFree(link);CHKERRQ(ierr);
702aa1993deSMatthew G Knepley     }
7030298fd71SBarry Smith     (*dm)->workin = NULL;
704aa1993deSMatthew G Knepley   }
705c58f1c22SToby Isaac   /* destroy the labels */
706f4cdcedcSVaclav Hapla   ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr);
707f4cdcedcSVaclav Hapla   /* destroy the fields */
708e5e52638SMatthew G. Knepley   ierr = DMClearFields(*dm);CHKERRQ(ierr);
709f4cdcedcSVaclav Hapla   /* destroy the boundaries */
710e6f8dbb6SToby Isaac   {
711e6f8dbb6SToby Isaac     DMBoundary next = (*dm)->boundary;
712e6f8dbb6SToby Isaac     while (next) {
713e6f8dbb6SToby Isaac       DMBoundary b = next;
714e6f8dbb6SToby Isaac 
715e6f8dbb6SToby Isaac       next = b->next;
716e6f8dbb6SToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
717e6f8dbb6SToby Isaac     }
718e6f8dbb6SToby Isaac   }
719b17ce1afSJed Brown 
72052536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
72152536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
72252536dc3SBarry Smith   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
72352536dc3SBarry Smith 
7241a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
7251a266240SBarry Smith     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
7261a266240SBarry Smith   }
72771cd77b2SBarry Smith   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
7286bf464f9SBarry Smith   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
7296bf464f9SBarry Smith   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
730073dac72SJed Brown   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
73188ed4aceSMatthew G Knepley 
7321bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr);
7331bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr);
7348b1ab98fSJed Brown   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
7353b8ba7d1SJed Brown   ierr = PetscSectionDestroy(&(*dm)->defaultConstraint.section);CHKERRQ(ierr);
7363b8ba7d1SJed Brown   ierr = MatDestroy(&(*dm)->defaultConstraint.mat);CHKERRQ(ierr);
73788ed4aceSMatthew G Knepley   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
7381bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr);
739736995cdSBlaise Bourdin   if ((*dm)->useNatural) {
740736995cdSBlaise Bourdin     if ((*dm)->sfNatural) {
7418e4ac7eaSMatthew G. Knepley       ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
742736995cdSBlaise Bourdin     }
743736995cdSBlaise Bourdin     ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr);
744736995cdSBlaise Bourdin   }
7459a2a23afSMatthew G. Knepley   {
7469a2a23afSMatthew G. Knepley     Vec     *auxData;
7479a2a23afSMatthew G. Knepley     PetscInt n, i, off = 0;
7489a2a23afSMatthew G. Knepley 
7499a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxGetSize((*dm)->auxData, &n);CHKERRQ(ierr);
7509a2a23afSMatthew G. Knepley     ierr = PetscMalloc1(n, &auxData);CHKERRQ(ierr);
7519a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxGetVals((*dm)->auxData, &off, auxData);CHKERRQ(ierr);
7529a2a23afSMatthew G. Knepley     for (i = 0; i < n; ++i) {ierr = VecDestroy(&auxData[i]);CHKERRQ(ierr);}
7539a2a23afSMatthew G. Knepley     ierr = PetscFree(auxData);CHKERRQ(ierr);
7549a2a23afSMatthew G. Knepley     ierr = PetscHMapAuxDestroy(&(*dm)->auxData);CHKERRQ(ierr);
7559a2a23afSMatthew G. Knepley   }
75688bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
75788bdff64SToby Isaac     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
75888bdff64SToby Isaac   }
7596eb26441SStefano Zampini 
760a8fb8f29SToby Isaac   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
76188bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
76288bdff64SToby Isaac     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
76388bdff64SToby Isaac   }
76488bdff64SToby Isaac   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
765f19dbd58SToby Isaac   ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr);
7666636e97aSMatthew G Knepley   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
7676636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
7686636e97aSMatthew G Knepley   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
769412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->L);CHKERRQ(ierr);
770412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr);
771412e9a14SMatthew G. Knepley   ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr);
772ca3d3a14SMatthew G. Knepley   if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);}
773ca3d3a14SMatthew G. Knepley   ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr);
774ca3d3a14SMatthew G. Knepley   ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr);
7756636e97aSMatthew G Knepley 
776e5e52638SMatthew G. Knepley   ierr = DMClearDS(*dm);CHKERRQ(ierr);
77714f150ffSMatthew G. Knepley   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
778e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
779e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
780732e2eb9SMatthew G Knepley 
781ed3c66a1SDave May   if ((*dm)->ops->destroy) {
7826bf464f9SBarry Smith     ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
783ed3c66a1SDave May   }
784c0f0dcc3SMatthew G. Knepley   ierr = DMMonitorCancel(*dm);CHKERRQ(ierr);
785f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
786a2c9b50fSJeremy L Thompson   ierr = CeedElemRestrictionDestroy(&(*dm)->ceedERestrict);CHKERRQ_CEED(ierr);
787a2c9b50fSJeremy L Thompson   ierr = CeedDestroy(&(*dm)->ceed);CHKERRQ_CEED(ierr);
788f918ec44SMatthew G. Knepley #endif
789435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
790732e2eb9SMatthew G Knepley   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
79147c6ae99SBarry Smith   PetscFunctionReturn(0);
79247c6ae99SBarry Smith }
79347c6ae99SBarry Smith 
794d7bf68aeSBarry Smith /*@
795d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
796d7bf68aeSBarry Smith 
797d083f849SBarry Smith     Collective on dm
798d7bf68aeSBarry Smith 
799d7bf68aeSBarry Smith     Input Parameter:
800d7bf68aeSBarry Smith .   dm - the DM object to setup
801d7bf68aeSBarry Smith 
802d7bf68aeSBarry Smith     Level: developer
803d7bf68aeSBarry Smith 
804e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
805d7bf68aeSBarry Smith 
806d7bf68aeSBarry Smith @*/
8077087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
808d7bf68aeSBarry Smith {
809d7bf68aeSBarry Smith   PetscErrorCode ierr;
810d7bf68aeSBarry Smith 
811d7bf68aeSBarry Smith   PetscFunctionBegin;
812171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8138387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
814d7bf68aeSBarry Smith   if (dm->ops->setup) {
815d7bf68aeSBarry Smith     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
816d7bf68aeSBarry Smith   }
8178387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
818d7bf68aeSBarry Smith   PetscFunctionReturn(0);
819d7bf68aeSBarry Smith }
820d7bf68aeSBarry Smith 
821d7bf68aeSBarry Smith /*@
822d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
823d7bf68aeSBarry Smith 
824d083f849SBarry Smith     Collective on dm
825d7bf68aeSBarry Smith 
826d7bf68aeSBarry Smith     Input Parameter:
827d7bf68aeSBarry Smith .   dm - the DM object to set options for
828d7bf68aeSBarry Smith 
829732e2eb9SMatthew G Knepley     Options Database:
8304164ae61SDominic Meiser +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
8314164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
8324164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
833a4ea9b21SRichard Tran Mills .   -dm_is_coloring_type - <global or local>
834a4ea9b21SRichard 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
835732e2eb9SMatthew G Knepley 
8369318fe57SMatthew G. Knepley     DMPLEX Specific creation options
8379318fe57SMatthew G. Knepley + -dm_plex_filename <str>           - File containing a mesh
8389318fe57SMatthew G. Knepley . -dm_plex_boundary_filename <str>  - File containing a mesh boundary
839cd7e8a5eSksagiyam . -dm_plex_name <str>               - Name of the mesh in the file
8409318fe57SMatthew G. Knepley . -dm_plex_shape <shape>            - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc.
8419318fe57SMatthew G. Knepley . -dm_plex_cell <ct>                - Cell shape
8429318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain
8439318fe57SMatthew G. Knepley . -dm_plex_dim <dim>                - Set the topological dimension
8449318fe57SMatthew G. Knepley . -dm_plex_simplex <bool>           - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements
8459318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool>       - PETSC_TRUE turns on topological interpolation (creating edges and faces)
8469318fe57SMatthew G. Knepley . -dm_plex_scale <sc>               - Scale factor for mesh coordinates
8479318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p>        - Number of faces along each dimension
8489318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z>        - Specify lower-left-bottom coordinates for the box
8499318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z>        - Specify upper-right-top coordinates for the box
8509318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz>        - Specify the DMBoundaryType for each direction
8519318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r>        - The sphere radius
8529318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r>          - Radius of the ball
8539318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz>         - Boundary type in the z direction
8549318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n>  - Number of wedges around the cylinder
855bdf63967SMatthew G. Knepley . -dm_plex_reorder <order>          - Reorder the mesh using the specified algorithm
8569318fe57SMatthew G. Knepley . -dm_refine_pre <n>                - The number of refinements before distribution
8579318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool>     - Flag for uniform refinement before distribution
8589318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v>   - The maximum cell volume after refinement before distribution
8599318fe57SMatthew G. Knepley . -dm_refine <n>                    - The number of refinements after distribution
860bdf63967SMatthew G. Knepley . -dm_extrude <l>                   - Activate extrusion and specify the number of layers to extrude
861d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thickness <t>           - The total thickness of extruded layers
862d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_use_tensor <bool>       - Use tensor cells when extruding
863d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_symmetric <bool>        - Extrude layers symmetrically about the surface
864d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_normal <n0,...,nd>      - Specify the extrusion direction
865d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thicknesses <t0,...,tl> - Specify thickness of each layer
866909dfd52SMatthew G. Knepley . -dm_plex_create_fv_ghost_cells    - Flag to create finite volume ghost cells on the boundary
867909dfd52SMatthew G. Knepley . -dm_plex_fv_ghost_cells_label <name> - Label name for ghost cells boundary
8689318fe57SMatthew G. Knepley . -dm_distribute <bool>             - Flag to redistribute a mesh among processes
8699318fe57SMatthew G. Knepley . -dm_distribute_overlap <n>        - The size of the overlap halo
8709318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool>          - Set adjacency direction
8719318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool>       - Set adjacency size
8729318fe57SMatthew G. Knepley 
873384a6580SVaclav Hapla     DMPLEX Specific Checks
874384a6580SVaclav Hapla +   -dm_plex_check_symmetry        - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry()
875384a6580SVaclav Hapla .   -dm_plex_check_skeleton        - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton()
876384a6580SVaclav 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()
877384a6580SVaclav Hapla .   -dm_plex_check_geometry        - Check that cells have positive volume - DMPlexCheckGeometry()
878384a6580SVaclav Hapla .   -dm_plex_check_pointsf         - Check some necessary conditions for PointSF - DMPlexCheckPointSF()
879384a6580SVaclav Hapla .   -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones()
880384a6580SVaclav Hapla -   -dm_plex_check_all             - Perform all the checks above
881d7bf68aeSBarry Smith 
88295eb5ee5SVaclav Hapla     Level: intermediate
88395eb5ee5SVaclav Hapla 
88495eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(),
88595eb5ee5SVaclav Hapla     DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones()
886d7bf68aeSBarry Smith 
887d7bf68aeSBarry Smith @*/
8887087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm)
889d7bf68aeSBarry Smith {
8907781c08eSBarry Smith   char           typeName[256];
891ca266f36SBarry Smith   PetscBool      flg;
892d7bf68aeSBarry Smith   PetscErrorCode ierr;
893d7bf68aeSBarry Smith 
894d7bf68aeSBarry Smith   PetscFunctionBegin;
895171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
89649be4549SMatthew G. Knepley   dm->setfromoptionscalled = PETSC_TRUE;
89749be4549SMatthew G. Knepley   if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);}
8981bb6d2a8SBarry Smith   if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);}
8993194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
9000298fd71SBarry 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);
901a264d7a6SBarry Smith   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
902f9ba7244SBarry Smith   if (flg) {
903f9ba7244SBarry Smith     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
904f9ba7244SBarry Smith   }
905a264d7a6SBarry 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);
906073dac72SJed Brown   if (flg) {
907521d9a4cSLisandro Dalcin     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
908073dac72SJed Brown   }
9098f1509bcSBarry Smith   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
910a4ea9b21SRichard 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);
911f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
912e55864a3SBarry Smith     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
913f9ba7244SBarry Smith   }
914f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
9150633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
91682fcb398SMatthew G Knepley   ierr = PetscOptionsEnd();CHKERRQ(ierr);
917d7bf68aeSBarry Smith   PetscFunctionReturn(0);
918d7bf68aeSBarry Smith }
919d7bf68aeSBarry Smith 
920fc9bc008SSatish Balay /*@C
921fe2efc57SMark    DMViewFromOptions - View from Options
922fe2efc57SMark 
923fe2efc57SMark    Collective on DM
924fe2efc57SMark 
925fe2efc57SMark    Input Parameters:
926fe2efc57SMark +  dm - the DM object
927736c3998SJose E. Roman .  obj - Optional object
928736c3998SJose E. Roman -  name - command line option
929fe2efc57SMark 
930fe2efc57SMark    Level: intermediate
931fe2efc57SMark .seealso:  DM, DMView, PetscObjectViewFromOptions(), DMCreate()
932fe2efc57SMark @*/
933fe2efc57SMark PetscErrorCode  DMViewFromOptions(DM dm,PetscObject obj,const char name[])
934fe2efc57SMark {
935fe2efc57SMark   PetscErrorCode ierr;
936fe2efc57SMark 
937fe2efc57SMark   PetscFunctionBegin;
938fe2efc57SMark   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
939fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr);
940fe2efc57SMark   PetscFunctionReturn(0);
941fe2efc57SMark }
942fe2efc57SMark 
943fe2efc57SMark /*@C
944224748a4SBarry Smith     DMView - Views a DM
94547c6ae99SBarry Smith 
946d083f849SBarry Smith     Collective on dm
94747c6ae99SBarry Smith 
948d8d19677SJose E. Roman     Input Parameters:
94947c6ae99SBarry Smith +   dm - the DM object to view
95047c6ae99SBarry Smith -   v - the viewer
95147c6ae99SBarry Smith 
952cd7e8a5eSksagiyam     Notes:
953cd7e8a5eSksagiyam     Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex
954cd7e8a5eSksagiyam     meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName()
955cd7e8a5eSksagiyam     before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object.
956cd7e8a5eSksagiyam 
957224748a4SBarry Smith     Level: beginner
95847c6ae99SBarry Smith 
959cd7e8a5eSksagiyam .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMLoad(), PetscObjectSetName()
96047c6ae99SBarry Smith 
96147c6ae99SBarry Smith @*/
9627087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
96347c6ae99SBarry Smith {
96447c6ae99SBarry Smith   PetscErrorCode    ierr;
96532c0f0efSBarry Smith   PetscBool         isbinary;
96676a8abe0SBarry Smith   PetscMPIInt       size;
96776a8abe0SBarry Smith   PetscViewerFormat format;
96847c6ae99SBarry Smith 
96947c6ae99SBarry Smith   PetscFunctionBegin;
970171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9713014e516SBarry Smith   if (!v) {
972ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
9733014e516SBarry Smith   }
974b1b135c8SBarry Smith   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2);
97574903a4fSStefano Zampini   /* Ideally, we would like to have this test on.
97674903a4fSStefano Zampini      However, it currently breaks socket viz via GLVis.
97774903a4fSStefano Zampini      During DMView(parallel_mesh,glvis_viewer), each
97874903a4fSStefano Zampini      process opens a sequential ASCII socket to visualize
97974903a4fSStefano Zampini      the local mesh, and PetscObjectView(dm,local_socket)
98074903a4fSStefano Zampini      is internally called inside VecView_GLVis, incurring
98174903a4fSStefano Zampini      in an error here */
98274903a4fSStefano Zampini   /* PetscCheckSameComm(dm,1,v,2); */
9838bfd1ab9SVaclav Hapla   ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr);
984b1b135c8SBarry Smith 
98576a8abe0SBarry Smith   ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr);
986ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRMPI(ierr);
98776a8abe0SBarry Smith   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0);
98898c3331eSBarry Smith   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
98932c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
99032c0f0efSBarry Smith   if (isbinary) {
99155849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
99232c0f0efSBarry Smith     char     type[256];
99332c0f0efSBarry Smith 
994f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr);
99532c0f0efSBarry Smith     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
996f253e43cSLisandro Dalcin     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr);
99732c0f0efSBarry Smith   }
9980c010503SBarry Smith   if (dm->ops->view) {
9990c010503SBarry Smith     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
100047c6ae99SBarry Smith   }
100147c6ae99SBarry Smith   PetscFunctionReturn(0);
100247c6ae99SBarry Smith }
100347c6ae99SBarry Smith 
100447c6ae99SBarry Smith /*@
10058472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
100647c6ae99SBarry Smith 
1007d083f849SBarry Smith     Collective on dm
100847c6ae99SBarry Smith 
100947c6ae99SBarry Smith     Input Parameter:
101047c6ae99SBarry Smith .   dm - the DM object
101147c6ae99SBarry Smith 
101247c6ae99SBarry Smith     Output Parameter:
101347c6ae99SBarry Smith .   vec - the global vector
101447c6ae99SBarry Smith 
1015073dac72SJed Brown     Level: beginner
101647c6ae99SBarry Smith 
1017ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
101847c6ae99SBarry Smith 
101947c6ae99SBarry Smith @*/
10207087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
102147c6ae99SBarry Smith {
102247c6ae99SBarry Smith   PetscErrorCode ierr;
102347c6ae99SBarry Smith 
102447c6ae99SBarry Smith   PetscFunctionBegin;
1025171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1026b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
10272c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createglobalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name);
102847c6ae99SBarry Smith   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
102976bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1030c6b011d8SStefano Zampini     DM vdm;
1031c6b011d8SStefano Zampini 
1032c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
10332c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name);
1034c6b011d8SStefano Zampini   }
103547c6ae99SBarry Smith   PetscFunctionReturn(0);
103647c6ae99SBarry Smith }
103747c6ae99SBarry Smith 
103847c6ae99SBarry Smith /*@
10398472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
104047c6ae99SBarry Smith 
104147c6ae99SBarry Smith     Not Collective
104247c6ae99SBarry Smith 
104347c6ae99SBarry Smith     Input Parameter:
104447c6ae99SBarry Smith .   dm - the DM object
104547c6ae99SBarry Smith 
104647c6ae99SBarry Smith     Output Parameter:
104747c6ae99SBarry Smith .   vec - the local vector
104847c6ae99SBarry Smith 
1049073dac72SJed Brown     Level: beginner
105047c6ae99SBarry Smith 
1051ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
105247c6ae99SBarry Smith 
105347c6ae99SBarry Smith @*/
10547087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
105547c6ae99SBarry Smith {
105647c6ae99SBarry Smith   PetscErrorCode ierr;
105747c6ae99SBarry Smith 
105847c6ae99SBarry Smith   PetscFunctionBegin;
1059171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1060b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
10612c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createlocalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name);
106247c6ae99SBarry Smith   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
106376bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1064c6b011d8SStefano Zampini     DM vdm;
1065c6b011d8SStefano Zampini 
1066c6b011d8SStefano Zampini     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
10672c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!vdm,PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name);
1068c6b011d8SStefano Zampini   }
106947c6ae99SBarry Smith   PetscFunctionReturn(0);
107047c6ae99SBarry Smith }
107147c6ae99SBarry Smith 
10721411c6eeSJed Brown /*@
10731411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
10741411c6eeSJed Brown 
1075d083f849SBarry Smith    Collective on dm
10761411c6eeSJed Brown 
10771411c6eeSJed Brown    Input Parameter:
10781411c6eeSJed Brown .  dm - the DM that provides the mapping
10791411c6eeSJed Brown 
10801411c6eeSJed Brown    Output Parameter:
10811411c6eeSJed Brown .  ltog - the mapping
10821411c6eeSJed Brown 
10831411c6eeSJed Brown    Level: intermediate
10841411c6eeSJed Brown 
10851411c6eeSJed Brown    Notes:
10861411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
10871411c6eeSJed Brown    MatSetLocalToGlobalMapping().
10881411c6eeSJed Brown 
1089fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
10901411c6eeSJed Brown @*/
10917087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
10921411c6eeSJed Brown {
10930be3e97aSMatthew G. Knepley   PetscInt       bs = -1, bsLocal[2], bsMinMax[2];
10941411c6eeSJed Brown   PetscErrorCode ierr;
10951411c6eeSJed Brown 
10961411c6eeSJed Brown   PetscFunctionBegin;
10971411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
10981411c6eeSJed Brown   PetscValidPointer(ltog,2);
10991411c6eeSJed Brown   if (!dm->ltogmap) {
110037d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
110137d0c07bSMatthew G Knepley 
110292fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
110337d0c07bSMatthew G Knepley     if (section) {
1104a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
110537d0c07bSMatthew G Knepley       PetscInt       *ltog;
1106ccf3bd66SMatthew G. Knepley       PetscInt        pStart, pEnd, n, p, k, l;
110737d0c07bSMatthew G Knepley 
1108e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
110937d0c07bSMatthew G Knepley       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
1110ccf3bd66SMatthew G. Knepley       ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr);
1111ccf3bd66SMatthew G. Knepley       ierr = PetscMalloc1(n, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
111237d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
1113e6befd46SJed Brown         PetscInt bdof, cdof, dof, off, c, cind;
111437d0c07bSMatthew G Knepley 
111537d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
111637d0c07bSMatthew G Knepley         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
1117a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
1118a974ec88SMatthew G. Knepley         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
111937d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
11201a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
11211a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
11221a7dc684SMatthew G. Knepley         if (dof) {
1123b190aa46SMatthew G. Knepley           if (bs < 0)          {bs = bdof;}
1124b190aa46SMatthew G. Knepley           else if (bs != bdof) {bs = 1;}
11251a7dc684SMatthew G. Knepley         }
1126e6befd46SJed Brown         for (c = 0, cind = 0; c < dof; ++c, ++l) {
1127e6befd46SJed Brown           if ((cind < cdof) && (c == cdofs[cind])) {
1128e6befd46SJed Brown             ltog[l] = off < 0 ? off-c : -(off+c+1);
1129e6befd46SJed Brown             cind++;
1130e6befd46SJed Brown           } else {
1131e6befd46SJed Brown             ltog[l] = (off < 0 ? -(off+1) : off) + c;
1132e6befd46SJed Brown           }
113337d0c07bSMatthew G Knepley         }
113437d0c07bSMatthew G Knepley       }
1135bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
11360be3e97aSMatthew G. Knepley       bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs;
11370be3e97aSMatthew G. Knepley       ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr);
11380be3e97aSMatthew G. Knepley       if (bsMinMax[0] != bsMinMax[1]) {bs = 1;}
11390be3e97aSMatthew G. Knepley       else                            {bs = bsMinMax[0];}
11407591dbb2SMatthew G. Knepley       bs = bs < 0 ? 1 : bs;
11417591dbb2SMatthew G. Knepley       /* Must reduce indices by blocksize */
1142ccf3bd66SMatthew G. Knepley       if (bs > 1) {
1143ca469d19SJed Brown         for (l = 0, k = 0; l < n; l += bs, ++k) {
1144ca469d19SJed Brown           // Integer division of negative values truncates toward zero(!), not toward negative infinity
1145ca469d19SJed Brown           ltog[k] = ltog[l] >= 0 ? ltog[l]/bs : -(-(ltog[l]+1)/bs + 1);
1146ca469d19SJed Brown         }
1147ccf3bd66SMatthew G. Knepley         n /= bs;
1148ccf3bd66SMatthew G. Knepley       }
1149ccf3bd66SMatthew G. Knepley       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
11503bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
115137d0c07bSMatthew G Knepley     } else {
11522c71b3e2SJacob Faibussowitsch       PetscCheckFalse(!dm->ops->getlocaltoglobalmapping,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name);
1153184d77edSJed Brown       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
11541411c6eeSJed Brown     }
115537d0c07bSMatthew G Knepley   }
11561411c6eeSJed Brown   *ltog = dm->ltogmap;
11571411c6eeSJed Brown   PetscFunctionReturn(0);
11581411c6eeSJed Brown }
11591411c6eeSJed Brown 
11601411c6eeSJed Brown /*@
11611411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
11621411c6eeSJed Brown 
11631411c6eeSJed Brown    Not Collective
11641411c6eeSJed Brown 
11651411c6eeSJed Brown    Input Parameter:
11661411c6eeSJed Brown .  dm - the DM with block structure
11671411c6eeSJed Brown 
11681411c6eeSJed Brown    Output Parameter:
11691411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
11701411c6eeSJed Brown 
11711411c6eeSJed Brown    Level: intermediate
11721411c6eeSJed Brown 
1173fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
11741411c6eeSJed Brown @*/
11757087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
11761411c6eeSJed Brown {
11771411c6eeSJed Brown   PetscFunctionBegin;
11781411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1179534a8f05SLisandro Dalcin   PetscValidIntPointer(bs,2);
11802c71b3e2SJacob Faibussowitsch   PetscCheckFalse(dm->bs < 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet");
11811411c6eeSJed Brown   *bs = dm->bs;
11821411c6eeSJed Brown   PetscFunctionReturn(0);
11831411c6eeSJed Brown }
11841411c6eeSJed Brown 
118548eeb7c8SBarry Smith /*@C
11868472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
118747c6ae99SBarry Smith 
1188a5bc1bf3SBarry Smith     Collective on dmc
118947c6ae99SBarry Smith 
1190d8d19677SJose E. Roman     Input Parameters:
1191a5bc1bf3SBarry Smith +   dmc - the DM object
1192a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
119347c6ae99SBarry Smith 
1194d8d19677SJose E. Roman     Output Parameters:
119547c6ae99SBarry Smith +  mat - the interpolation
119647c6ae99SBarry Smith -  vec - the scaling (optional)
119747c6ae99SBarry Smith 
119847c6ae99SBarry Smith     Level: developer
119947c6ae99SBarry Smith 
120095452b02SPatrick Sanan     Notes:
120195452b02SPatrick Sanan     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
120285afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1203d52bd9f3SBarry Smith 
12041f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1205d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
120685afcc9aSBarry Smith 
12072ed6491fSPatrick Sanan .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale()
120847c6ae99SBarry Smith 
120947c6ae99SBarry Smith @*/
1210a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec)
121147c6ae99SBarry Smith {
121247c6ae99SBarry Smith   PetscErrorCode ierr;
121347c6ae99SBarry Smith 
121447c6ae99SBarry Smith   PetscFunctionBegin;
1215a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1216a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1217c7d20fa0SStefano Zampini   PetscValidPointer(mat,3);
12182c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dmc->ops->createinterpolation,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name);
1219a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
1220a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr);
1221a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
122247c6ae99SBarry Smith   PetscFunctionReturn(0);
122347c6ae99SBarry Smith }
122447c6ae99SBarry Smith 
12253ad4599aSBarry Smith /*@
1226d3e313eaSPatrick Sanan     DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction.
12272ed6491fSPatrick Sanan 
12282ed6491fSPatrick Sanan   Input Parameters:
12292ed6491fSPatrick Sanan +      dac - DM that defines a coarse mesh
12302ed6491fSPatrick Sanan .      daf - DM that defines a fine mesh
12312ed6491fSPatrick Sanan -      mat - the restriction (or interpolation operator) from fine to coarse
12322ed6491fSPatrick Sanan 
12332ed6491fSPatrick Sanan   Output Parameter:
12342ed6491fSPatrick Sanan .    scale - the scaled vector
12352ed6491fSPatrick Sanan 
12362ed6491fSPatrick Sanan   Level: developer
12372ed6491fSPatrick Sanan 
1238e9c74fd6SRichard Tran Mills   Developer Notes:
1239e9c74fd6SRichard Tran Mills   If the fine-scale DMDA has the -dm_bind_below option set to true, then DMCreateInterpolationScale() calls MatSetBindingPropagates()
1240e9c74fd6SRichard Tran Mills   on the restriction/interpolation operator to set the bindingpropagates flag to true.
1241e9c74fd6SRichard Tran Mills 
12422ed6491fSPatrick Sanan .seealso: DMCreateInterpolation()
12432ed6491fSPatrick Sanan 
12442ed6491fSPatrick Sanan @*/
12452ed6491fSPatrick Sanan PetscErrorCode  DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale)
12462ed6491fSPatrick Sanan {
12472ed6491fSPatrick Sanan   PetscErrorCode ierr;
12482ed6491fSPatrick Sanan   Vec            fine;
12492ed6491fSPatrick Sanan   PetscScalar    one = 1.0;
12509704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
1251e9c74fd6SRichard Tran Mills   PetscBool      bindingpropagates,isbound;
12529704db99SRichard Tran Mills #endif
12532ed6491fSPatrick Sanan 
12542ed6491fSPatrick Sanan   PetscFunctionBegin;
12552ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr);
12562ed6491fSPatrick Sanan   ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr);
12572ed6491fSPatrick Sanan   ierr = VecSet(fine,one);CHKERRQ(ierr);
12589704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
12599704db99SRichard Tran Mills   /* If the 'fine' Vec is bound to the CPU, it makes sense to bind 'mat' as well.
12609704db99SRichard Tran Mills    * Note that we only do this for the CUDA case, right now, but if we add support for MatMultTranspose() via ViennaCL,
12619704db99SRichard Tran Mills    * we'll need to do it for that case, too.*/
1262e9c74fd6SRichard Tran Mills   ierr = VecGetBindingPropagates(fine,&bindingpropagates);CHKERRQ(ierr);
1263e9c74fd6SRichard Tran Mills   if (bindingpropagates) {
1264b1538989SRichard Tran Mills     ierr = MatSetBindingPropagates(mat,PETSC_TRUE);CHKERRQ(ierr);
1265e9c74fd6SRichard Tran Mills     ierr = VecBoundToCPU(fine,&isbound);CHKERRQ(ierr);
1266e9c74fd6SRichard Tran Mills     ierr = MatBindToCPU(mat,isbound);CHKERRQ(ierr);
126783aa49f4SRichard Tran Mills   }
12689704db99SRichard Tran Mills #endif
12692ed6491fSPatrick Sanan   ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr);
12702ed6491fSPatrick Sanan   ierr = VecDestroy(&fine);CHKERRQ(ierr);
12712ed6491fSPatrick Sanan   ierr = VecReciprocal(*scale);CHKERRQ(ierr);
12722ed6491fSPatrick Sanan   PetscFunctionReturn(0);
12732ed6491fSPatrick Sanan }
12742ed6491fSPatrick Sanan 
12752ed6491fSPatrick Sanan /*@
12763ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
12773ad4599aSBarry Smith 
1278a5bc1bf3SBarry Smith     Collective on dmc
12793ad4599aSBarry Smith 
1280d8d19677SJose E. Roman     Input Parameters:
1281a5bc1bf3SBarry Smith +   dmc - the DM object
1282a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
12833ad4599aSBarry Smith 
12843ad4599aSBarry Smith     Output Parameter:
12853ad4599aSBarry Smith .  mat - the restriction
12863ad4599aSBarry Smith 
12873ad4599aSBarry Smith     Level: developer
12883ad4599aSBarry Smith 
128995452b02SPatrick Sanan     Notes:
129095452b02SPatrick Sanan     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
12913ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
12923ad4599aSBarry Smith 
12933ad4599aSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
12943ad4599aSBarry Smith 
12953ad4599aSBarry Smith @*/
1296a5bc1bf3SBarry Smith PetscErrorCode  DMCreateRestriction(DM dmc,DM dmf,Mat *mat)
12973ad4599aSBarry Smith {
12983ad4599aSBarry Smith   PetscErrorCode ierr;
12993ad4599aSBarry Smith 
13003ad4599aSBarry Smith   PetscFunctionBegin;
1301a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1302a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
13035a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13042c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dmc->ops->createrestriction,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name);
1305a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
1306a5bc1bf3SBarry Smith   ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr);
1307a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
13083ad4599aSBarry Smith   PetscFunctionReturn(0);
13093ad4599aSBarry Smith }
13103ad4599aSBarry Smith 
131147c6ae99SBarry Smith /*@
13128472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
131347c6ae99SBarry Smith 
1314a5bc1bf3SBarry Smith     Collective on dac
131547c6ae99SBarry Smith 
1316d8d19677SJose E. Roman     Input Parameters:
1317a5bc1bf3SBarry Smith +   dac - the DM object
1318a5bc1bf3SBarry Smith -   daf - the second, finer DM object
131947c6ae99SBarry Smith 
132047c6ae99SBarry Smith     Output Parameter:
13216dbf9973SLawrence Mitchell .   mat - the injection
132247c6ae99SBarry Smith 
132347c6ae99SBarry Smith     Level: developer
132447c6ae99SBarry Smith 
132595452b02SPatrick Sanan    Notes:
132695452b02SPatrick Sanan     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
132785afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
132885afcc9aSBarry Smith 
1329e727c939SJed Brown .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
133047c6ae99SBarry Smith 
133147c6ae99SBarry Smith @*/
1332a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInjection(DM dac,DM daf,Mat *mat)
133347c6ae99SBarry Smith {
133447c6ae99SBarry Smith   PetscErrorCode ierr;
133547c6ae99SBarry Smith 
133647c6ae99SBarry Smith   PetscFunctionBegin;
1337a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac,DM_CLASSID,1);
1338a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf,DM_CLASSID,2);
13395a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13402c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dac->ops->createinjection,PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name);
1341a5bc1bf3SBarry Smith   ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
1342a5bc1bf3SBarry Smith   ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr);
1343a5bc1bf3SBarry Smith   ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
134447c6ae99SBarry Smith   PetscFunctionReturn(0);
134547c6ae99SBarry Smith }
134647c6ae99SBarry Smith 
1347b412c318SBarry Smith /*@
1348bd041c0cSMatthew G. Knepley   DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j
1349bd041c0cSMatthew G. Knepley 
1350a5bc1bf3SBarry Smith   Collective on dac
1351bd041c0cSMatthew G. Knepley 
1352d8d19677SJose E. Roman   Input Parameters:
1353b4937a87SMatthew G. Knepley + dmc - the target DM object
1354b4937a87SMatthew G. Knepley - dmf - the source DM object
1355bd041c0cSMatthew G. Knepley 
1356bd041c0cSMatthew G. Knepley   Output Parameter:
1357b4937a87SMatthew G. Knepley . mat - the mass matrix
1358bd041c0cSMatthew G. Knepley 
1359bd041c0cSMatthew G. Knepley   Level: developer
1360bd041c0cSMatthew G. Knepley 
1361b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrixLumped(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1362bd041c0cSMatthew G. Knepley @*/
1363b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrix(DM dmc, DM dmf, Mat *mat)
1364bd041c0cSMatthew G. Knepley {
1365bd041c0cSMatthew G. Knepley   PetscErrorCode ierr;
1366bd041c0cSMatthew G. Knepley 
1367bd041c0cSMatthew G. Knepley   PetscFunctionBegin;
1368b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dmc, DM_CLASSID, 1);
1369b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dmf, DM_CLASSID, 2);
13705a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13712c71b3e2SJacob Faibussowitsch   PetscCheck(dmc->ops->createmassmatrix,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dmc)->type_name);
1372b4937a87SMatthew G. Knepley   ierr = (*dmc->ops->createmassmatrix)(dmc, dmf, mat);CHKERRQ(ierr);
1373b4937a87SMatthew G. Knepley   PetscFunctionReturn(0);
1374b4937a87SMatthew G. Knepley }
1375b4937a87SMatthew G. Knepley 
1376b4937a87SMatthew G. Knepley /*@
1377b4937a87SMatthew G. Knepley   DMCreateMassMatrixLumped - Gets the lumped mass matrix for a given DM
1378b4937a87SMatthew G. Knepley 
1379b4937a87SMatthew G. Knepley   Collective on dm
1380b4937a87SMatthew G. Knepley 
1381b4937a87SMatthew G. Knepley   Input Parameter:
1382b4937a87SMatthew G. Knepley . dm - the DM object
1383b4937a87SMatthew G. Knepley 
1384b4937a87SMatthew G. Knepley   Output Parameter:
1385b4937a87SMatthew G. Knepley . lm - the lumped mass matrix
1386b4937a87SMatthew G. Knepley 
1387b4937a87SMatthew G. Knepley   Level: developer
1388b4937a87SMatthew G. Knepley 
1389b4937a87SMatthew G. Knepley .seealso DMCreateMassMatrix(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1390b4937a87SMatthew G. Knepley @*/
1391b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrixLumped(DM dm, Vec *lm)
1392b4937a87SMatthew G. Knepley {
1393b4937a87SMatthew G. Knepley   PetscErrorCode ierr;
1394b4937a87SMatthew G. Knepley 
1395b4937a87SMatthew G. Knepley   PetscFunctionBegin;
1396b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1397b4937a87SMatthew G. Knepley   PetscValidPointer(lm,2);
13982c71b3e2SJacob Faibussowitsch   PetscCheck(dm->ops->createmassmatrixlumped,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrixLumped",((PetscObject)dm)->type_name);
1399b4937a87SMatthew G. Knepley   ierr = (*dm->ops->createmassmatrixlumped)(dm, lm);CHKERRQ(ierr);
1400bd041c0cSMatthew G. Knepley   PetscFunctionReturn(0);
1401bd041c0cSMatthew G. Knepley }
1402bd041c0cSMatthew G. Knepley 
1403bd041c0cSMatthew G. Knepley /*@
1404b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
140547c6ae99SBarry Smith 
1406d083f849SBarry Smith     Collective on dm
140747c6ae99SBarry Smith 
1408d8d19677SJose E. Roman     Input Parameters:
140947c6ae99SBarry Smith +   dm - the DM object
14105bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
141147c6ae99SBarry Smith 
141247c6ae99SBarry Smith     Output Parameter:
141347c6ae99SBarry Smith .   coloring - the coloring
141447c6ae99SBarry Smith 
1415ec5066bdSBarry Smith     Notes:
1416ec5066bdSBarry Smith        Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the
1417ec5066bdSBarry Smith        matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors).
1418ec5066bdSBarry Smith 
1419ec5066bdSBarry Smith        This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate()
1420ec5066bdSBarry Smith 
142147c6ae99SBarry Smith     Level: developer
142247c6ae99SBarry Smith 
1423ec5066bdSBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate()
142447c6ae99SBarry Smith 
1425aab9d709SJed Brown @*/
1426b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
142747c6ae99SBarry Smith {
142847c6ae99SBarry Smith   PetscErrorCode ierr;
142947c6ae99SBarry Smith 
143047c6ae99SBarry Smith   PetscFunctionBegin;
1431171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
14325a84ad33SLisandro Dalcin   PetscValidPointer(coloring,3);
14332c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->getcoloring,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name);
1434b412c318SBarry Smith   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
143547c6ae99SBarry Smith   PetscFunctionReturn(0);
143647c6ae99SBarry Smith }
143747c6ae99SBarry Smith 
1438b412c318SBarry Smith /*@
14398472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
144047c6ae99SBarry Smith 
1441d083f849SBarry Smith     Collective on dm
144247c6ae99SBarry Smith 
144347c6ae99SBarry Smith     Input Parameter:
1444b412c318SBarry Smith .   dm - the DM object
144547c6ae99SBarry Smith 
144647c6ae99SBarry Smith     Output Parameter:
144747c6ae99SBarry Smith .   mat - the empty Jacobian
144847c6ae99SBarry Smith 
1449073dac72SJed Brown     Level: beginner
145047c6ae99SBarry Smith 
1451f27dd7c6SMatthew G. Knepley     Options Database Keys:
1452f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1453f27dd7c6SMatthew G. Knepley 
145495452b02SPatrick Sanan     Notes:
145595452b02SPatrick Sanan     This properly preallocates the number of nonzeros in the sparse matrix so you
145694013140SBarry Smith        do not need to do it yourself.
145794013140SBarry Smith 
145894013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
14597889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
146094013140SBarry Smith 
146194013140SBarry Smith        For structured grid problems, when you call MatView() on this matrix it is displayed using the global natural ordering, NOT in the ordering used
146294013140SBarry Smith        internally by PETSc.
146394013140SBarry Smith 
146494013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1465aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
146694013140SBarry Smith 
1467b412c318SBarry Smith .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
146847c6ae99SBarry Smith 
1469aab9d709SJed Brown @*/
1470b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
147147c6ae99SBarry Smith {
147247c6ae99SBarry Smith   PetscErrorCode ierr;
147347c6ae99SBarry Smith 
147447c6ae99SBarry Smith   PetscFunctionBegin;
1475171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1476064a246eSJacob Faibussowitsch   PetscValidPointer(mat,2);
14772c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->creatematrix,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
14785a84ad33SLisandro Dalcin   ierr = MatInitializePackage();CHKERRQ(ierr);
1479fdc842d1SBarry Smith   ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1480b412c318SBarry Smith   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
148176bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1482c6b011d8SStefano Zampini     DM mdm;
1483c6b011d8SStefano Zampini 
1484c6b011d8SStefano Zampini     ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr);
14852c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!mdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix",((PetscObject)dm)->type_name);
1486c6b011d8SStefano Zampini   }
1487e571a35bSMatthew G. Knepley   /* Handle nullspace and near nullspace */
1488e5e52638SMatthew G. Knepley   if (dm->Nf) {
1489e571a35bSMatthew G. Knepley     MatNullSpace nullSpace;
1490649ef022SMatthew Knepley     PetscInt     Nf, f;
1491e571a35bSMatthew G. Knepley 
1492e5e52638SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
1493649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1494649ef022SMatthew Knepley       if (dm->nullspaceConstructors[f]) {
1495649ef022SMatthew Knepley         ierr = (*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1496e571a35bSMatthew G. Knepley         ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1497e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1498649ef022SMatthew Knepley         break;
1499e571a35bSMatthew G. Knepley       }
1500649ef022SMatthew Knepley     }
1501649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1502649ef022SMatthew Knepley       if (dm->nearnullspaceConstructors[f]) {
1503649ef022SMatthew Knepley         ierr = (*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace);CHKERRQ(ierr);
1504e571a35bSMatthew G. Knepley         ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1505e571a35bSMatthew G. Knepley         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1506e571a35bSMatthew G. Knepley       }
1507e571a35bSMatthew G. Knepley     }
1508e571a35bSMatthew G. Knepley   }
1509fdc842d1SBarry Smith   ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
151047c6ae99SBarry Smith   PetscFunctionReturn(0);
151147c6ae99SBarry Smith }
151247c6ae99SBarry Smith 
1513732e2eb9SMatthew G Knepley /*@
1514950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1515732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1516732e2eb9SMatthew G Knepley 
1517d083f849SBarry Smith   Logically Collective on dm
1518732e2eb9SMatthew G Knepley 
1519d8d19677SJose E. Roman   Input Parameters:
1520732e2eb9SMatthew G Knepley + dm - the DM
1521732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1522732e2eb9SMatthew G Knepley 
1523732e2eb9SMatthew G Knepley   Level: developer
1524f27dd7c6SMatthew G. Knepley 
1525f27dd7c6SMatthew G. Knepley   Options Database Keys:
1526f27dd7c6SMatthew G. Knepley . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
1527f27dd7c6SMatthew G. Knepley 
1528b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1529732e2eb9SMatthew G Knepley @*/
1530732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1531732e2eb9SMatthew G Knepley {
1532732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1533732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1534732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1535732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1536732e2eb9SMatthew G Knepley }
1537732e2eb9SMatthew G Knepley 
1538b06ff27eSHong Zhang /*@
1539b06ff27eSHong Zhang   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1540b06ff27eSHong Zhang     but the array for values will not be allocated.
1541b06ff27eSHong Zhang 
1542d083f849SBarry Smith   Logically Collective on dm
1543b06ff27eSHong Zhang 
1544d8d19677SJose E. Roman   Input Parameters:
1545b06ff27eSHong Zhang + dm - the DM
1546b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture
1547b06ff27eSHong Zhang 
1548b06ff27eSHong Zhang   Level: developer
1549b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1550b06ff27eSHong Zhang @*/
1551b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1552b06ff27eSHong Zhang {
1553b06ff27eSHong Zhang   PetscFunctionBegin;
1554b06ff27eSHong Zhang   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1555b06ff27eSHong Zhang   dm->structure_only = only;
1556b06ff27eSHong Zhang   PetscFunctionReturn(0);
1557b06ff27eSHong Zhang }
1558b06ff27eSHong Zhang 
1559a89ea682SMatthew G Knepley /*@C
1560aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1561a89ea682SMatthew G Knepley 
1562a89ea682SMatthew G Knepley   Not Collective
1563a89ea682SMatthew G Knepley 
1564a89ea682SMatthew G Knepley   Input Parameters:
1565a89ea682SMatthew G Knepley + dm - the DM object
1566a5b23f4aSJose E. Roman . count - The minimum size
156769291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1568a89ea682SMatthew G Knepley 
1569a89ea682SMatthew G Knepley   Output Parameter:
1570a89ea682SMatthew G Knepley . array - the work array
1571a89ea682SMatthew G Knepley 
1572a89ea682SMatthew G Knepley   Level: developer
1573a89ea682SMatthew G Knepley 
1574a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1575a89ea682SMatthew G Knepley @*/
157669291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1577a89ea682SMatthew G Knepley {
1578a89ea682SMatthew G Knepley   PetscErrorCode ierr;
1579aa1993deSMatthew G Knepley   DMWorkLink     link;
158069291d52SBarry Smith   PetscMPIInt    dsize;
1581a89ea682SMatthew G Knepley 
1582a89ea682SMatthew G Knepley   PetscFunctionBegin;
1583a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1584aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1585aa1993deSMatthew G Knepley   if (dm->workin) {
1586aa1993deSMatthew G Knepley     link       = dm->workin;
1587aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1588aa1993deSMatthew G Knepley   } else {
1589b00a9115SJed Brown     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1590a89ea682SMatthew G Knepley   }
1591ffc4695bSBarry Smith   ierr = MPI_Type_size(dtype,&dsize);CHKERRMPI(ierr);
15925056fcd2SBarry Smith   if (((size_t)dsize*count) > link->bytes) {
1593aa1993deSMatthew G Knepley     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1594854ce69bSBarry Smith     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1595854ce69bSBarry Smith     link->bytes = dsize*count;
1596aa1993deSMatthew G Knepley   }
1597aa1993deSMatthew G Knepley   link->next   = dm->workout;
1598aa1993deSMatthew G Knepley   dm->workout  = link;
159900d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
160000d952a4SJed Brown   VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count);
160100d952a4SJed Brown   VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count);
160200d952a4SJed Brown #endif
1603aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1604a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1605a89ea682SMatthew G Knepley }
1606a89ea682SMatthew G Knepley 
1607aa1993deSMatthew G Knepley /*@C
1608aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1609aa1993deSMatthew G Knepley 
1610aa1993deSMatthew G Knepley   Not Collective
1611aa1993deSMatthew G Knepley 
1612aa1993deSMatthew G Knepley   Input Parameters:
1613aa1993deSMatthew G Knepley + dm - the DM object
1614a5b23f4aSJose E. Roman . count - The minimum size
161569291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT
1616aa1993deSMatthew G Knepley 
1617aa1993deSMatthew G Knepley   Output Parameter:
1618aa1993deSMatthew G Knepley . array - the work array
1619aa1993deSMatthew G Knepley 
1620aa1993deSMatthew G Knepley   Level: developer
1621aa1993deSMatthew G Knepley 
162295452b02SPatrick Sanan   Developer Notes:
162395452b02SPatrick Sanan     count and dtype are ignored, they are only needed for DMGetWorkArray()
1624aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1625aa1993deSMatthew G Knepley @*/
162669291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1627aa1993deSMatthew G Knepley {
1628aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1629aa1993deSMatthew G Knepley 
1630aa1993deSMatthew G Knepley   PetscFunctionBegin;
1631aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1632aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1633aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1634aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1635aa1993deSMatthew G Knepley       *p           = link->next;
1636aa1993deSMatthew G Knepley       link->next   = dm->workin;
1637aa1993deSMatthew G Knepley       dm->workin   = link;
16380298fd71SBarry Smith       *(void**)mem = NULL;
1639aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1640aa1993deSMatthew G Knepley     }
1641aa1993deSMatthew G Knepley   }
1642aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1643aa1993deSMatthew G Knepley }
1644e7c4fc90SDmitry Karpeev 
16458cda7954SMatthew G. Knepley /*@C
16468cda7954SMatthew G. Knepley   DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field
16478cda7954SMatthew G. Knepley 
16488cda7954SMatthew G. Knepley   Logically collective on DM
16498cda7954SMatthew G. Knepley 
16508cda7954SMatthew G. Knepley   Input Parameters:
16518cda7954SMatthew G. Knepley + dm     - The DM
16528cda7954SMatthew G. Knepley . field  - The field number for the nullspace
16538cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace
16548cda7954SMatthew G. Knepley 
16558cda7954SMatthew G. Knepley   Notes:
16568cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16578cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16588cda7954SMatthew G. Knepley $ dm        - The present DM
16598cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16608cda7954SMatthew G. Knepley $ field     - The field number in dm
16618cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16628cda7954SMatthew G. Knepley 
16638cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16648cda7954SMatthew G. Knepley 
16658cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16668cda7954SMatthew G. Knepley */
16678cda7954SMatthew G. Knepley PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1668435a35e8SMatthew G Knepley {
1669435a35e8SMatthew G Knepley   PetscFunctionBegin;
1670435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
16712c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1672435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1673435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1674435a35e8SMatthew G Knepley }
1675435a35e8SMatthew G Knepley 
16768cda7954SMatthew G. Knepley /*@C
16778cda7954SMatthew G. Knepley   DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL
16788cda7954SMatthew G. Knepley 
16798cda7954SMatthew G. Knepley   Not collective
16808cda7954SMatthew G. Knepley 
16818cda7954SMatthew G. Knepley   Input Parameters:
16828cda7954SMatthew G. Knepley + dm     - The DM
16838cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16848cda7954SMatthew G. Knepley 
16858cda7954SMatthew G. Knepley   Output Parameter:
16868cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace
16878cda7954SMatthew G. Knepley 
16888cda7954SMatthew G. Knepley   Notes:
16898cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
16908cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
16918cda7954SMatthew G. Knepley $ dm        - The present DM
16928cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
16938cda7954SMatthew G. Knepley $ field     - The field number in dm
16948cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
16958cda7954SMatthew G. Knepley 
16968cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16978cda7954SMatthew G. Knepley 
16988cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
16998cda7954SMatthew G. Knepley */
17008cda7954SMatthew G. Knepley PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
17010a50eb56SMatthew G. Knepley {
17020a50eb56SMatthew G. Knepley   PetscFunctionBegin;
17030a50eb56SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1704f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
17052c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
17060a50eb56SMatthew G. Knepley   *nullsp = dm->nullspaceConstructors[field];
17070a50eb56SMatthew G. Knepley   PetscFunctionReturn(0);
17080a50eb56SMatthew G. Knepley }
17090a50eb56SMatthew G. Knepley 
17108cda7954SMatthew G. Knepley /*@C
17118cda7954SMatthew G. Knepley   DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field
17128cda7954SMatthew G. Knepley 
17138cda7954SMatthew G. Knepley   Logically collective on DM
17148cda7954SMatthew G. Knepley 
17158cda7954SMatthew G. Knepley   Input Parameters:
17168cda7954SMatthew G. Knepley + dm     - The DM
17178cda7954SMatthew G. Knepley . field  - The field number for the nullspace
17188cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace
17198cda7954SMatthew G. Knepley 
17208cda7954SMatthew G. Knepley   Notes:
17218cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
17228cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
17238cda7954SMatthew G. Knepley $ dm        - The present DM
17248cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
17258cda7954SMatthew G. Knepley $ field     - The field number in dm
17268cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
17278cda7954SMatthew G. Knepley 
17288cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
17298cda7954SMatthew G. Knepley 
17308cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
17318cda7954SMatthew G. Knepley */
17328cda7954SMatthew G. Knepley PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1733f9d4088aSMatthew G. Knepley {
1734f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1735f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
17362c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1737f9d4088aSMatthew G. Knepley   dm->nearnullspaceConstructors[field] = nullsp;
1738f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1739f9d4088aSMatthew G. Knepley }
1740f9d4088aSMatthew G. Knepley 
17418cda7954SMatthew G. Knepley /*@C
17428cda7954SMatthew G. Knepley   DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL
17438cda7954SMatthew G. Knepley 
17448cda7954SMatthew G. Knepley   Not collective
17458cda7954SMatthew G. Knepley 
17468cda7954SMatthew G. Knepley   Input Parameters:
17478cda7954SMatthew G. Knepley + dm     - The DM
17488cda7954SMatthew G. Knepley - field  - The field number for the nullspace
17498cda7954SMatthew G. Knepley 
17508cda7954SMatthew G. Knepley   Output Parameter:
17518cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace
17528cda7954SMatthew G. Knepley 
17538cda7954SMatthew G. Knepley   Notes:
17548cda7954SMatthew G. Knepley   The callback is intended to provide nullspaces when function spaces are joined or split, such as in DMCreateSubDM(). The calling sequence is
17558cda7954SMatthew G. Knepley $ PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
17568cda7954SMatthew G. Knepley $ dm        - The present DM
17578cda7954SMatthew G. Knepley $ origField - The field number given above, in the original DM
17588cda7954SMatthew G. Knepley $ field     - The field number in dm
17598cda7954SMatthew G. Knepley $ nullSpace - The nullspace for the given field
17608cda7954SMatthew G. Knepley 
17618cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
17628cda7954SMatthew G. Knepley 
17638cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
17648cda7954SMatthew G. Knepley */
17658cda7954SMatthew G. Knepley PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace))
1766f9d4088aSMatthew G. Knepley {
1767f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1768f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1769f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
17702c71b3e2SJacob Faibussowitsch   PetscCheckFalse(field >= 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1771f9d4088aSMatthew G. Knepley   *nullsp = dm->nearnullspaceConstructors[field];
1772f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1773f9d4088aSMatthew G. Knepley }
1774f9d4088aSMatthew G. Knepley 
17754f3b5142SJed Brown /*@C
17764d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
17774d343eeaSMatthew G Knepley 
17784d343eeaSMatthew G Knepley   Not collective
17794d343eeaSMatthew G Knepley 
17804d343eeaSMatthew G Knepley   Input Parameter:
17814d343eeaSMatthew G Knepley . dm - the DM object
17824d343eeaSMatthew G Knepley 
17834d343eeaSMatthew G Knepley   Output Parameters:
17840298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
17850298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
17860298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
17874d343eeaSMatthew G Knepley 
17884d343eeaSMatthew G Knepley   Level: intermediate
17894d343eeaSMatthew G Knepley 
179021c9b008SJed Brown   Notes:
179121c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
179221c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
179321c9b008SJed Brown   PetscFree().
179421c9b008SJed Brown 
17954d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
17964d343eeaSMatthew G Knepley @*/
179737d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
17984d343eeaSMatthew G Knepley {
179937d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
18004d343eeaSMatthew G Knepley   PetscErrorCode ierr;
18014d343eeaSMatthew G Knepley 
18024d343eeaSMatthew G Knepley   PetscFunctionBegin;
18034d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
180469ca1f37SDmitry Karpeev   if (numFields) {
1805534a8f05SLisandro Dalcin     PetscValidIntPointer(numFields,2);
180669ca1f37SDmitry Karpeev     *numFields = 0;
180769ca1f37SDmitry Karpeev   }
180837d0c07bSMatthew G Knepley   if (fieldNames) {
180937d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
18100298fd71SBarry Smith     *fieldNames = NULL;
181169ca1f37SDmitry Karpeev   }
181269ca1f37SDmitry Karpeev   if (fields) {
181369ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
18140298fd71SBarry Smith     *fields = NULL;
181569ca1f37SDmitry Karpeev   }
181692fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
181737d0c07bSMatthew G Knepley   if (section) {
18183a544194SStefano Zampini     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
181937d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
182037d0c07bSMatthew G Knepley 
1821e87a4003SBarry Smith     ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
182237d0c07bSMatthew G Knepley     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
18233a544194SStefano Zampini     ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr);
182437d0c07bSMatthew G Knepley     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
182537d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
182637d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
18273a544194SStefano Zampini       ierr          = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr);
182837d0c07bSMatthew G Knepley     }
182937d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
183037d0c07bSMatthew G Knepley       PetscInt gdof;
183137d0c07bSMatthew G Knepley 
183237d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
183337d0c07bSMatthew G Knepley       if (gdof > 0) {
183437d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
18353a544194SStefano Zampini           PetscInt fdof, fcdof, fpdof;
183637d0c07bSMatthew G Knepley 
183737d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
183837d0c07bSMatthew G Knepley           ierr  = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
18393a544194SStefano Zampini           fpdof = fdof-fcdof;
18403a544194SStefano Zampini           if (fpdof && fpdof != fieldNc[f]) {
18413a544194SStefano Zampini             /* Layout does not admit a pointwise block size */
18423a544194SStefano Zampini             fieldNc[f] = 1;
18433a544194SStefano Zampini           }
18443a544194SStefano Zampini           fieldSizes[f] += fpdof;
184537d0c07bSMatthew G Knepley         }
184637d0c07bSMatthew G Knepley       }
184737d0c07bSMatthew G Knepley     }
184837d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
1849785e854fSJed Brown       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
185037d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
185137d0c07bSMatthew G Knepley     }
185237d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
185337d0c07bSMatthew G Knepley       PetscInt gdof, goff;
185437d0c07bSMatthew G Knepley 
185537d0c07bSMatthew G Knepley       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
185637d0c07bSMatthew G Knepley       if (gdof > 0) {
185737d0c07bSMatthew G Knepley         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
185837d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
185937d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
186037d0c07bSMatthew G Knepley 
186137d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
186237d0c07bSMatthew G Knepley           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
186337d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
186437d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
186537d0c07bSMatthew G Knepley           }
186637d0c07bSMatthew G Knepley         }
186737d0c07bSMatthew G Knepley       }
186837d0c07bSMatthew G Knepley     }
18698865f1eaSKarl Rupp     if (numFields) *numFields = nF;
187037d0c07bSMatthew G Knepley     if (fieldNames) {
1871785e854fSJed Brown       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
187237d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
187337d0c07bSMatthew G Knepley         const char *fieldName;
187437d0c07bSMatthew G Knepley 
187537d0c07bSMatthew G Knepley         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
187637d0c07bSMatthew G Knepley         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
187737d0c07bSMatthew G Knepley       }
187837d0c07bSMatthew G Knepley     }
187937d0c07bSMatthew G Knepley     if (fields) {
1880785e854fSJed Brown       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
188137d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
18823a544194SStefano Zampini         PetscInt bs, in[2], out[2];
18833a544194SStefano Zampini 
188482f516ccSBarry Smith         ierr  = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
18853a544194SStefano Zampini         in[0] = -fieldNc[f];
18863a544194SStefano Zampini         in[1] = fieldNc[f];
1887820f2d46SBarry Smith         ierr  = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
18883a544194SStefano Zampini         bs    = (-out[0] == out[1]) ? out[1] : 1;
18893a544194SStefano Zampini         ierr  = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr);
189037d0c07bSMatthew G Knepley       }
189137d0c07bSMatthew G Knepley     }
18923a544194SStefano Zampini     ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr);
18938865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
18948865f1eaSKarl Rupp     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
189569ca1f37SDmitry Karpeev   }
18964d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
18974d343eeaSMatthew G Knepley }
18984d343eeaSMatthew G Knepley 
189916621825SDmitry Karpeev /*@C
190016621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
190116621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
190216621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1903e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1904e7c4fc90SDmitry Karpeev 
1905e7c4fc90SDmitry Karpeev   Not collective
1906e7c4fc90SDmitry Karpeev 
1907e7c4fc90SDmitry Karpeev   Input Parameter:
1908e7c4fc90SDmitry Karpeev . dm - the DM object
1909e7c4fc90SDmitry Karpeev 
1910e7c4fc90SDmitry Karpeev   Output Parameters:
19110298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
19120298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
19130298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
19140298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1915e7c4fc90SDmitry Karpeev 
1916e7c4fc90SDmitry Karpeev   Level: intermediate
1917e7c4fc90SDmitry Karpeev 
1918e7c4fc90SDmitry Karpeev   Notes:
1919e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1920e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1921e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1922e7c4fc90SDmitry Karpeev 
1923e7c4fc90SDmitry Karpeev .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1924e7c4fc90SDmitry Karpeev @*/
192516621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1926e7c4fc90SDmitry Karpeev {
1927e7c4fc90SDmitry Karpeev   PetscErrorCode ierr;
1928e7c4fc90SDmitry Karpeev 
1929e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1930e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
19318865f1eaSKarl Rupp   if (len) {
1932534a8f05SLisandro Dalcin     PetscValidIntPointer(len,2);
19338865f1eaSKarl Rupp     *len = 0;
19348865f1eaSKarl Rupp   }
19358865f1eaSKarl Rupp   if (namelist) {
19368865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
1937ea78f98cSLisandro Dalcin     *namelist = NULL;
19388865f1eaSKarl Rupp   }
19398865f1eaSKarl Rupp   if (islist) {
19408865f1eaSKarl Rupp     PetscValidPointer(islist,4);
1941ea78f98cSLisandro Dalcin     *islist = NULL;
19428865f1eaSKarl Rupp   }
19438865f1eaSKarl Rupp   if (dmlist) {
19448865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
1945ea78f98cSLisandro Dalcin     *dmlist = NULL;
19468865f1eaSKarl Rupp   }
1947f3f0edfdSDmitry Karpeev   /*
1948f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1949f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1950f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1951f3f0edfdSDmitry Karpeev    */
19522c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
195316621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1954435a35e8SMatthew G Knepley     PetscSection section;
1955435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1956435a35e8SMatthew G Knepley 
195792fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1958435a35e8SMatthew G Knepley     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1959435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1960f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
196103dc3394SMatthew G. Knepley       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
196203dc3394SMatthew G. Knepley       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
196303dc3394SMatthew G. Knepley       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1964435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1965435a35e8SMatthew G Knepley         const char *fieldName;
1966435a35e8SMatthew G Knepley 
196703dc3394SMatthew G. Knepley         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
196803dc3394SMatthew G. Knepley         if (namelist) {
1969435a35e8SMatthew G Knepley           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1970435a35e8SMatthew G Knepley           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1971435a35e8SMatthew G Knepley         }
197203dc3394SMatthew G. Knepley       }
1973435a35e8SMatthew G Knepley     } else {
197469ca1f37SDmitry Karpeev       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1975e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
19760298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1977e7c4fc90SDmitry Karpeev     }
19788865f1eaSKarl Rupp   } else {
197916621825SDmitry Karpeev     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
198016621825SDmitry Karpeev   }
198116621825SDmitry Karpeev   PetscFunctionReturn(0);
198216621825SDmitry Karpeev }
198316621825SDmitry Karpeev 
1984564cec59SMatthew G. Knepley /*@
1985435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1986435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1987435a35e8SMatthew G Knepley 
1988435a35e8SMatthew G Knepley   Not collective
1989435a35e8SMatthew G Knepley 
1990435a35e8SMatthew G Knepley   Input Parameters:
19912adcc780SMatthew G. Knepley + dm        - The DM object
19922adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem
19932adcc780SMatthew G. Knepley - fields    - The field numbers of the selected fields
1994435a35e8SMatthew G Knepley 
1995435a35e8SMatthew G Knepley   Output Parameters:
19962adcc780SMatthew G. Knepley + is - The global indices for the subproblem
19972adcc780SMatthew G. Knepley - subdm - The DM for the subproblem
1998435a35e8SMatthew G Knepley 
19995d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
20005d3b26e6SMatthew G. Knepley 
2001435a35e8SMatthew G Knepley   Level: intermediate
2002435a35e8SMatthew G Knepley 
20035d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2004435a35e8SMatthew G Knepley @*/
200537bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
2006435a35e8SMatthew G Knepley {
2007435a35e8SMatthew G Knepley   PetscErrorCode ierr;
2008435a35e8SMatthew G Knepley 
2009435a35e8SMatthew G Knepley   PetscFunctionBegin;
2010435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2011435a35e8SMatthew G Knepley   PetscValidPointer(fields,3);
20128865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
20138865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
20142c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createsubdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
2015435a35e8SMatthew G Knepley   ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
2016435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
2017435a35e8SMatthew G Knepley }
2018435a35e8SMatthew G Knepley 
20192adcc780SMatthew G. Knepley /*@C
20202adcc780SMatthew G. Knepley   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
20212adcc780SMatthew G. Knepley 
20222adcc780SMatthew G. Knepley   Not collective
20232adcc780SMatthew G. Knepley 
2024d8d19677SJose E. Roman   Input Parameters:
20252adcc780SMatthew G. Knepley + dms - The DM objects
20262adcc780SMatthew G. Knepley - len - The number of DMs
20272adcc780SMatthew G. Knepley 
20282adcc780SMatthew G. Knepley   Output Parameters:
2029a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL
20302adcc780SMatthew G. Knepley - superdm - The DM for the superproblem
20312adcc780SMatthew G. Knepley 
20325d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
20335d3b26e6SMatthew G. Knepley 
20342adcc780SMatthew G. Knepley   Level: intermediate
20352adcc780SMatthew G. Knepley 
20365d3b26e6SMatthew G. Knepley .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
20372adcc780SMatthew G. Knepley @*/
20382adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
20392adcc780SMatthew G. Knepley {
20402adcc780SMatthew G. Knepley   PetscInt       i;
20412adcc780SMatthew G. Knepley   PetscErrorCode ierr;
20422adcc780SMatthew G. Knepley 
20432adcc780SMatthew G. Knepley   PetscFunctionBegin;
20442adcc780SMatthew G. Knepley   PetscValidPointer(dms,1);
20452adcc780SMatthew G. Knepley   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
20462adcc780SMatthew G. Knepley   if (is) PetscValidPointer(is,3);
2047a42bd24dSMatthew G. Knepley   PetscValidPointer(superdm,4);
20482c71b3e2SJacob Faibussowitsch   PetscCheckFalse(len < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
20492adcc780SMatthew G. Knepley   if (len) {
2050b9d85ea2SLisandro Dalcin     DM dm = dms[0];
20512c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->createsuperdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
2052b9d85ea2SLisandro Dalcin     ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr);
20532adcc780SMatthew G. Knepley   }
20542adcc780SMatthew G. Knepley   PetscFunctionReturn(0);
20552adcc780SMatthew G. Knepley }
20562adcc780SMatthew G. Knepley 
205716621825SDmitry Karpeev /*@C
20588d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
20598d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
20608d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
20618d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
20628d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
206316621825SDmitry Karpeev 
206416621825SDmitry Karpeev   Not collective
206516621825SDmitry Karpeev 
206616621825SDmitry Karpeev   Input Parameter:
206716621825SDmitry Karpeev . dm - the DM object
206816621825SDmitry Karpeev 
206916621825SDmitry Karpeev   Output Parameters:
20700298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
20710298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
20720298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
20730298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
20740298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
207516621825SDmitry Karpeev 
207616621825SDmitry Karpeev   Level: intermediate
207716621825SDmitry Karpeev 
207816621825SDmitry Karpeev   Notes:
207916621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
208016621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
208116621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
208216621825SDmitry Karpeev 
2083245d9833Sprj- .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition()
208416621825SDmitry Karpeev @*/
20858d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
208616621825SDmitry Karpeev {
208716621825SDmitry Karpeev   PetscErrorCode      ierr;
2088be081cd6SPeter Brune   DMSubDomainHookLink link;
2089be081cd6SPeter Brune   PetscInt            i,l;
209016621825SDmitry Karpeev 
209116621825SDmitry Karpeev   PetscFunctionBegin;
209216621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
209314a18fd3SPeter Brune   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
20940298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
20950298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
20960298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
20970298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
2098f3f0edfdSDmitry Karpeev   /*
2099f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
2100f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
2101f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
2102f3f0edfdSDmitry Karpeev    */
21032c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
210416621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
2105be081cd6SPeter Brune     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
210614a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
2107f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
2108be081cd6SPeter Brune       for (i = 0; i < l; i++) {
2109be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
2110be081cd6SPeter Brune           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
2111be081cd6SPeter Brune         }
2112648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
2113e7c4fc90SDmitry Karpeev       }
211414a18fd3SPeter Brune     }
211514a18fd3SPeter Brune     if (len) *len = l;
211614a18fd3SPeter Brune   }
2117e30e807fSPeter Brune   PetscFunctionReturn(0);
2118e30e807fSPeter Brune }
2119e30e807fSPeter Brune 
2120e30e807fSPeter Brune /*@C
2121e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
2122e30e807fSPeter Brune 
2123e30e807fSPeter Brune   Not collective
2124e30e807fSPeter Brune 
2125e30e807fSPeter Brune   Input Parameters:
2126e30e807fSPeter Brune + dm - the DM object
2127e30e807fSPeter Brune . n  - the number of subdomain scatters
2128e30e807fSPeter Brune - subdms - the local subdomains
2129e30e807fSPeter Brune 
2130e30e807fSPeter Brune   Output Parameters:
21316b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2132e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2133e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2134e30e807fSPeter Brune 
213595452b02SPatrick Sanan   Notes:
213695452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2137e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2138e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2139e30e807fSPeter Brune   solution and residual data.
2140e30e807fSPeter Brune 
2141e30e807fSPeter Brune   Level: developer
2142e30e807fSPeter Brune 
2143e30e807fSPeter Brune .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
2144e30e807fSPeter Brune @*/
2145e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2146e30e807fSPeter Brune {
2147e30e807fSPeter Brune   PetscErrorCode ierr;
2148e30e807fSPeter Brune 
2149e30e807fSPeter Brune   PetscFunctionBegin;
2150e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2151e30e807fSPeter Brune   PetscValidPointer(subdms,3);
21522c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->createddscatters,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
2153e30e807fSPeter Brune   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
2154e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2155e7c4fc90SDmitry Karpeev }
2156e7c4fc90SDmitry Karpeev 
215747c6ae99SBarry Smith /*@
215847c6ae99SBarry Smith   DMRefine - Refines a DM object
215947c6ae99SBarry Smith 
2160d083f849SBarry Smith   Collective on dm
216147c6ae99SBarry Smith 
2162d8d19677SJose E. Roman   Input Parameters:
216347c6ae99SBarry Smith + dm   - the DM object
216491d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
216547c6ae99SBarry Smith 
216647c6ae99SBarry Smith   Output Parameter:
21670298fd71SBarry Smith . dmf - the refined DM, or NULL
2168ae0a1c52SMatthew G Knepley 
2169f27dd7c6SMatthew G. Knepley   Options Database Keys:
2170412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2171412e9a14SMatthew G. Knepley 
21720298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
217347c6ae99SBarry Smith 
217447c6ae99SBarry Smith   Level: developer
217547c6ae99SBarry Smith 
2176e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
217747c6ae99SBarry Smith @*/
21787087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
217947c6ae99SBarry Smith {
218047c6ae99SBarry Smith   PetscErrorCode   ierr;
2181c833c3b5SJed Brown   DMRefineHookLink link;
218247c6ae99SBarry Smith 
218347c6ae99SBarry Smith   PetscFunctionBegin;
2184732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
21852c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->refine,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
21861ac00216SMatthew G. Knepley   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
218747c6ae99SBarry Smith   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
21884057135bSMatthew G Knepley   if (*dmf) {
218943842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
21908865f1eaSKarl Rupp 
21918cd211a4SJed Brown     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
21928865f1eaSKarl Rupp 
2193644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
21940598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2195656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
21968865f1eaSKarl Rupp 
2197e4b4b23bSJed Brown     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
2198c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
21998865f1eaSKarl Rupp       if (link->refinehook) {
22008865f1eaSKarl Rupp         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
22018865f1eaSKarl Rupp       }
2202c833c3b5SJed Brown     }
2203c833c3b5SJed Brown   }
22041ac00216SMatthew G. Knepley   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
2205c833c3b5SJed Brown   PetscFunctionReturn(0);
2206c833c3b5SJed Brown }
2207c833c3b5SJed Brown 
2208bb9467b5SJed Brown /*@C
2209c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2210c833c3b5SJed Brown 
2211c833c3b5SJed Brown    Logically Collective
2212c833c3b5SJed Brown 
22134165533cSJose E. Roman    Input Parameters:
2214c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2215c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2216c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22170298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2218c833c3b5SJed Brown 
2219c833c3b5SJed Brown    Calling sequence of refinehook:
2220c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2221c833c3b5SJed Brown 
2222c833c3b5SJed Brown +  coarse - coarse level DM
2223c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2224c833c3b5SJed Brown -  ctx - optional user-defined function context
2225c833c3b5SJed Brown 
2226c833c3b5SJed Brown    Calling sequence for interphook:
2227c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2228c833c3b5SJed Brown 
2229c833c3b5SJed Brown +  coarse - coarse level DM
2230c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2231c833c3b5SJed Brown .  fine - fine level DM to update
2232c833c3b5SJed Brown -  ctx - optional user-defined function context
2233c833c3b5SJed Brown 
2234c833c3b5SJed Brown    Level: advanced
2235c833c3b5SJed Brown 
2236c833c3b5SJed Brown    Notes:
2237c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2238c833c3b5SJed Brown 
2239c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2240c833c3b5SJed Brown 
2241bb9467b5SJed Brown    This function is currently not available from Fortran.
2242bb9467b5SJed Brown 
2243c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2244c833c3b5SJed Brown @*/
2245c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2246c833c3b5SJed Brown {
2247c833c3b5SJed Brown   PetscErrorCode   ierr;
2248c833c3b5SJed Brown   DMRefineHookLink link,*p;
2249c833c3b5SJed Brown 
2250c833c3b5SJed Brown   PetscFunctionBegin;
2251c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22523d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
22533d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
22543d8e3701SJed Brown   }
225595dccacaSBarry Smith   ierr             = PetscNew(&link);CHKERRQ(ierr);
2256c833c3b5SJed Brown   link->refinehook = refinehook;
2257c833c3b5SJed Brown   link->interphook = interphook;
2258c833c3b5SJed Brown   link->ctx        = ctx;
22590298fd71SBarry Smith   link->next       = NULL;
2260c833c3b5SJed Brown   *p               = link;
2261c833c3b5SJed Brown   PetscFunctionReturn(0);
2262c833c3b5SJed Brown }
2263c833c3b5SJed Brown 
22643d8e3701SJed Brown /*@C
22653d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
22663d8e3701SJed Brown 
22673d8e3701SJed Brown    Logically Collective
22683d8e3701SJed Brown 
22694165533cSJose E. Roman    Input Parameters:
22703d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
22713d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
22723d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22733d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
22743d8e3701SJed Brown 
22753d8e3701SJed Brown    Level: advanced
22763d8e3701SJed Brown 
22773d8e3701SJed Brown    Notes:
22783d8e3701SJed Brown    This function does nothing if the hook is not in the list.
22793d8e3701SJed Brown 
22803d8e3701SJed Brown    This function is currently not available from Fortran.
22813d8e3701SJed Brown 
22823d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
22833d8e3701SJed Brown @*/
22843d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
22853d8e3701SJed Brown {
22863d8e3701SJed Brown   PetscErrorCode   ierr;
22873d8e3701SJed Brown   DMRefineHookLink link,*p;
22883d8e3701SJed Brown 
22893d8e3701SJed Brown   PetscFunctionBegin;
22903d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22913d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
22923d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
22933d8e3701SJed Brown       link = *p;
22943d8e3701SJed Brown       *p = link->next;
22953d8e3701SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
22963d8e3701SJed Brown       break;
22973d8e3701SJed Brown     }
22983d8e3701SJed Brown   }
22993d8e3701SJed Brown   PetscFunctionReturn(0);
23003d8e3701SJed Brown }
23013d8e3701SJed Brown 
2302c833c3b5SJed Brown /*@
2303c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2304c833c3b5SJed Brown 
2305c833c3b5SJed Brown    Collective if any hooks are
2306c833c3b5SJed Brown 
23074165533cSJose E. Roman    Input Parameters:
2308c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2309e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2310c833c3b5SJed Brown -  fine - finer DM to update
2311c833c3b5SJed Brown 
2312c833c3b5SJed Brown    Level: developer
2313c833c3b5SJed Brown 
2314c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2315c833c3b5SJed Brown @*/
2316c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2317c833c3b5SJed Brown {
2318c833c3b5SJed Brown   PetscErrorCode   ierr;
2319c833c3b5SJed Brown   DMRefineHookLink link;
2320c833c3b5SJed Brown 
2321c833c3b5SJed Brown   PetscFunctionBegin;
2322c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
23238865f1eaSKarl Rupp     if (link->interphook) {
23248865f1eaSKarl Rupp       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
23258865f1eaSKarl Rupp     }
23264057135bSMatthew G Knepley   }
232747c6ae99SBarry Smith   PetscFunctionReturn(0);
232847c6ae99SBarry Smith }
232947c6ae99SBarry Smith 
2330eb3f98d2SBarry Smith /*@
23311f3379b2SToby Isaac    DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh.
23321f3379b2SToby Isaac 
23331f3379b2SToby Isaac    Collective on DM
23341f3379b2SToby Isaac 
23354165533cSJose E. Roman    Input Parameters:
23361f3379b2SToby Isaac +  coarse - coarse DM
23371f3379b2SToby Isaac .  fine   - fine DM
23381f3379b2SToby Isaac .  interp - (optional) the matrix computed by DMCreateInterpolation().  Implementations may not need this, but if it
23391f3379b2SToby Isaac             is available it can avoid some recomputation.  If it is provided, MatInterpolate() will be used if
23401f3379b2SToby Isaac             the coarse DM does not have a specialized implementation.
23411f3379b2SToby Isaac -  coarseSol - solution on the coarse mesh
23421f3379b2SToby Isaac 
23434165533cSJose E. Roman    Output Parameter:
23441f3379b2SToby Isaac .  fineSol - the interpolation of coarseSol to the fine mesh
23451f3379b2SToby Isaac 
23461f3379b2SToby Isaac    Level: developer
23471f3379b2SToby Isaac 
23481f3379b2SToby Isaac    Note: This function exists because the interpolation of a solution vector between meshes is not always a linear
23491f3379b2SToby Isaac    map.  For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed
23501f3379b2SToby Isaac    out of the solution vector.  Or if interpolation is inherently a nonlinear operation, such as a method using
23511f3379b2SToby Isaac    slope-limiting reconstruction.
23521f3379b2SToby Isaac 
23531f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation()
23541f3379b2SToby Isaac @*/
23551f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol)
23561f3379b2SToby Isaac {
23571f3379b2SToby Isaac   PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL;
23581f3379b2SToby Isaac   PetscErrorCode ierr;
23591f3379b2SToby Isaac 
23601f3379b2SToby Isaac   PetscFunctionBegin;
23611f3379b2SToby Isaac   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
23621f3379b2SToby Isaac   if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3);
23631f3379b2SToby Isaac   PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4);
23641f3379b2SToby Isaac   PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5);
23651f3379b2SToby Isaac 
23661f3379b2SToby Isaac   ierr = PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol);CHKERRQ(ierr);
23671f3379b2SToby Isaac   if (interpsol) {
23681f3379b2SToby Isaac     ierr = (*interpsol)(coarse, fine, interp, coarseSol, fineSol);CHKERRQ(ierr);
23691f3379b2SToby Isaac   } else if (interp) {
23701f3379b2SToby Isaac     ierr = MatInterpolate(interp, coarseSol, fineSol);CHKERRQ(ierr);
237198921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name);
23721f3379b2SToby Isaac   PetscFunctionReturn(0);
23731f3379b2SToby Isaac }
23741f3379b2SToby Isaac 
23751f3379b2SToby Isaac /*@
2376aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2377eb3f98d2SBarry Smith 
2378eb3f98d2SBarry Smith     Not Collective
2379eb3f98d2SBarry Smith 
2380eb3f98d2SBarry Smith     Input Parameter:
2381eb3f98d2SBarry Smith .   dm - the DM object
2382eb3f98d2SBarry Smith 
2383eb3f98d2SBarry Smith     Output Parameter:
2384eb3f98d2SBarry Smith .   level - number of refinements
2385eb3f98d2SBarry Smith 
2386eb3f98d2SBarry Smith     Level: developer
2387eb3f98d2SBarry Smith 
23886a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2389eb3f98d2SBarry Smith 
2390eb3f98d2SBarry Smith @*/
2391eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2392eb3f98d2SBarry Smith {
2393eb3f98d2SBarry Smith   PetscFunctionBegin;
2394eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2395eb3f98d2SBarry Smith   *level = dm->levelup;
2396eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2397eb3f98d2SBarry Smith }
2398eb3f98d2SBarry Smith 
2399fef3a512SBarry Smith /*@
2400aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2401fef3a512SBarry Smith 
2402fef3a512SBarry Smith     Not Collective
2403fef3a512SBarry Smith 
2404d8d19677SJose E. Roman     Input Parameters:
2405fef3a512SBarry Smith +   dm - the DM object
2406fef3a512SBarry Smith -   level - number of refinements
2407fef3a512SBarry Smith 
2408fef3a512SBarry Smith     Level: advanced
2409fef3a512SBarry Smith 
241095452b02SPatrick Sanan     Notes:
241195452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2412fef3a512SBarry Smith 
2413fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2414fef3a512SBarry Smith 
2415fef3a512SBarry Smith @*/
2416fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2417fef3a512SBarry Smith {
2418fef3a512SBarry Smith   PetscFunctionBegin;
2419fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2420fef3a512SBarry Smith   dm->levelup = level;
2421fef3a512SBarry Smith   PetscFunctionReturn(0);
2422fef3a512SBarry Smith }
2423fef3a512SBarry Smith 
2424d410b0cfSMatthew G. Knepley /*@
2425d410b0cfSMatthew G. Knepley   DMExtrude - Extrude a DM object from a surface
2426d410b0cfSMatthew G. Knepley 
2427d410b0cfSMatthew G. Knepley   Collective on dm
2428d410b0cfSMatthew G. Knepley 
2429f1a722f8SMatthew G. Knepley   Input Parameters:
2430d410b0cfSMatthew G. Knepley + dm     - the DM object
2431d410b0cfSMatthew G. Knepley - layers - the number of extruded cell layers
2432d410b0cfSMatthew G. Knepley 
2433d410b0cfSMatthew G. Knepley   Output Parameter:
2434d410b0cfSMatthew G. Knepley . dme - the extruded DM, or NULL
2435d410b0cfSMatthew G. Knepley 
2436d410b0cfSMatthew G. Knepley   Note: If no extrusion was done, the return value is NULL
2437d410b0cfSMatthew G. Knepley 
2438d410b0cfSMatthew G. Knepley   Level: developer
2439d410b0cfSMatthew G. Knepley 
2440d410b0cfSMatthew G. Knepley .seealso DMRefine(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector()
2441d410b0cfSMatthew G. Knepley @*/
2442d410b0cfSMatthew G. Knepley PetscErrorCode DMExtrude(DM dm, PetscInt layers, DM *dme)
2443d410b0cfSMatthew G. Knepley {
2444d410b0cfSMatthew G. Knepley   PetscErrorCode ierr;
2445d410b0cfSMatthew G. Knepley 
2446d410b0cfSMatthew G. Knepley   PetscFunctionBegin;
2447d410b0cfSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
24482c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->extrude,PetscObjectComm((PetscObject) dm), PETSC_ERR_SUP, "DM type %s does not implement DMExtrude", ((PetscObject) dm)->type_name);
2449d410b0cfSMatthew G. Knepley   ierr = (*dm->ops->extrude)(dm, layers, dme);CHKERRQ(ierr);
2450d410b0cfSMatthew G. Knepley   if (*dme) {
2451d410b0cfSMatthew G. Knepley     (*dme)->ops->creatematrix = dm->ops->creatematrix;
2452d410b0cfSMatthew G. Knepley     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject) dm, (PetscObject) *dme);CHKERRQ(ierr);
2453d410b0cfSMatthew G. Knepley     (*dme)->ctx = dm->ctx;
2454d410b0cfSMatthew G. Knepley     ierr = DMSetMatType(*dme, dm->mattype);CHKERRQ(ierr);
2455d410b0cfSMatthew G. Knepley   }
2456d410b0cfSMatthew G. Knepley   PetscFunctionReturn(0);
2457d410b0cfSMatthew G. Knepley }
2458d410b0cfSMatthew G. Knepley 
2459ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2460ca3d3a14SMatthew G. Knepley {
2461ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2462ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2463ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2464ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2465ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2466ca3d3a14SMatthew G. Knepley }
2467ca3d3a14SMatthew G. Knepley 
2468ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2469ca3d3a14SMatthew G. Knepley {
2470ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2471ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2472ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2473ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2474ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2475ca3d3a14SMatthew G. Knepley }
2476ca3d3a14SMatthew G. Knepley 
2477ca3d3a14SMatthew G. Knepley /*@
2478c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2479ca3d3a14SMatthew G. Knepley 
2480ca3d3a14SMatthew G. Knepley   Input Parameter:
2481ca3d3a14SMatthew G. Knepley . dm - The DM
2482ca3d3a14SMatthew G. Knepley 
2483ca3d3a14SMatthew G. Knepley   Output Parameter:
2484ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2485ca3d3a14SMatthew G. Knepley 
2486ca3d3a14SMatthew G. Knepley   Level: developer
2487ca3d3a14SMatthew G. Knepley 
2488436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2489ca3d3a14SMatthew G. Knepley @*/
2490ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2491ca3d3a14SMatthew G. Knepley {
2492ca3d3a14SMatthew G. Knepley   Vec            tv;
2493ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2494ca3d3a14SMatthew G. Knepley 
2495ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2496ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2497534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
2498ca3d3a14SMatthew G. Knepley   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2499ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2500ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2501ca3d3a14SMatthew G. Knepley }
2502ca3d3a14SMatthew G. Knepley 
2503ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2504ca3d3a14SMatthew G. Knepley {
2505ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2506ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2507ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2508ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2509ca3d3a14SMatthew G. Knepley 
2510ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2511ca3d3a14SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
251292fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2513ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2514ca3d3a14SMatthew G. Knepley   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2515ca3d3a14SMatthew G. Knepley   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
251692fd8e1eSJed Brown   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2517ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2518ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2519ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
2520ca3d3a14SMatthew G. Knepley     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2521ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2522ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2523ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
2524ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2525ca3d3a14SMatthew G. Knepley       if (!dof) continue;
2526ca3d3a14SMatthew G. Knepley       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2527ca3d3a14SMatthew G. Knepley       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2528ca3d3a14SMatthew G. Knepley     }
2529ca3d3a14SMatthew G. Knepley   }
2530ca3d3a14SMatthew G. Knepley   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2531ca3d3a14SMatthew G. Knepley   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2532ca3d3a14SMatthew G. Knepley   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2533ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2534ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
2535ca3d3a14SMatthew G. Knepley       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2536ca3d3a14SMatthew G. Knepley       if (dof) {
2537ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2538ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2539ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2540ca3d3a14SMatthew G. Knepley 
2541ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
2542ca3d3a14SMatthew G. Knepley         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2543ca3d3a14SMatthew G. Knepley         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2544580bdb30SBarry Smith         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2545ca3d3a14SMatthew G. Knepley       }
2546ca3d3a14SMatthew G. Knepley     }
2547ca3d3a14SMatthew G. Knepley   }
2548ca3d3a14SMatthew G. Knepley   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2549ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2550ca3d3a14SMatthew G. Knepley }
2551ca3d3a14SMatthew G. Knepley 
2552ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2553ca3d3a14SMatthew G. Knepley {
2554ca3d3a14SMatthew G. Knepley   PetscErrorCode ierr;
2555ca3d3a14SMatthew G. Knepley 
2556ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2557ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2558ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2559ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2560ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2561ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2562ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
2563ca3d3a14SMatthew G. Knepley   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2564ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2565ca3d3a14SMatthew G. Knepley }
2566ca3d3a14SMatthew G. Knepley 
2567bb9467b5SJed Brown /*@C
2568baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2569baf369e7SPeter Brune 
2570baf369e7SPeter Brune    Logically Collective
2571baf369e7SPeter Brune 
25724165533cSJose E. Roman    Input Parameters:
2573baf369e7SPeter Brune +  dm - the DM
2574baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2575baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
25760298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2577baf369e7SPeter Brune 
2578baf369e7SPeter Brune    Calling sequence for beginhook:
2579baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2580baf369e7SPeter Brune 
2581baf369e7SPeter Brune +  dm - global DM
2582baf369e7SPeter Brune .  g - global vector
2583baf369e7SPeter Brune .  mode - mode
2584baf369e7SPeter Brune .  l - local vector
2585baf369e7SPeter Brune -  ctx - optional user-defined function context
2586baf369e7SPeter Brune 
2587baf369e7SPeter Brune    Calling sequence for endhook:
2588ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2589baf369e7SPeter Brune 
2590baf369e7SPeter Brune +  global - global DM
2591baf369e7SPeter Brune -  ctx - optional user-defined function context
2592baf369e7SPeter Brune 
2593baf369e7SPeter Brune    Level: advanced
2594baf369e7SPeter Brune 
2595baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2596baf369e7SPeter Brune @*/
2597baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2598baf369e7SPeter Brune {
2599baf369e7SPeter Brune   PetscErrorCode          ierr;
2600baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2601baf369e7SPeter Brune 
2602baf369e7SPeter Brune   PetscFunctionBegin;
2603baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2604baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
260595dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2606baf369e7SPeter Brune   link->beginhook = beginhook;
2607baf369e7SPeter Brune   link->endhook   = endhook;
2608baf369e7SPeter Brune   link->ctx       = ctx;
26090298fd71SBarry Smith   link->next      = NULL;
2610baf369e7SPeter Brune   *p              = link;
2611baf369e7SPeter Brune   PetscFunctionReturn(0);
2612baf369e7SPeter Brune }
2613baf369e7SPeter Brune 
26144c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
26154c274da1SToby Isaac {
26164c274da1SToby Isaac   Mat cMat;
2617*79769bd5SJed Brown   Vec cVec, cBias;
26184c274da1SToby Isaac   PetscSection section, cSec;
26194c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
26204c274da1SToby Isaac   PetscErrorCode ierr;
26214c274da1SToby Isaac 
26224c274da1SToby Isaac   PetscFunctionBegin;
26234c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2624*79769bd5SJed Brown   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat,&cBias);CHKERRQ(ierr);
26254c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
26265db9a05bSToby Isaac     PetscInt nRows;
26275db9a05bSToby Isaac 
26285db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
26295db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
263092fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
26317711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
26324c274da1SToby Isaac     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
2633*79769bd5SJed Brown     if (cBias) {ierr = VecAXPY(cVec,1.,cBias);CHKERRQ(ierr);}
26344c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
26354c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
26364c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
26374c274da1SToby Isaac       if (dof) {
26384c274da1SToby Isaac         PetscScalar *vals;
26394c274da1SToby Isaac         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
26404c274da1SToby Isaac         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
26414c274da1SToby Isaac       }
26424c274da1SToby Isaac     }
26434c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
26444c274da1SToby Isaac   }
26454c274da1SToby Isaac   PetscFunctionReturn(0);
26464c274da1SToby Isaac }
26474c274da1SToby Isaac 
264847c6ae99SBarry Smith /*@
264901729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
265001729b5cSPatrick Sanan 
2651d083f849SBarry Smith     Neighbor-wise Collective on dm
265201729b5cSPatrick Sanan 
265301729b5cSPatrick Sanan     Input Parameters:
265401729b5cSPatrick Sanan +   dm - the DM object
265501729b5cSPatrick Sanan .   g - the global vector
265601729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
265701729b5cSPatrick Sanan -   l - the local vector
265801729b5cSPatrick Sanan 
265901729b5cSPatrick Sanan     Notes:
266001729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
266101729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
266201729b5cSPatrick Sanan 
266301729b5cSPatrick Sanan     Level: beginner
266401729b5cSPatrick Sanan 
266501729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
266601729b5cSPatrick Sanan 
266701729b5cSPatrick Sanan @*/
266801729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
266901729b5cSPatrick Sanan {
267001729b5cSPatrick Sanan   PetscErrorCode ierr;
267101729b5cSPatrick Sanan 
267201729b5cSPatrick Sanan   PetscFunctionBegin;
267301729b5cSPatrick Sanan   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
267401729b5cSPatrick Sanan   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
267501729b5cSPatrick Sanan   PetscFunctionReturn(0);
267601729b5cSPatrick Sanan }
267701729b5cSPatrick Sanan 
267801729b5cSPatrick Sanan /*@
267947c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
268047c6ae99SBarry Smith 
2681d083f849SBarry Smith     Neighbor-wise Collective on dm
268247c6ae99SBarry Smith 
268347c6ae99SBarry Smith     Input Parameters:
268447c6ae99SBarry Smith +   dm - the DM object
268547c6ae99SBarry Smith .   g - the global vector
268647c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
268747c6ae99SBarry Smith -   l - the local vector
268847c6ae99SBarry Smith 
268901729b5cSPatrick Sanan     Level: intermediate
269047c6ae99SBarry Smith 
269101729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
269247c6ae99SBarry Smith 
269347c6ae99SBarry Smith @*/
26947087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
269547c6ae99SBarry Smith {
26967128ae9fSMatthew G Knepley   PetscSF                 sf;
269747c6ae99SBarry Smith   PetscErrorCode          ierr;
2698baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
269947c6ae99SBarry Smith 
270047c6ae99SBarry Smith   PetscFunctionBegin;
2701171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2702baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
27038865f1eaSKarl Rupp     if (link->beginhook) {
27048865f1eaSKarl Rupp       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
27058865f1eaSKarl Rupp     }
2706baf369e7SPeter Brune   }
27071bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
27087128ae9fSMatthew G Knepley   if (sf) {
2709ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2710ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
2711d0295fc0SJunchao Zhang     PetscMemType      lmtype,gmtype;
27127128ae9fSMatthew G Knepley 
27132c71b3e2SJacob Faibussowitsch     PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2714a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2715a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2716ad227feaSJunchao Zhang     ierr = PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE);CHKERRQ(ierr);
2717a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2718a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
27197128ae9fSMatthew G Knepley   } else {
27202c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->globaltolocalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2721843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
27227128ae9fSMatthew G Knepley   }
272347c6ae99SBarry Smith   PetscFunctionReturn(0);
272447c6ae99SBarry Smith }
272547c6ae99SBarry Smith 
272647c6ae99SBarry Smith /*@
272747c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
272847c6ae99SBarry Smith 
2729d083f849SBarry Smith     Neighbor-wise Collective on dm
273047c6ae99SBarry Smith 
273147c6ae99SBarry Smith     Input Parameters:
273247c6ae99SBarry Smith +   dm - the DM object
273347c6ae99SBarry Smith .   g - the global vector
273447c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
273547c6ae99SBarry Smith -   l - the local vector
273647c6ae99SBarry Smith 
273701729b5cSPatrick Sanan     Level: intermediate
273847c6ae99SBarry Smith 
273901729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
274047c6ae99SBarry Smith 
274147c6ae99SBarry Smith @*/
27427087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
274347c6ae99SBarry Smith {
27447128ae9fSMatthew G Knepley   PetscSF                 sf;
274547c6ae99SBarry Smith   PetscErrorCode          ierr;
2746ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2747ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2748ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2749baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
2750d0295fc0SJunchao Zhang   PetscMemType            lmtype,gmtype;
275147c6ae99SBarry Smith 
275247c6ae99SBarry Smith   PetscFunctionBegin;
2753171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27541bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2755ca3d3a14SMatthew G. Knepley   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
27567128ae9fSMatthew G Knepley   if (sf) {
27572c71b3e2SJacob Faibussowitsch     PetscCheckFalse(mode == ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
27587128ae9fSMatthew G Knepley 
2759a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2760a256111fSJunchao Zhang     ierr = VecGetArrayReadAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2761ad227feaSJunchao Zhang     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE);CHKERRQ(ierr);
2762a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(l, &lArray);CHKERRQ(ierr);
2763a256111fSJunchao Zhang     ierr = VecRestoreArrayReadAndMemType(g, &gArray);CHKERRQ(ierr);
2764ca3d3a14SMatthew G. Knepley     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
27657128ae9fSMatthew G Knepley   } else {
27662c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->globaltolocalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2767843c4018SMatthew G Knepley     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
27687128ae9fSMatthew G Knepley   }
27694c274da1SToby Isaac   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2770baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
2771baf369e7SPeter Brune     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2772baf369e7SPeter Brune   }
277347c6ae99SBarry Smith   PetscFunctionReturn(0);
277447c6ae99SBarry Smith }
277547c6ae99SBarry Smith 
2776d4d07f1eSToby Isaac /*@C
2777d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2778d4d07f1eSToby Isaac 
2779d4d07f1eSToby Isaac    Logically Collective
2780d4d07f1eSToby Isaac 
27814165533cSJose E. Roman    Input Parameters:
2782d4d07f1eSToby Isaac +  dm - the DM
2783d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2784d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2785d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2786d4d07f1eSToby Isaac 
2787d4d07f1eSToby Isaac    Calling sequence for beginhook:
2788d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2789d4d07f1eSToby Isaac 
2790d4d07f1eSToby Isaac +  dm - global DM
2791d4d07f1eSToby Isaac .  l - local vector
2792d4d07f1eSToby Isaac .  mode - mode
2793d4d07f1eSToby Isaac .  g - global vector
2794d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2795d4d07f1eSToby Isaac 
2796d4d07f1eSToby Isaac    Calling sequence for endhook:
2797d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2798d4d07f1eSToby Isaac 
2799d4d07f1eSToby Isaac +  global - global DM
2800d4d07f1eSToby Isaac .  l - local vector
2801d4d07f1eSToby Isaac .  mode - mode
2802d4d07f1eSToby Isaac .  g - global vector
2803d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2804d4d07f1eSToby Isaac 
2805d4d07f1eSToby Isaac    Level: advanced
2806d4d07f1eSToby Isaac 
2807d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2808d4d07f1eSToby Isaac @*/
2809d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2810d4d07f1eSToby Isaac {
2811d4d07f1eSToby Isaac   PetscErrorCode          ierr;
2812d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2813d4d07f1eSToby Isaac 
2814d4d07f1eSToby Isaac   PetscFunctionBegin;
2815d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2816d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
281795dccacaSBarry Smith   ierr            = PetscNew(&link);CHKERRQ(ierr);
2818d4d07f1eSToby Isaac   link->beginhook = beginhook;
2819d4d07f1eSToby Isaac   link->endhook   = endhook;
2820d4d07f1eSToby Isaac   link->ctx       = ctx;
2821d4d07f1eSToby Isaac   link->next      = NULL;
2822d4d07f1eSToby Isaac   *p              = link;
2823d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2824d4d07f1eSToby Isaac }
2825d4d07f1eSToby Isaac 
28264c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
28274c274da1SToby Isaac {
28284c274da1SToby Isaac   Mat cMat;
28294c274da1SToby Isaac   Vec cVec;
28304c274da1SToby Isaac   PetscSection section, cSec;
28314c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
28324c274da1SToby Isaac   PetscErrorCode ierr;
28334c274da1SToby Isaac 
28344c274da1SToby Isaac   PetscFunctionBegin;
28354c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2836*79769bd5SJed Brown   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat,NULL);CHKERRQ(ierr);
28374c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
28385db9a05bSToby Isaac     PetscInt nRows;
28395db9a05bSToby Isaac 
28405db9a05bSToby Isaac     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
28415db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
284292fd8e1eSJed Brown     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
28437711e48fSToby Isaac     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
28444c274da1SToby Isaac     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
28454c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
28464c274da1SToby Isaac       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
28474c274da1SToby Isaac       if (dof) {
28484c274da1SToby Isaac         PetscInt d;
28494c274da1SToby Isaac         PetscScalar *vals;
28504c274da1SToby Isaac         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
28514c274da1SToby Isaac         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
28524c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
28534c274da1SToby Isaac          * we just extracted */
28544c274da1SToby Isaac         for (d = 0; d < dof; d++) {
28554c274da1SToby Isaac           vals[d] = 0.;
28564c274da1SToby Isaac         }
28574c274da1SToby Isaac       }
28584c274da1SToby Isaac     }
28594c274da1SToby Isaac     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
28604c274da1SToby Isaac     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
28614c274da1SToby Isaac   }
28624c274da1SToby Isaac   PetscFunctionReturn(0);
28634c274da1SToby Isaac }
286401729b5cSPatrick Sanan /*@
286501729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
286601729b5cSPatrick Sanan 
2867d083f849SBarry Smith     Neighbor-wise Collective on dm
286801729b5cSPatrick Sanan 
286901729b5cSPatrick Sanan     Input Parameters:
287001729b5cSPatrick Sanan +   dm - the DM object
287101729b5cSPatrick Sanan .   l - the local vector
287201729b5cSPatrick 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.
287301729b5cSPatrick Sanan -   g - the global vector
287401729b5cSPatrick Sanan 
287501729b5cSPatrick Sanan     Notes:
287601729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
287701729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
287801729b5cSPatrick Sanan 
287901729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
288001729b5cSPatrick 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.
288101729b5cSPatrick Sanan 
288201729b5cSPatrick Sanan     Level: beginner
288301729b5cSPatrick Sanan 
288401729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
288501729b5cSPatrick Sanan 
288601729b5cSPatrick Sanan @*/
288701729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
288801729b5cSPatrick Sanan {
288901729b5cSPatrick Sanan   PetscErrorCode ierr;
289001729b5cSPatrick Sanan 
289101729b5cSPatrick Sanan   PetscFunctionBegin;
289201729b5cSPatrick Sanan   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
289301729b5cSPatrick Sanan   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
289401729b5cSPatrick Sanan   PetscFunctionReturn(0);
289501729b5cSPatrick Sanan }
28964c274da1SToby Isaac 
289747c6ae99SBarry Smith /*@
289801729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
28999a42bb27SBarry Smith 
2900d083f849SBarry Smith     Neighbor-wise Collective on dm
29019a42bb27SBarry Smith 
29029a42bb27SBarry Smith     Input Parameters:
29039a42bb27SBarry Smith +   dm - the DM object
2904f6813fd5SJed Brown .   l - the local vector
29051eb28f2eSBarry 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.
29061eb28f2eSBarry Smith -   g - the global vector
29079a42bb27SBarry Smith 
290895452b02SPatrick Sanan     Notes:
290995452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
291084330215SMatthew 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.
29119a42bb27SBarry Smith 
291201729b5cSPatrick Sanan     Level: intermediate
29139a42bb27SBarry Smith 
291401729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
29159a42bb27SBarry Smith 
29169a42bb27SBarry Smith @*/
29177087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
29189a42bb27SBarry Smith {
29197128ae9fSMatthew G Knepley   PetscSF                 sf;
292084330215SMatthew G. Knepley   PetscSection            s, gs;
2921d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2922ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2923ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2924ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2925fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
292684330215SMatthew G. Knepley   PetscErrorCode          ierr;
2927d0295fc0SJunchao Zhang   PetscMemType            lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST;
29289a42bb27SBarry Smith 
29299a42bb27SBarry Smith   PetscFunctionBegin;
2930171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2931d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2932d4d07f1eSToby Isaac     if (link->beginhook) {
2933d4d07f1eSToby Isaac       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2934d4d07f1eSToby Isaac     }
2935d4d07f1eSToby Isaac   }
29364c274da1SToby Isaac   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
29371bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
293892fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
29397128ae9fSMatthew G Knepley   switch (mode) {
29407128ae9fSMatthew G Knepley   case INSERT_VALUES:
29417128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2942304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
294384330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
29447128ae9fSMatthew G Knepley   case ADD_VALUES:
29457128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2946304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
294784330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
29487128ae9fSMatthew G Knepley   default:
294998921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
29507128ae9fSMatthew G Knepley   }
2951ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
2952ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2953ca3d3a14SMatthew G. Knepley     if (transform) {
2954ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2955ca3d3a14SMatthew G. Knepley       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2956ca3d3a14SMatthew G. Knepley       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2957ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2958fa88e482SJed Brown     } else if (isInsert) {
2959ae5cfb4aSMatthew G. Knepley       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2960fa88e482SJed Brown     } else {
2961a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, &lmtype);CHKERRQ(ierr);
2962fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2963ca3d3a14SMatthew G. Knepley     }
2964fa88e482SJed Brown     if (s && isInsert) {
29657128ae9fSMatthew G Knepley       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2966fa88e482SJed Brown     } else {
2967a256111fSJunchao Zhang       ierr = VecGetArrayAndMemType(g, &gArray, &gmtype);CHKERRQ(ierr);
2968fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2969fa88e482SJed Brown     }
2970ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
2971d0295fc0SJunchao Zhang       ierr = PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM);CHKERRQ(ierr);
297284330215SMatthew G. Knepley     } else if (s && isInsert) {
297384330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
297484330215SMatthew G. Knepley 
2975e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
297684330215SMatthew G. Knepley       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
297784330215SMatthew G. Knepley       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
297884330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2979b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
298084330215SMatthew G. Knepley 
298184330215SMatthew G. Knepley         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
298203442857SMatthew G. Knepley         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
298384330215SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2984b3b16f48SMatthew G. Knepley         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
298584330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
298684330215SMatthew G. Knepley         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2987b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
298803442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
29892c71b3e2SJacob Faibussowitsch         PetscCheckFalse(dof != gdof,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
2990b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2991b3b16f48SMatthew G. Knepley         if (!gcdof) {
299284330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2993b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2994b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
299584330215SMatthew G. Knepley           const PetscInt *cdofs;
299684330215SMatthew G. Knepley           PetscInt        cind = 0;
299784330215SMatthew G. Knepley 
299884330215SMatthew G. Knepley           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2999b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
300084330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
3001b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
300284330215SMatthew G. Knepley           }
300398921bdaSJacob Faibussowitsch         } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
300484330215SMatthew G. Knepley       }
3005ca3d3a14SMatthew G. Knepley     }
3006fa88e482SJed Brown     if (g_inplace) {
3007a256111fSJunchao Zhang       ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
3008fa88e482SJed Brown     } else {
30097128ae9fSMatthew G Knepley       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
3010fa88e482SJed Brown     }
3011ca3d3a14SMatthew G. Knepley     if (transform) {
3012ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3013ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3014fa88e482SJed Brown     } else if (l_inplace) {
3015a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
3016ca3d3a14SMatthew G. Knepley     } else {
3017ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
3018ca3d3a14SMatthew G. Knepley     }
30197128ae9fSMatthew G Knepley   } else {
30202c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->localtoglobalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
3021843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
30227128ae9fSMatthew G Knepley   }
30239a42bb27SBarry Smith   PetscFunctionReturn(0);
30249a42bb27SBarry Smith }
30259a42bb27SBarry Smith 
30269a42bb27SBarry Smith /*@
30279a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
302847c6ae99SBarry Smith 
3029d083f849SBarry Smith     Neighbor-wise Collective on dm
303047c6ae99SBarry Smith 
303147c6ae99SBarry Smith     Input Parameters:
303247c6ae99SBarry Smith +   dm - the DM object
3033f6813fd5SJed Brown .   l - the local vector
303447c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
3035f6813fd5SJed Brown -   g - the global vector
303647c6ae99SBarry Smith 
303701729b5cSPatrick Sanan     Level: intermediate
303847c6ae99SBarry Smith 
3039e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
304047c6ae99SBarry Smith 
304147c6ae99SBarry Smith @*/
30427087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
304347c6ae99SBarry Smith {
30447128ae9fSMatthew G Knepley   PetscSF                 sf;
304584330215SMatthew G. Knepley   PetscSection            s;
3046d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
3047ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
304884330215SMatthew G. Knepley   PetscErrorCode          ierr;
304947c6ae99SBarry Smith 
305047c6ae99SBarry Smith   PetscFunctionBegin;
3051171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
30521bb6d2a8SBarry Smith   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
305392fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
30547128ae9fSMatthew G Knepley   switch (mode) {
30557128ae9fSMatthew G Knepley   case INSERT_VALUES:
30567128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
305784330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
30587128ae9fSMatthew G Knepley   case ADD_VALUES:
30597128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
306084330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
30617128ae9fSMatthew G Knepley   default:
306298921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
30637128ae9fSMatthew G Knepley   }
306484330215SMatthew G. Knepley   if (sf && !isInsert) {
3065ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
3066ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
3067ca3d3a14SMatthew G. Knepley     Vec                tmpl;
306884330215SMatthew G. Knepley 
3069ca3d3a14SMatthew G. Knepley     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
3070ca3d3a14SMatthew G. Knepley     if (transform) {
3071ca3d3a14SMatthew G. Knepley       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3072ca3d3a14SMatthew G. Knepley       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3073ca3d3a14SMatthew G. Knepley     } else {
3074a256111fSJunchao Zhang       ierr = VecGetArrayReadAndMemType(l, &lArray, NULL);CHKERRQ(ierr);
3075ca3d3a14SMatthew G. Knepley     }
3076a256111fSJunchao Zhang     ierr = VecGetArrayAndMemType(g, &gArray, NULL);CHKERRQ(ierr);
3077a9b180a6SBarry Smith     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
3078ca3d3a14SMatthew G. Knepley     if (transform) {
3079ca3d3a14SMatthew G. Knepley       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
3080ca3d3a14SMatthew G. Knepley       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
3081ca3d3a14SMatthew G. Knepley     } else {
3082a256111fSJunchao Zhang       ierr = VecRestoreArrayReadAndMemType(l, &lArray);CHKERRQ(ierr);
3083ca3d3a14SMatthew G. Knepley     }
3084a256111fSJunchao Zhang     ierr = VecRestoreArrayAndMemType(g, &gArray);CHKERRQ(ierr);
308584330215SMatthew G. Knepley   } else if (s && isInsert) {
30867128ae9fSMatthew G Knepley   } else {
30872c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->localtoglobalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
3088843c4018SMatthew G Knepley     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
30897128ae9fSMatthew G Knepley   }
3090d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
3091d4d07f1eSToby Isaac     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
3092d4d07f1eSToby Isaac   }
309347c6ae99SBarry Smith   PetscFunctionReturn(0);
309447c6ae99SBarry Smith }
309547c6ae99SBarry Smith 
3096f089877aSRichard Tran Mills /*@
3097bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
3098bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3099d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
3100f089877aSRichard Tran Mills 
3101d083f849SBarry Smith    Neighbor-wise Collective on dm
3102f089877aSRichard Tran Mills 
3103f089877aSRichard Tran Mills    Input Parameters:
3104f089877aSRichard Tran Mills +  dm - the DM object
3105bc0a1609SRichard Tran Mills .  g - the original local vector
3106bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3107f089877aSRichard Tran Mills 
3108bc0a1609SRichard Tran Mills    Output Parameter:
3109bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3110f089877aSRichard Tran Mills 
3111f089877aSRichard Tran Mills    Level: intermediate
3112f089877aSRichard Tran Mills 
3113bc0a1609SRichard Tran Mills    Notes:
3114bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3115bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3116bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3117bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3118bc0a1609SRichard Tran Mills 
3119bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3120f089877aSRichard Tran Mills 
3121f089877aSRichard Tran Mills @*/
3122f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
3123f089877aSRichard Tran Mills {
3124f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3125f089877aSRichard Tran Mills 
3126f089877aSRichard Tran Mills   PetscFunctionBegin;
3127f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31282c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->localtolocalbegin,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3129f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3130f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3131f089877aSRichard Tran Mills }
3132f089877aSRichard Tran Mills 
3133f089877aSRichard Tran Mills /*@
3134bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
3135bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3136d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
3137f089877aSRichard Tran Mills 
3138d083f849SBarry Smith    Neighbor-wise Collective on dm
3139f089877aSRichard Tran Mills 
3140f089877aSRichard Tran Mills    Input Parameters:
3141bc0a1609SRichard Tran Mills +  da - the DM object
3142bc0a1609SRichard Tran Mills .  g - the original local vector
3143bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3144f089877aSRichard Tran Mills 
3145bc0a1609SRichard Tran Mills    Output Parameter:
3146bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3147f089877aSRichard Tran Mills 
3148f089877aSRichard Tran Mills    Level: intermediate
3149f089877aSRichard Tran Mills 
3150bc0a1609SRichard Tran Mills    Notes:
3151bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3152bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3153bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3154bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3155bc0a1609SRichard Tran Mills 
3156bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3157f089877aSRichard Tran Mills 
3158f089877aSRichard Tran Mills @*/
3159f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
3160f089877aSRichard Tran Mills {
3161f089877aSRichard Tran Mills   PetscErrorCode          ierr;
3162f089877aSRichard Tran Mills 
3163f089877aSRichard Tran Mills   PetscFunctionBegin;
3164f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31652c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->localtolocalend,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
3166f089877aSRichard Tran Mills   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
3167f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3168f089877aSRichard Tran Mills }
3169f089877aSRichard Tran Mills 
317047c6ae99SBarry Smith /*@
317147c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
317247c6ae99SBarry Smith 
3173d083f849SBarry Smith     Collective on dm
317447c6ae99SBarry Smith 
3175d8d19677SJose E. Roman     Input Parameters:
317647c6ae99SBarry Smith +   dm - the DM object
317791d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
317847c6ae99SBarry Smith 
317947c6ae99SBarry Smith     Output Parameter:
318047c6ae99SBarry Smith .   dmc - the coarsened DM
318147c6ae99SBarry Smith 
318247c6ae99SBarry Smith     Level: developer
318347c6ae99SBarry Smith 
3184e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
318547c6ae99SBarry Smith 
318647c6ae99SBarry Smith @*/
31877087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
318847c6ae99SBarry Smith {
318947c6ae99SBarry Smith   PetscErrorCode    ierr;
3190b17ce1afSJed Brown   DMCoarsenHookLink link;
319147c6ae99SBarry Smith 
319247c6ae99SBarry Smith   PetscFunctionBegin;
3193171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31942c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->coarsen,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
319547a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
319647c6ae99SBarry Smith   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
3197b9d85ea2SLisandro Dalcin   if (*dmc) {
3198a3574896SRichard Tran Mills     (*dmc)->bind_below = dm->bind_below; /* Propagate this from parent DM; otherwise -dm_bind_below will be useless for multigrid cases. */
3199a8fb8f29SToby Isaac     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
320043842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
32018cd211a4SJed Brown     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
3202644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
32030598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
3204656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
3205e4b4b23bSJed Brown     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
3206b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
3207b17ce1afSJed Brown       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
3208b17ce1afSJed Brown     }
3209b9d85ea2SLisandro Dalcin   }
321047a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
32112c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!(*dmc),PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3212b17ce1afSJed Brown   PetscFunctionReturn(0);
3213b17ce1afSJed Brown }
3214b17ce1afSJed Brown 
3215bb9467b5SJed Brown /*@C
3216b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3217b17ce1afSJed Brown 
3218b17ce1afSJed Brown    Logically Collective
3219b17ce1afSJed Brown 
32204165533cSJose E. Roman    Input Parameters:
3221b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3222b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3223b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
32240298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3225b17ce1afSJed Brown 
3226b17ce1afSJed Brown    Calling sequence of coarsenhook:
3227b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3228b17ce1afSJed Brown 
3229b17ce1afSJed Brown +  fine - fine level DM
3230b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3231b17ce1afSJed Brown -  ctx - optional user-defined function context
3232b17ce1afSJed Brown 
3233b17ce1afSJed Brown    Calling sequence for restricthook:
3234c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3235b17ce1afSJed Brown 
3236b17ce1afSJed Brown +  fine - fine level DM
3237b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3238c833c3b5SJed Brown .  rscale - scaling vector for restriction
3239c833c3b5SJed Brown .  inject - matrix restricting by injection
3240b17ce1afSJed Brown .  coarse - coarse level DM to update
3241b17ce1afSJed Brown -  ctx - optional user-defined function context
3242b17ce1afSJed Brown 
3243b17ce1afSJed Brown    Level: advanced
3244b17ce1afSJed Brown 
3245b17ce1afSJed Brown    Notes:
3246b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3247b17ce1afSJed Brown 
3248b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3249b17ce1afSJed Brown 
3250b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3251b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3252b17ce1afSJed Brown 
3253bb9467b5SJed Brown    This function is currently not available from Fortran.
3254bb9467b5SJed Brown 
3255dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3256b17ce1afSJed Brown @*/
3257b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3258b17ce1afSJed Brown {
3259b17ce1afSJed Brown   PetscErrorCode    ierr;
3260b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3261b17ce1afSJed Brown 
3262b17ce1afSJed Brown   PetscFunctionBegin;
3263b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
32641e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
32651e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
32661e3d8eccSJed Brown   }
326795dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
3268b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3269b17ce1afSJed Brown   link->restricthook = restricthook;
3270b17ce1afSJed Brown   link->ctx          = ctx;
32710298fd71SBarry Smith   link->next         = NULL;
3272b17ce1afSJed Brown   *p                 = link;
3273b17ce1afSJed Brown   PetscFunctionReturn(0);
3274b17ce1afSJed Brown }
3275b17ce1afSJed Brown 
3276dc822a44SJed Brown /*@C
3277dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3278dc822a44SJed Brown 
3279dc822a44SJed Brown    Logically Collective
3280dc822a44SJed Brown 
32814165533cSJose E. Roman    Input Parameters:
3282dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3283dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3284dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3285dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3286dc822a44SJed Brown 
3287dc822a44SJed Brown    Level: advanced
3288dc822a44SJed Brown 
3289dc822a44SJed Brown    Notes:
3290dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3291dc822a44SJed Brown 
3292dc822a44SJed Brown    This function is currently not available from Fortran.
3293dc822a44SJed Brown 
3294dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3295dc822a44SJed Brown @*/
3296dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3297dc822a44SJed Brown {
3298dc822a44SJed Brown   PetscErrorCode    ierr;
3299dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3300dc822a44SJed Brown 
3301dc822a44SJed Brown   PetscFunctionBegin;
3302dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3303dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3304dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3305dc822a44SJed Brown       link = *p;
3306dc822a44SJed Brown       *p = link->next;
3307dc822a44SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3308dc822a44SJed Brown       break;
3309dc822a44SJed Brown     }
3310dc822a44SJed Brown   }
3311dc822a44SJed Brown   PetscFunctionReturn(0);
3312dc822a44SJed Brown }
3313dc822a44SJed Brown 
3314b17ce1afSJed Brown /*@
3315b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3316b17ce1afSJed Brown 
3317b17ce1afSJed Brown    Collective if any hooks are
3318b17ce1afSJed Brown 
33194165533cSJose E. Roman    Input Parameters:
3320b17ce1afSJed Brown +  fine - finer DM to use as a base
3321b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3322e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3323b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3324e91eccc2SStefano Zampini -  coarse - coarser DM to update
3325b17ce1afSJed Brown 
3326b17ce1afSJed Brown    Level: developer
3327b17ce1afSJed Brown 
3328b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3329b17ce1afSJed Brown @*/
3330b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3331b17ce1afSJed Brown {
3332b17ce1afSJed Brown   PetscErrorCode    ierr;
3333b17ce1afSJed Brown   DMCoarsenHookLink link;
3334b17ce1afSJed Brown 
3335b17ce1afSJed Brown   PetscFunctionBegin;
3336b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
33378865f1eaSKarl Rupp     if (link->restricthook) {
33388865f1eaSKarl Rupp       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
33398865f1eaSKarl Rupp     }
3340b17ce1afSJed Brown   }
334147c6ae99SBarry Smith   PetscFunctionReturn(0);
334247c6ae99SBarry Smith }
334347c6ae99SBarry Smith 
3344bb9467b5SJed Brown /*@C
3345be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
33465dbd56e3SPeter Brune 
3347d083f849SBarry Smith    Logically Collective on global
33485dbd56e3SPeter Brune 
33494165533cSJose E. Roman    Input Parameters:
33505dbd56e3SPeter Brune +  global - global DM
3351ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
33525dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
33530298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
33545dbd56e3SPeter Brune 
3355ec4806b8SPeter Brune    Calling sequence for ddhook:
3356ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3357ec4806b8SPeter Brune 
3358ec4806b8SPeter Brune +  global - global DM
3359ec4806b8SPeter Brune .  block  - block DM
3360ec4806b8SPeter Brune -  ctx - optional user-defined function context
3361ec4806b8SPeter Brune 
33625dbd56e3SPeter Brune    Calling sequence for restricthook:
3363ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
33645dbd56e3SPeter Brune 
33655dbd56e3SPeter Brune +  global - global DM
33665dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
33675dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3368ec4806b8SPeter Brune .  block  - block DM
33695dbd56e3SPeter Brune -  ctx - optional user-defined function context
33705dbd56e3SPeter Brune 
33715dbd56e3SPeter Brune    Level: advanced
33725dbd56e3SPeter Brune 
33735dbd56e3SPeter Brune    Notes:
3374ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
33755dbd56e3SPeter Brune 
33765dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
33775dbd56e3SPeter Brune 
33785dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3379ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
33805dbd56e3SPeter Brune 
3381bb9467b5SJed Brown    This function is currently not available from Fortran.
3382bb9467b5SJed Brown 
33835dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
33845dbd56e3SPeter Brune @*/
3385be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
33865dbd56e3SPeter Brune {
33875dbd56e3SPeter Brune   PetscErrorCode      ierr;
3388be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
33895dbd56e3SPeter Brune 
33905dbd56e3SPeter Brune   PetscFunctionBegin;
33915dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3392b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3393b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3394b3a6b972SJed Brown   }
339595dccacaSBarry Smith   ierr               = PetscNew(&link);CHKERRQ(ierr);
33965dbd56e3SPeter Brune   link->restricthook = restricthook;
3397be081cd6SPeter Brune   link->ddhook       = ddhook;
33985dbd56e3SPeter Brune   link->ctx          = ctx;
33990298fd71SBarry Smith   link->next         = NULL;
34005dbd56e3SPeter Brune   *p                 = link;
34015dbd56e3SPeter Brune   PetscFunctionReturn(0);
34025dbd56e3SPeter Brune }
34035dbd56e3SPeter Brune 
3404b3a6b972SJed Brown /*@C
3405b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3406b3a6b972SJed Brown 
3407b3a6b972SJed Brown    Logically Collective
3408b3a6b972SJed Brown 
34094165533cSJose E. Roman    Input Parameters:
3410b3a6b972SJed Brown +  global - global DM
3411b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3412b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3413b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3414b3a6b972SJed Brown 
3415b3a6b972SJed Brown    Level: advanced
3416b3a6b972SJed Brown 
3417b3a6b972SJed Brown    Notes:
3418b3a6b972SJed Brown 
3419b3a6b972SJed Brown    This function is currently not available from Fortran.
3420b3a6b972SJed Brown 
3421b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3422b3a6b972SJed Brown @*/
3423b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3424b3a6b972SJed Brown {
3425b3a6b972SJed Brown   PetscErrorCode      ierr;
3426b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3427b3a6b972SJed Brown 
3428b3a6b972SJed Brown   PetscFunctionBegin;
3429b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3430b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3431b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3432b3a6b972SJed Brown       link = *p;
3433b3a6b972SJed Brown       *p = link->next;
3434b3a6b972SJed Brown       ierr = PetscFree(link);CHKERRQ(ierr);
3435b3a6b972SJed Brown       break;
3436b3a6b972SJed Brown     }
3437b3a6b972SJed Brown   }
3438b3a6b972SJed Brown   PetscFunctionReturn(0);
3439b3a6b972SJed Brown }
3440b3a6b972SJed Brown 
34415dbd56e3SPeter Brune /*@
3442be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
34435dbd56e3SPeter Brune 
34445dbd56e3SPeter Brune    Collective if any hooks are
34455dbd56e3SPeter Brune 
34464165533cSJose E. Roman    Input Parameters:
34475dbd56e3SPeter Brune +  fine - finer DM to use as a base
3448be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3449be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
34505dbd56e3SPeter Brune -  coarse - coarer DM to update
34515dbd56e3SPeter Brune 
34525dbd56e3SPeter Brune    Level: developer
34535dbd56e3SPeter Brune 
34545dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
34555dbd56e3SPeter Brune @*/
3456be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
34575dbd56e3SPeter Brune {
34585dbd56e3SPeter Brune   PetscErrorCode      ierr;
3459be081cd6SPeter Brune   DMSubDomainHookLink link;
34605dbd56e3SPeter Brune 
34615dbd56e3SPeter Brune   PetscFunctionBegin;
3462be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
34638865f1eaSKarl Rupp     if (link->restricthook) {
34648865f1eaSKarl Rupp       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
34658865f1eaSKarl Rupp     }
34665dbd56e3SPeter Brune   }
34675dbd56e3SPeter Brune   PetscFunctionReturn(0);
34685dbd56e3SPeter Brune }
34695dbd56e3SPeter Brune 
34705fe1f584SPeter Brune /*@
34716a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
34725fe1f584SPeter Brune 
34735fe1f584SPeter Brune     Not Collective
34745fe1f584SPeter Brune 
34755fe1f584SPeter Brune     Input Parameter:
34765fe1f584SPeter Brune .   dm - the DM object
34775fe1f584SPeter Brune 
34785fe1f584SPeter Brune     Output Parameter:
34796a7d9d85SPeter Brune .   level - number of coarsenings
34805fe1f584SPeter Brune 
34815fe1f584SPeter Brune     Level: developer
34825fe1f584SPeter Brune 
34836a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34845fe1f584SPeter Brune 
34855fe1f584SPeter Brune @*/
34865fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
34875fe1f584SPeter Brune {
34885fe1f584SPeter Brune   PetscFunctionBegin;
34895fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3490b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
34915fe1f584SPeter Brune   *level = dm->leveldown;
34925fe1f584SPeter Brune   PetscFunctionReturn(0);
34935fe1f584SPeter Brune }
34945fe1f584SPeter Brune 
34959a64c4a8SMatthew G. Knepley /*@
34969a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
34979a64c4a8SMatthew G. Knepley 
34989a64c4a8SMatthew G. Knepley     Not Collective
34999a64c4a8SMatthew G. Knepley 
35009a64c4a8SMatthew G. Knepley     Input Parameters:
35019a64c4a8SMatthew G. Knepley +   dm - the DM object
35029a64c4a8SMatthew G. Knepley -   level - number of coarsenings
35039a64c4a8SMatthew G. Knepley 
35049a64c4a8SMatthew G. Knepley     Level: developer
35059a64c4a8SMatthew G. Knepley 
35069a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
35079a64c4a8SMatthew G. Knepley @*/
35089a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
35099a64c4a8SMatthew G. Knepley {
35109a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
35119a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35129a64c4a8SMatthew G. Knepley   dm->leveldown = level;
35139a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
35149a64c4a8SMatthew G. Knepley }
35159a64c4a8SMatthew G. Knepley 
351647c6ae99SBarry Smith /*@C
351747c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
351847c6ae99SBarry Smith 
3519d083f849SBarry Smith     Collective on dm
352047c6ae99SBarry Smith 
3521d8d19677SJose E. Roman     Input Parameters:
352247c6ae99SBarry Smith +   dm - the DM object
352347c6ae99SBarry Smith -   nlevels - the number of levels of refinement
352447c6ae99SBarry Smith 
352547c6ae99SBarry Smith     Output Parameter:
352647c6ae99SBarry Smith .   dmf - the refined DM hierarchy
352747c6ae99SBarry Smith 
352847c6ae99SBarry Smith     Level: developer
352947c6ae99SBarry Smith 
3530e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
353147c6ae99SBarry Smith 
353247c6ae99SBarry Smith @*/
35337087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
353447c6ae99SBarry Smith {
353547c6ae99SBarry Smith   PetscErrorCode ierr;
353647c6ae99SBarry Smith 
353747c6ae99SBarry Smith   PetscFunctionBegin;
3538171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35392c71b3e2SJacob Faibussowitsch   PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
354047c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3541b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
354247c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
354347c6ae99SBarry Smith     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
354447c6ae99SBarry Smith   } else if (dm->ops->refine) {
354547c6ae99SBarry Smith     PetscInt i;
354647c6ae99SBarry Smith 
3547ce94432eSBarry Smith     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
354847c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3549ce94432eSBarry Smith       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
355047c6ae99SBarry Smith     }
3551ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
355247c6ae99SBarry Smith   PetscFunctionReturn(0);
355347c6ae99SBarry Smith }
355447c6ae99SBarry Smith 
355547c6ae99SBarry Smith /*@C
355647c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
355747c6ae99SBarry Smith 
3558d083f849SBarry Smith     Collective on dm
355947c6ae99SBarry Smith 
3560d8d19677SJose E. Roman     Input Parameters:
356147c6ae99SBarry Smith +   dm - the DM object
356247c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
356347c6ae99SBarry Smith 
356447c6ae99SBarry Smith     Output Parameter:
356547c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
356647c6ae99SBarry Smith 
356747c6ae99SBarry Smith     Level: developer
356847c6ae99SBarry Smith 
3569e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
357047c6ae99SBarry Smith 
357147c6ae99SBarry Smith @*/
35727087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
357347c6ae99SBarry Smith {
357447c6ae99SBarry Smith   PetscErrorCode ierr;
357547c6ae99SBarry Smith 
357647c6ae99SBarry Smith   PetscFunctionBegin;
3577171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35782c71b3e2SJacob Faibussowitsch   PetscCheckFalse(nlevels < 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
357947c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
358047c6ae99SBarry Smith   PetscValidPointer(dmc,3);
358147c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
358247c6ae99SBarry Smith     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
358347c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
358447c6ae99SBarry Smith     PetscInt i;
358547c6ae99SBarry Smith 
3586ce94432eSBarry Smith     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
358747c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
3588ce94432eSBarry Smith       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
358947c6ae99SBarry Smith     }
3590ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
359147c6ae99SBarry Smith   PetscFunctionReturn(0);
359247c6ae99SBarry Smith }
359347c6ae99SBarry Smith 
35941a266240SBarry Smith /*@C
35951a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
35961a266240SBarry Smith 
35971a266240SBarry Smith     Not Collective
35981a266240SBarry Smith 
35991a266240SBarry Smith     Input Parameters:
36001a266240SBarry Smith +   dm - the DM object
36011a266240SBarry Smith -   destroy - the destroy function
36021a266240SBarry Smith 
36031a266240SBarry Smith     Level: intermediate
36041a266240SBarry Smith 
3605e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
36061a266240SBarry Smith 
3607f07f9ceaSJed Brown @*/
36081a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
36091a266240SBarry Smith {
36101a266240SBarry Smith   PetscFunctionBegin;
3611171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
36121a266240SBarry Smith   dm->ctxdestroy = destroy;
36131a266240SBarry Smith   PetscFunctionReturn(0);
36141a266240SBarry Smith }
36151a266240SBarry Smith 
3616b07ff414SBarry Smith /*@
36171b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
361847c6ae99SBarry Smith 
361947c6ae99SBarry Smith     Not Collective
362047c6ae99SBarry Smith 
362147c6ae99SBarry Smith     Input Parameters:
362247c6ae99SBarry Smith +   dm - the DM object
362347c6ae99SBarry Smith -   ctx - the user context
362447c6ae99SBarry Smith 
362547c6ae99SBarry Smith     Level: intermediate
362647c6ae99SBarry Smith 
3627e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
362847c6ae99SBarry Smith 
362947c6ae99SBarry Smith @*/
36301b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
363147c6ae99SBarry Smith {
363247c6ae99SBarry Smith   PetscFunctionBegin;
3633171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
363447c6ae99SBarry Smith   dm->ctx = ctx;
363547c6ae99SBarry Smith   PetscFunctionReturn(0);
363647c6ae99SBarry Smith }
363747c6ae99SBarry Smith 
363847c6ae99SBarry Smith /*@
36391b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
364047c6ae99SBarry Smith 
364147c6ae99SBarry Smith     Not Collective
364247c6ae99SBarry Smith 
364347c6ae99SBarry Smith     Input Parameter:
364447c6ae99SBarry Smith .   dm - the DM object
364547c6ae99SBarry Smith 
364647c6ae99SBarry Smith     Output Parameter:
364747c6ae99SBarry Smith .   ctx - the user context
364847c6ae99SBarry Smith 
364947c6ae99SBarry Smith     Level: intermediate
365047c6ae99SBarry Smith 
3651e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
365247c6ae99SBarry Smith 
365347c6ae99SBarry Smith @*/
36541b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
365547c6ae99SBarry Smith {
365647c6ae99SBarry Smith   PetscFunctionBegin;
3657171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
36581b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
365947c6ae99SBarry Smith   PetscFunctionReturn(0);
366047c6ae99SBarry Smith }
366147c6ae99SBarry Smith 
366208da532bSDmitry Karpeev /*@C
3663df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
366408da532bSDmitry Karpeev 
3665d083f849SBarry Smith     Logically Collective on dm
366608da532bSDmitry Karpeev 
3667d8d19677SJose E. Roman     Input Parameters:
366808da532bSDmitry Karpeev +   dm - the DM object
36690298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
367008da532bSDmitry Karpeev 
367108da532bSDmitry Karpeev     Level: intermediate
367208da532bSDmitry Karpeev 
3673835c3ec7SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
367408da532bSDmitry Karpeev          DMSetJacobian()
367508da532bSDmitry Karpeev 
367608da532bSDmitry Karpeev @*/
367708da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
367808da532bSDmitry Karpeev {
367908da532bSDmitry Karpeev   PetscFunctionBegin;
36805a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
368108da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
368208da532bSDmitry Karpeev   PetscFunctionReturn(0);
368308da532bSDmitry Karpeev }
368408da532bSDmitry Karpeev 
368508da532bSDmitry Karpeev /*@
368608da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
368708da532bSDmitry Karpeev 
368808da532bSDmitry Karpeev     Not Collective
368908da532bSDmitry Karpeev 
369008da532bSDmitry Karpeev     Input Parameter:
369108da532bSDmitry Karpeev .   dm - the DM object to destroy
369208da532bSDmitry Karpeev 
369308da532bSDmitry Karpeev     Output Parameter:
369408da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
369508da532bSDmitry Karpeev 
369608da532bSDmitry Karpeev     Level: developer
369708da532bSDmitry Karpeev 
369874e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
369908da532bSDmitry Karpeev 
370008da532bSDmitry Karpeev @*/
370108da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
370208da532bSDmitry Karpeev {
370308da532bSDmitry Karpeev   PetscFunctionBegin;
37045a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3705534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
370608da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
370708da532bSDmitry Karpeev   PetscFunctionReturn(0);
370808da532bSDmitry Karpeev }
370908da532bSDmitry Karpeev 
371008da532bSDmitry Karpeev /*@C
371108da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
371208da532bSDmitry Karpeev 
3713d083f849SBarry Smith     Logically Collective on dm
371408da532bSDmitry Karpeev 
3715f899ff85SJose E. Roman     Input Parameter:
3716907376e6SBarry Smith .   dm - the DM object
371708da532bSDmitry Karpeev 
371808da532bSDmitry Karpeev     Output parameters:
371908da532bSDmitry Karpeev +   xl - lower bound
372008da532bSDmitry Karpeev -   xu - upper bound
372108da532bSDmitry Karpeev 
3722907376e6SBarry Smith     Level: advanced
3723907376e6SBarry Smith 
372495452b02SPatrick Sanan     Notes:
372595452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
372608da532bSDmitry Karpeev 
372774e1e8c1SBarry Smith .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
372808da532bSDmitry Karpeev 
372908da532bSDmitry Karpeev @*/
373008da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
373108da532bSDmitry Karpeev {
373208da532bSDmitry Karpeev   PetscErrorCode ierr;
37335fd66863SKarl Rupp 
373408da532bSDmitry Karpeev   PetscFunctionBegin;
37355a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
373608da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
37375a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
37382c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computevariablebounds,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
373908da532bSDmitry Karpeev   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
374008da532bSDmitry Karpeev   PetscFunctionReturn(0);
374108da532bSDmitry Karpeev }
374208da532bSDmitry Karpeev 
3743b0ae01b7SPeter Brune /*@
3744b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3745b0ae01b7SPeter Brune 
3746b0ae01b7SPeter Brune     Not Collective
3747b0ae01b7SPeter Brune 
3748b0ae01b7SPeter Brune     Input Parameter:
3749b0ae01b7SPeter Brune .   dm - the DM object
3750b0ae01b7SPeter Brune 
3751b0ae01b7SPeter Brune     Output Parameter:
3752b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3753b0ae01b7SPeter Brune 
3754b0ae01b7SPeter Brune     Level: developer
3755b0ae01b7SPeter Brune 
37561565f0a7SPatrick Sanan .seealso DMCreateColoring()
3757b0ae01b7SPeter Brune 
3758b0ae01b7SPeter Brune @*/
3759b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3760b0ae01b7SPeter Brune {
3761b0ae01b7SPeter Brune   PetscFunctionBegin;
37625a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3763534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3764b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3765b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3766b0ae01b7SPeter Brune }
3767b0ae01b7SPeter Brune 
37683ad4599aSBarry Smith /*@
37693ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
37703ad4599aSBarry Smith 
37713ad4599aSBarry Smith     Not Collective
37723ad4599aSBarry Smith 
37733ad4599aSBarry Smith     Input Parameter:
37743ad4599aSBarry Smith .   dm - the DM object
37753ad4599aSBarry Smith 
37763ad4599aSBarry Smith     Output Parameter:
37773ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
37783ad4599aSBarry Smith 
37793ad4599aSBarry Smith     Level: developer
37803ad4599aSBarry Smith 
37811565f0a7SPatrick Sanan .seealso DMCreateRestriction()
37823ad4599aSBarry Smith 
37833ad4599aSBarry Smith @*/
37843ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
37853ad4599aSBarry Smith {
37863ad4599aSBarry Smith   PetscFunctionBegin;
37875a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3788534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37893ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
37903ad4599aSBarry Smith   PetscFunctionReturn(0);
37913ad4599aSBarry Smith }
37923ad4599aSBarry Smith 
3793a7058e45SLawrence Mitchell /*@
3794a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3795a7058e45SLawrence Mitchell 
3796a7058e45SLawrence Mitchell     Not Collective
3797a7058e45SLawrence Mitchell 
3798a7058e45SLawrence Mitchell     Input Parameter:
3799a7058e45SLawrence Mitchell .   dm - the DM object
3800a7058e45SLawrence Mitchell 
3801a7058e45SLawrence Mitchell     Output Parameter:
3802a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3803a7058e45SLawrence Mitchell 
3804a7058e45SLawrence Mitchell     Level: developer
3805a7058e45SLawrence Mitchell 
38061565f0a7SPatrick Sanan .seealso DMCreateInjection()
3807a7058e45SLawrence Mitchell 
3808a7058e45SLawrence Mitchell @*/
3809a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3810a7058e45SLawrence Mitchell {
38114a7a4c06SLawrence Mitchell   PetscErrorCode ierr;
38125a84ad33SLisandro Dalcin 
3813a7058e45SLawrence Mitchell   PetscFunctionBegin;
38145a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3815534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
38165a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
38174a7a4c06SLawrence Mitchell     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
38185a84ad33SLisandro Dalcin   } else {
38195a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
38205a84ad33SLisandro Dalcin   }
3821a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3822a7058e45SLawrence Mitchell }
3823a7058e45SLawrence Mitchell 
38240298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3825264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3826264ace61SBarry Smith 
3827264ace61SBarry Smith /*@C
3828264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3829264ace61SBarry Smith 
3830d083f849SBarry Smith   Collective on dm
3831264ace61SBarry Smith 
3832264ace61SBarry Smith   Input Parameters:
3833264ace61SBarry Smith + dm     - The DM object
3834264ace61SBarry Smith - method - The name of the DM type
3835264ace61SBarry Smith 
3836264ace61SBarry Smith   Options Database Key:
3837264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3838264ace61SBarry Smith 
3839264ace61SBarry Smith   Notes:
3840e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3841264ace61SBarry Smith 
3842264ace61SBarry Smith   Level: intermediate
3843264ace61SBarry Smith 
3844264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3845264ace61SBarry Smith @*/
384619fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3847264ace61SBarry Smith {
3848264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3849264ace61SBarry Smith   PetscBool      match;
3850264ace61SBarry Smith   PetscErrorCode ierr;
3851264ace61SBarry Smith 
3852264ace61SBarry Smith   PetscFunctionBegin;
3853264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3854251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3855264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3856264ace61SBarry Smith 
38570f51fdf8SToby Isaac   ierr = DMRegisterAll();CHKERRQ(ierr);
38581c9cd337SJed Brown   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
38592c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!r,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3860264ace61SBarry Smith 
3861264ace61SBarry Smith   if (dm->ops->destroy) {
3862264ace61SBarry Smith     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3863264ace61SBarry Smith   }
3864d57f96a3SLisandro Dalcin   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3865264ace61SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3866d57f96a3SLisandro Dalcin   ierr = (*r)(dm);CHKERRQ(ierr);
3867264ace61SBarry Smith   PetscFunctionReturn(0);
3868264ace61SBarry Smith }
3869264ace61SBarry Smith 
3870264ace61SBarry Smith /*@C
3871264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3872264ace61SBarry Smith 
3873264ace61SBarry Smith   Not Collective
3874264ace61SBarry Smith 
3875264ace61SBarry Smith   Input Parameter:
3876264ace61SBarry Smith . dm  - The DM
3877264ace61SBarry Smith 
3878264ace61SBarry Smith   Output Parameter:
3879264ace61SBarry Smith . type - The DM type name
3880264ace61SBarry Smith 
3881264ace61SBarry Smith   Level: intermediate
3882264ace61SBarry Smith 
3883264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3884264ace61SBarry Smith @*/
388519fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3886264ace61SBarry Smith {
3887264ace61SBarry Smith   PetscErrorCode ierr;
3888264ace61SBarry Smith 
3889264ace61SBarry Smith   PetscFunctionBegin;
3890264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3891c959eef4SJed Brown   PetscValidPointer(type,2);
3892607a6623SBarry Smith   ierr = DMRegisterAll();CHKERRQ(ierr);
3893264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3894264ace61SBarry Smith   PetscFunctionReturn(0);
3895264ace61SBarry Smith }
3896264ace61SBarry Smith 
389767a56275SMatthew G Knepley /*@C
389867a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
389967a56275SMatthew G Knepley 
3900d083f849SBarry Smith   Collective on dm
390167a56275SMatthew G Knepley 
390267a56275SMatthew G Knepley   Input Parameters:
390367a56275SMatthew G Knepley + dm - the DM
390467a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
390567a56275SMatthew G Knepley 
390667a56275SMatthew G Knepley   Output Parameter:
390767a56275SMatthew G Knepley . M - pointer to new DM
390867a56275SMatthew G Knepley 
390967a56275SMatthew G Knepley   Notes:
391067a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
391167a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
391267a56275SMatthew G Knepley   of the input DM.
391367a56275SMatthew G Knepley 
391467a56275SMatthew G Knepley   Level: intermediate
391567a56275SMatthew G Knepley 
391667a56275SMatthew G Knepley .seealso: DMCreate()
391767a56275SMatthew G Knepley @*/
391819fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
391967a56275SMatthew G Knepley {
392067a56275SMatthew G Knepley   DM             B;
392167a56275SMatthew G Knepley   char           convname[256];
3922c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
392367a56275SMatthew G Knepley   PetscErrorCode ierr;
392467a56275SMatthew G Knepley 
392567a56275SMatthew G Knepley   PetscFunctionBegin;
392667a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
392767a56275SMatthew G Knepley   PetscValidType(dm,1);
392867a56275SMatthew G Knepley   PetscValidPointer(M,3);
3929251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3930c067b6caSMatthew G. Knepley   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3931c067b6caSMatthew G. Knepley   if (sametype) {
3932c067b6caSMatthew G. Knepley     *M   = dm;
3933c067b6caSMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3934c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3935c067b6caSMatthew G. Knepley   } else {
39360298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
393767a56275SMatthew G Knepley 
393867a56275SMatthew G Knepley     /*
393967a56275SMatthew G Knepley        Order of precedence:
394067a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
394167a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
394267a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
394367a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
394467a56275SMatthew G Knepley        5) Use a really basic converter.
394567a56275SMatthew G Knepley     */
394667a56275SMatthew G Knepley 
394767a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
3948a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3949a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3950a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3951a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3952a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
39530005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
395467a56275SMatthew G Knepley     if (conv) goto foundconv;
395567a56275SMatthew G Knepley 
395667a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
395782f516ccSBarry Smith     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
395867a56275SMatthew G Knepley     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3959a126751eSBarry Smith     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3960a126751eSBarry Smith     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3961a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3962a126751eSBarry Smith     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3963a126751eSBarry Smith     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
39640005d66cSJed Brown     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
396567a56275SMatthew G Knepley     if (conv) {
3966fcfd50ebSBarry Smith       ierr = DMDestroy(&B);CHKERRQ(ierr);
396767a56275SMatthew G Knepley       goto foundconv;
396867a56275SMatthew G Knepley     }
396967a56275SMatthew G Knepley 
397067a56275SMatthew G Knepley #if 0
397167a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
397267a56275SMatthew G Knepley     conv = B->ops->convertfrom;
3973fcfd50ebSBarry Smith     ierr = DMDestroy(&B);CHKERRQ(ierr);
397467a56275SMatthew G Knepley     if (conv) goto foundconv;
397567a56275SMatthew G Knepley 
397667a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
397767a56275SMatthew G Knepley     if (dm->ops->convert) {
397867a56275SMatthew G Knepley       conv = dm->ops->convert;
397967a56275SMatthew G Knepley     }
398067a56275SMatthew G Knepley     if (conv) goto foundconv;
398167a56275SMatthew G Knepley #endif
398267a56275SMatthew G Knepley 
398367a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
398498921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
398567a56275SMatthew G Knepley 
398667a56275SMatthew G Knepley foundconv:
398767a56275SMatthew G Knepley     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
398867a56275SMatthew G Knepley     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
398912fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
399090b157c4SStefano Zampini     {
399190b157c4SStefano Zampini       PetscBool             isper;
399212fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
399312fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
399490b157c4SStefano Zampini       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
399590b157c4SStefano Zampini       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
3996c8a6034eSMark       (*M)->prealloc_only = dm->prealloc_only;
3997a587d139SMark       ierr = PetscFree((*M)->vectype);CHKERRQ(ierr);
3998a587d139SMark       ierr = PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype);CHKERRQ(ierr);
3999a587d139SMark       ierr = PetscFree((*M)->mattype);CHKERRQ(ierr);
4000a587d139SMark       ierr = PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype);CHKERRQ(ierr);
400112fa691eSMatthew G. Knepley     }
400267a56275SMatthew G Knepley     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
400367a56275SMatthew G Knepley   }
400467a56275SMatthew G Knepley   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
400567a56275SMatthew G Knepley   PetscFunctionReturn(0);
400667a56275SMatthew G Knepley }
4007264ace61SBarry Smith 
4008264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
4009264ace61SBarry Smith 
4010264ace61SBarry Smith /*@C
40111c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
40121c84c290SBarry Smith 
40131c84c290SBarry Smith   Not Collective
40141c84c290SBarry Smith 
40151c84c290SBarry Smith   Input Parameters:
40161c84c290SBarry Smith + name        - The name of a new user-defined creation routine
40171c84c290SBarry Smith - create_func - The creation routine itself
40181c84c290SBarry Smith 
40191c84c290SBarry Smith   Notes:
40201c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
40211c84c290SBarry Smith 
40221c84c290SBarry Smith   Sample usage:
40231c84c290SBarry Smith .vb
4024bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
40251c84c290SBarry Smith .ve
40261c84c290SBarry Smith 
40271c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
40281c84c290SBarry Smith .vb
40291c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
40301c84c290SBarry Smith     DMSetType(DM,"my_da");
40311c84c290SBarry Smith .ve
40321c84c290SBarry Smith    or at runtime via the option
40331c84c290SBarry Smith .vb
40341c84c290SBarry Smith     -da_type my_da
40351c84c290SBarry Smith .ve
4036264ace61SBarry Smith 
4037264ace61SBarry Smith   Level: advanced
40381c84c290SBarry Smith 
4039bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
40401c84c290SBarry Smith 
4041264ace61SBarry Smith @*/
4042bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
4043264ace61SBarry Smith {
4044264ace61SBarry Smith   PetscErrorCode ierr;
4045264ace61SBarry Smith 
4046264ace61SBarry Smith   PetscFunctionBegin;
40471d36bdfdSBarry Smith   ierr = DMInitializePackage();CHKERRQ(ierr);
4048a240a19fSJed Brown   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
4049264ace61SBarry Smith   PetscFunctionReturn(0);
4050264ace61SBarry Smith }
4051264ace61SBarry Smith 
4052b859378eSBarry Smith /*@C
405355849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
4054b859378eSBarry Smith 
4055d083f849SBarry Smith   Collective on viewer
4056b859378eSBarry Smith 
4057b859378eSBarry Smith   Input Parameters:
4058b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
4059b859378eSBarry Smith            some related function before a call to DMLoad().
4060b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
4061b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
4062b859378eSBarry Smith 
4063b859378eSBarry Smith    Level: intermediate
4064b859378eSBarry Smith 
4065b859378eSBarry Smith   Notes:
406655849f57SBarry Smith   The type is determined by the data in the file, any type set into the DM before this call is ignored.
4067b859378eSBarry Smith 
4068cd7e8a5eSksagiyam   Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex
4069cd7e8a5eSksagiyam   meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName()
4070cd7e8a5eSksagiyam   before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object.
4071cd7e8a5eSksagiyam 
4072b859378eSBarry Smith   Notes for advanced users:
4073b859378eSBarry Smith   Most users should not need to know the details of the binary storage
4074b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
4075b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
4076b859378eSBarry Smith   format is
4077b859378eSBarry Smith .vb
4078b859378eSBarry Smith      has not yet been determined
4079b859378eSBarry Smith .ve
4080b859378eSBarry Smith 
4081b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
4082b859378eSBarry Smith @*/
4083b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
4084b859378eSBarry Smith {
40859331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
4086b859378eSBarry Smith   PetscErrorCode ierr;
4087b859378eSBarry Smith 
4088b859378eSBarry Smith   PetscFunctionBegin;
4089b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
4090b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
4091fb694a9eSVaclav Hapla   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
409232c0f0efSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
40939331c7a4SMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
409458cd63d5SVaclav Hapla   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
40959331c7a4SMatthew G. Knepley   if (isbinary) {
40969331c7a4SMatthew G. Knepley     PetscInt classid;
40979331c7a4SMatthew G. Knepley     char     type[256];
4098b859378eSBarry Smith 
4099060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
41002c71b3e2SJacob Faibussowitsch     PetscCheckFalse(classid != DM_FILE_CLASSID,PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
4101060da220SMatthew G. Knepley     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
410232c0f0efSBarry Smith     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
41039331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
41049331c7a4SMatthew G. Knepley   } else if (ishdf5) {
41059331c7a4SMatthew G. Knepley     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
41069331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
410758cd63d5SVaclav Hapla   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
4108b859378eSBarry Smith   PetscFunctionReturn(0);
4109b859378eSBarry Smith }
4110b859378eSBarry Smith 
4111b2e4378dSMatthew G. Knepley /*@
4112b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
4113b2e4378dSMatthew G. Knepley 
4114b2e4378dSMatthew G. Knepley   Not collective
4115b2e4378dSMatthew G. Knepley 
4116b2e4378dSMatthew G. Knepley   Input Parameter:
4117b2e4378dSMatthew G. Knepley . dm - the DM
4118b2e4378dSMatthew G. Knepley 
4119b2e4378dSMatthew G. Knepley   Output Parameters:
4120b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
4121b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
4122b2e4378dSMatthew G. Knepley 
4123b2e4378dSMatthew G. Knepley   Level: beginner
4124b2e4378dSMatthew G. Knepley 
4125b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
4126b2e4378dSMatthew G. Knepley 
4127b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
4128b2e4378dSMatthew G. Knepley @*/
4129b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
4130b2e4378dSMatthew G. Knepley {
4131b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
4132b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
4133b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
4134b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
4135b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
4136b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
4137b2e4378dSMatthew G. Knepley   PetscErrorCode     ierr;
4138b2e4378dSMatthew G. Knepley 
4139b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4140b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4141b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4142b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
4143b2e4378dSMatthew G. Knepley   if (coords) {
4144b2e4378dSMatthew G. Knepley     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
4145b2e4378dSMatthew G. Knepley     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
4146b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
4147b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
4148b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
4149b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4150b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4151b2e4378dSMatthew G. Knepley       }
4152b2e4378dSMatthew G. Knepley     }
4153b2e4378dSMatthew G. Knepley     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
4154b2e4378dSMatthew G. Knepley   } else {
4155b2e4378dSMatthew G. Knepley     PetscBool isda;
4156b2e4378dSMatthew G. Knepley 
4157b2e4378dSMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
4158b2e4378dSMatthew G. Knepley     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
4159b2e4378dSMatthew G. Knepley   }
4160b2e4378dSMatthew G. Knepley   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
4161b2e4378dSMatthew G. Knepley   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
4162b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4163b2e4378dSMatthew G. Knepley }
4164b2e4378dSMatthew G. Knepley 
4165b2e4378dSMatthew G. Knepley /*@
4166b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
4167b2e4378dSMatthew G. Knepley 
4168b2e4378dSMatthew G. Knepley   Collective
4169b2e4378dSMatthew G. Knepley 
4170b2e4378dSMatthew G. Knepley   Input Parameter:
4171b2e4378dSMatthew G. Knepley . dm - the DM
4172b2e4378dSMatthew G. Knepley 
4173b2e4378dSMatthew G. Knepley   Output Parameters:
4174b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
4175b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
4176b2e4378dSMatthew G. Knepley 
4177b2e4378dSMatthew G. Knepley   Level: beginner
4178b2e4378dSMatthew G. Knepley 
4179b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
4180b2e4378dSMatthew G. Knepley @*/
4181b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
4182b2e4378dSMatthew G. Knepley {
4183b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
41846ce308c4SMatthew G. Knepley   PetscInt       cdim;
41856ce308c4SMatthew G. Knepley   PetscMPIInt    count;
4186b2e4378dSMatthew G. Knepley   PetscErrorCode ierr;
4187b2e4378dSMatthew G. Knepley 
4188b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4189b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4190b2e4378dSMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
4191b2e4378dSMatthew G. Knepley   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
4192b2e4378dSMatthew G. Knepley   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
4193820f2d46SBarry Smith   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4194820f2d46SBarry Smith   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);}
4195b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4196b2e4378dSMatthew G. Knepley }
4197b2e4378dSMatthew G. Knepley 
41987da65231SMatthew G Knepley /******************************** FEM Support **********************************/
41997da65231SMatthew G Knepley 
4200a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
4201a6dfd86eSKarl Rupp {
42021d47ebbbSSatish Balay   PetscInt       f;
42031b30c384SMatthew G Knepley   PetscErrorCode ierr;
42041b30c384SMatthew G Knepley 
42057da65231SMatthew G Knepley   PetscFunctionBegin;
420674778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
42071d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
420857622a8eSBarry Smith     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
42097da65231SMatthew G Knepley   }
42107da65231SMatthew G Knepley   PetscFunctionReturn(0);
42117da65231SMatthew G Knepley }
42127da65231SMatthew G Knepley 
4213a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4214a6dfd86eSKarl Rupp {
42151b30c384SMatthew G Knepley   PetscInt       f, g;
42167da65231SMatthew G Knepley   PetscErrorCode ierr;
42177da65231SMatthew G Knepley 
42187da65231SMatthew G Knepley   PetscFunctionBegin;
421974778d6cSJed Brown   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
42201d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
422174778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
42221d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
4223e3556bceSMatthew G. Knepley       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
42247da65231SMatthew G Knepley     }
422574778d6cSJed Brown     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
42267da65231SMatthew G Knepley   }
42277da65231SMatthew G Knepley   PetscFunctionReturn(0);
42287da65231SMatthew G Knepley }
4229e7c4fc90SDmitry Karpeev 
42306113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4231e759306cSMatthew G. Knepley {
42320c5b8624SToby Isaac   PetscInt          localSize, bs;
42330c5b8624SToby Isaac   PetscMPIInt       size;
42340c5b8624SToby Isaac   Vec               x, xglob;
42350c5b8624SToby Isaac   const PetscScalar *xarray;
4236e759306cSMatthew G. Knepley   PetscErrorCode    ierr;
4237e759306cSMatthew G. Knepley 
4238e759306cSMatthew G. Knepley   PetscFunctionBegin;
4239ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRMPI(ierr);
4240e759306cSMatthew G. Knepley   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
4241e759306cSMatthew G. Knepley   ierr = VecCopy(X, x);CHKERRQ(ierr);
42426113b454SMatthew G. Knepley   ierr = VecChop(x, tol);CHKERRQ(ierr);
42430c5b8624SToby Isaac   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
42440c5b8624SToby Isaac   if (size > 1) {
42450c5b8624SToby Isaac     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
42460c5b8624SToby Isaac     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
42470c5b8624SToby Isaac     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
42480c5b8624SToby Isaac     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
42490c5b8624SToby Isaac   } else {
42500c5b8624SToby Isaac     xglob = x;
42510c5b8624SToby Isaac   }
42520c5b8624SToby Isaac   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
42530c5b8624SToby Isaac   if (size > 1) {
42540c5b8624SToby Isaac     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
42550c5b8624SToby Isaac     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
42560c5b8624SToby Isaac   }
4257e759306cSMatthew G. Knepley   ierr = VecDestroy(&x);CHKERRQ(ierr);
4258e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4259e759306cSMatthew G. Knepley }
4260e759306cSMatthew G. Knepley 
426188ed4aceSMatthew G Knepley /*@
42621bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4263061576a5SJed Brown 
4264061576a5SJed Brown   Input Parameter:
4265061576a5SJed Brown . dm - The DM
4266061576a5SJed Brown 
4267061576a5SJed Brown   Output Parameter:
4268061576a5SJed Brown . section - The PetscSection
4269061576a5SJed Brown 
4270061576a5SJed Brown   Options Database Keys:
4271061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4272061576a5SJed Brown 
4273061576a5SJed Brown   Level: advanced
4274061576a5SJed Brown 
4275061576a5SJed Brown   Notes:
4276061576a5SJed Brown   Use DMGetLocalSection() in new code.
4277061576a5SJed Brown 
4278061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4279061576a5SJed Brown 
4280061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4281061576a5SJed Brown @*/
4282061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4283061576a5SJed Brown {
4284061576a5SJed Brown   PetscErrorCode ierr;
4285061576a5SJed Brown 
4286061576a5SJed Brown   PetscFunctionBegin;
4287061576a5SJed Brown   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
4288061576a5SJed Brown   PetscFunctionReturn(0);
4289061576a5SJed Brown }
4290061576a5SJed Brown 
4291061576a5SJed Brown /*@
4292061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
429388ed4aceSMatthew G Knepley 
429488ed4aceSMatthew G Knepley   Input Parameter:
429588ed4aceSMatthew G Knepley . dm - The DM
429688ed4aceSMatthew G Knepley 
429788ed4aceSMatthew G Knepley   Output Parameter:
429888ed4aceSMatthew G Knepley . section - The PetscSection
429988ed4aceSMatthew G Knepley 
4300e5893cccSMatthew G. Knepley   Options Database Keys:
4301e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4302e5893cccSMatthew G. Knepley 
430388ed4aceSMatthew G Knepley   Level: intermediate
430488ed4aceSMatthew G Knepley 
430588ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
430688ed4aceSMatthew G Knepley 
4307061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
430888ed4aceSMatthew G Knepley @*/
4309061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
43100adebc6cSBarry Smith {
4311fd59a867SMatthew G. Knepley   PetscErrorCode ierr;
4312fd59a867SMatthew G. Knepley 
431388ed4aceSMatthew G Knepley   PetscFunctionBegin;
431488ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
431588ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
43161bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4317e5e52638SMatthew G. Knepley     PetscInt d;
4318e5e52638SMatthew G. Knepley 
431945480ffeSMatthew G. Knepley     if (dm->setfromoptionscalled) {
432045480ffeSMatthew G. Knepley       PetscObject       obj = (PetscObject) dm;
432145480ffeSMatthew G. Knepley       PetscViewer       viewer;
432245480ffeSMatthew G. Knepley       PetscViewerFormat format;
432345480ffeSMatthew G. Knepley       PetscBool         flg;
432445480ffeSMatthew G. Knepley 
432545480ffeSMatthew G. Knepley       ierr = PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg);CHKERRQ(ierr);
432645480ffeSMatthew G. Knepley       if (flg) {ierr = PetscViewerPushFormat(viewer, format);CHKERRQ(ierr);}
432745480ffeSMatthew G. Knepley       for (d = 0; d < dm->Nds; ++d) {
432845480ffeSMatthew G. Knepley         ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);
432945480ffeSMatthew G. Knepley         if (flg) {ierr = PetscDSView(dm->probs[d].ds, viewer);CHKERRQ(ierr);}
433045480ffeSMatthew G. Knepley       }
433145480ffeSMatthew G. Knepley       if (flg) {
433245480ffeSMatthew G. Knepley         ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
433345480ffeSMatthew G. Knepley         ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
433445480ffeSMatthew G. Knepley         ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
433545480ffeSMatthew G. Knepley       }
433645480ffeSMatthew G. Knepley     }
43371bb6d2a8SBarry Smith     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
43381bb6d2a8SBarry Smith     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
43392f0f8703SMatthew G. Knepley   }
43401bb6d2a8SBarry Smith   *section = dm->localSection;
434188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
434288ed4aceSMatthew G Knepley }
434388ed4aceSMatthew G Knepley 
434488ed4aceSMatthew G Knepley /*@
43451bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4346061576a5SJed Brown 
4347061576a5SJed Brown   Input Parameters:
4348061576a5SJed Brown + dm - The DM
4349061576a5SJed Brown - section - The PetscSection
4350061576a5SJed Brown 
4351061576a5SJed Brown   Level: advanced
4352061576a5SJed Brown 
4353061576a5SJed Brown   Notes:
4354061576a5SJed Brown   Use DMSetLocalSection() in new code.
4355061576a5SJed Brown 
4356061576a5SJed Brown   Any existing Section will be destroyed
4357061576a5SJed Brown 
4358061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4359061576a5SJed Brown @*/
4360061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4361061576a5SJed Brown {
4362061576a5SJed Brown   PetscErrorCode ierr;
4363061576a5SJed Brown 
4364061576a5SJed Brown   PetscFunctionBegin;
4365061576a5SJed Brown   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4366061576a5SJed Brown   PetscFunctionReturn(0);
4367061576a5SJed Brown }
4368061576a5SJed Brown 
4369061576a5SJed Brown /*@
4370061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
437188ed4aceSMatthew G Knepley 
437288ed4aceSMatthew G Knepley   Input Parameters:
437388ed4aceSMatthew G Knepley + dm - The DM
437488ed4aceSMatthew G Knepley - section - The PetscSection
437588ed4aceSMatthew G Knepley 
437688ed4aceSMatthew G Knepley   Level: intermediate
437788ed4aceSMatthew G Knepley 
437888ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
437988ed4aceSMatthew G Knepley 
4380061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
438188ed4aceSMatthew G Knepley @*/
4382061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
43830adebc6cSBarry Smith {
4384c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4385af122d2aSMatthew G Knepley   PetscInt       f;
438688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
438788ed4aceSMatthew G Knepley 
438888ed4aceSMatthew G Knepley   PetscFunctionBegin;
438988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4390b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
43911d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
43921bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
43931bb6d2a8SBarry Smith   dm->localSection = section;
43941bb6d2a8SBarry Smith   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4395af122d2aSMatthew G Knepley   if (numFields) {
4396af122d2aSMatthew G Knepley     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4397af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
43980f21e855SMatthew G. Knepley       PetscObject disc;
4399af122d2aSMatthew G Knepley       const char *name;
4400af122d2aSMatthew G Knepley 
44011bb6d2a8SBarry Smith       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
440244a7f3ddSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
44030f21e855SMatthew G. Knepley       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4404af122d2aSMatthew G Knepley     }
4405af122d2aSMatthew G Knepley   }
4406e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
44071bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
440888ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
440988ed4aceSMatthew G Knepley }
441088ed4aceSMatthew G Knepley 
44119435951eSToby Isaac /*@
4412b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
44139435951eSToby Isaac 
4414e228b242SToby Isaac   not collective
4415e228b242SToby Isaac 
44169435951eSToby Isaac   Input Parameter:
44179435951eSToby Isaac . dm - The DM
44189435951eSToby Isaac 
4419d8d19677SJose E. Roman   Output Parameters:
44209435951eSToby 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.
4421*79769bd5SJed Brown . 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.
4422*79769bd5SJed Brown - bias - Vector containing bias to be added to constrained dofs
44239435951eSToby Isaac 
44249435951eSToby Isaac   Level: advanced
44259435951eSToby Isaac 
4426*79769bd5SJed Brown   Note: This gets borrowed references, so the user should not destroy the PetscSection, Mat, or Vec.
44279435951eSToby Isaac 
44289435951eSToby Isaac .seealso: DMSetDefaultConstraints()
44299435951eSToby Isaac @*/
4430*79769bd5SJed Brown PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat, Vec *bias)
44319435951eSToby Isaac {
44329435951eSToby Isaac   PetscErrorCode ierr;
44339435951eSToby Isaac 
44349435951eSToby Isaac   PetscFunctionBegin;
44359435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
44363b8ba7d1SJed Brown   if (!dm->defaultConstraint.section && !dm->defaultConstraint.mat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
44373b8ba7d1SJed Brown   if (section) *section = dm->defaultConstraint.section;
44383b8ba7d1SJed Brown   if (mat) *mat = dm->defaultConstraint.mat;
4439*79769bd5SJed Brown   if (bias) *bias = dm->defaultConstraint.bias;
44409435951eSToby Isaac   PetscFunctionReturn(0);
44419435951eSToby Isaac }
44429435951eSToby Isaac 
44439435951eSToby Isaac /*@
4444b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
44459435951eSToby Isaac 
4446*79769bd5SJed Brown   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 + bias, l[s[i]] = c[i], where the scatter s is defined by the PetscSection returned by DMGetDefaultConstraints().
44479435951eSToby Isaac 
4448*79769bd5SJed Brown   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.  Any bias, if specified, is ignored when accumulating.
44499435951eSToby Isaac 
4450e228b242SToby Isaac   collective on dm
4451e228b242SToby Isaac 
44529435951eSToby Isaac   Input Parameters:
44539435951eSToby Isaac + dm - The DM
4454*79769bd5SJed Brown . 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).
4455*79769bd5SJed Brown . 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).
4456*79769bd5SJed Brown - bias - A bias vector to be added to constrained values in the local vector.  NULL indicates no bias.  Must have a local communicator (PETSC_COMM_SELF or derivative).
44579435951eSToby Isaac 
44589435951eSToby Isaac   Level: advanced
44599435951eSToby Isaac 
4460*79769bd5SJed Brown   Note: This increments the references of the PetscSection, Mat, and Vec, so they user can destroy them.
44619435951eSToby Isaac 
44629435951eSToby Isaac .seealso: DMGetDefaultConstraints()
44639435951eSToby Isaac @*/
4464*79769bd5SJed Brown PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat, Vec bias)
44659435951eSToby Isaac {
4466e228b242SToby Isaac   PetscMPIInt result;
44679435951eSToby Isaac   PetscErrorCode ierr;
44689435951eSToby Isaac 
44699435951eSToby Isaac   PetscFunctionBegin;
44709435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4471e228b242SToby Isaac   if (section) {
4472e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4473ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRMPI(ierr);
44742c71b3e2SJacob Faibussowitsch     PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4475e228b242SToby Isaac   }
4476e228b242SToby Isaac   if (mat) {
4477e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4478ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRMPI(ierr);
44792c71b3e2SJacob Faibussowitsch     PetscCheckFalse(result != MPI_CONGRUENT && result != MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4480e228b242SToby Isaac   }
4481*79769bd5SJed Brown   if (bias) {
4482*79769bd5SJed Brown     PetscValidHeaderSpecific(bias,VEC_CLASSID,4);
4483*79769bd5SJed Brown     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)bias),&result);CHKERRMPI(ierr);
4484*79769bd5SJed Brown     PetscCheck(result == MPI_CONGRUENT || result == MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint bias must have local communicator");
4485*79769bd5SJed Brown   }
44869435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
44873b8ba7d1SJed Brown   ierr = PetscSectionDestroy(&dm->defaultConstraint.section);CHKERRQ(ierr);
44883b8ba7d1SJed Brown   dm->defaultConstraint.section = section;
44899435951eSToby Isaac   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
44903b8ba7d1SJed Brown   ierr = MatDestroy(&dm->defaultConstraint.mat);CHKERRQ(ierr);
44913b8ba7d1SJed Brown   dm->defaultConstraint.mat = mat;
4492*79769bd5SJed Brown   ierr = PetscObjectReference((PetscObject)bias);CHKERRQ(ierr);
4493*79769bd5SJed Brown   ierr = VecDestroy(&dm->defaultConstraint.bias);CHKERRQ(ierr);
4494*79769bd5SJed Brown   dm->defaultConstraint.bias = bias;
44959435951eSToby Isaac   PetscFunctionReturn(0);
44969435951eSToby Isaac }
44979435951eSToby Isaac 
4498497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4499507e4973SMatthew G. Knepley /*
4500507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4501507e4973SMatthew G. Knepley 
4502507e4973SMatthew G. Knepley   Input Parameters:
4503507e4973SMatthew G. Knepley + dm - The DM
4504507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4505507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4506507e4973SMatthew G. Knepley 
4507507e4973SMatthew G. Knepley   Level: intermediate
4508507e4973SMatthew G. Knepley 
45091bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4510507e4973SMatthew G. Knepley */
4511f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4512507e4973SMatthew G. Knepley {
4513507e4973SMatthew G. Knepley   MPI_Comm        comm;
4514507e4973SMatthew G. Knepley   PetscLayout     layout;
4515507e4973SMatthew G. Knepley   const PetscInt *ranges;
4516507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4517507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4518507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4519507e4973SMatthew G. Knepley   PetscErrorCode  ierr;
4520507e4973SMatthew G. Knepley 
4521507e4973SMatthew G. Knepley   PetscFunctionBegin;
4522507e4973SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4523507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4524ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
4525ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
4526507e4973SMatthew G. Knepley   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4527507e4973SMatthew G. Knepley   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4528507e4973SMatthew G. Knepley   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4529507e4973SMatthew G. Knepley   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4530507e4973SMatthew G. Knepley   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4531507e4973SMatthew G. Knepley   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4532507e4973SMatthew G. Knepley   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4533507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4534f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4535507e4973SMatthew G. Knepley 
4536507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4537507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4538507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4539507e4973SMatthew G. Knepley     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4540507e4973SMatthew G. Knepley     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4541507e4973SMatthew G. Knepley     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4542507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
4543507e4973SMatthew 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;}
4544507e4973SMatthew 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;}
4545507e4973SMatthew G. Knepley     if (gdof < 0) {
4546507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4547507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4548507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4549507e4973SMatthew G. Knepley 
4550507e4973SMatthew G. Knepley         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4551507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
4552507e4973SMatthew 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;}
4553507e4973SMatthew G. Knepley       }
4554507e4973SMatthew G. Knepley     }
4555507e4973SMatthew G. Knepley   }
4556507e4973SMatthew G. Knepley   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4557507e4973SMatthew G. Knepley   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4558820f2d46SBarry Smith   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
4559507e4973SMatthew G. Knepley   if (!gvalid) {
4560507e4973SMatthew G. Knepley     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4561507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4562507e4973SMatthew G. Knepley   }
4563507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4564507e4973SMatthew G. Knepley }
4565f741bcd2SMatthew G. Knepley #endif
4566507e4973SMatthew G. Knepley 
456788ed4aceSMatthew G Knepley /*@
4568e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
456988ed4aceSMatthew G Knepley 
4570d083f849SBarry Smith   Collective on dm
45718b1ab98fSJed Brown 
457288ed4aceSMatthew G Knepley   Input Parameter:
457388ed4aceSMatthew G Knepley . dm - The DM
457488ed4aceSMatthew G Knepley 
457588ed4aceSMatthew G Knepley   Output Parameter:
457688ed4aceSMatthew G Knepley . section - The PetscSection
457788ed4aceSMatthew G Knepley 
457888ed4aceSMatthew G Knepley   Level: intermediate
457988ed4aceSMatthew G Knepley 
458088ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
458188ed4aceSMatthew G Knepley 
458292fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
458388ed4aceSMatthew G Knepley @*/
4584e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
45850adebc6cSBarry Smith {
458688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
458788ed4aceSMatthew G Knepley 
458888ed4aceSMatthew G Knepley   PetscFunctionBegin;
458988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
459088ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
45911bb6d2a8SBarry Smith   if (!dm->globalSection) {
4592fd59a867SMatthew G. Knepley     PetscSection s;
4593fd59a867SMatthew G. Knepley 
459492fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
45952c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!s,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection");
45962c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->sf,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection");
45971bb6d2a8SBarry Smith     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4598cf06b437SMatthew G. Knepley     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
45991bb6d2a8SBarry Smith     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
46001bb6d2a8SBarry Smith     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
460188ed4aceSMatthew G Knepley   }
46021bb6d2a8SBarry Smith   *section = dm->globalSection;
460388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
460488ed4aceSMatthew G Knepley }
460588ed4aceSMatthew G Knepley 
4606b21d0597SMatthew G Knepley /*@
4607e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4608b21d0597SMatthew G Knepley 
4609b21d0597SMatthew G Knepley   Input Parameters:
4610b21d0597SMatthew G Knepley + dm - The DM
46115080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4612b21d0597SMatthew G Knepley 
4613b21d0597SMatthew G Knepley   Level: intermediate
4614b21d0597SMatthew G Knepley 
4615b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4616b21d0597SMatthew G Knepley 
461792fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4618b21d0597SMatthew G Knepley @*/
4619e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
46200adebc6cSBarry Smith {
4621b21d0597SMatthew G Knepley   PetscErrorCode ierr;
4622b21d0597SMatthew G Knepley 
4623b21d0597SMatthew G Knepley   PetscFunctionBegin;
4624b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
46255080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
46261d799100SJed Brown   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
46271bb6d2a8SBarry Smith   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
46281bb6d2a8SBarry Smith   dm->globalSection = section;
4629497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
46301bb6d2a8SBarry Smith   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4631507e4973SMatthew G. Knepley #endif
4632b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4633b21d0597SMatthew G Knepley }
4634b21d0597SMatthew G Knepley 
463588ed4aceSMatthew G Knepley /*@
46361bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
463788ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
463888ed4aceSMatthew G Knepley 
463988ed4aceSMatthew G Knepley   Input Parameter:
464088ed4aceSMatthew G Knepley . dm - The DM
464188ed4aceSMatthew G Knepley 
464288ed4aceSMatthew G Knepley   Output Parameter:
464388ed4aceSMatthew G Knepley . sf - The PetscSF
464488ed4aceSMatthew G Knepley 
464588ed4aceSMatthew G Knepley   Level: intermediate
464688ed4aceSMatthew G Knepley 
464788ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
464888ed4aceSMatthew G Knepley 
46491bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
465088ed4aceSMatthew G Knepley @*/
46511bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
46520adebc6cSBarry Smith {
465388ed4aceSMatthew G Knepley   PetscInt       nroots;
465488ed4aceSMatthew G Knepley   PetscErrorCode ierr;
465588ed4aceSMatthew G Knepley 
465688ed4aceSMatthew G Knepley   PetscFunctionBegin;
465788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
465888ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
46591bb6d2a8SBarry Smith   if (!dm->sectionSF) {
46601bb6d2a8SBarry Smith     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
466133907cc2SStefano Zampini   }
46621bb6d2a8SBarry Smith   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
466388ed4aceSMatthew G Knepley   if (nroots < 0) {
466488ed4aceSMatthew G Knepley     PetscSection section, gSection;
466588ed4aceSMatthew G Knepley 
466692fd8e1eSJed Brown     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
466731ea6d37SMatthew G Knepley     if (section) {
4668e87a4003SBarry Smith       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
46691bb6d2a8SBarry Smith       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
467031ea6d37SMatthew G Knepley     } else {
46710298fd71SBarry Smith       *sf = NULL;
467231ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
467331ea6d37SMatthew G Knepley     }
467488ed4aceSMatthew G Knepley   }
46751bb6d2a8SBarry Smith   *sf = dm->sectionSF;
467688ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
467788ed4aceSMatthew G Knepley }
467888ed4aceSMatthew G Knepley 
467988ed4aceSMatthew G Knepley /*@
46801bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
468188ed4aceSMatthew G Knepley 
468288ed4aceSMatthew G Knepley   Input Parameters:
468388ed4aceSMatthew G Knepley + dm - The DM
468488ed4aceSMatthew G Knepley - sf - The PetscSF
468588ed4aceSMatthew G Knepley 
468688ed4aceSMatthew G Knepley   Level: intermediate
468788ed4aceSMatthew G Knepley 
468888ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
468988ed4aceSMatthew G Knepley 
46901bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
469188ed4aceSMatthew G Knepley @*/
46921bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
46930adebc6cSBarry Smith {
469488ed4aceSMatthew G Knepley   PetscErrorCode ierr;
469588ed4aceSMatthew G Knepley 
469688ed4aceSMatthew G Knepley   PetscFunctionBegin;
469788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4698b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
469933907cc2SStefano Zampini   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
47001bb6d2a8SBarry Smith   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
47011bb6d2a8SBarry Smith   dm->sectionSF = sf;
470288ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
470388ed4aceSMatthew G Knepley }
470488ed4aceSMatthew G Knepley 
470588ed4aceSMatthew G Knepley /*@C
47061bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
470788ed4aceSMatthew G Knepley   describing the data layout.
470888ed4aceSMatthew G Knepley 
470988ed4aceSMatthew G Knepley   Input Parameters:
471088ed4aceSMatthew G Knepley + dm - The DM
471188ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
471288ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
471388ed4aceSMatthew G Knepley 
47141bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
471588ed4aceSMatthew G Knepley 
47161bb6d2a8SBarry Smith   Level: developer
47171bb6d2a8SBarry Smith 
47181bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
47191bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
47201bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
47211bb6d2a8SBarry Smith 
47221bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
472388ed4aceSMatthew G Knepley @*/
47241bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
472588ed4aceSMatthew G Knepley {
472688ed4aceSMatthew G Knepley   PetscErrorCode ierr;
472788ed4aceSMatthew G Knepley 
472888ed4aceSMatthew G Knepley   PetscFunctionBegin;
472988ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4730b0c7db22SLisandro Dalcin   ierr = PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection);CHKERRQ(ierr);
473188ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
473288ed4aceSMatthew G Knepley }
4733af122d2aSMatthew G Knepley 
4734b21d0597SMatthew G Knepley /*@
4735b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4736b21d0597SMatthew G Knepley 
4737b21d0597SMatthew G Knepley   Input Parameter:
4738b21d0597SMatthew G Knepley . dm - The DM
4739b21d0597SMatthew G Knepley 
4740b21d0597SMatthew G Knepley   Output Parameter:
4741b21d0597SMatthew G Knepley . sf - The PetscSF
4742b21d0597SMatthew G Knepley 
4743b21d0597SMatthew G Knepley   Level: intermediate
4744b21d0597SMatthew G Knepley 
4745b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4746b21d0597SMatthew G Knepley 
47471bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4748b21d0597SMatthew G Knepley @*/
47490adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
47500adebc6cSBarry Smith {
4751b21d0597SMatthew G Knepley   PetscFunctionBegin;
4752b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4753b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4754b21d0597SMatthew G Knepley   *sf = dm->sf;
4755b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4756b21d0597SMatthew G Knepley }
4757b21d0597SMatthew G Knepley 
4758057b4bcdSMatthew G Knepley /*@
4759057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4760057b4bcdSMatthew G Knepley 
4761057b4bcdSMatthew G Knepley   Input Parameters:
4762057b4bcdSMatthew G Knepley + dm - The DM
4763057b4bcdSMatthew G Knepley - sf - The PetscSF
4764057b4bcdSMatthew G Knepley 
4765057b4bcdSMatthew G Knepley   Level: intermediate
4766057b4bcdSMatthew G Knepley 
47671bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4768057b4bcdSMatthew G Knepley @*/
47690adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
47700adebc6cSBarry Smith {
4771057b4bcdSMatthew G Knepley   PetscErrorCode ierr;
4772057b4bcdSMatthew G Knepley 
4773057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4774057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4775b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4776057b4bcdSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
477733907cc2SStefano Zampini   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4778057b4bcdSMatthew G Knepley   dm->sf = sf;
4779057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4780057b4bcdSMatthew G Knepley }
4781057b4bcdSMatthew G Knepley 
47824f37162bSMatthew G. Knepley /*@
47834f37162bSMatthew G. Knepley   DMGetNaturalSF - Get the PetscSF encoding the map back to the original mesh ordering
47844f37162bSMatthew G. Knepley 
47854f37162bSMatthew G. Knepley   Input Parameter:
47864f37162bSMatthew G. Knepley . dm - The DM
47874f37162bSMatthew G. Knepley 
47884f37162bSMatthew G. Knepley   Output Parameter:
47894f37162bSMatthew G. Knepley . sf - The PetscSF
47904f37162bSMatthew G. Knepley 
47914f37162bSMatthew G. Knepley   Level: intermediate
47924f37162bSMatthew G. Knepley 
47934f37162bSMatthew G. Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
47944f37162bSMatthew G. Knepley 
47954f37162bSMatthew G. Knepley .seealso: DMSetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
47964f37162bSMatthew G. Knepley @*/
47974f37162bSMatthew G. Knepley PetscErrorCode DMGetNaturalSF(DM dm, PetscSF *sf)
47984f37162bSMatthew G. Knepley {
47994f37162bSMatthew G. Knepley   PetscFunctionBegin;
48004f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
48014f37162bSMatthew G. Knepley   PetscValidPointer(sf, 2);
48024f37162bSMatthew G. Knepley   *sf = dm->sfNatural;
48034f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
48044f37162bSMatthew G. Knepley }
48054f37162bSMatthew G. Knepley 
48064f37162bSMatthew G. Knepley /*@
48074f37162bSMatthew G. Knepley   DMSetNaturalSF - Set the PetscSF encoding the map back to the original mesh ordering
48084f37162bSMatthew G. Knepley 
48094f37162bSMatthew G. Knepley   Input Parameters:
48104f37162bSMatthew G. Knepley + dm - The DM
48114f37162bSMatthew G. Knepley - sf - The PetscSF
48124f37162bSMatthew G. Knepley 
48134f37162bSMatthew G. Knepley   Level: intermediate
48144f37162bSMatthew G. Knepley 
48154f37162bSMatthew G. Knepley .seealso: DMGetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
48164f37162bSMatthew G. Knepley @*/
48174f37162bSMatthew G. Knepley PetscErrorCode DMSetNaturalSF(DM dm, PetscSF sf)
48184f37162bSMatthew G. Knepley {
48194f37162bSMatthew G. Knepley   PetscErrorCode ierr;
48204f37162bSMatthew G. Knepley 
48214f37162bSMatthew G. Knepley   PetscFunctionBegin;
48224f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
48234f37162bSMatthew G. Knepley   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
48244f37162bSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
48254f37162bSMatthew G. Knepley   ierr = PetscSFDestroy(&dm->sfNatural);CHKERRQ(ierr);
48264f37162bSMatthew G. Knepley   dm->sfNatural = sf;
48274f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
48284f37162bSMatthew G. Knepley }
48294f37162bSMatthew G. Knepley 
483034aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
483134aa8a36SMatthew G. Knepley {
483234aa8a36SMatthew G. Knepley   PetscClassId   id;
483334aa8a36SMatthew G. Knepley   PetscErrorCode ierr;
483434aa8a36SMatthew G. Knepley 
483534aa8a36SMatthew G. Knepley   PetscFunctionBegin;
483634aa8a36SMatthew G. Knepley   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
483734aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
483834aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
483934aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
484034aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
484117c1d62eSMatthew G. Knepley   } else {
484217c1d62eSMatthew G. Knepley     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
484334aa8a36SMatthew G. Knepley   }
484434aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
484534aa8a36SMatthew G. Knepley }
484634aa8a36SMatthew G. Knepley 
484744a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
484844a7f3ddSMatthew G. Knepley {
484944a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
485044a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
485144a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
485244a7f3ddSMatthew G. Knepley 
485344a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
485444a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
485544a7f3ddSMatthew G. Knepley   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
485644a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4857e0b68406SMatthew Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;}
485844a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
485944a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
486044a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
486144a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
486244a7f3ddSMatthew G. Knepley }
486344a7f3ddSMatthew G. Knepley 
486444a7f3ddSMatthew G. Knepley /*@
486544a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
486644a7f3ddSMatthew G. Knepley 
4867d083f849SBarry Smith   Logically collective on dm
486844a7f3ddSMatthew G. Knepley 
486944a7f3ddSMatthew G. Knepley   Input Parameter:
487044a7f3ddSMatthew G. Knepley . dm - The DM
487144a7f3ddSMatthew G. Knepley 
487244a7f3ddSMatthew G. Knepley   Level: intermediate
487344a7f3ddSMatthew G. Knepley 
487444a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
487544a7f3ddSMatthew G. Knepley @*/
487644a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
487744a7f3ddSMatthew G. Knepley {
487844a7f3ddSMatthew G. Knepley   PetscInt       f;
487944a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
488044a7f3ddSMatthew G. Knepley 
488144a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
488244a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
488344a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
488444a7f3ddSMatthew G. Knepley     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
488544a7f3ddSMatthew G. Knepley     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
488644a7f3ddSMatthew G. Knepley   }
488744a7f3ddSMatthew G. Knepley   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
488844a7f3ddSMatthew G. Knepley   dm->fields = NULL;
488944a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
489044a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
489144a7f3ddSMatthew G. Knepley }
489244a7f3ddSMatthew G. Knepley 
4893689b5837SMatthew G. Knepley /*@
4894689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4895689b5837SMatthew G. Knepley 
4896689b5837SMatthew G. Knepley   Not collective
4897689b5837SMatthew G. Knepley 
4898689b5837SMatthew G. Knepley   Input Parameter:
4899689b5837SMatthew G. Knepley . dm - The DM
4900689b5837SMatthew G. Knepley 
4901689b5837SMatthew G. Knepley   Output Parameter:
4902689b5837SMatthew G. Knepley . Nf - The number of fields
4903689b5837SMatthew G. Knepley 
4904689b5837SMatthew G. Knepley   Level: intermediate
4905689b5837SMatthew G. Knepley 
4906689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4907689b5837SMatthew G. Knepley @*/
49080f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
49090f21e855SMatthew G. Knepley {
49100f21e855SMatthew G. Knepley   PetscFunctionBegin;
49110f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4912534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
491344a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4914af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4915af122d2aSMatthew G Knepley }
4916af122d2aSMatthew G Knepley 
4917689b5837SMatthew G. Knepley /*@
4918689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4919689b5837SMatthew G. Knepley 
4920d083f849SBarry Smith   Logically collective on dm
4921689b5837SMatthew G. Knepley 
4922689b5837SMatthew G. Knepley   Input Parameters:
4923689b5837SMatthew G. Knepley + dm - The DM
4924689b5837SMatthew G. Knepley - Nf - The number of fields
4925689b5837SMatthew G. Knepley 
4926689b5837SMatthew G. Knepley   Level: intermediate
4927689b5837SMatthew G. Knepley 
4928689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4929689b5837SMatthew G. Knepley @*/
4930af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4931af122d2aSMatthew G Knepley {
49320f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4933af122d2aSMatthew G Knepley   PetscErrorCode ierr;
4934af122d2aSMatthew G Knepley 
4935af122d2aSMatthew G Knepley   PetscFunctionBegin;
4936af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
493744a7f3ddSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
49380f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
49390f21e855SMatthew G. Knepley     PetscContainer obj;
49400f21e855SMatthew G. Knepley 
49410f21e855SMatthew G. Knepley     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
494244a7f3ddSMatthew G. Knepley     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
49430f21e855SMatthew G. Knepley     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4944af122d2aSMatthew G Knepley   }
4945af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4946af122d2aSMatthew G Knepley }
4947af122d2aSMatthew G Knepley 
4948c1929be8SMatthew G. Knepley /*@
4949c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4950c1929be8SMatthew G. Knepley 
4951c1929be8SMatthew G. Knepley   Not collective
4952c1929be8SMatthew G. Knepley 
4953c1929be8SMatthew G. Knepley   Input Parameters:
4954c1929be8SMatthew G. Knepley + dm - The DM
4955c1929be8SMatthew G. Knepley - f  - The field number
4956c1929be8SMatthew G. Knepley 
495744a7f3ddSMatthew G. Knepley   Output Parameters:
495844a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
495944a7f3ddSMatthew G. Knepley - field - The discretization object
4960c1929be8SMatthew G. Knepley 
496144a7f3ddSMatthew G. Knepley   Level: intermediate
4962c1929be8SMatthew G. Knepley 
496344a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4964c1929be8SMatthew G. Knepley @*/
496544a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4966af122d2aSMatthew G Knepley {
4967af122d2aSMatthew G Knepley   PetscFunctionBegin;
4968af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4969064a246eSJacob Faibussowitsch   PetscValidPointer(field, 4);
49702c71b3e2SJacob Faibussowitsch   PetscCheckFalse((f < 0) || (f >= dm->Nf),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf);
497144a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
497244a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4973decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4974decb47aaSMatthew G. Knepley }
4975decb47aaSMatthew G. Knepley 
4976083401c6SMatthew G. Knepley /* Does not clear the DS */
4977083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4978083401c6SMatthew G. Knepley {
4979083401c6SMatthew G. Knepley   PetscErrorCode ierr;
4980083401c6SMatthew G. Knepley 
4981083401c6SMatthew G. Knepley   PetscFunctionBegin;
4982083401c6SMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4983083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4984083401c6SMatthew G. Knepley   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4985083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4986083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
4987083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4988083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4989083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4990083401c6SMatthew G. Knepley }
4991083401c6SMatthew G. Knepley 
4992c1929be8SMatthew G. Knepley /*@
4993c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4994c1929be8SMatthew G. Knepley 
4995d083f849SBarry Smith   Logically collective on dm
4996c1929be8SMatthew G. Knepley 
4997c1929be8SMatthew G. Knepley   Input Parameters:
4998c1929be8SMatthew G. Knepley + dm    - The DM
4999c1929be8SMatthew G. Knepley . f     - The field number
500044a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
5001c1929be8SMatthew G. Knepley - field - The discretization object
5002c1929be8SMatthew G. Knepley 
500344a7f3ddSMatthew G. Knepley   Level: intermediate
5004c1929be8SMatthew G. Knepley 
500544a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
5006c1929be8SMatthew G. Knepley @*/
500744a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
5008decb47aaSMatthew G. Knepley {
5009decb47aaSMatthew G. Knepley   PetscErrorCode ierr;
5010decb47aaSMatthew G. Knepley 
5011decb47aaSMatthew G. Knepley   PetscFunctionBegin;
5012decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5013e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
501444a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
50152c71b3e2SJacob Faibussowitsch   PetscCheckFalse(f < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
5016083401c6SMatthew G. Knepley   ierr = DMSetField_Internal(dm, f, label, field);CHKERRQ(ierr);
501734aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
50182df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
501944a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
502044a7f3ddSMatthew G. Knepley }
502144a7f3ddSMatthew G. Knepley 
502244a7f3ddSMatthew G. Knepley /*@
502344a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
502444a7f3ddSMatthew G. Knepley 
5025d083f849SBarry Smith   Logically collective on dm
502644a7f3ddSMatthew G. Knepley 
502744a7f3ddSMatthew G. Knepley   Input Parameters:
502844a7f3ddSMatthew G. Knepley + dm    - The DM
502944a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
503044a7f3ddSMatthew G. Knepley - field - The discretization object
503144a7f3ddSMatthew G. Knepley 
503244a7f3ddSMatthew G. Knepley   Level: intermediate
503344a7f3ddSMatthew G. Knepley 
503444a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
503544a7f3ddSMatthew G. Knepley @*/
503644a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
503744a7f3ddSMatthew G. Knepley {
503844a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
503944a7f3ddSMatthew G. Knepley   PetscErrorCode ierr;
504044a7f3ddSMatthew G. Knepley 
504144a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
504244a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5043064a246eSJacob Faibussowitsch   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
504444a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
504544a7f3ddSMatthew G. Knepley   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
504644a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
504744a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
504844a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
504944a7f3ddSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
505034aa8a36SMatthew G. Knepley   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
50512df9ee95SMatthew G. Knepley   ierr = DMClearDS(dm);CHKERRQ(ierr);
5052af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
5053af122d2aSMatthew G Knepley }
50546636e97aSMatthew G Knepley 
5055e5e52638SMatthew G. Knepley /*@
5056e0b68406SMatthew Knepley   DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells
5057e0b68406SMatthew Knepley 
5058e0b68406SMatthew Knepley   Logically collective on dm
5059e0b68406SMatthew Knepley 
5060e0b68406SMatthew Knepley   Input Parameters:
5061e0b68406SMatthew Knepley + dm          - The DM
5062e0b68406SMatthew Knepley . f           - The field index
5063e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells
5064e0b68406SMatthew Knepley 
5065e0b68406SMatthew Knepley   Level: intermediate
5066e0b68406SMatthew Knepley 
5067e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField()
5068e0b68406SMatthew Knepley @*/
5069e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor)
5070e0b68406SMatthew Knepley {
5071e0b68406SMatthew Knepley   PetscFunctionBegin;
50722c71b3e2SJacob Faibussowitsch   PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
5073e0b68406SMatthew Knepley   dm->fields[f].avoidTensor = avoidTensor;
5074e0b68406SMatthew Knepley   PetscFunctionReturn(0);
5075e0b68406SMatthew Knepley }
5076e0b68406SMatthew Knepley 
5077e0b68406SMatthew Knepley /*@
5078e0b68406SMatthew Knepley   DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells
5079e0b68406SMatthew Knepley 
5080e0b68406SMatthew Knepley   Logically collective on dm
5081e0b68406SMatthew Knepley 
5082e0b68406SMatthew Knepley   Input Parameters:
5083e0b68406SMatthew Knepley + dm          - The DM
5084e0b68406SMatthew Knepley - f           - The field index
5085e0b68406SMatthew Knepley 
5086e0b68406SMatthew Knepley   Output Parameter:
5087e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells
5088e0b68406SMatthew Knepley 
5089e0b68406SMatthew Knepley   Level: intermediate
5090e0b68406SMatthew Knepley 
5091e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField()
5092e0b68406SMatthew Knepley @*/
5093e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor)
5094e0b68406SMatthew Knepley {
5095e0b68406SMatthew Knepley   PetscFunctionBegin;
50962c71b3e2SJacob Faibussowitsch   PetscCheckFalse((f < 0) || (f >= dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
5097e0b68406SMatthew Knepley   *avoidTensor = dm->fields[f].avoidTensor;
5098e0b68406SMatthew Knepley   PetscFunctionReturn(0);
5099e0b68406SMatthew Knepley }
5100e0b68406SMatthew Knepley 
5101e0b68406SMatthew Knepley /*@
5102e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
5103e5e52638SMatthew G. Knepley 
5104d083f849SBarry Smith   Collective on dm
5105e5e52638SMatthew G. Knepley 
5106e5e52638SMatthew G. Knepley   Input Parameter:
5107e5e52638SMatthew G. Knepley . dm - The DM
5108e5e52638SMatthew G. Knepley 
5109e5e52638SMatthew G. Knepley   Output Parameter:
5110e5e52638SMatthew G. Knepley . newdm - The DM
5111e5e52638SMatthew G. Knepley 
5112e5e52638SMatthew G. Knepley   Level: advanced
5113e5e52638SMatthew G. Knepley 
5114e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
5115e5e52638SMatthew G. Knepley @*/
5116e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
5117e5e52638SMatthew G. Knepley {
5118e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
5119e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5120e5e52638SMatthew G. Knepley 
5121e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5122e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
5123e5e52638SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5124e5e52638SMatthew G. Knepley   ierr = DMClearFields(newdm);CHKERRQ(ierr);
5125e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5126e5e52638SMatthew G. Knepley     DMLabel     label;
5127e5e52638SMatthew G. Knepley     PetscObject field;
512834aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
5129e5e52638SMatthew G. Knepley 
5130e5e52638SMatthew G. Knepley     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
5131e5e52638SMatthew G. Knepley     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
513234aa8a36SMatthew G. Knepley     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
513334aa8a36SMatthew G. Knepley     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
513434aa8a36SMatthew G. Knepley   }
513534aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
513634aa8a36SMatthew G. Knepley }
513734aa8a36SMatthew G. Knepley 
513834aa8a36SMatthew G. Knepley /*@
513934aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
514034aa8a36SMatthew G. Knepley 
514134aa8a36SMatthew G. Knepley   Not collective
514234aa8a36SMatthew G. Knepley 
514334aa8a36SMatthew G. Knepley   Input Parameters:
514434aa8a36SMatthew G. Knepley + dm - The DM object
514534aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
514634aa8a36SMatthew G. Knepley 
5147d8d19677SJose E. Roman   Output Parameters:
514834aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
514934aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
515034aa8a36SMatthew G. Knepley 
515134aa8a36SMatthew G. Knepley   Notes:
515234aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
515334aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
515434aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5155979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
515634aa8a36SMatthew G. Knepley 
515734aa8a36SMatthew G. Knepley   Level: developer
515834aa8a36SMatthew G. Knepley 
515934aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
516034aa8a36SMatthew G. Knepley @*/
516134aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
516234aa8a36SMatthew G. Knepley {
516334aa8a36SMatthew G. Knepley   PetscFunctionBegin;
516434aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5165534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
5166534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
516734aa8a36SMatthew G. Knepley   if (f < 0) {
516834aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
516934aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
517034aa8a36SMatthew G. Knepley   } else {
517134aa8a36SMatthew G. Knepley     PetscInt       Nf;
517234aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
517334aa8a36SMatthew G. Knepley 
517434aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
51752c71b3e2SJacob Faibussowitsch     PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
517634aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
517734aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
517834aa8a36SMatthew G. Knepley   }
517934aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
518034aa8a36SMatthew G. Knepley }
518134aa8a36SMatthew G. Knepley 
518234aa8a36SMatthew G. Knepley /*@
518334aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
518434aa8a36SMatthew G. Knepley 
518534aa8a36SMatthew G. Knepley   Not collective
518634aa8a36SMatthew G. Knepley 
518734aa8a36SMatthew G. Knepley   Input Parameters:
518834aa8a36SMatthew G. Knepley + dm         - The DM object
518934aa8a36SMatthew G. Knepley . f          - The field number
519034aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
519134aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
519234aa8a36SMatthew G. Knepley 
519334aa8a36SMatthew G. Knepley   Notes:
519434aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
519534aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
519634aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5197979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
519834aa8a36SMatthew G. Knepley 
519934aa8a36SMatthew G. Knepley   Level: developer
520034aa8a36SMatthew G. Knepley 
520134aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
520234aa8a36SMatthew G. Knepley @*/
520334aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
520434aa8a36SMatthew G. Knepley {
520534aa8a36SMatthew G. Knepley   PetscFunctionBegin;
520634aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
520734aa8a36SMatthew G. Knepley   if (f < 0) {
520834aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
520934aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
521034aa8a36SMatthew G. Knepley   } else {
521134aa8a36SMatthew G. Knepley     PetscInt       Nf;
521234aa8a36SMatthew G. Knepley     PetscErrorCode ierr;
521334aa8a36SMatthew G. Knepley 
521434aa8a36SMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
52152c71b3e2SJacob Faibussowitsch     PetscCheckFalse(f >= Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
521634aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
521734aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
5218e5e52638SMatthew G. Knepley   }
5219e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5220e5e52638SMatthew G. Knepley }
5221e5e52638SMatthew G. Knepley 
5222b0441da4SMatthew G. Knepley /*@
5223b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
5224b0441da4SMatthew G. Knepley 
5225b0441da4SMatthew G. Knepley   Not collective
5226b0441da4SMatthew G. Knepley 
5227f899ff85SJose E. Roman   Input Parameter:
5228b0441da4SMatthew G. Knepley . dm - The DM object
5229b0441da4SMatthew G. Knepley 
5230d8d19677SJose E. Roman   Output Parameters:
5231b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
5232b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5233b0441da4SMatthew G. Knepley 
5234b0441da4SMatthew G. Knepley   Notes:
5235b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5236b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5237b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5238b0441da4SMatthew G. Knepley 
5239b0441da4SMatthew G. Knepley   Level: developer
5240b0441da4SMatthew G. Knepley 
5241b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
5242b0441da4SMatthew G. Knepley @*/
5243b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
5244b0441da4SMatthew G. Knepley {
5245b0441da4SMatthew G. Knepley   PetscInt       Nf;
5246b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5247b0441da4SMatthew G. Knepley 
5248b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5249b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5250064a246eSJacob Faibussowitsch   if (useCone)    PetscValidBoolPointer(useCone, 2);
5251064a246eSJacob Faibussowitsch   if (useClosure) PetscValidBoolPointer(useClosure, 3);
5252b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5253b0441da4SMatthew G. Knepley   if (!Nf) {
5254b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5255b0441da4SMatthew G. Knepley   } else {
5256b0441da4SMatthew G. Knepley     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5257b0441da4SMatthew G. Knepley   }
5258b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
5259b0441da4SMatthew G. Knepley }
5260b0441da4SMatthew G. Knepley 
5261b0441da4SMatthew G. Knepley /*@
5262b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
5263b0441da4SMatthew G. Knepley 
5264b0441da4SMatthew G. Knepley   Not collective
5265b0441da4SMatthew G. Knepley 
5266b0441da4SMatthew G. Knepley   Input Parameters:
5267b0441da4SMatthew G. Knepley + dm         - The DM object
5268b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5269b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5270b0441da4SMatthew G. Knepley 
5271b0441da4SMatthew G. Knepley   Notes:
5272b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5273b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5274b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5275b0441da4SMatthew G. Knepley 
5276b0441da4SMatthew G. Knepley   Level: developer
5277b0441da4SMatthew G. Knepley 
5278b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5279b0441da4SMatthew G. Knepley @*/
5280b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5281b0441da4SMatthew G. Knepley {
5282b0441da4SMatthew G. Knepley   PetscInt       Nf;
5283b0441da4SMatthew G. Knepley   PetscErrorCode ierr;
5284b0441da4SMatthew G. Knepley 
5285b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5286b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5287b0441da4SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
5288b0441da4SMatthew G. Knepley   if (!Nf) {
5289b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
5290b0441da4SMatthew G. Knepley   } else {
5291b0441da4SMatthew G. Knepley     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
5292e5e52638SMatthew G. Knepley   }
5293e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5294e5e52638SMatthew G. Knepley }
5295e5e52638SMatthew G. Knepley 
5296783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
529745480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label)
5298783e2ec8SMatthew G. Knepley {
5299783e2ec8SMatthew G. Knepley   PetscObject    obj;
5300783e2ec8SMatthew G. Knepley   PetscClassId   id;
5301783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5302783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5303783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5304783e2ec8SMatthew G. Knepley   PetscErrorCode ierr;
5305783e2ec8SMatthew G. Knepley 
5306783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
5307783e2ec8SMatthew G. Knepley   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
5308783e2ec8SMatthew G. Knepley   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
5309783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5310783e2ec8SMatthew G. Knepley   if (isFE && label) {
5311783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
5312783e2ec8SMatthew G. Knepley     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5313783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
531445480ffeSMatthew G. Knepley       DMLabel l;
5315783e2ec8SMatthew G. Knepley 
531645480ffeSMatthew G. Knepley       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
531745480ffeSMatthew G. Knepley       duplicate = l == label ? PETSC_TRUE : PETSC_FALSE;
5318783e2ec8SMatthew G. Knepley       if (duplicate) break;
5319783e2ec8SMatthew G. Knepley     }
5320783e2ec8SMatthew G. Knepley     if (!duplicate) {
5321783e2ec8SMatthew G. Knepley       DM plex;
5322783e2ec8SMatthew G. Knepley 
5323783e2ec8SMatthew G. Knepley       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5324783e2ec8SMatthew G. Knepley       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
5325783e2ec8SMatthew G. Knepley       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5326783e2ec8SMatthew G. Knepley     }
5327783e2ec8SMatthew G. Knepley   }
5328783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5329783e2ec8SMatthew G. Knepley }
5330783e2ec8SMatthew G. Knepley 
5331e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5332e5e52638SMatthew G. Knepley {
5333e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5334e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5335e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5336e5e52638SMatthew G. Knepley 
5337e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5338e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
5339e5e52638SMatthew G. Knepley   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
5340e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5341b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
5342e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5343e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5344e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5345e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5346e5e52638SMatthew G. Knepley }
5347e5e52638SMatthew G. Knepley 
5348e5e52638SMatthew G. Knepley /*@
5349e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5350e5e52638SMatthew G. Knepley 
5351e5e52638SMatthew G. Knepley   Not collective
5352e5e52638SMatthew G. Knepley 
5353e5e52638SMatthew G. Knepley   Input Parameter:
5354e5e52638SMatthew G. Knepley . dm - The DM
5355e5e52638SMatthew G. Knepley 
5356e5e52638SMatthew G. Knepley   Output Parameter:
5357e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5358e5e52638SMatthew G. Knepley 
5359e5e52638SMatthew G. Knepley   Level: intermediate
5360e5e52638SMatthew G. Knepley 
5361e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5362e5e52638SMatthew G. Knepley @*/
5363e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5364e5e52638SMatthew G. Knepley {
5365e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5366e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5367534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5368e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5369e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5370e5e52638SMatthew G. Knepley }
5371e5e52638SMatthew G. Knepley 
5372e5e52638SMatthew G. Knepley /*@
5373e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5374e5e52638SMatthew G. Knepley 
5375d083f849SBarry Smith   Logically collective on dm
5376e5e52638SMatthew G. Knepley 
5377e5e52638SMatthew G. Knepley   Input Parameter:
5378e5e52638SMatthew G. Knepley . dm - The DM
5379e5e52638SMatthew G. Knepley 
5380e5e52638SMatthew G. Knepley   Level: intermediate
5381e5e52638SMatthew G. Knepley 
5382e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5383e5e52638SMatthew G. Knepley @*/
5384e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5385e5e52638SMatthew G. Knepley {
5386e5e52638SMatthew G. Knepley   PetscInt       s;
5387e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5388e5e52638SMatthew G. Knepley 
5389e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5390e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5391e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5392e5e52638SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5393e5e52638SMatthew G. Knepley     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5394b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5395e5e52638SMatthew G. Knepley   }
5396e5e52638SMatthew G. Knepley   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5397e5e52638SMatthew G. Knepley   dm->probs = NULL;
5398e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5399e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5400e5e52638SMatthew G. Knepley }
5401e5e52638SMatthew G. Knepley 
5402e5e52638SMatthew G. Knepley /*@
5403e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5404e5e52638SMatthew G. Knepley 
5405e5e52638SMatthew G. Knepley   Not collective
5406e5e52638SMatthew G. Knepley 
5407e5e52638SMatthew G. Knepley   Input Parameter:
5408e5e52638SMatthew G. Knepley . dm    - The DM
5409e5e52638SMatthew G. Knepley 
5410e5e52638SMatthew G. Knepley   Output Parameter:
5411e5e52638SMatthew G. Knepley . prob - The default PetscDS
5412e5e52638SMatthew G. Knepley 
5413e5e52638SMatthew G. Knepley   Level: intermediate
5414e5e52638SMatthew G. Knepley 
5415e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5416e5e52638SMatthew G. Knepley @*/
5417e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5418e5e52638SMatthew G. Knepley {
5419b0143b4dSMatthew G. Knepley   PetscErrorCode ierr;
5420b0143b4dSMatthew G. Knepley 
5421e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5422e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5423e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5424b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5425b0143b4dSMatthew G. Knepley     PetscDS ds;
5426b0143b4dSMatthew G. Knepley 
542745480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5428b3cf3223SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5429b0143b4dSMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5430b0143b4dSMatthew G. Knepley   }
5431b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5432e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5433e5e52638SMatthew G. Knepley }
5434e5e52638SMatthew G. Knepley 
5435e5e52638SMatthew G. Knepley /*@
5436e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5437e5e52638SMatthew G. Knepley 
5438e5e52638SMatthew G. Knepley   Not collective
5439e5e52638SMatthew G. Knepley 
5440e5e52638SMatthew G. Knepley   Input Parameters:
5441e5e52638SMatthew G. Knepley + dm    - The DM
5442e5e52638SMatthew G. Knepley - point - Cell for the DS
5443e5e52638SMatthew G. Knepley 
5444e5e52638SMatthew G. Knepley   Output Parameter:
5445e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5446e5e52638SMatthew G. Knepley 
5447e5e52638SMatthew G. Knepley   Level: developer
5448e5e52638SMatthew G. Knepley 
5449b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5450e5e52638SMatthew G. Knepley @*/
5451e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5452e5e52638SMatthew G. Knepley {
5453e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5454e5e52638SMatthew G. Knepley   PetscInt       s;
5455e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5456e5e52638SMatthew G. Knepley 
5457e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5458e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5459e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
54602c71b3e2SJacob Faibussowitsch   PetscCheckFalse(point < 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5461e5e52638SMatthew G. Knepley   *prob = NULL;
5462e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5463e5e52638SMatthew G. Knepley     PetscInt val;
5464e5e52638SMatthew G. Knepley 
5465e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5466e5e52638SMatthew G. Knepley     else {
5467e5e52638SMatthew G. Knepley       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5468e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5469e5e52638SMatthew G. Knepley     }
5470e5e52638SMatthew G. Knepley   }
5471e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5472e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5473e5e52638SMatthew G. Knepley }
5474e5e52638SMatthew G. Knepley 
5475e5e52638SMatthew G. Knepley /*@
5476e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5477e5e52638SMatthew G. Knepley 
5478e5e52638SMatthew G. Knepley   Not collective
5479e5e52638SMatthew G. Knepley 
5480e5e52638SMatthew G. Knepley   Input Parameters:
5481e5e52638SMatthew G. Knepley + dm    - The DM
5482e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5483e5e52638SMatthew G. Knepley 
5484b3cf3223SMatthew G. Knepley   Output Parameters:
5485b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5486b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5487e5e52638SMatthew G. Knepley 
5488154ca461SJed Brown   Note:
5489154ca461SJed Brown   If a non-NULL label is given, but there is no PetscDS on that specific label,
5490154ca461SJed Brown   the PetscDS for the full domain (if present) is returned. Returns with
5491154ca461SJed Brown   fields=NULL and prob=NULL if there is no PetscDS for the full domain.
5492e5e52638SMatthew G. Knepley 
5493e5e52638SMatthew G. Knepley   Level: advanced
5494e5e52638SMatthew G. Knepley 
5495e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5496e5e52638SMatthew G. Knepley @*/
5497b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5498e5e52638SMatthew G. Knepley {
5499e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5500e5e52638SMatthew G. Knepley 
5501e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5502e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5503e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5504b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5505b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5506e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5507154ca461SJed Brown     if (dm->probs[s].label == label || !dm->probs[s].label) {
5508b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5509b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5510154ca461SJed Brown       if (dm->probs[s].label) PetscFunctionReturn(0);
5511b3cf3223SMatthew G. Knepley     }
5512e5e52638SMatthew G. Knepley   }
55132df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5514e5e52638SMatthew G. Knepley }
5515e5e52638SMatthew G. Knepley 
5516e5e52638SMatthew G. Knepley /*@
5517083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5518083401c6SMatthew G. Knepley 
5519083401c6SMatthew G. Knepley   Collective on dm
5520083401c6SMatthew G. Knepley 
5521083401c6SMatthew G. Knepley   Input Parameters:
5522083401c6SMatthew G. Knepley + dm     - The DM
5523083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5524083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5525083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5526083401c6SMatthew G. Knepley 
5527083401c6SMatthew 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,
5528083401c6SMatthew G. Knepley   the fields argument is ignored.
5529083401c6SMatthew G. Knepley 
5530083401c6SMatthew G. Knepley   Level: advanced
5531083401c6SMatthew G. Knepley 
5532083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5533083401c6SMatthew G. Knepley @*/
5534083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5535083401c6SMatthew G. Knepley {
5536083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5537083401c6SMatthew G. Knepley   PetscErrorCode ierr;
5538083401c6SMatthew G. Knepley 
5539083401c6SMatthew G. Knepley   PetscFunctionBegin;
5540083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5541083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5542064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4);
5543083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5544083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
5545083401c6SMatthew G. Knepley       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5546083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5547083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5548083401c6SMatthew G. Knepley     }
5549083401c6SMatthew G. Knepley   }
5550083401c6SMatthew G. Knepley   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5551083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5552083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5553083401c6SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5554083401c6SMatthew G. Knepley   if (!label) {
5555083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5556083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5557083401c6SMatthew G. Knepley     Nds = 0;
5558083401c6SMatthew G. Knepley   }
5559083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5560083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5561083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5562083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5563083401c6SMatthew G. Knepley }
5564083401c6SMatthew G. Knepley 
5565083401c6SMatthew G. Knepley /*@
5566e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5567e5e52638SMatthew G. Knepley 
5568e5e52638SMatthew G. Knepley   Not collective
5569e5e52638SMatthew G. Knepley 
5570e5e52638SMatthew G. Knepley   Input Parameters:
5571e5e52638SMatthew G. Knepley + dm  - The DM
5572e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5573e5e52638SMatthew G. Knepley 
5574e5e52638SMatthew G. Knepley   Output Parameters:
5575b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5576b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5577083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5578e5e52638SMatthew G. Knepley 
5579e5e52638SMatthew G. Knepley   Level: advanced
5580e5e52638SMatthew G. Knepley 
5581e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5582e5e52638SMatthew G. Knepley @*/
5583b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5584e5e52638SMatthew G. Knepley {
5585e5e52638SMatthew G. Knepley   PetscInt       Nds;
5586e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5587e5e52638SMatthew G. Knepley 
5588e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5589e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5590e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
55912c71b3e2SJacob Faibussowitsch   PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5592e5e52638SMatthew G. Knepley   if (label) {
5593e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5594e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5595e5e52638SMatthew G. Knepley   }
5596b3cf3223SMatthew G. Knepley   if (fields) {
5597b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5598b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5599b3cf3223SMatthew G. Knepley   }
5600e5e52638SMatthew G. Knepley   if (ds) {
5601b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5602e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5603e5e52638SMatthew G. Knepley   }
5604e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5605e5e52638SMatthew G. Knepley }
5606e5e52638SMatthew G. Knepley 
5607e5e52638SMatthew G. Knepley /*@
5608083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5609e5e52638SMatthew G. Knepley 
5610083401c6SMatthew G. Knepley   Not collective
5611e5e52638SMatthew G. Knepley 
5612e5e52638SMatthew G. Knepley   Input Parameters:
5613e5e52638SMatthew G. Knepley + dm     - The DM
5614083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5615083401c6SMatthew G. Knepley . label  - The region label, or NULL
5616083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5617083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5618e5e52638SMatthew G. Knepley 
5619e5e52638SMatthew G. Knepley   Level: advanced
5620e5e52638SMatthew G. Knepley 
5621083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5622e5e52638SMatthew G. Knepley @*/
5623083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5624e5e52638SMatthew G. Knepley {
5625083401c6SMatthew G. Knepley   PetscInt       Nds;
5626e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5627e5e52638SMatthew G. Knepley 
5628e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5629e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5630083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
5631083401c6SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
56322c71b3e2SJacob Faibussowitsch   PetscCheckFalse((num < 0) || (num >= Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5633e5e52638SMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5634083401c6SMatthew G. Knepley   ierr = DMLabelDestroy(&dm->probs[num].label);CHKERRQ(ierr);
5635083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5636083401c6SMatthew G. Knepley   if (fields) {
5637083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
5638b3cf3223SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5639083401c6SMatthew G. Knepley     ierr = ISDestroy(&dm->probs[num].fields);CHKERRQ(ierr);
5640083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5641e5e52638SMatthew G. Knepley   }
5642083401c6SMatthew G. Knepley   if (ds) {
5643083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
5644083401c6SMatthew G. Knepley     ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5645083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dm->probs[num].ds);CHKERRQ(ierr);
5646083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5647083401c6SMatthew G. Knepley   }
5648e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5649e5e52638SMatthew G. Knepley }
5650e5e52638SMatthew G. Knepley 
5651e5e52638SMatthew G. Knepley /*@
56521d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
56531d3af9e0SMatthew G. Knepley 
56541d3af9e0SMatthew G. Knepley   Not collective
56551d3af9e0SMatthew G. Knepley 
56561d3af9e0SMatthew G. Knepley   Input Parameters:
56571d3af9e0SMatthew G. Knepley + dm  - The DM
56581d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
56591d3af9e0SMatthew G. Knepley 
56601d3af9e0SMatthew G. Knepley   Output Parameter:
56611d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
56621d3af9e0SMatthew G. Knepley 
56631d3af9e0SMatthew G. Knepley   Level: advanced
56641d3af9e0SMatthew G. Knepley 
56651d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
56661d3af9e0SMatthew G. Knepley @*/
56671d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
56681d3af9e0SMatthew G. Knepley {
56691d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
56701d3af9e0SMatthew G. Knepley   PetscErrorCode ierr;
56711d3af9e0SMatthew G. Knepley 
56721d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
56731d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
56741d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
56751d3af9e0SMatthew G. Knepley   PetscValidPointer(num, 3);
56761d3af9e0SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
56771d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
56781d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
56791d3af9e0SMatthew G. Knepley   else          *num = n;
56801d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
56811d3af9e0SMatthew G. Knepley }
56821d3af9e0SMatthew G. Knepley 
56832df84da0SMatthew G. Knepley /*@C
56842df84da0SMatthew G. Knepley   DMCreateFEDefault - Create a PetscFE based on the celltype for the mesh
56852df84da0SMatthew G. Knepley 
56862df84da0SMatthew G. Knepley   Not collective
56872df84da0SMatthew G. Knepley 
5688f1a722f8SMatthew G. Knepley   Input Parameters:
56892df84da0SMatthew G. Knepley + dm     - The DM
56902df84da0SMatthew G. Knepley . Nc     - The number of components for the field
56912df84da0SMatthew G. Knepley . prefix - The options prefix for the output PetscFE, or NULL
56922df84da0SMatthew G. Knepley - qorder - The quadrature order or PETSC_DETERMINE to use PetscSpace polynomial degree
56932df84da0SMatthew G. Knepley 
56942df84da0SMatthew G. Knepley   Output Parameter:
56952df84da0SMatthew G. Knepley . fem - The PetscFE
56962df84da0SMatthew G. Knepley 
56972df84da0SMatthew G. Knepley   Note: This is a convenience method that just calls PetscFECreateByCell() underneath.
56982df84da0SMatthew G. Knepley 
56992df84da0SMatthew G. Knepley   Level: intermediate
57002df84da0SMatthew G. Knepley 
57012df84da0SMatthew G. Knepley .seealso: PetscFECreateByCell(), DMAddField(), DMCreateDS(), DMGetCellDS(), DMGetRegionDS()
57022df84da0SMatthew G. Knepley @*/
57032df84da0SMatthew G. Knepley PetscErrorCode DMCreateFEDefault(DM dm, PetscInt Nc, const char prefix[], PetscInt qorder, PetscFE *fem)
57042df84da0SMatthew G. Knepley {
57052df84da0SMatthew G. Knepley   DMPolytopeType ct;
57062df84da0SMatthew G. Knepley   PetscInt       dim, cStart;
57072df84da0SMatthew G. Knepley   PetscErrorCode ierr;
57082df84da0SMatthew G. Knepley 
57092df84da0SMatthew G. Knepley   PetscFunctionBegin;
57102df84da0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
57112df84da0SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 2);
57122df84da0SMatthew G. Knepley   if (prefix) PetscValidCharPointer(prefix, 3);
57132df84da0SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, qorder, 4);
57142df84da0SMatthew G. Knepley   PetscValidPointer(fem, 5);
57152df84da0SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
57162df84da0SMatthew G. Knepley   ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
57172df84da0SMatthew G. Knepley   ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
57182df84da0SMatthew G. Knepley   ierr = PetscFECreateByCell(PETSC_COMM_SELF, dim, Nc, ct, prefix, qorder, fem);CHKERRQ(ierr);
57192df84da0SMatthew G. Knepley   PetscFunctionReturn(0);
57202df84da0SMatthew G. Knepley }
57212df84da0SMatthew G. Knepley 
57221d3af9e0SMatthew G. Knepley /*@
5723e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5724e5e52638SMatthew G. Knepley 
5725d083f849SBarry Smith   Collective on dm
5726e5e52638SMatthew G. Knepley 
5727e5e52638SMatthew G. Knepley   Input Parameter:
5728e5e52638SMatthew G. Knepley . dm - The DM
5729e5e52638SMatthew G. Knepley 
573045480ffeSMatthew G. Knepley   Options Database Keys:
573145480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM
573245480ffeSMatthew G. Knepley 
5733e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5734e5e52638SMatthew G. Knepley 
5735e5e52638SMatthew G. Knepley   Level: intermediate
5736e5e52638SMatthew G. Knepley 
5737e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5738e5e52638SMatthew G. Knepley @*/
5739e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5740e5e52638SMatthew G. Knepley {
5741e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5742083401c6SMatthew G. Knepley   PetscDS        dsDef;
5743083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5744f9244615SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k;
5745f9244615SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE, flg;
5746e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
5747e5e52638SMatthew G. Knepley 
5748e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5749e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5750e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
5751e5e52638SMatthew G. Knepley   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5752083401c6SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
5753083401c6SMatthew G. Knepley   /* Determine how many regions we have */
5754083401c6SMatthew G. Knepley   ierr = PetscMalloc1(Nf, &labelSet);CHKERRQ(ierr);
5755083401c6SMatthew G. Knepley   Nl   = 0;
5756083401c6SMatthew G. Knepley   Ndef = 0;
5757083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5758083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5759083401c6SMatthew G. Knepley     PetscInt l;
5760083401c6SMatthew G. Knepley 
5761f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
5762f918ec44SMatthew G. Knepley     /* Move CEED context to discretizations */
5763f918ec44SMatthew G. Knepley     {
5764f918ec44SMatthew G. Knepley       PetscClassId id;
5765f918ec44SMatthew G. Knepley 
5766f918ec44SMatthew G. Knepley       ierr = PetscObjectGetClassId(dm->fields[f].disc, &id);CHKERRQ(ierr);
5767f918ec44SMatthew G. Knepley       if (id == PETSCFE_CLASSID) {
5768f918ec44SMatthew G. Knepley         Ceed ceed;
5769f918ec44SMatthew G. Knepley 
5770f918ec44SMatthew G. Knepley         ierr = DMGetCeed(dm, &ceed);CHKERRQ(ierr);
5771f918ec44SMatthew G. Knepley         ierr = PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed);CHKERRQ(ierr);
5772f918ec44SMatthew G. Knepley       }
5773f918ec44SMatthew G. Knepley     }
5774f918ec44SMatthew G. Knepley #endif
5775083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5776083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5777083401c6SMatthew G. Knepley     if (l < Nl) continue;
5778083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5779083401c6SMatthew G. Knepley   }
5780083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
5781083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5782083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5783b3cf3223SMatthew G. Knepley     IS        fields;
5784b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5785b3cf3223SMatthew G. Knepley 
5786b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
57872c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!nf,comm, PETSC_ERR_PLIB, "All fields have labels, but we are trying to create a default DS");
5788b3cf3223SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5789b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
579088f0c812SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
579188f0c812SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
579288f0c812SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
579388f0c812SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
579488f0c812SMatthew G. Knepley 
579545480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5796083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, NULL, fields, dsDef);CHKERRQ(ierr);
5797083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5798b3cf3223SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
57992df9ee95SMatthew G. Knepley   }
5800083401c6SMatthew G. Knepley   ierr = DMGetRegionDS(dm, NULL, NULL, &dsDef);CHKERRQ(ierr);
5801083401c6SMatthew G. Knepley   if (dsDef) {ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);}
5802083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5803083401c6SMatthew G. Knepley   if (Ndef && Nl) {
58040122748bSMatthew G. Knepley     DM              plex;
5805083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5806083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5807083401c6SMatthew G. Knepley     PetscInt       *fields;
5808083401c6SMatthew G. Knepley     const PetscInt *cells;
5809083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
58100122748bSMatthew G. Knepley 
58110122748bSMatthew G. Knepley     ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
58120122748bSMatthew G. Knepley     ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5813083401c6SMatthew G. Knepley     ierr = DMGetStratumIS(plex, "dim", depth, &allcellIS);CHKERRQ(ierr);
5814083401c6SMatthew G. Knepley     if (!allcellIS) {ierr = DMGetStratumIS(plex, "depth", depth, &allcellIS);CHKERRQ(ierr);}
58155fedec97SMatthew G. Knepley     /* TODO This looks like it only works for one label */
5816083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5817083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5818083401c6SMatthew G. Knepley       IS      pointIS;
5819083401c6SMatthew G. Knepley 
5820083401c6SMatthew G. Knepley       ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5821083401c6SMatthew G. Knepley       ierr = DMLabelGetStratumIS(label, 1, &pointIS);CHKERRQ(ierr);
5822083401c6SMatthew G. Knepley       ierr = ISDifference(allcellIS, pointIS, &defcellIS);CHKERRQ(ierr);
5823083401c6SMatthew G. Knepley       ierr = ISDestroy(&pointIS);CHKERRQ(ierr);
5824083401c6SMatthew G. Knepley     }
5825083401c6SMatthew G. Knepley     ierr = ISDestroy(&allcellIS);CHKERRQ(ierr);
5826083401c6SMatthew G. Knepley 
5827083401c6SMatthew G. Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel);CHKERRQ(ierr);
5828083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(defcellIS, &n);CHKERRQ(ierr);
5829083401c6SMatthew G. Knepley     ierr = ISGetIndices(defcellIS, &cells);CHKERRQ(ierr);
5830083401c6SMatthew G. Knepley     for (c = 0; c < n; ++c) {ierr = DMLabelSetValue(cellLabel, cells[c], 1);CHKERRQ(ierr);}
5831083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(defcellIS, &cells);CHKERRQ(ierr);
5832083401c6SMatthew G. Knepley     ierr = ISDestroy(&defcellIS);CHKERRQ(ierr);
5833083401c6SMatthew G. Knepley     ierr = DMPlexLabelComplete(plex, cellLabel);CHKERRQ(ierr);
5834083401c6SMatthew G. Knepley 
5835083401c6SMatthew G. Knepley     ierr = PetscMalloc1(Ndef, &fields);CHKERRQ(ierr);
5836083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
5837083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fieldIS);CHKERRQ(ierr);
5838083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_");CHKERRQ(ierr);
5839083401c6SMatthew G. Knepley     ierr = ISSetType(fieldIS, ISGENERAL);CHKERRQ(ierr);
5840083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER);CHKERRQ(ierr);
5841083401c6SMatthew G. Knepley 
584245480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &dsDef);CHKERRQ(ierr);
5843083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, cellLabel, fieldIS, dsDef);CHKERRQ(ierr);
5844083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsDef, dE);CHKERRQ(ierr);
58455fedec97SMatthew G. Knepley     ierr = DMLabelDestroy(&cellLabel);CHKERRQ(ierr);
5846083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&dsDef);CHKERRQ(ierr);
5847083401c6SMatthew G. Knepley     ierr = ISDestroy(&fieldIS);CHKERRQ(ierr);
58480122748bSMatthew G. Knepley     ierr = DMDestroy(&plex);CHKERRQ(ierr);
5849083401c6SMatthew G. Knepley   }
5850083401c6SMatthew G. Knepley   /* Create label DSes
5851083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5852083401c6SMatthew G. Knepley   */
5853083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5854083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5855083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5856083401c6SMatthew G. Knepley     PetscDS   ds;
5857083401c6SMatthew G. Knepley     IS        fields;
5858083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5859083401c6SMatthew G. Knepley 
586045480ffeSMatthew G. Knepley     ierr = PetscDSCreate(PETSC_COMM_SELF, &ds);CHKERRQ(ierr);
5861083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
5862083401c6SMatthew G. Knepley     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5863083401c6SMatthew G. Knepley     for (f = 0, nf  = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
5864083401c6SMatthew G. Knepley     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5865083401c6SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5866083401c6SMatthew G. Knepley     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5867083401c6SMatthew G. Knepley     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5868083401c6SMatthew G. Knepley     ierr = DMSetRegionDS(dm, label, fields, ds);CHKERRQ(ierr);
5869083401c6SMatthew G. Knepley     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5870083401c6SMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(ds, dE);CHKERRQ(ierr);
5871083401c6SMatthew G. Knepley     {
5872083401c6SMatthew G. Knepley       DMPolytopeType ct;
5873083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
58745fedec97SMatthew G. Knepley       PetscBool      isCohesiveLocal = PETSC_FALSE, isCohesive;
58750122748bSMatthew G. Knepley 
5876e5e52638SMatthew G. Knepley       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5877665f567fSMatthew G. Knepley       if (lStart >= 0) {
5878412e9a14SMatthew G. Knepley         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5879412e9a14SMatthew G. Knepley         switch (ct) {
5880412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5881412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5882412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5883412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
58845fedec97SMatthew G. Knepley             isCohesiveLocal = PETSC_TRUE;break;
5885083401c6SMatthew G. Knepley           default: break;
5886412e9a14SMatthew G. Knepley         }
5887665f567fSMatthew G. Knepley       }
58885fedec97SMatthew G. Knepley       ierr = MPI_Allreduce(&isCohesiveLocal, &isCohesive, 1, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr);
58895fedec97SMatthew G. Knepley       for (f = 0, nf  = 0; f < Nf; ++f) {
58905fedec97SMatthew G. Knepley         if (label == dm->fields[f].label || !dm->fields[f].label) {
58915fedec97SMatthew G. Knepley           if (label == dm->fields[f].label) {
58925fedec97SMatthew G. Knepley             ierr = PetscDSSetDiscretization(ds, nf, NULL);CHKERRQ(ierr);
58935fedec97SMatthew G. Knepley             ierr = PetscDSSetCohesive(ds, nf, isCohesive);CHKERRQ(ierr);
58945fedec97SMatthew G. Knepley           }
58955fedec97SMatthew G. Knepley           ++nf;
58965fedec97SMatthew G. Knepley         }
58975fedec97SMatthew G. Knepley       }
5898e5e52638SMatthew G. Knepley     }
5899083401c6SMatthew G. Knepley     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5900e5e52638SMatthew G. Knepley   }
5901083401c6SMatthew G. Knepley   ierr = PetscFree(labelSet);CHKERRQ(ierr);
5902e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5903083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5904083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5905083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5906083401c6SMatthew G. Knepley     const PetscInt *fld;
59075fedec97SMatthew G. Knepley     PetscInt        nf, dsnf;
59085fedec97SMatthew G. Knepley     PetscBool       isCohesive;
5909e5e52638SMatthew G. Knepley 
59105fedec97SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsnf);CHKERRQ(ierr);
59115fedec97SMatthew G. Knepley     ierr = PetscDSIsCohesive(ds, &isCohesive);CHKERRQ(ierr);
5912083401c6SMatthew G. Knepley     ierr = ISGetLocalSize(fields, &nf);CHKERRQ(ierr);
5913083401c6SMatthew G. Knepley     ierr = ISGetIndices(fields, &fld);CHKERRQ(ierr);
5914083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5915083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
59165fedec97SMatthew G. Knepley       PetscBool    isCohesiveField;
5917e5e52638SMatthew G. Knepley       PetscClassId id;
5918e5e52638SMatthew G. Knepley 
59195fedec97SMatthew G. Knepley       /* Handle DS with no fields */
59205fedec97SMatthew G. Knepley       if (dsnf) {ierr = PetscDSGetCohesive(ds, f, &isCohesiveField);CHKERRQ(ierr);}
59215fedec97SMatthew G. Knepley       /* If this is a cohesive cell, then regular fields need the lower dimensional discretization */
59225fedec97SMatthew G. Knepley       if (isCohesive && !isCohesiveField) {ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc);CHKERRQ(ierr);}
5923083401c6SMatthew G. Knepley       ierr = PetscDSSetDiscretization(ds, f, disc);CHKERRQ(ierr);
5924083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
5925e5e52638SMatthew G. Knepley       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5926e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5927e5e52638SMatthew G. Knepley     }
5928083401c6SMatthew G. Knepley     ierr = ISRestoreIndices(fields, &fld);CHKERRQ(ierr);
5929e5e52638SMatthew G. Knepley   }
5930f9244615SMatthew G. Knepley   /* Allow k-jet tabulation */
5931f9244615SMatthew G. Knepley   ierr = PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg);CHKERRQ(ierr);
5932f9244615SMatthew G. Knepley   if (flg) {
59333b4aee56SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {
59343b4aee56SMatthew G. Knepley       PetscDS  ds = dm->probs[s].ds;
59353b4aee56SMatthew G. Knepley       PetscInt Nf, f;
59363b4aee56SMatthew G. Knepley 
59373b4aee56SMatthew G. Knepley       ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
59383b4aee56SMatthew G. Knepley       for (f = 0; f < Nf; ++f) {ierr = PetscDSSetJetDegree(ds, f, k);CHKERRQ(ierr);}
59393b4aee56SMatthew G. Knepley     }
5940f9244615SMatthew G. Knepley   }
5941e5e52638SMatthew G. Knepley   /* Setup DSes */
5942e5e52638SMatthew G. Knepley   if (doSetup) {
5943e5e52638SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5944e5e52638SMatthew G. Knepley   }
5945e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5946e5e52638SMatthew G. Knepley }
5947e5e52638SMatthew G. Knepley 
5948e5e52638SMatthew G. Knepley /*@
59497f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
59507f96f943SMatthew G. Knepley 
5951f2cacb80SMatthew G. Knepley   Collective on DM
5952f2cacb80SMatthew G. Knepley 
59537f96f943SMatthew G. Knepley   Input Parameters:
59547f96f943SMatthew G. Knepley + dm   - The DM
59557f96f943SMatthew G. Knepley - time - The time
59567f96f943SMatthew G. Knepley 
59577f96f943SMatthew G. Knepley   Output Parameters:
5958f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5959f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
59607f96f943SMatthew G. Knepley 
59617f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
59627f96f943SMatthew G. Knepley 
59637f96f943SMatthew G. Knepley   Level: developer
59647f96f943SMatthew G. Knepley 
59657f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
59667f96f943SMatthew G. Knepley @*/
5967f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
59687f96f943SMatthew G. Knepley {
59697f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
59707f96f943SMatthew G. Knepley   void            **ectxs;
59717f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
59727f96f943SMatthew G. Knepley   PetscErrorCode    ierr;
59737f96f943SMatthew G. Knepley 
59747f96f943SMatthew G. Knepley   PetscFunctionBegin;
5975f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5976f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5977f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
59787f96f943SMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
59797f96f943SMatthew G. Knepley   ierr = PetscMalloc2(Nf, &exacts, Nf, &ectxs);CHKERRQ(ierr);
59807f96f943SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
59817f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
59827f96f943SMatthew G. Knepley     PetscDS         ds;
59837f96f943SMatthew G. Knepley     DMLabel         label;
59847f96f943SMatthew G. Knepley     IS              fieldIS;
59857f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
59867f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
59877f96f943SMatthew G. Knepley 
59887f96f943SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
59897f96f943SMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
59907f96f943SMatthew G. Knepley     ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);
59917f96f943SMatthew G. Knepley     ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
59927f96f943SMatthew G. Knepley     ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
5993f2cacb80SMatthew G. Knepley     if (u) {
59947f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
59957f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
59967f96f943SMatthew G. Knepley         ierr = PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
59977f96f943SMatthew G. Knepley       }
59987f96f943SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
59997f96f943SMatthew G. Knepley       if (label) {
60007f96f943SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
60017f96f943SMatthew G. Knepley       } else {
60027f96f943SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u);CHKERRQ(ierr);
60037f96f943SMatthew G. Knepley       }
60047f96f943SMatthew G. Knepley     }
6005f2cacb80SMatthew G. Knepley     if (u_t) {
6006f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(exacts, Nf);CHKERRQ(ierr);
6007f2cacb80SMatthew G. Knepley       ierr = PetscArrayzero(ectxs, Nf);CHKERRQ(ierr);
6008f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
6009f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
6010f2cacb80SMatthew G. Knepley         ierr = PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]);CHKERRQ(ierr);
6011f2cacb80SMatthew G. Knepley       }
6012f2cacb80SMatthew G. Knepley       ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);
6013f2cacb80SMatthew G. Knepley       if (label) {
6014f2cacb80SMatthew G. Knepley         ierr = DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
6015f2cacb80SMatthew G. Knepley       } else {
6016f2cacb80SMatthew G. Knepley         ierr = DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t);CHKERRQ(ierr);
6017f2cacb80SMatthew G. Knepley       }
6018f2cacb80SMatthew G. Knepley     }
6019f2cacb80SMatthew G. Knepley   }
6020f2cacb80SMatthew G. Knepley   if (u) {
60217f96f943SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution");CHKERRQ(ierr);
60227f96f943SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u, "exact_");CHKERRQ(ierr);
6023f2cacb80SMatthew G. Knepley   }
6024f2cacb80SMatthew G. Knepley   if (u_t) {
6025f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative");CHKERRQ(ierr);
6026f2cacb80SMatthew G. Knepley     ierr = PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_");CHKERRQ(ierr);
6027f2cacb80SMatthew G. Knepley   }
60287f96f943SMatthew G. Knepley   ierr = PetscFree2(exacts, ectxs);CHKERRQ(ierr);
60297f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
60307f96f943SMatthew G. Knepley }
60317f96f943SMatthew G. Knepley 
603245480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds)
603345480ffeSMatthew G. Knepley {
603445480ffeSMatthew G. Knepley   PetscDS        dsNew;
603545480ffeSMatthew G. Knepley   DSBoundary     b;
603645480ffeSMatthew G. Knepley   PetscInt       cdim, Nf, f;
60375fedec97SMatthew G. Knepley   PetscBool      isCohesive;
603845480ffeSMatthew G. Knepley   void          *ctx;
603945480ffeSMatthew G. Knepley   PetscErrorCode ierr;
604045480ffeSMatthew G. Knepley 
604145480ffeSMatthew G. Knepley   PetscFunctionBegin;
604245480ffeSMatthew G. Knepley   ierr = PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew);CHKERRQ(ierr);
604345480ffeSMatthew G. Knepley   ierr = PetscDSCopyConstants(ds, dsNew);CHKERRQ(ierr);
604445480ffeSMatthew G. Knepley   ierr = PetscDSCopyExactSolutions(ds, dsNew);CHKERRQ(ierr);
604545480ffeSMatthew G. Knepley   ierr = PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
604645480ffeSMatthew G. Knepley   ierr = PetscDSCopyEquations(ds, dsNew);CHKERRQ(ierr);
604745480ffeSMatthew G. Knepley   ierr = PetscDSGetNumFields(ds, &Nf);CHKERRQ(ierr);
604845480ffeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
604945480ffeSMatthew G. Knepley     ierr = PetscDSGetContext(ds, f, &ctx);CHKERRQ(ierr);
605045480ffeSMatthew G. Knepley     ierr = PetscDSSetContext(dsNew, f, ctx);CHKERRQ(ierr);
60515fedec97SMatthew G. Knepley     ierr = PetscDSGetCohesive(ds, f, &isCohesive);CHKERRQ(ierr);
60525fedec97SMatthew G. Knepley     ierr = PetscDSSetCohesive(dsNew, f, isCohesive);CHKERRQ(ierr);
605345480ffeSMatthew G. Knepley   }
605445480ffeSMatthew G. Knepley   if (Nf) {
605545480ffeSMatthew G. Knepley     ierr = PetscDSGetCoordinateDimension(ds, &cdim);CHKERRQ(ierr);
605645480ffeSMatthew G. Knepley     ierr = PetscDSSetCoordinateDimension(dsNew, cdim);CHKERRQ(ierr);
605745480ffeSMatthew G. Knepley   }
605845480ffeSMatthew G. Knepley   ierr = PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew);CHKERRQ(ierr);
605945480ffeSMatthew G. Knepley   for (b = dsNew->boundary; b; b = b->next) {
606045480ffeSMatthew G. Knepley     ierr = DMGetLabel(dm, b->lname, &b->label);CHKERRQ(ierr);
606145480ffeSMatthew G. Knepley     /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
60622c71b3e2SJacob Faibussowitsch     //PetscCheckFalse(!b->label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name);
606345480ffeSMatthew G. Knepley   }
606445480ffeSMatthew G. Knepley 
606545480ffeSMatthew G. Knepley   ierr = DMSetRegionDS(dm, label, fields, dsNew);CHKERRQ(ierr);
606645480ffeSMatthew G. Knepley   ierr = PetscDSDestroy(&dsNew);CHKERRQ(ierr);
606745480ffeSMatthew G. Knepley   PetscFunctionReturn(0);
606845480ffeSMatthew G. Knepley }
606945480ffeSMatthew G. Knepley 
60707f96f943SMatthew G. Knepley /*@
6071e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
6072e5e52638SMatthew G. Knepley 
6073d083f849SBarry Smith   Collective on dm
6074e5e52638SMatthew G. Knepley 
6075e5e52638SMatthew G. Knepley   Input Parameter:
6076e5e52638SMatthew G. Knepley . dm - The DM
6077e5e52638SMatthew G. Knepley 
6078e5e52638SMatthew G. Knepley   Output Parameter:
6079e5e52638SMatthew G. Knepley . newdm - The DM
6080e5e52638SMatthew G. Knepley 
6081e5e52638SMatthew G. Knepley   Level: advanced
6082e5e52638SMatthew G. Knepley 
6083e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
6084e5e52638SMatthew G. Knepley @*/
6085e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
6086e5e52638SMatthew G. Knepley {
6087e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
6088e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
6089e5e52638SMatthew G. Knepley 
6090e5e52638SMatthew G. Knepley   PetscFunctionBegin;
6091e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
6092e5e52638SMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
6093e5e52638SMatthew G. Knepley   ierr = DMClearDS(newdm);CHKERRQ(ierr);
6094e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
6095e5e52638SMatthew G. Knepley     DMLabel  label;
6096b3cf3223SMatthew G. Knepley     IS       fields;
609745480ffeSMatthew G. Knepley     PetscDS  ds, newds;
6098783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
6099e5e52638SMatthew G. Knepley 
6100b3cf3223SMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
6101b8025e53SMatthew G. Knepley     /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */
610245480ffeSMatthew G. Knepley     ierr = DMTransferDS_Internal(newdm, label, fields, ds);CHKERRQ(ierr);
610345480ffeSMatthew G. Knepley     /* Commplete new labels in the new DS */
610445480ffeSMatthew G. Knepley     ierr = DMGetRegionDS(newdm, label, NULL, &newds);CHKERRQ(ierr);
610545480ffeSMatthew G. Knepley     ierr = PetscDSGetNumBoundary(newds, &Nbd);CHKERRQ(ierr);
6106783e2ec8SMatthew G. Knepley     for (bd = 0; bd < Nbd; ++bd) {
6107b8025e53SMatthew G. Knepley       PetscWeakForm wf;
610845480ffeSMatthew G. Knepley       DMLabel       label;
6109783e2ec8SMatthew G. Knepley       PetscInt      field;
6110783e2ec8SMatthew G. Knepley 
6111b8025e53SMatthew G. Knepley       ierr = PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
611245480ffeSMatthew G. Knepley       ierr = DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label);CHKERRQ(ierr);
6113b8025e53SMatthew G. Knepley       ierr = PetscWeakFormReplaceLabel(wf, label);CHKERRQ(ierr);
6114783e2ec8SMatthew G. Knepley     }
6115e5e52638SMatthew G. Knepley   }
6116e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
6117e5e52638SMatthew G. Knepley }
6118e5e52638SMatthew G. Knepley 
6119e5e52638SMatthew G. Knepley /*@
6120e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
6121e5e52638SMatthew G. Knepley 
6122d083f849SBarry Smith   Collective on dm
6123e5e52638SMatthew G. Knepley 
6124e5e52638SMatthew G. Knepley   Input Parameter:
6125e5e52638SMatthew G. Knepley . dm - The DM
6126e5e52638SMatthew G. Knepley 
6127e5e52638SMatthew G. Knepley   Output Parameter:
6128e5e52638SMatthew G. Knepley . newdm - The DM
6129e5e52638SMatthew G. Knepley 
6130e5e52638SMatthew G. Knepley   Level: advanced
6131e5e52638SMatthew G. Knepley 
6132e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
6133e5e52638SMatthew G. Knepley @*/
6134e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
6135e5e52638SMatthew G. Knepley {
6136e5e52638SMatthew G. Knepley   PetscErrorCode ierr;
6137e5e52638SMatthew G. Knepley 
6138e5e52638SMatthew G. Knepley   PetscFunctionBegin;
6139e5e52638SMatthew G. Knepley   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
6140e5e52638SMatthew G. Knepley   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
6141e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
6142e5e52638SMatthew G. Knepley }
6143e5e52638SMatthew G. Knepley 
6144b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
6145b64e0483SPeter Brune {
6146b64e0483SPeter Brune   DM dm_coord,dmc_coord;
6147b64e0483SPeter Brune   PetscErrorCode ierr;
6148b64e0483SPeter Brune   Vec coords,ccoords;
61496dbf9973SLawrence Mitchell   Mat inject;
6150b64e0483SPeter Brune   PetscFunctionBegin;
6151b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
6152b64e0483SPeter Brune   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
6153b64e0483SPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
6154b64e0483SPeter Brune   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
6155b64e0483SPeter Brune   if (coords && !ccoords) {
6156b64e0483SPeter Brune     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
61576668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
61586dbf9973SLawrence Mitchell     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
61592adcf181SLawrence Mitchell     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
61606dbf9973SLawrence Mitchell     ierr = MatDestroy(&inject);CHKERRQ(ierr);
6161b64e0483SPeter Brune     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
6162b64e0483SPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
6163b64e0483SPeter Brune   }
6164b64e0483SPeter Brune   PetscFunctionReturn(0);
6165b64e0483SPeter Brune }
6166b64e0483SPeter Brune 
616703dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
616803dadc2fSPeter Brune {
616903dadc2fSPeter Brune   DM dm_coord,subdm_coord;
617003dadc2fSPeter Brune   PetscErrorCode ierr;
617103dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
617203dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
617303dadc2fSPeter Brune   PetscFunctionBegin;
617403dadc2fSPeter Brune   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
617503dadc2fSPeter Brune   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
617603dadc2fSPeter Brune   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
617703dadc2fSPeter Brune   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
617803dadc2fSPeter Brune   if (coords && !ccoords) {
617903dadc2fSPeter Brune     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
61806668ed41SLisandro Dalcin     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
618103dadc2fSPeter Brune     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
618224640c55SToby Isaac     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
618303dadc2fSPeter Brune     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
618403dadc2fSPeter Brune     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
618503dadc2fSPeter Brune     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
61861ed9ada7SJunchao Zhang     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
618703dadc2fSPeter Brune     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
618803dadc2fSPeter Brune     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
618903dadc2fSPeter Brune     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
619003dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
619103dadc2fSPeter Brune     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
619203dadc2fSPeter Brune     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
619303dadc2fSPeter Brune     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
619403dadc2fSPeter Brune     ierr = PetscFree(scat_i);CHKERRQ(ierr);
619503dadc2fSPeter Brune     ierr = PetscFree(scat_g);CHKERRQ(ierr);
619603dadc2fSPeter Brune   }
619703dadc2fSPeter Brune   PetscFunctionReturn(0);
619803dadc2fSPeter Brune }
619903dadc2fSPeter Brune 
6200c73cfb54SMatthew G. Knepley /*@
6201c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
6202c73cfb54SMatthew G. Knepley 
6203c73cfb54SMatthew G. Knepley   Not collective
6204c73cfb54SMatthew G. Knepley 
6205c73cfb54SMatthew G. Knepley   Input Parameter:
6206c73cfb54SMatthew G. Knepley . dm - The DM
6207c73cfb54SMatthew G. Knepley 
6208c73cfb54SMatthew G. Knepley   Output Parameter:
6209c73cfb54SMatthew G. Knepley . dim - The topological dimension
6210c73cfb54SMatthew G. Knepley 
6211c73cfb54SMatthew G. Knepley   Level: beginner
6212c73cfb54SMatthew G. Knepley 
6213c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
6214c73cfb54SMatthew G. Knepley @*/
6215c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
6216c73cfb54SMatthew G. Knepley {
6217c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6218c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6219534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
6220c73cfb54SMatthew G. Knepley   *dim = dm->dim;
6221c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6222c73cfb54SMatthew G. Knepley }
6223c73cfb54SMatthew G. Knepley 
6224c73cfb54SMatthew G. Knepley /*@
6225c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
6226c73cfb54SMatthew G. Knepley 
6227c73cfb54SMatthew G. Knepley   Collective on dm
6228c73cfb54SMatthew G. Knepley 
6229c73cfb54SMatthew G. Knepley   Input Parameters:
6230c73cfb54SMatthew G. Knepley + dm - The DM
6231c73cfb54SMatthew G. Knepley - dim - The topological dimension
6232c73cfb54SMatthew G. Knepley 
6233c73cfb54SMatthew G. Knepley   Level: beginner
6234c73cfb54SMatthew G. Knepley 
6235c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
6236c73cfb54SMatthew G. Knepley @*/
6237c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
6238c73cfb54SMatthew G. Knepley {
6239e5e52638SMatthew G. Knepley   PetscDS        ds;
624045480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6241f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6242f17e8794SMatthew G. Knepley 
6243c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6244c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6245c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
6246c73cfb54SMatthew G. Knepley   dm->dim = dim;
6247d17bd122SMatthew G. Knepley   if (dm->dim >= 0) {
624845480ffeSMatthew G. Knepley     ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
624945480ffeSMatthew G. Knepley     for (n = 0; n < Nds; ++n) {
625045480ffeSMatthew G. Knepley       ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
625145480ffeSMatthew G. Knepley       if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);}
625245480ffeSMatthew G. Knepley     }
6253d17bd122SMatthew G. Knepley   }
6254c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6255c73cfb54SMatthew G. Knepley }
6256c73cfb54SMatthew G. Knepley 
6257793f3fe5SMatthew G. Knepley /*@
6258793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
6259793f3fe5SMatthew G. Knepley 
6260d083f849SBarry Smith   Collective on dm
6261793f3fe5SMatthew G. Knepley 
6262793f3fe5SMatthew G. Knepley   Input Parameters:
6263793f3fe5SMatthew G. Knepley + dm - the DM
6264793f3fe5SMatthew G. Knepley - dim - the dimension
6265793f3fe5SMatthew G. Knepley 
6266793f3fe5SMatthew G. Knepley   Output Parameters:
6267793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
6268aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
6269793f3fe5SMatthew G. Knepley 
6270793f3fe5SMatthew G. Knepley   Note:
6271793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
6272a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
6273793f3fe5SMatthew G. Knepley   then the interval is empty.
6274793f3fe5SMatthew G. Knepley 
6275793f3fe5SMatthew G. Knepley   Level: intermediate
6276793f3fe5SMatthew G. Knepley 
6277793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
6278793f3fe5SMatthew G. Knepley @*/
6279793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
6280793f3fe5SMatthew G. Knepley {
6281793f3fe5SMatthew G. Knepley   PetscInt       d;
6282793f3fe5SMatthew G. Knepley   PetscErrorCode ierr;
6283793f3fe5SMatthew G. Knepley 
6284793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
6285793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6286793f3fe5SMatthew G. Knepley   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
62872c71b3e2SJacob Faibussowitsch   PetscCheckFalse((dim < 0) || (dim > d),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
62882c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->getdimpoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
6289793f3fe5SMatthew G. Knepley   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
6290793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
6291793f3fe5SMatthew G. Knepley }
6292793f3fe5SMatthew G. Knepley 
62936636e97aSMatthew G Knepley /*@
62946636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
62956636e97aSMatthew G Knepley 
6296d083f849SBarry Smith   Collective on dm
62976636e97aSMatthew G Knepley 
62986636e97aSMatthew G Knepley   Input Parameters:
62996636e97aSMatthew G Knepley + dm - the DM
63006636e97aSMatthew G Knepley - c - coordinate vector
63016636e97aSMatthew G Knepley 
63022dd40e9bSPatrick Sanan   Notes:
63032dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
63042dd40e9bSPatrick Sanan 
63052dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
63066636e97aSMatthew G Knepley 
63076636e97aSMatthew G Knepley   Level: intermediate
63086636e97aSMatthew G Knepley 
630960c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
63106636e97aSMatthew G Knepley @*/
63116636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
63126636e97aSMatthew G Knepley {
63136636e97aSMatthew G Knepley   PetscErrorCode ierr;
63146636e97aSMatthew G Knepley 
63156636e97aSMatthew G Knepley   PetscFunctionBegin;
63166636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63176636e97aSMatthew G Knepley   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
63186636e97aSMatthew G Knepley   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
63196636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
63206636e97aSMatthew G Knepley   dm->coordinates = c;
63216636e97aSMatthew G Knepley   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
6322b64e0483SPeter Brune   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
632303dadc2fSPeter Brune   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
63246636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63256636e97aSMatthew G Knepley }
63266636e97aSMatthew G Knepley 
63276636e97aSMatthew G Knepley /*@
63286636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
63296636e97aSMatthew G Knepley 
63307058e716SVaclav Hapla   Not collective
63316636e97aSMatthew G Knepley 
63326636e97aSMatthew G Knepley    Input Parameters:
63336636e97aSMatthew G Knepley +  dm - the DM
63346636e97aSMatthew G Knepley -  c - coordinate vector
63356636e97aSMatthew G Knepley 
63362dd40e9bSPatrick Sanan   Notes:
63376636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
63386636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
63396636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
63406636e97aSMatthew G Knepley 
63412dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
63422dd40e9bSPatrick Sanan 
63436636e97aSMatthew G Knepley   Level: intermediate
63446636e97aSMatthew G Knepley 
63456636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
63466636e97aSMatthew G Knepley @*/
63476636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
63486636e97aSMatthew G Knepley {
63496636e97aSMatthew G Knepley   PetscErrorCode ierr;
63506636e97aSMatthew G Knepley 
63516636e97aSMatthew G Knepley   PetscFunctionBegin;
63526636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6353b7f5c055SJed Brown   if (c) PetscValidHeaderSpecific(c,VEC_CLASSID,2);
63546636e97aSMatthew G Knepley   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
63556636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
63568865f1eaSKarl Rupp 
63576636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
63588865f1eaSKarl Rupp 
63596636e97aSMatthew G Knepley   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
63606636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63616636e97aSMatthew G Knepley }
63626636e97aSMatthew G Knepley 
63636636e97aSMatthew G Knepley /*@
63646636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
63656636e97aSMatthew G Knepley 
6366d083f849SBarry Smith   Collective on dm
63676636e97aSMatthew G Knepley 
63686636e97aSMatthew G Knepley   Input Parameter:
63696636e97aSMatthew G Knepley . dm - the DM
63706636e97aSMatthew G Knepley 
63716636e97aSMatthew G Knepley   Output Parameter:
63726636e97aSMatthew G Knepley . c - global coordinate vector
63736636e97aSMatthew G Knepley 
63746636e97aSMatthew G Knepley   Note:
637560c22052SBarry Smith   This is a borrowed reference, so the user should NOT destroy this vector. When the DM is
637660c22052SBarry Smith   destroyed the array will no longer be valid.
63776636e97aSMatthew G Knepley 
6378959c7569SPatrick Sanan   Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates).
63796636e97aSMatthew G Knepley 
63806636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63816636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63826636e97aSMatthew G Knepley 
63836636e97aSMatthew G Knepley   Level: intermediate
63846636e97aSMatthew G Knepley 
638560c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
63866636e97aSMatthew G Knepley @*/
63876636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
63886636e97aSMatthew G Knepley {
63896636e97aSMatthew G Knepley   PetscErrorCode ierr;
63906636e97aSMatthew G Knepley 
63916636e97aSMatthew G Knepley   PetscFunctionBegin;
63926636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63936636e97aSMatthew G Knepley   PetscValidPointer(c,2);
63941f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
63950298fd71SBarry Smith     DM        cdm = NULL;
63961970a576SMatthew G. Knepley     PetscBool localized;
63976636e97aSMatthew G Knepley 
63986636e97aSMatthew G Knepley     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
63996636e97aSMatthew G Knepley     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
64001970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
64011970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
64021970a576SMatthew G. Knepley     if (localized) {
64031970a576SMatthew G. Knepley       PetscInt cdim;
64041970a576SMatthew G. Knepley 
64051970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
64061970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
64071970a576SMatthew G. Knepley     }
64086636e97aSMatthew G Knepley     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
64096636e97aSMatthew G Knepley     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
64106636e97aSMatthew G Knepley     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
64116636e97aSMatthew G Knepley   }
64126636e97aSMatthew G Knepley   *c = dm->coordinates;
64136636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64146636e97aSMatthew G Knepley }
64156636e97aSMatthew G Knepley 
64166636e97aSMatthew G Knepley /*@
641781e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
641881e9a530SVaclav Hapla 
6419d083f849SBarry Smith   Collective on dm
642081e9a530SVaclav Hapla 
642181e9a530SVaclav Hapla   Input Parameter:
642281e9a530SVaclav Hapla . dm - the DM
642381e9a530SVaclav Hapla 
642481e9a530SVaclav Hapla   Level: advanced
642581e9a530SVaclav Hapla 
642681e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
642781e9a530SVaclav Hapla @*/
642881e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
642981e9a530SVaclav Hapla {
643081e9a530SVaclav Hapla   PetscErrorCode ierr;
643181e9a530SVaclav Hapla 
643281e9a530SVaclav Hapla   PetscFunctionBegin;
643381e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
643481e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
64351970a576SMatthew G. Knepley     DM        cdm = NULL;
64361970a576SMatthew G. Knepley     PetscBool localized;
64371970a576SMatthew G. Knepley 
643881e9a530SVaclav Hapla     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
643981e9a530SVaclav Hapla     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
64401970a576SMatthew G. Knepley     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
64411970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
64421970a576SMatthew G. Knepley     if (localized) {
64431970a576SMatthew G. Knepley       PetscInt cdim;
64441970a576SMatthew G. Knepley 
64451970a576SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
64461970a576SMatthew G. Knepley       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
64471970a576SMatthew G. Knepley     }
644881e9a530SVaclav Hapla     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
644981e9a530SVaclav Hapla     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
645081e9a530SVaclav Hapla     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
645181e9a530SVaclav Hapla   }
645281e9a530SVaclav Hapla   PetscFunctionReturn(0);
645381e9a530SVaclav Hapla }
645481e9a530SVaclav Hapla 
645581e9a530SVaclav Hapla /*@
64566636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
64576636e97aSMatthew G Knepley 
6458d083f849SBarry Smith   Collective on dm
64596636e97aSMatthew G Knepley 
64606636e97aSMatthew G Knepley   Input Parameter:
64616636e97aSMatthew G Knepley . dm - the DM
64626636e97aSMatthew G Knepley 
64636636e97aSMatthew G Knepley   Output Parameter:
64646636e97aSMatthew G Knepley . c - coordinate vector
64656636e97aSMatthew G Knepley 
64666636e97aSMatthew G Knepley   Note:
64676636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
64686636e97aSMatthew G Knepley 
64696636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
64706636e97aSMatthew G Knepley 
64716636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
64726636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
64736636e97aSMatthew G Knepley 
64746636e97aSMatthew G Knepley   Level: intermediate
64756636e97aSMatthew G Knepley 
647681e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
64776636e97aSMatthew G Knepley @*/
64786636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
64796636e97aSMatthew G Knepley {
64806636e97aSMatthew G Knepley   PetscErrorCode ierr;
64816636e97aSMatthew G Knepley 
64826636e97aSMatthew G Knepley   PetscFunctionBegin;
64836636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64846636e97aSMatthew G Knepley   PetscValidPointer(c,2);
648581e9a530SVaclav Hapla   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
64866636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
64876636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64886636e97aSMatthew G Knepley }
64896636e97aSMatthew G Knepley 
649081e9a530SVaclav Hapla /*@
649181e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
649281e9a530SVaclav Hapla 
649381e9a530SVaclav Hapla   Not collective
649481e9a530SVaclav Hapla 
649581e9a530SVaclav Hapla   Input Parameter:
649681e9a530SVaclav Hapla . dm - the DM
649781e9a530SVaclav Hapla 
649881e9a530SVaclav Hapla   Output Parameter:
649981e9a530SVaclav Hapla . c - coordinate vector
650081e9a530SVaclav Hapla 
650181e9a530SVaclav Hapla   Level: advanced
650281e9a530SVaclav Hapla 
650381e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
650481e9a530SVaclav Hapla @*/
650581e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
650681e9a530SVaclav Hapla {
650781e9a530SVaclav Hapla   PetscFunctionBegin;
650881e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
650981e9a530SVaclav Hapla   PetscValidPointer(c,2);
65102c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->coordinatesLocal && dm->coordinates,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
65116636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
65126636e97aSMatthew G Knepley   PetscFunctionReturn(0);
65136636e97aSMatthew G Knepley }
65146636e97aSMatthew G Knepley 
65152db98f8dSVaclav Hapla /*@
65162db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
65172db98f8dSVaclav Hapla 
65182db98f8dSVaclav Hapla   Not collective
65192db98f8dSVaclav Hapla 
6520d8d19677SJose E. Roman   Input Parameters:
65212db98f8dSVaclav Hapla + dm - the DM
65222db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
65232db98f8dSVaclav Hapla 
6524d8d19677SJose E. Roman   Output Parameters:
65252db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
65262db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
65272db98f8dSVaclav Hapla 
65282db98f8dSVaclav Hapla   Note:
65292db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
65302db98f8dSVaclav Hapla 
65312db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
65322db98f8dSVaclav Hapla 
65332db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
65342db98f8dSVaclav Hapla 
65352db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
65362db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
65372db98f8dSVaclav Hapla 
65382db98f8dSVaclav Hapla   Level: advanced
65392db98f8dSVaclav Hapla 
65402db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
65412db98f8dSVaclav Hapla @*/
65422db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
65432db98f8dSVaclav Hapla {
65442db98f8dSVaclav Hapla   PetscSection        cs, newcs;
65452db98f8dSVaclav Hapla   Vec                 coords;
65462db98f8dSVaclav Hapla   const PetscScalar   *arr;
65472db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
65482db98f8dSVaclav Hapla   PetscInt            n;
65492db98f8dSVaclav Hapla   PetscErrorCode      ierr;
65502db98f8dSVaclav Hapla 
65512db98f8dSVaclav Hapla   PetscFunctionBegin;
65522db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
65532db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
65542db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
65552db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
65562c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->coordinatesLocal,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
65572c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->coordinateDM || !dm->coordinateDM->localSection,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
65581bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
65592db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
65602db98f8dSVaclav Hapla   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
65612db98f8dSVaclav Hapla   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
65622db98f8dSVaclav Hapla   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
65632db98f8dSVaclav Hapla   if (pCoord) {
65642db98f8dSVaclav Hapla     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
65652db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
65662db98f8dSVaclav Hapla     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
65672db98f8dSVaclav Hapla     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
6568ad9ac99dSVaclav Hapla   } else {
6569ad9ac99dSVaclav Hapla     ierr = PetscFree(newarr);CHKERRQ(ierr);
65702db98f8dSVaclav Hapla   }
6571ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
6572ad9ac99dSVaclav Hapla   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
65732db98f8dSVaclav Hapla   PetscFunctionReturn(0);
65742db98f8dSVaclav Hapla }
65752db98f8dSVaclav Hapla 
6576f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6577f19dbd58SToby Isaac {
6578f19dbd58SToby Isaac   PetscErrorCode ierr;
6579f19dbd58SToby Isaac 
6580f19dbd58SToby Isaac   PetscFunctionBegin;
6581f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6582f19dbd58SToby Isaac   PetscValidPointer(field,2);
6583f19dbd58SToby Isaac   if (!dm->coordinateField) {
6584f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
6585f19dbd58SToby Isaac       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
6586f19dbd58SToby Isaac     }
6587f19dbd58SToby Isaac   }
6588f19dbd58SToby Isaac   *field = dm->coordinateField;
6589f19dbd58SToby Isaac   PetscFunctionReturn(0);
6590f19dbd58SToby Isaac }
6591f19dbd58SToby Isaac 
6592f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6593f19dbd58SToby Isaac {
6594f19dbd58SToby Isaac   PetscErrorCode ierr;
6595f19dbd58SToby Isaac 
6596f19dbd58SToby Isaac   PetscFunctionBegin;
6597f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6598f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
6599c4e6da2cSBarry Smith   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
6600f19dbd58SToby Isaac   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
6601f19dbd58SToby Isaac   dm->coordinateField = field;
6602f19dbd58SToby Isaac   PetscFunctionReturn(0);
6603f19dbd58SToby Isaac }
6604f19dbd58SToby Isaac 
66056636e97aSMatthew G Knepley /*@
66061cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
66076636e97aSMatthew G Knepley 
6608d083f849SBarry Smith   Collective on dm
66096636e97aSMatthew G Knepley 
66106636e97aSMatthew G Knepley   Input Parameter:
66116636e97aSMatthew G Knepley . dm - the DM
66126636e97aSMatthew G Knepley 
66136636e97aSMatthew G Knepley   Output Parameter:
66146636e97aSMatthew G Knepley . cdm - coordinate DM
66156636e97aSMatthew G Knepley 
66166636e97aSMatthew G Knepley   Level: intermediate
66176636e97aSMatthew G Knepley 
66181cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
66196636e97aSMatthew G Knepley @*/
66206636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
66216636e97aSMatthew G Knepley {
66226636e97aSMatthew G Knepley   PetscErrorCode ierr;
66236636e97aSMatthew G Knepley 
66246636e97aSMatthew G Knepley   PetscFunctionBegin;
66256636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
66266636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
66276636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6628308f8a94SToby Isaac     DM cdm;
6629308f8a94SToby Isaac 
66302c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm->ops->createcoordinatedm,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
6631308f8a94SToby Isaac     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
6632c9ad657eSksagiyam     ierr = PetscObjectSetName((PetscObject)cdm, "coordinateDM");CHKERRQ(ierr);
6633308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6634308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
6635308f8a94SToby Isaac     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
6636308f8a94SToby Isaac     dm->coordinateDM = cdm;
66376636e97aSMatthew G Knepley   }
66386636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
66396636e97aSMatthew G Knepley   PetscFunctionReturn(0);
66406636e97aSMatthew G Knepley }
6641e87bb0d3SMatthew G Knepley 
66421cfe2091SMatthew G. Knepley /*@
66431cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
66441cfe2091SMatthew G. Knepley 
6645d083f849SBarry Smith   Logically Collective on dm
66461cfe2091SMatthew G. Knepley 
66471cfe2091SMatthew G. Knepley   Input Parameters:
66481cfe2091SMatthew G. Knepley + dm - the DM
66491cfe2091SMatthew G. Knepley - cdm - coordinate DM
66501cfe2091SMatthew G. Knepley 
66511cfe2091SMatthew G. Knepley   Level: intermediate
66521cfe2091SMatthew G. Knepley 
66531cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
66541cfe2091SMatthew G. Knepley @*/
66551cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
66561cfe2091SMatthew G. Knepley {
66571cfe2091SMatthew G. Knepley   PetscErrorCode ierr;
66581cfe2091SMatthew G. Knepley 
66591cfe2091SMatthew G. Knepley   PetscFunctionBegin;
66601cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
66611cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
6662f26b38b9SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
66631cfe2091SMatthew G. Knepley   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
66641cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
66651cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
66661cfe2091SMatthew G. Knepley }
66671cfe2091SMatthew G. Knepley 
666846e270d4SMatthew G. Knepley /*@
666946e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
667046e270d4SMatthew G. Knepley 
667146e270d4SMatthew G. Knepley   Not Collective
667246e270d4SMatthew G. Knepley 
667346e270d4SMatthew G. Knepley   Input Parameter:
667446e270d4SMatthew G. Knepley . dm - The DM object
667546e270d4SMatthew G. Knepley 
667646e270d4SMatthew G. Knepley   Output Parameter:
667746e270d4SMatthew G. Knepley . dim - The embedding dimension
667846e270d4SMatthew G. Knepley 
667946e270d4SMatthew G. Knepley   Level: intermediate
668046e270d4SMatthew G. Knepley 
668192fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
668246e270d4SMatthew G. Knepley @*/
668346e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
668446e270d4SMatthew G. Knepley {
668546e270d4SMatthew G. Knepley   PetscFunctionBegin;
668646e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6687534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
66889a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
66899a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
66909a9a41abSToby Isaac   }
669146e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
669246e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
669346e270d4SMatthew G. Knepley }
669446e270d4SMatthew G. Knepley 
669546e270d4SMatthew G. Knepley /*@
669646e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
669746e270d4SMatthew G. Knepley 
669846e270d4SMatthew G. Knepley   Not Collective
669946e270d4SMatthew G. Knepley 
670046e270d4SMatthew G. Knepley   Input Parameters:
670146e270d4SMatthew G. Knepley + dm  - The DM object
670246e270d4SMatthew G. Knepley - dim - The embedding dimension
670346e270d4SMatthew G. Knepley 
670446e270d4SMatthew G. Knepley   Level: intermediate
670546e270d4SMatthew G. Knepley 
670692fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
670746e270d4SMatthew G. Knepley @*/
670846e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
670946e270d4SMatthew G. Knepley {
6710e5e52638SMatthew G. Knepley   PetscDS        ds;
671145480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6712f17e8794SMatthew G. Knepley   PetscErrorCode ierr;
6713f17e8794SMatthew G. Knepley 
671446e270d4SMatthew G. Knepley   PetscFunctionBegin;
671546e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
671646e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
6717d17bd122SMatthew G. Knepley   if (dm->dim >= 0) {
671845480ffeSMatthew G. Knepley     ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
671945480ffeSMatthew G. Knepley     for (n = 0; n < Nds; ++n) {
672045480ffeSMatthew G. Knepley       ierr = DMGetRegionNumDS(dm, n, NULL, NULL, &ds);CHKERRQ(ierr);
6721e5e52638SMatthew G. Knepley       ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
672245480ffeSMatthew G. Knepley     }
6723d17bd122SMatthew G. Knepley   }
672446e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
672546e270d4SMatthew G. Knepley }
672646e270d4SMatthew G. Knepley 
6727e8abe2deSMatthew G. Knepley /*@
6728e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6729e8abe2deSMatthew G. Knepley 
6730d083f849SBarry Smith   Collective on dm
6731e8abe2deSMatthew G. Knepley 
6732e8abe2deSMatthew G. Knepley   Input Parameter:
6733e8abe2deSMatthew G. Knepley . dm - The DM object
6734e8abe2deSMatthew G. Knepley 
6735e8abe2deSMatthew G. Knepley   Output Parameter:
6736e8abe2deSMatthew G. Knepley . section - The PetscSection object
6737e8abe2deSMatthew G. Knepley 
6738e8abe2deSMatthew G. Knepley   Level: intermediate
6739e8abe2deSMatthew G. Knepley 
674092fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6741e8abe2deSMatthew G. Knepley @*/
6742e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6743e8abe2deSMatthew G. Knepley {
6744e8abe2deSMatthew G. Knepley   DM             cdm;
6745e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6746e8abe2deSMatthew G. Knepley 
6747e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6748e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6749e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
6750e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
675192fd8e1eSJed Brown   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6752e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6753e8abe2deSMatthew G. Knepley }
6754e8abe2deSMatthew G. Knepley 
6755e8abe2deSMatthew G. Knepley /*@
6756e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6757e8abe2deSMatthew G. Knepley 
6758e8abe2deSMatthew G. Knepley   Not Collective
6759e8abe2deSMatthew G. Knepley 
6760e8abe2deSMatthew G. Knepley   Input Parameters:
6761e8abe2deSMatthew G. Knepley + dm      - The DM object
676246e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6763e8abe2deSMatthew G. Knepley - section - The PetscSection object
6764e8abe2deSMatthew G. Knepley 
6765e8abe2deSMatthew G. Knepley   Level: intermediate
6766e8abe2deSMatthew G. Knepley 
676792fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6768e8abe2deSMatthew G. Knepley @*/
676946e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6770e8abe2deSMatthew G. Knepley {
6771e8abe2deSMatthew G. Knepley   DM             cdm;
6772e8abe2deSMatthew G. Knepley   PetscErrorCode ierr;
6773e8abe2deSMatthew G. Knepley 
6774e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6775e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
677646e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6777e8abe2deSMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
677892fd8e1eSJed Brown   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
677946e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
67804c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
678146e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
678246e270d4SMatthew G. Knepley 
678346e270d4SMatthew G. Knepley     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
678446e270d4SMatthew G. Knepley     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
678546e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
678646e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
678746e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
678846e270d4SMatthew G. Knepley       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
678946e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
679046e270d4SMatthew G. Knepley     }
6791ebfe4b0dSMatthew G. Knepley     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
679246e270d4SMatthew G. Knepley   }
6793e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6794e8abe2deSMatthew G. Knepley }
6795e8abe2deSMatthew G. Knepley 
6796d864a3eaSLisandro Dalcin /*@
6797d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6798d864a3eaSLisandro Dalcin 
6799d864a3eaSLisandro Dalcin   Input Parameters:
6800d864a3eaSLisandro Dalcin + dm      - The DM object
6801d864a3eaSLisandro Dalcin - disc    - The new coordinate discretization
6802d864a3eaSLisandro Dalcin 
6803d864a3eaSLisandro Dalcin   Level: intermediate
6804d864a3eaSLisandro Dalcin 
6805d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6806d864a3eaSLisandro Dalcin @*/
6807d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6808d864a3eaSLisandro Dalcin {
6809d864a3eaSLisandro Dalcin   PetscObject    discOld;
6810d864a3eaSLisandro Dalcin   PetscClassId   classid;
6811d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6812d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6813d864a3eaSLisandro Dalcin   Mat            matInterp;
6814d864a3eaSLisandro Dalcin   PetscErrorCode ierr;
6815d864a3eaSLisandro Dalcin 
6816d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6817d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6818d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6819d864a3eaSLisandro Dalcin 
6820d864a3eaSLisandro Dalcin   ierr = DMGetCoordinateDM(dm, &cdmOld);CHKERRQ(ierr);
6821d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
6822d864a3eaSLisandro Dalcin   ierr = DMGetField(cdmOld, 0, NULL, &discOld);CHKERRQ(ierr);
6823d864a3eaSLisandro Dalcin   ierr = PetscObjectGetClassId(discOld, &classid);CHKERRQ(ierr);
682429ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
682529ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
682629ad44c5SMatthew G. Knepley       PetscFE        feLinear;
682729ad44c5SMatthew G. Knepley       DMPolytopeType ct;
682829ad44c5SMatthew G. Knepley       PetscInt       dim, dE, cStart;
682929ad44c5SMatthew G. Knepley       PetscBool      simplex;
683029ad44c5SMatthew G. Knepley 
683129ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
683229ad44c5SMatthew G. Knepley       ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
683329ad44c5SMatthew G. Knepley       ierr = DMGetCoordinateDim(dm, &dE);CHKERRQ(ierr);
683429ad44c5SMatthew G. Knepley       ierr = DMPlexGetHeightStratum(cdmOld, 0, &cStart, NULL);CHKERRQ(ierr);
683529ad44c5SMatthew G. Knepley       ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
683629ad44c5SMatthew G. Knepley       switch (ct) {
683729ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM:
683829ad44c5SMatthew G. Knepley         case DM_POLYTOPE_TRI_PRISM_TENSOR:
683929ad44c5SMatthew G. Knepley           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
684029ad44c5SMatthew G. Knepley         default: break;
684129ad44c5SMatthew G. Knepley       }
684229ad44c5SMatthew G. Knepley       simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
684329ad44c5SMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear);CHKERRQ(ierr);
684429ad44c5SMatthew G. Knepley       ierr = DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear);CHKERRQ(ierr);
684529ad44c5SMatthew G. Knepley       ierr = PetscFEDestroy(&feLinear);CHKERRQ(ierr);
684629ad44c5SMatthew G. Knepley       ierr = DMCreateDS(cdmOld);CHKERRQ(ierr);
684729ad44c5SMatthew G. Knepley     } else {
684829ad44c5SMatthew G. Knepley       const char *discname;
684929ad44c5SMatthew G. Knepley 
685029ad44c5SMatthew G. Knepley       ierr = PetscObjectGetType(discOld, &discname);CHKERRQ(ierr);
685198921bdaSJacob Faibussowitsch       SETERRQ(PetscObjectComm(discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
685229ad44c5SMatthew G. Knepley     }
685329ad44c5SMatthew G. Knepley   }
6854d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
6855d864a3eaSLisandro Dalcin   ierr = DMClone(cdmOld, &cdmNew);CHKERRQ(ierr);
6856d864a3eaSLisandro Dalcin   ierr = DMSetField(cdmNew, 0, NULL, (PetscObject) disc);CHKERRQ(ierr);
6857d864a3eaSLisandro Dalcin   ierr = DMCreateDS(cdmNew);CHKERRQ(ierr);
6858d864a3eaSLisandro Dalcin   /* Project the coordinate vector from old to new space  */
6859d864a3eaSLisandro Dalcin   ierr = DMGetCoordinates(dm, &coordsOld);CHKERRQ(ierr);
6860d864a3eaSLisandro Dalcin   ierr = DMCreateGlobalVector(cdmNew, &coordsNew);CHKERRQ(ierr);
6861d864a3eaSLisandro Dalcin   ierr = DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL);CHKERRQ(ierr);
6862d864a3eaSLisandro Dalcin   ierr = MatInterpolate(matInterp, coordsOld, coordsNew);CHKERRQ(ierr);
6863d864a3eaSLisandro Dalcin   ierr = MatDestroy(&matInterp);CHKERRQ(ierr);
6864d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
6865d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateField(dm, NULL);CHKERRQ(ierr);
6866d864a3eaSLisandro Dalcin   ierr = DMSetCoordinateDM(dm, cdmNew);CHKERRQ(ierr);
6867d864a3eaSLisandro Dalcin   ierr = DMSetCoordinates(dm, coordsNew);CHKERRQ(ierr);
6868d864a3eaSLisandro Dalcin   ierr = VecDestroy(&coordsNew);CHKERRQ(ierr);
6869d864a3eaSLisandro Dalcin   ierr = DMDestroy(&cdmNew);CHKERRQ(ierr);
6870d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6871d864a3eaSLisandro Dalcin }
6872d864a3eaSLisandro Dalcin 
68735dc8c3f7SMatthew G. Knepley /*@C
687490b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
68755dc8c3f7SMatthew G. Knepley 
6876f899ff85SJose E. Roman   Input Parameter:
687790b157c4SStefano Zampini . dm      - The DM object
687890b157c4SStefano Zampini 
687990b157c4SStefano Zampini   Output Parameters:
688090b157c4SStefano Zampini + per     - Whether the DM is periodic or not
68815dc8c3f7SMatthew 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
68825dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
68835dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
68845dc8c3f7SMatthew G. Knepley 
68855dc8c3f7SMatthew G. Knepley   Level: developer
68865dc8c3f7SMatthew G. Knepley 
68875dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
68885dc8c3f7SMatthew G. Knepley @*/
688990b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6890c6b900c6SMatthew G. Knepley {
6891c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6892c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
689390b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6894c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6895c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
68965dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6897c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6898c6b900c6SMatthew G. Knepley }
6899c6b900c6SMatthew G. Knepley 
69005dc8c3f7SMatthew G. Knepley /*@C
69015dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
69025dc8c3f7SMatthew G. Knepley 
69035dc8c3f7SMatthew G. Knepley   Input Parameters:
69045dc8c3f7SMatthew G. Knepley + dm      - The DM object
6905db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6906db2bf62eSStefano 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.
69075dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
69085dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
69095dc8c3f7SMatthew G. Knepley 
6910db2bf62eSStefano 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.
6911db2bf62eSStefano Zampini 
69125dc8c3f7SMatthew G. Knepley   Level: developer
69135dc8c3f7SMatthew G. Knepley 
69145dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
69155dc8c3f7SMatthew G. Knepley @*/
691690b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6917c6b900c6SMatthew G. Knepley {
6918c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6919c6b900c6SMatthew G. Knepley   PetscErrorCode ierr;
6920c6b900c6SMatthew G. Knepley 
6921c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6922c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
692390b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6924412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6925412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6926412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
69275dc8c3f7SMatthew G. Knepley   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
692890b157c4SStefano Zampini   if (maxCell) {
6929412e9a14SMatthew G. Knepley     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6930412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6931db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
6932db2bf62eSStefano Zampini     ierr = PetscFree(dm->maxCell);CHKERRQ(ierr);
6933412e9a14SMatthew G. Knepley   }
6934db2bf62eSStefano Zampini 
6935412e9a14SMatthew G. Knepley   if (L) {
6936412e9a14SMatthew G. Knepley     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6937412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6938412e9a14SMatthew G. Knepley   }
6939412e9a14SMatthew G. Knepley   if (bd) {
6940412e9a14SMatthew G. Knepley     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6941412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
694290b157c4SStefano Zampini   }
6943072d7d67SStefano Zampini   dm->periodic = per;
6944c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6945c6b900c6SMatthew G. Knepley }
6946c6b900c6SMatthew G. Knepley 
69472e17dfb7SMatthew G. Knepley /*@
69482e17dfb7SMatthew 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.
69492e17dfb7SMatthew G. Knepley 
69502e17dfb7SMatthew G. Knepley   Input Parameters:
69512e17dfb7SMatthew G. Knepley + dm     - The DM
695265da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
695365da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
69542e17dfb7SMatthew G. Knepley 
69552e17dfb7SMatthew G. Knepley   Output Parameter:
69562e17dfb7SMatthew G. Knepley . out - The localized coordinate point
69572e17dfb7SMatthew G. Knepley 
69582e17dfb7SMatthew G. Knepley   Level: developer
69592e17dfb7SMatthew G. Knepley 
69602e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
69612e17dfb7SMatthew G. Knepley @*/
696265da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
69632e17dfb7SMatthew G. Knepley {
69642e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
69652e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
69662e17dfb7SMatthew G. Knepley 
69672e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69682e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
69692e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
69702e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
69712e17dfb7SMatthew G. Knepley   } else {
697265da65dcSMatthew G. Knepley     if (endpoint) {
697365da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6974da3333bfSMatthew 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)) {
6975da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
697665da65dcSMatthew G. Knepley         } else {
6977da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
697865da65dcSMatthew G. Knepley         }
697965da65dcSMatthew G. Knepley       }
698065da65dcSMatthew G. Knepley     } else {
69812e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
69821118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
69832e17dfb7SMatthew G. Knepley       }
69842e17dfb7SMatthew G. Knepley     }
698565da65dcSMatthew G. Knepley   }
69862e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69872e17dfb7SMatthew G. Knepley }
69882e17dfb7SMatthew G. Knepley 
69892e17dfb7SMatthew G. Knepley /*
69902e17dfb7SMatthew 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.
69912e17dfb7SMatthew G. Knepley 
69922e17dfb7SMatthew G. Knepley   Input Parameters:
69932e17dfb7SMatthew G. Knepley + dm     - The DM
69942e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
69952e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
69962e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
69972e17dfb7SMatthew G. Knepley 
69982e17dfb7SMatthew G. Knepley   Output Parameter:
69992e17dfb7SMatthew G. Knepley . out - The localized coordinate point
70002e17dfb7SMatthew G. Knepley 
70012e17dfb7SMatthew G. Knepley   Level: developer
70022e17dfb7SMatthew G. Knepley 
70032e17dfb7SMatthew 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
70042e17dfb7SMatthew G. Knepley 
70052e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
70062e17dfb7SMatthew G. Knepley */
70072e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
70082e17dfb7SMatthew G. Knepley {
70092e17dfb7SMatthew G. Knepley   PetscInt d;
70102e17dfb7SMatthew G. Knepley 
70112e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70122e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
70132e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
70142e17dfb7SMatthew G. Knepley   } else {
70152e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
7016908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
70172e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
70182e17dfb7SMatthew G. Knepley       } else {
70192e17dfb7SMatthew G. Knepley         out[d] = in[d];
70202e17dfb7SMatthew G. Knepley       }
70212e17dfb7SMatthew G. Knepley     }
70222e17dfb7SMatthew G. Knepley   }
70232e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70242e17dfb7SMatthew G. Knepley }
7025a5801f52SStefano Zampini 
70262e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
70272e17dfb7SMatthew G. Knepley {
70282e17dfb7SMatthew G. Knepley   PetscInt d;
70292e17dfb7SMatthew G. Knepley 
70302e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70312e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
70322e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
70332e17dfb7SMatthew G. Knepley   } else {
70342e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
7035908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
70362e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
70372e17dfb7SMatthew G. Knepley       } else {
70382e17dfb7SMatthew G. Knepley         out[d] = in[d];
70392e17dfb7SMatthew G. Knepley       }
70402e17dfb7SMatthew G. Knepley     }
70412e17dfb7SMatthew G. Knepley   }
70422e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70432e17dfb7SMatthew G. Knepley }
70442e17dfb7SMatthew G. Knepley 
70452e17dfb7SMatthew G. Knepley /*
70462e17dfb7SMatthew 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.
70472e17dfb7SMatthew G. Knepley 
70482e17dfb7SMatthew G. Knepley   Input Parameters:
70492e17dfb7SMatthew G. Knepley + dm     - The DM
70502e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
70512e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
70522e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
70532e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
70542e17dfb7SMatthew G. Knepley 
70552e17dfb7SMatthew G. Knepley   Output Parameter:
70562e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
70572e17dfb7SMatthew G. Knepley 
70582e17dfb7SMatthew G. Knepley   Level: developer
70592e17dfb7SMatthew G. Knepley 
70602e17dfb7SMatthew 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
70612e17dfb7SMatthew G. Knepley 
70622e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
70632e17dfb7SMatthew G. Knepley */
70642e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
70652e17dfb7SMatthew G. Knepley {
70662e17dfb7SMatthew G. Knepley   PetscInt d;
70672e17dfb7SMatthew G. Knepley 
70682e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70692e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
70702e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
70712e17dfb7SMatthew G. Knepley   } else {
70722e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
7073412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
7074412e9a14SMatthew G. Knepley 
7075412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
7076412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
7077412e9a14SMatthew G. Knepley 
7078412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
707998921bdaSJacob Faibussowitsch           SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%D-Coordinate %g more than %g away from anchor %g", d, (double) PetscRealPart(in[d]), (double) maxC, (double) PetscRealPart(anchor[d]));
7080412e9a14SMatthew G. Knepley         out[d] += newCoord;
70812e17dfb7SMatthew G. Knepley       } else {
70822e17dfb7SMatthew G. Knepley         out[d] += in[d];
70832e17dfb7SMatthew G. Knepley       }
70842e17dfb7SMatthew G. Knepley     }
70852e17dfb7SMatthew G. Knepley   }
70862e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
70872e17dfb7SMatthew G. Knepley }
70882e17dfb7SMatthew G. Knepley 
708936447a5eSToby Isaac /*@
70908f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
70918f700142SStefano Zampini 
70928f700142SStefano Zampini   Not collective
709336447a5eSToby Isaac 
709436447a5eSToby Isaac   Input Parameter:
709536447a5eSToby Isaac . dm - The DM
709636447a5eSToby Isaac 
709736447a5eSToby Isaac   Output Parameter:
709836447a5eSToby Isaac   areLocalized - True if localized
709936447a5eSToby Isaac 
710036447a5eSToby Isaac   Level: developer
710136447a5eSToby Isaac 
71028f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
710336447a5eSToby Isaac @*/
71048f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
710536447a5eSToby Isaac {
710636447a5eSToby Isaac   DM             cdm;
710736447a5eSToby Isaac   PetscSection   coordSection;
71082ccac677SMatthew G. Knepley   PetscInt       depth, cStart, cEnd, sStart, sEnd, c, dof;
710946a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
711036447a5eSToby Isaac   PetscErrorCode ierr;
711136447a5eSToby Isaac 
711236447a5eSToby Isaac   PetscFunctionBegin;
711336447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7114534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
71158b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
711646a3a80fSLisandro Dalcin 
711736447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
711836447a5eSToby Isaac   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
711946a3a80fSLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
71209f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
71212ccac677SMatthew G. Knepley   ierr = DMPlexGetDepth(cdm, &depth);CHKERRQ(ierr);
71222ccac677SMatthew G. Knepley   if (!depth) PetscFunctionReturn(0);
712346a3a80fSLisandro Dalcin 
71249f7230bfSMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
712546a3a80fSLisandro Dalcin   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
712636447a5eSToby Isaac   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
712736447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
712846a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
712946a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
713036447a5eSToby Isaac     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
713146a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
713236447a5eSToby Isaac   }
71338f700142SStefano Zampini   *areLocalized = alreadyLocalized;
713436447a5eSToby Isaac   PetscFunctionReturn(0);
713536447a5eSToby Isaac }
713636447a5eSToby Isaac 
71378f700142SStefano Zampini /*@
71388f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
71398f700142SStefano Zampini 
71408f700142SStefano Zampini   Collective on dm
71418f700142SStefano Zampini 
71428f700142SStefano Zampini   Input Parameter:
71438f700142SStefano Zampini . dm - The DM
71448f700142SStefano Zampini 
71458f700142SStefano Zampini   Output Parameter:
71468f700142SStefano Zampini   areLocalized - True if localized
71478f700142SStefano Zampini 
71488f700142SStefano Zampini   Level: developer
71498f700142SStefano Zampini 
71508f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
71518f700142SStefano Zampini @*/
71528f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
71538f700142SStefano Zampini {
71548f700142SStefano Zampini   PetscBool      localized;
71558f700142SStefano Zampini   PetscErrorCode ierr;
71568f700142SStefano Zampini 
71578f700142SStefano Zampini   PetscFunctionBegin;
71588f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7159534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
71608f700142SStefano Zampini   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
7161820f2d46SBarry Smith   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
71628f700142SStefano Zampini   PetscFunctionReturn(0);
71638f700142SStefano Zampini }
716436447a5eSToby Isaac 
71652e17dfb7SMatthew G. Knepley /*@
7166492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
71672e17dfb7SMatthew G. Knepley 
71688f700142SStefano Zampini   Collective on dm
71698f700142SStefano Zampini 
71702e17dfb7SMatthew G. Knepley   Input Parameter:
71712e17dfb7SMatthew G. Knepley . dm - The DM
71722e17dfb7SMatthew G. Knepley 
71732e17dfb7SMatthew G. Knepley   Level: developer
71742e17dfb7SMatthew G. Knepley 
71758f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
71762e17dfb7SMatthew G. Knepley @*/
71772e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
71782e17dfb7SMatthew G. Knepley {
71792e17dfb7SMatthew G. Knepley   DM             cdm;
71802e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
71812e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
71823e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
71833e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
7184e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
71853e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
71863e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
71872e17dfb7SMatthew G. Knepley   PetscErrorCode ierr;
71882e17dfb7SMatthew G. Knepley 
71892e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
71902e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
719192c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
7192f7cbd40bSStefano Zampini   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
7193f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
7194f7cbd40bSStefano Zampini 
71952e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
71962e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
71972e17dfb7SMatthew G. Knepley   {
71982e17dfb7SMatthew G. Knepley     PetscBool isplex;
71992e17dfb7SMatthew G. Knepley 
72002e17dfb7SMatthew G. Knepley     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
72012e17dfb7SMatthew G. Knepley     if (isplex) {
72022e17dfb7SMatthew G. Knepley       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
72033e922f36SToby Isaac       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
720469291d52SBarry Smith       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
72053e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
72063e922f36SToby Isaac       newStart = vStart;
72073e922f36SToby Isaac       newEnd   = vEnd;
72083e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
72093e922f36SToby Isaac         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
72103e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
72113e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
72123e922f36SToby Isaac       }
72132e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
72142e17dfb7SMatthew G. Knepley   }
72152e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
72162c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!coordinates,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
72172e17dfb7SMatthew G. Knepley   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
72183e922f36SToby Isaac   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
7219e0ae35bbSToby Isaac   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
72203e922f36SToby Isaac 
72212e17dfb7SMatthew G. Knepley   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
72222e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
72232e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
72242e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
72253e922f36SToby Isaac   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
72263e922f36SToby Isaac 
722769291d52SBarry Smith   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
72283e922f36SToby Isaac   localized = &anchor[bs];
72293e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
72303e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
72313e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
72323e922f36SToby Isaac 
72333e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
72343e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
72353e922f36SToby Isaac       PetscInt     b;
72363e922f36SToby Isaac 
72373e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
72383e922f36SToby Isaac       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
72393e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
72403e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
72413e922f36SToby Isaac         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
72423e922f36SToby Isaac         for (b = 0; b < bs; b++) {
72433e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
72443e922f36SToby Isaac         }
72453e922f36SToby Isaac         if (b < bs) break;
72463e922f36SToby Isaac       }
72473e922f36SToby Isaac       if (d < dof/bs) {
72483e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
72493e922f36SToby Isaac           PetscInt cdof;
72503e922f36SToby Isaac 
72513e922f36SToby Isaac           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
72523e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
72533e922f36SToby Isaac         }
72543e922f36SToby Isaac         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
72553e922f36SToby Isaac         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
72563e922f36SToby Isaac       }
72573e922f36SToby Isaac       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
72583e922f36SToby Isaac     }
72593e922f36SToby Isaac   }
7260ffc4695bSBarry Smith   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRMPI(ierr);
72613e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
726269291d52SBarry Smith     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
72633e922f36SToby Isaac     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
726469291d52SBarry Smith     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
72653e922f36SToby Isaac     PetscFunctionReturn(0);
72663e922f36SToby Isaac   }
72672e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
72682e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
72692e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
72702e17dfb7SMatthew G. Knepley     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
72712e17dfb7SMatthew G. Knepley   }
72722e17dfb7SMatthew G. Knepley   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
72732e17dfb7SMatthew G. Knepley   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
7274c2be7e5eSLisandro Dalcin   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
72752e17dfb7SMatthew G. Knepley   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
72762e17dfb7SMatthew G. Knepley   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
72772e17dfb7SMatthew G. Knepley   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
72782e17dfb7SMatthew G. Knepley   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
7279c2be7e5eSLisandro Dalcin   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
72802e17dfb7SMatthew G. Knepley   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
72812e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
72822e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
72832e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
72842e17dfb7SMatthew G. Knepley     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
72852e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
72862e17dfb7SMatthew G. Knepley   }
72873e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
72883e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
72893e922f36SToby Isaac 
72902e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
72912e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
72923e922f36SToby Isaac       PetscInt     b, cdof;
72932e17dfb7SMatthew G. Knepley 
72943e922f36SToby Isaac       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
72953e922f36SToby Isaac       if (!cdof) continue;
72962e17dfb7SMatthew G. Knepley       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
72972e17dfb7SMatthew G. Knepley       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
72982e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
72992e17dfb7SMatthew G. Knepley       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
73002e17dfb7SMatthew G. Knepley       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
73012e17dfb7SMatthew G. Knepley     }
73023e922f36SToby Isaac   }
730369291d52SBarry Smith   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
730469291d52SBarry Smith   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
7305c2be7e5eSLisandro Dalcin   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
73062e17dfb7SMatthew G. Knepley   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
73072e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
73082e17dfb7SMatthew G. Knepley   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
73092e17dfb7SMatthew G. Knepley   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
73102e17dfb7SMatthew G. Knepley   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
73112e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
73122e17dfb7SMatthew G. Knepley }
73132e17dfb7SMatthew G. Knepley 
7314e87bb0d3SMatthew G Knepley /*@
73153a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
7316e87bb0d3SMatthew G Knepley 
7317d083f849SBarry Smith   Collective on v (see explanation below)
7318e87bb0d3SMatthew G Knepley 
7319e87bb0d3SMatthew G Knepley   Input Parameters:
7320e87bb0d3SMatthew G Knepley + dm - The DM
73216b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
7322e87bb0d3SMatthew G Knepley 
73236b867d5aSJose E. Roman   Input/Output Parameters:
73246b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
73256b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point;
73266b867d5aSJose E. Roman            on output, the PetscSF containing the ranks and local indices of the containing points
73273a93e3b7SToby Isaac 
7328e87bb0d3SMatthew G Knepley   Level: developer
732961e3bb9bSMatthew G Knepley 
733062a38674SMatthew G. Knepley   Notes:
73313a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
733262a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
73333a93e3b7SToby Isaac 
73343a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
733562a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
73363a93e3b7SToby Isaac 
73373a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
73383a93e3b7SToby Isaac 
733962a38674SMatthew G. Knepley $    const PetscSFNode *cells;
734062a38674SMatthew G. Knepley $    PetscInt           nFound;
7341a6216909SToby Isaac $    const PetscInt    *found;
734262a38674SMatthew G. Knepley $
7343a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
73443a93e3b7SToby Isaac 
73453a93e3b7SToby 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
73463a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
73473a93e3b7SToby Isaac 
734862a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
734961e3bb9bSMatthew G Knepley @*/
735062a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
7351e87bb0d3SMatthew G Knepley {
7352735aa83eSMatthew G Knepley   PetscErrorCode ierr;
7353735aa83eSMatthew G Knepley 
7354e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
7355e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7356e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
7357e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
73583a93e3b7SToby Isaac   if (*cellSF) {
73593a93e3b7SToby Isaac     PetscMPIInt result;
73603a93e3b7SToby Isaac 
7361e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
7362ffc4695bSBarry Smith     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRMPI(ierr);
73632c71b3e2SJacob Faibussowitsch     PetscCheckFalse(result != MPI_IDENT && result != MPI_CONGRUENT,PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's");
7364e0fc9d1bSMatthew G. Knepley   } else {
73653a93e3b7SToby Isaac     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
73663a93e3b7SToby Isaac   }
73672c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->locatepoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
736847a35634SPatrick Farrell   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
736962a38674SMatthew G. Knepley   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
737047a35634SPatrick Farrell   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
7371e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
7372e87bb0d3SMatthew G Knepley }
737314f150ffSMatthew G. Knepley 
7374f4d763aaSMatthew G. Knepley /*@
7375f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
7376f4d763aaSMatthew G. Knepley 
73778f700142SStefano Zampini   Collective on dm
73788f700142SStefano Zampini 
7379f4d763aaSMatthew G. Knepley   Input Parameter:
7380f4d763aaSMatthew G. Knepley . dm - The original DM
7381f4d763aaSMatthew G. Knepley 
7382f4d763aaSMatthew G. Knepley   Output Parameter:
7383f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
7384f4d763aaSMatthew G. Knepley 
7385f4d763aaSMatthew G. Knepley   Level: intermediate
7386f4d763aaSMatthew G. Knepley 
7387e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
7388f4d763aaSMatthew G. Knepley @*/
738914f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
739014f150ffSMatthew G. Knepley {
7391c26acbdeSMatthew G. Knepley   PetscSection   section;
73922d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
739314f150ffSMatthew G. Knepley   PetscErrorCode ierr;
739414f150ffSMatthew G. Knepley 
739514f150ffSMatthew G. Knepley   PetscFunctionBegin;
739614f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
739714f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
739892fd8e1eSJed Brown   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
7399c26acbdeSMatthew G. Knepley   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
7400ffc4695bSBarry Smith   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRMPI(ierr);
74012d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7402c26acbdeSMatthew G. Knepley     *odm = dm;
7403c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7404c26acbdeSMatthew G. Knepley   }
740514f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7406c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
740714f150ffSMatthew G. Knepley     PetscSF      sf;
740814f150ffSMatthew G. Knepley 
740914f150ffSMatthew G. Knepley     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
7410e5e52638SMatthew G. Knepley     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
741114f150ffSMatthew G. Knepley     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
741292fd8e1eSJed Brown     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
741314f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
741414f150ffSMatthew G. Knepley     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
741515b58121SMatthew G. Knepley     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
7416e87a4003SBarry Smith     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
741714f150ffSMatthew G. Knepley     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
741814f150ffSMatthew G. Knepley   }
741914f150ffSMatthew G. Knepley   *odm = dm->dmBC;
742014f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
742114f150ffSMatthew G. Knepley }
7422f4d763aaSMatthew G. Knepley 
7423f4d763aaSMatthew G. Knepley /*@
7424cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7425f4d763aaSMatthew G. Knepley 
7426f4d763aaSMatthew G. Knepley   Input Parameter:
7427f4d763aaSMatthew G. Knepley . dm - The original DM
7428f4d763aaSMatthew G. Knepley 
7429cdb7a50dSMatthew G. Knepley   Output Parameters:
7430cdb7a50dSMatthew G. Knepley + num - The output sequence number
7431cdb7a50dSMatthew G. Knepley - val - The output sequence value
7432f4d763aaSMatthew G. Knepley 
7433f4d763aaSMatthew G. Knepley   Level: intermediate
7434f4d763aaSMatthew G. Knepley 
7435f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7436f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7437f4d763aaSMatthew G. Knepley 
7438f4d763aaSMatthew G. Knepley .seealso: VecView()
7439f4d763aaSMatthew G. Knepley @*/
7440cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7441f4d763aaSMatthew G. Knepley {
7442f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7443f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7444534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7445534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7446f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7447f4d763aaSMatthew G. Knepley }
7448f4d763aaSMatthew G. Knepley 
7449f4d763aaSMatthew G. Knepley /*@
7450cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7451f4d763aaSMatthew G. Knepley 
7452f4d763aaSMatthew G. Knepley   Input Parameters:
7453f4d763aaSMatthew G. Knepley + dm - The original DM
7454cdb7a50dSMatthew G. Knepley . num - The output sequence number
7455cdb7a50dSMatthew G. Knepley - val - The output sequence value
7456f4d763aaSMatthew G. Knepley 
7457f4d763aaSMatthew G. Knepley   Level: intermediate
7458f4d763aaSMatthew G. Knepley 
7459f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7460f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7461f4d763aaSMatthew G. Knepley 
7462f4d763aaSMatthew G. Knepley .seealso: VecView()
7463f4d763aaSMatthew G. Knepley @*/
7464cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7465f4d763aaSMatthew G. Knepley {
7466f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7467f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7468f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7469cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7470cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7471cdb7a50dSMatthew G. Knepley }
7472cdb7a50dSMatthew G. Knepley 
7473cdb7a50dSMatthew G. Knepley /*@C
7474cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7475cdb7a50dSMatthew G. Knepley 
7476cdb7a50dSMatthew G. Knepley   Input Parameters:
7477cdb7a50dSMatthew G. Knepley + dm   - The original DM
7478cdb7a50dSMatthew G. Knepley . name - The sequence name
7479cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7480cdb7a50dSMatthew G. Knepley 
7481cdb7a50dSMatthew G. Knepley   Output Parameter:
7482cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7483cdb7a50dSMatthew G. Knepley 
7484cdb7a50dSMatthew G. Knepley   Level: intermediate
7485cdb7a50dSMatthew G. Knepley 
7486cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7487cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7488cdb7a50dSMatthew G. Knepley 
7489cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7490cdb7a50dSMatthew G. Knepley @*/
7491cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7492cdb7a50dSMatthew G. Knepley {
7493cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7494cdb7a50dSMatthew G. Knepley   PetscErrorCode ierr;
7495cdb7a50dSMatthew G. Knepley 
7496cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7497cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7498cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7499064a246eSJacob Faibussowitsch   PetscValidRealPointer(val,5);
7500cdb7a50dSMatthew G. Knepley   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
7501cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7502cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7503cdb7a50dSMatthew G. Knepley     PetscScalar value;
7504cdb7a50dSMatthew G. Knepley 
750539d25373SMatthew G. Knepley     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
75064aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7507cdb7a50dSMatthew G. Knepley #endif
7508cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7509f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7510f4d763aaSMatthew G. Knepley }
75118e4ac7eaSMatthew G. Knepley 
75128e4ac7eaSMatthew G. Knepley /*@
75138e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
75148e4ac7eaSMatthew G. Knepley 
75158e4ac7eaSMatthew G. Knepley   Not collective
75168e4ac7eaSMatthew G. Knepley 
75178e4ac7eaSMatthew G. Knepley   Input Parameter:
75188e4ac7eaSMatthew G. Knepley . dm - The DM
75198e4ac7eaSMatthew G. Knepley 
75208e4ac7eaSMatthew G. Knepley   Output Parameter:
75218e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
75228e4ac7eaSMatthew G. Knepley 
75238e4ac7eaSMatthew G. Knepley   Level: beginner
75248e4ac7eaSMatthew G. Knepley 
75258e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
75268e4ac7eaSMatthew G. Knepley @*/
75278e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
75288e4ac7eaSMatthew G. Knepley {
75298e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
75308e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7531534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
75328e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
75338e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
75348e4ac7eaSMatthew G. Knepley }
75358e4ac7eaSMatthew G. Knepley 
75368e4ac7eaSMatthew G. Knepley /*@
75375d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
75388e4ac7eaSMatthew G. Knepley 
75398e4ac7eaSMatthew G. Knepley   Collective on dm
75408e4ac7eaSMatthew G. Knepley 
75418e4ac7eaSMatthew G. Knepley   Input Parameters:
75428e4ac7eaSMatthew G. Knepley + dm - The DM
75438e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
75448e4ac7eaSMatthew G. Knepley 
75455d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
75465d3b26e6SMatthew G. Knepley 
75478e4ac7eaSMatthew G. Knepley   Level: beginner
75488e4ac7eaSMatthew G. Knepley 
75495d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
75508e4ac7eaSMatthew G. Knepley @*/
75518e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
75528e4ac7eaSMatthew G. Knepley {
75538e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
75548e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
75558833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
75568e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
75578e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
75588e4ac7eaSMatthew G. Knepley }
7559c58f1c22SToby Isaac 
7560c58f1c22SToby Isaac /*@C
7561c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7562c58f1c22SToby Isaac 
7563c58f1c22SToby Isaac   Not Collective
7564c58f1c22SToby Isaac 
7565c58f1c22SToby Isaac   Input Parameters:
7566c58f1c22SToby Isaac + dm   - The DM object
7567c58f1c22SToby Isaac - name - The label name
7568c58f1c22SToby Isaac 
7569c58f1c22SToby Isaac   Level: intermediate
7570c58f1c22SToby Isaac 
7571c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7572c58f1c22SToby Isaac @*/
7573c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7574c58f1c22SToby Isaac {
75755d80c0bfSVaclav Hapla   PetscBool      flg;
75765d80c0bfSVaclav Hapla   DMLabel        label;
7577c58f1c22SToby Isaac   PetscErrorCode ierr;
7578c58f1c22SToby Isaac 
7579c58f1c22SToby Isaac   PetscFunctionBegin;
7580c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7581c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
75825d80c0bfSVaclav Hapla   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
7583c58f1c22SToby Isaac   if (!flg) {
75845d80c0bfSVaclav Hapla     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
75855d80c0bfSVaclav Hapla     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
75865d80c0bfSVaclav Hapla     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
7587c58f1c22SToby Isaac   }
7588c58f1c22SToby Isaac   PetscFunctionReturn(0);
7589c58f1c22SToby Isaac }
7590c58f1c22SToby Isaac 
7591c58f1c22SToby Isaac /*@C
75920fdc7489SMatthew Knepley   DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index.
75930fdc7489SMatthew Knepley 
75940fdc7489SMatthew Knepley   Not Collective
75950fdc7489SMatthew Knepley 
75960fdc7489SMatthew Knepley   Input Parameters:
75970fdc7489SMatthew Knepley + dm   - The DM object
75980fdc7489SMatthew Knepley . l    - The index for the label
75990fdc7489SMatthew Knepley - name - The label name
76000fdc7489SMatthew Knepley 
76010fdc7489SMatthew Knepley   Level: intermediate
76020fdc7489SMatthew Knepley 
76030fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
76040fdc7489SMatthew Knepley @*/
76050fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[])
76060fdc7489SMatthew Knepley {
76070fdc7489SMatthew Knepley   DMLabelLink    orig, prev = NULL;
76080fdc7489SMatthew Knepley   DMLabel        label;
76090fdc7489SMatthew Knepley   PetscInt       Nl, m;
76100fdc7489SMatthew Knepley   PetscBool      flg, match;
76110fdc7489SMatthew Knepley   const char    *lname;
76120fdc7489SMatthew Knepley   PetscErrorCode ierr;
76130fdc7489SMatthew Knepley 
76140fdc7489SMatthew Knepley   PetscFunctionBegin;
76150fdc7489SMatthew Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7616064a246eSJacob Faibussowitsch   PetscValidCharPointer(name, 3);
76170fdc7489SMatthew Knepley   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
76180fdc7489SMatthew Knepley   if (!flg) {
76190fdc7489SMatthew Knepley     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
76200fdc7489SMatthew Knepley     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
76210fdc7489SMatthew Knepley     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
76220fdc7489SMatthew Knepley   }
76230fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
76242c71b3e2SJacob Faibussowitsch   PetscCheckFalse(l >= Nl,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl);
76250fdc7489SMatthew Knepley   for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) {
76260fdc7489SMatthew Knepley     ierr = PetscObjectGetName((PetscObject) orig->label, &lname);CHKERRQ(ierr);
76270fdc7489SMatthew Knepley     ierr = PetscStrcmp(name, lname, &match);CHKERRQ(ierr);
76280fdc7489SMatthew Knepley     if (match) break;
76290fdc7489SMatthew Knepley   }
76300fdc7489SMatthew Knepley   if (m == l) PetscFunctionReturn(0);
76310fdc7489SMatthew Knepley   if (!m) dm->labels = orig->next;
76320fdc7489SMatthew Knepley   else    prev->next = orig->next;
76330fdc7489SMatthew Knepley   if (!l) {
76340fdc7489SMatthew Knepley     orig->next = dm->labels;
76350fdc7489SMatthew Knepley     dm->labels = orig;
76360fdc7489SMatthew Knepley   } else {
76370fdc7489SMatthew Knepley     for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next);
76380fdc7489SMatthew Knepley     orig->next = prev->next;
76390fdc7489SMatthew Knepley     prev->next = orig;
76400fdc7489SMatthew Knepley   }
76410fdc7489SMatthew Knepley   PetscFunctionReturn(0);
76420fdc7489SMatthew Knepley }
76430fdc7489SMatthew Knepley 
76440fdc7489SMatthew Knepley /*@C
7645c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7646c58f1c22SToby Isaac 
7647c58f1c22SToby Isaac   Not Collective
7648c58f1c22SToby Isaac 
7649c58f1c22SToby Isaac   Input Parameters:
7650c58f1c22SToby Isaac + dm   - The DM object
7651c58f1c22SToby Isaac . name - The label name
7652c58f1c22SToby Isaac - point - The mesh point
7653c58f1c22SToby Isaac 
7654c58f1c22SToby Isaac   Output Parameter:
7655c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7656c58f1c22SToby Isaac 
7657c58f1c22SToby Isaac   Level: beginner
7658c58f1c22SToby Isaac 
7659c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7660c58f1c22SToby Isaac @*/
7661c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7662c58f1c22SToby Isaac {
7663c58f1c22SToby Isaac   DMLabel        label;
7664c58f1c22SToby Isaac   PetscErrorCode ierr;
7665c58f1c22SToby Isaac 
7666c58f1c22SToby Isaac   PetscFunctionBegin;
7667c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7668c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7669c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
76702c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
7671c58f1c22SToby Isaac   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
7672c58f1c22SToby Isaac   PetscFunctionReturn(0);
7673c58f1c22SToby Isaac }
7674c58f1c22SToby Isaac 
7675c58f1c22SToby Isaac /*@C
7676c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7677c58f1c22SToby Isaac 
7678c58f1c22SToby Isaac   Not Collective
7679c58f1c22SToby Isaac 
7680c58f1c22SToby Isaac   Input Parameters:
7681c58f1c22SToby Isaac + dm   - The DM object
7682c58f1c22SToby Isaac . name - The label name
7683c58f1c22SToby Isaac . point - The mesh point
7684c58f1c22SToby Isaac - value - The label value for this point
7685c58f1c22SToby Isaac 
7686c58f1c22SToby Isaac   Output Parameter:
7687c58f1c22SToby Isaac 
7688c58f1c22SToby Isaac   Level: beginner
7689c58f1c22SToby Isaac 
7690c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7691c58f1c22SToby Isaac @*/
7692c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7693c58f1c22SToby Isaac {
7694c58f1c22SToby Isaac   DMLabel        label;
7695c58f1c22SToby Isaac   PetscErrorCode ierr;
7696c58f1c22SToby Isaac 
7697c58f1c22SToby Isaac   PetscFunctionBegin;
7698c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7699c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7700c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7701c58f1c22SToby Isaac   if (!label) {
7702c58f1c22SToby Isaac     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
7703c58f1c22SToby Isaac     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7704c58f1c22SToby Isaac   }
7705c58f1c22SToby Isaac   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
7706c58f1c22SToby Isaac   PetscFunctionReturn(0);
7707c58f1c22SToby Isaac }
7708c58f1c22SToby Isaac 
7709c58f1c22SToby Isaac /*@C
7710c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7711c58f1c22SToby Isaac 
7712c58f1c22SToby Isaac   Not Collective
7713c58f1c22SToby Isaac 
7714c58f1c22SToby Isaac   Input Parameters:
7715c58f1c22SToby Isaac + dm   - The DM object
7716c58f1c22SToby Isaac . name - The label name
7717c58f1c22SToby Isaac . point - The mesh point
7718c58f1c22SToby Isaac - value - The label value for this point
7719c58f1c22SToby Isaac 
7720c58f1c22SToby Isaac   Output Parameter:
7721c58f1c22SToby Isaac 
7722c58f1c22SToby Isaac   Level: beginner
7723c58f1c22SToby Isaac 
7724c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7725c58f1c22SToby Isaac @*/
7726c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7727c58f1c22SToby Isaac {
7728c58f1c22SToby Isaac   DMLabel        label;
7729c58f1c22SToby Isaac   PetscErrorCode ierr;
7730c58f1c22SToby Isaac 
7731c58f1c22SToby Isaac   PetscFunctionBegin;
7732c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7733c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7734c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7735c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7736c58f1c22SToby Isaac   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
7737c58f1c22SToby Isaac   PetscFunctionReturn(0);
7738c58f1c22SToby Isaac }
7739c58f1c22SToby Isaac 
7740c58f1c22SToby Isaac /*@C
7741c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7742c58f1c22SToby Isaac 
7743c58f1c22SToby Isaac   Not Collective
7744c58f1c22SToby Isaac 
7745c58f1c22SToby Isaac   Input Parameters:
7746c58f1c22SToby Isaac + dm   - The DM object
7747c58f1c22SToby Isaac - name - The label name
7748c58f1c22SToby Isaac 
7749c58f1c22SToby Isaac   Output Parameter:
7750c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7751c58f1c22SToby Isaac 
7752c58f1c22SToby Isaac   Level: beginner
7753c58f1c22SToby Isaac 
7754df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7755c58f1c22SToby Isaac @*/
7756c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7757c58f1c22SToby Isaac {
7758c58f1c22SToby Isaac   DMLabel        label;
7759c58f1c22SToby Isaac   PetscErrorCode ierr;
7760c58f1c22SToby Isaac 
7761c58f1c22SToby Isaac   PetscFunctionBegin;
7762c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7763c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7764534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
7765c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7766c58f1c22SToby Isaac   *size = 0;
7767c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7768c58f1c22SToby Isaac   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
7769c58f1c22SToby Isaac   PetscFunctionReturn(0);
7770c58f1c22SToby Isaac }
7771c58f1c22SToby Isaac 
7772c58f1c22SToby Isaac /*@C
7773c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7774c58f1c22SToby Isaac 
7775c58f1c22SToby Isaac   Not Collective
7776c58f1c22SToby Isaac 
7777c58f1c22SToby Isaac   Input Parameters:
7778c58f1c22SToby Isaac + mesh - The DM object
7779c58f1c22SToby Isaac - name - The label name
7780c58f1c22SToby Isaac 
7781c58f1c22SToby Isaac   Output Parameter:
7782c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7783c58f1c22SToby Isaac 
7784c58f1c22SToby Isaac   Level: beginner
7785c58f1c22SToby Isaac 
7786c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7787c58f1c22SToby Isaac @*/
7788c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7789c58f1c22SToby Isaac {
7790c58f1c22SToby Isaac   DMLabel        label;
7791c58f1c22SToby Isaac   PetscErrorCode ierr;
7792c58f1c22SToby Isaac 
7793c58f1c22SToby Isaac   PetscFunctionBegin;
7794c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7795c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7796c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
7797c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7798c58f1c22SToby Isaac   *ids = NULL;
7799dab2e251SBlaise Bourdin  if (label) {
7800c58f1c22SToby Isaac     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
7801dab2e251SBlaise Bourdin   } else {
7802dab2e251SBlaise Bourdin     /* returning an empty IS */
7803dab2e251SBlaise Bourdin     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
7804dab2e251SBlaise Bourdin   }
7805c58f1c22SToby Isaac   PetscFunctionReturn(0);
7806c58f1c22SToby Isaac }
7807c58f1c22SToby Isaac 
7808c58f1c22SToby Isaac /*@C
7809c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
7810c58f1c22SToby Isaac 
7811c58f1c22SToby Isaac   Not Collective
7812c58f1c22SToby Isaac 
7813c58f1c22SToby Isaac   Input Parameters:
7814c58f1c22SToby Isaac + dm - The DM object
7815c58f1c22SToby Isaac . name - The label name
7816c58f1c22SToby Isaac - value - The stratum value
7817c58f1c22SToby Isaac 
7818c58f1c22SToby Isaac   Output Parameter:
7819c58f1c22SToby Isaac . size - The stratum size
7820c58f1c22SToby Isaac 
7821c58f1c22SToby Isaac   Level: beginner
7822c58f1c22SToby Isaac 
7823c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7824c58f1c22SToby Isaac @*/
7825c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7826c58f1c22SToby Isaac {
7827c58f1c22SToby Isaac   DMLabel        label;
7828c58f1c22SToby Isaac   PetscErrorCode ierr;
7829c58f1c22SToby Isaac 
7830c58f1c22SToby Isaac   PetscFunctionBegin;
7831c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7832c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7833534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
7834c58f1c22SToby Isaac   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7835c58f1c22SToby Isaac   *size = 0;
7836c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7837c58f1c22SToby Isaac   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
7838c58f1c22SToby Isaac   PetscFunctionReturn(0);
7839c58f1c22SToby Isaac }
7840c58f1c22SToby Isaac 
7841c58f1c22SToby Isaac /*@C
7842c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7843c58f1c22SToby Isaac 
7844c58f1c22SToby Isaac   Not Collective
7845c58f1c22SToby Isaac 
7846c58f1c22SToby Isaac   Input Parameters:
7847c58f1c22SToby Isaac + dm - The DM object
7848c58f1c22SToby Isaac . name - The label name
7849c58f1c22SToby Isaac - value - The stratum value
7850c58f1c22SToby Isaac 
7851c58f1c22SToby Isaac   Output Parameter:
7852c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7853c58f1c22SToby Isaac 
7854c58f1c22SToby Isaac   Level: beginner
7855c58f1c22SToby Isaac 
7856c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7857c58f1c22SToby Isaac @*/
7858c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7859c58f1c22SToby Isaac {
7860c58f1c22SToby Isaac   DMLabel        label;
7861c58f1c22SToby Isaac   PetscErrorCode ierr;
7862c58f1c22SToby Isaac 
7863c58f1c22SToby Isaac   PetscFunctionBegin;
7864c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7865c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7866c58f1c22SToby Isaac   PetscValidPointer(points, 4);
7867c58f1c22SToby Isaac   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7868c58f1c22SToby Isaac   *points = NULL;
7869c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7870c58f1c22SToby Isaac   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7871c58f1c22SToby Isaac   PetscFunctionReturn(0);
7872c58f1c22SToby Isaac }
7873c58f1c22SToby Isaac 
78744de306b1SToby Isaac /*@C
78759044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
78764de306b1SToby Isaac 
78774de306b1SToby Isaac   Not Collective
78784de306b1SToby Isaac 
78794de306b1SToby Isaac   Input Parameters:
78804de306b1SToby Isaac + dm - The DM object
78814de306b1SToby Isaac . name - The label name
78824de306b1SToby Isaac . value - The stratum value
78834de306b1SToby Isaac - points - The stratum points
78844de306b1SToby Isaac 
78854de306b1SToby Isaac   Level: beginner
78864de306b1SToby Isaac 
78874de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
78884de306b1SToby Isaac @*/
78894de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
78904de306b1SToby Isaac {
78914de306b1SToby Isaac   DMLabel        label;
78924de306b1SToby Isaac   PetscErrorCode ierr;
78934de306b1SToby Isaac 
78944de306b1SToby Isaac   PetscFunctionBegin;
78954de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
78964de306b1SToby Isaac   PetscValidCharPointer(name, 2);
78974de306b1SToby Isaac   PetscValidPointer(points, 4);
78984de306b1SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
78994de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
79004de306b1SToby Isaac   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
79014de306b1SToby Isaac   PetscFunctionReturn(0);
79024de306b1SToby Isaac }
79034de306b1SToby Isaac 
7904c58f1c22SToby Isaac /*@C
7905c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7906c58f1c22SToby Isaac 
7907c58f1c22SToby Isaac   Not Collective
7908c58f1c22SToby Isaac 
7909c58f1c22SToby Isaac   Input Parameters:
7910c58f1c22SToby Isaac + dm   - The DM object
7911c58f1c22SToby Isaac . name - The label name
7912c58f1c22SToby Isaac - value - The label value for this point
7913c58f1c22SToby Isaac 
7914c58f1c22SToby Isaac   Output Parameter:
7915c58f1c22SToby Isaac 
7916c58f1c22SToby Isaac   Level: beginner
7917c58f1c22SToby Isaac 
7918c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7919c58f1c22SToby Isaac @*/
7920c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7921c58f1c22SToby Isaac {
7922c58f1c22SToby Isaac   DMLabel        label;
7923c58f1c22SToby Isaac   PetscErrorCode ierr;
7924c58f1c22SToby Isaac 
7925c58f1c22SToby Isaac   PetscFunctionBegin;
7926c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7927c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7928c58f1c22SToby Isaac   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7929c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
7930c58f1c22SToby Isaac   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7931c58f1c22SToby Isaac   PetscFunctionReturn(0);
7932c58f1c22SToby Isaac }
7933c58f1c22SToby Isaac 
7934c58f1c22SToby Isaac /*@
7935c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7936c58f1c22SToby Isaac 
7937c58f1c22SToby Isaac   Not Collective
7938c58f1c22SToby Isaac 
7939c58f1c22SToby Isaac   Input Parameter:
7940c58f1c22SToby Isaac . dm   - The DM object
7941c58f1c22SToby Isaac 
7942c58f1c22SToby Isaac   Output Parameter:
7943c58f1c22SToby Isaac . numLabels - the number of Labels
7944c58f1c22SToby Isaac 
7945c58f1c22SToby Isaac   Level: intermediate
7946c58f1c22SToby Isaac 
7947c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7948c58f1c22SToby Isaac @*/
7949c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7950c58f1c22SToby Isaac {
79515d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7952c58f1c22SToby Isaac   PetscInt  n    = 0;
7953c58f1c22SToby Isaac 
7954c58f1c22SToby Isaac   PetscFunctionBegin;
7955c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7956534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7957c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7958c58f1c22SToby Isaac   *numLabels = n;
7959c58f1c22SToby Isaac   PetscFunctionReturn(0);
7960c58f1c22SToby Isaac }
7961c58f1c22SToby Isaac 
7962c58f1c22SToby Isaac /*@C
7963c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7964c58f1c22SToby Isaac 
7965c58f1c22SToby Isaac   Not Collective
7966c58f1c22SToby Isaac 
7967c58f1c22SToby Isaac   Input Parameters:
7968c58f1c22SToby Isaac + dm - The DM object
7969c58f1c22SToby Isaac - n  - the label number
7970c58f1c22SToby Isaac 
7971c58f1c22SToby Isaac   Output Parameter:
7972c58f1c22SToby Isaac . name - the label name
7973c58f1c22SToby Isaac 
7974c58f1c22SToby Isaac   Level: intermediate
7975c58f1c22SToby Isaac 
7976c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7977c58f1c22SToby Isaac @*/
7978c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7979c58f1c22SToby Isaac {
79805d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7981c58f1c22SToby Isaac   PetscInt       l    = 0;
7982d67d17b1SMatthew G. Knepley   PetscErrorCode ierr;
7983c58f1c22SToby Isaac 
7984c58f1c22SToby Isaac   PetscFunctionBegin;
7985c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7986c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7987c58f1c22SToby Isaac   while (next) {
7988c58f1c22SToby Isaac     if (l == n) {
7989d67d17b1SMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7990c58f1c22SToby Isaac       PetscFunctionReturn(0);
7991c58f1c22SToby Isaac     }
7992c58f1c22SToby Isaac     ++l;
7993c58f1c22SToby Isaac     next = next->next;
7994c58f1c22SToby Isaac   }
799598921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7996c58f1c22SToby Isaac }
7997c58f1c22SToby Isaac 
7998c58f1c22SToby Isaac /*@C
7999c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
8000c58f1c22SToby Isaac 
8001c58f1c22SToby Isaac   Not Collective
8002c58f1c22SToby Isaac 
8003c58f1c22SToby Isaac   Input Parameters:
8004c58f1c22SToby Isaac + dm   - The DM object
8005c58f1c22SToby Isaac - name - The label name
8006c58f1c22SToby Isaac 
8007c58f1c22SToby Isaac   Output Parameter:
8008c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
8009c58f1c22SToby Isaac 
8010c58f1c22SToby Isaac   Level: intermediate
8011c58f1c22SToby Isaac 
8012c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8013c58f1c22SToby Isaac @*/
8014c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
8015c58f1c22SToby Isaac {
80165d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8017d67d17b1SMatthew G. Knepley   const char    *lname;
8018c58f1c22SToby Isaac   PetscErrorCode ierr;
8019c58f1c22SToby Isaac 
8020c58f1c22SToby Isaac   PetscFunctionBegin;
8021c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8022c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
8023534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
8024c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
8025c58f1c22SToby Isaac   while (next) {
8026d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8027d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
8028c58f1c22SToby Isaac     if (*hasLabel) break;
8029c58f1c22SToby Isaac     next = next->next;
8030c58f1c22SToby Isaac   }
8031c58f1c22SToby Isaac   PetscFunctionReturn(0);
8032c58f1c22SToby Isaac }
8033c58f1c22SToby Isaac 
8034c58f1c22SToby Isaac /*@C
8035c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
8036c58f1c22SToby Isaac 
8037c58f1c22SToby Isaac   Not Collective
8038c58f1c22SToby Isaac 
8039c58f1c22SToby Isaac   Input Parameters:
8040c58f1c22SToby Isaac + dm   - The DM object
8041c58f1c22SToby Isaac - name - The label name
8042c58f1c22SToby Isaac 
8043c58f1c22SToby Isaac   Output Parameter:
8044c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
8045c58f1c22SToby Isaac 
80466d7c9049SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
80476d7c9049SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
80486d7c9049SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
80496d7c9049SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
80506d7c9049SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
80516d7c9049SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
80526d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
80536d7c9049SMatthew G. Knepley 
8054c58f1c22SToby Isaac   Level: intermediate
8055c58f1c22SToby Isaac 
80566d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
8057c58f1c22SToby Isaac @*/
8058c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
8059c58f1c22SToby Isaac {
80605d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8061c58f1c22SToby Isaac   PetscBool      hasLabel;
8062d67d17b1SMatthew G. Knepley   const char    *lname;
8063c58f1c22SToby Isaac   PetscErrorCode ierr;
8064c58f1c22SToby Isaac 
8065c58f1c22SToby Isaac   PetscFunctionBegin;
8066c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8067c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
8068c58f1c22SToby Isaac   PetscValidPointer(label, 3);
8069c58f1c22SToby Isaac   *label = NULL;
8070c58f1c22SToby Isaac   while (next) {
8071d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8072d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8073c58f1c22SToby Isaac     if (hasLabel) {
8074c58f1c22SToby Isaac       *label = next->label;
8075c58f1c22SToby Isaac       break;
8076c58f1c22SToby Isaac     }
8077c58f1c22SToby Isaac     next = next->next;
8078c58f1c22SToby Isaac   }
8079c58f1c22SToby Isaac   PetscFunctionReturn(0);
8080c58f1c22SToby Isaac }
8081c58f1c22SToby Isaac 
8082c58f1c22SToby Isaac /*@C
8083c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
8084c58f1c22SToby Isaac 
8085c58f1c22SToby Isaac   Not Collective
8086c58f1c22SToby Isaac 
8087c58f1c22SToby Isaac   Input Parameters:
8088c58f1c22SToby Isaac + dm - The DM object
8089c58f1c22SToby Isaac - n  - the label number
8090c58f1c22SToby Isaac 
8091c58f1c22SToby Isaac   Output Parameter:
8092c58f1c22SToby Isaac . label - the label
8093c58f1c22SToby Isaac 
8094c58f1c22SToby Isaac   Level: intermediate
8095c58f1c22SToby Isaac 
8096c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8097c58f1c22SToby Isaac @*/
8098c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
8099c58f1c22SToby Isaac {
81005d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
8101c58f1c22SToby Isaac   PetscInt    l    = 0;
8102c58f1c22SToby Isaac 
8103c58f1c22SToby Isaac   PetscFunctionBegin;
8104c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8105c58f1c22SToby Isaac   PetscValidPointer(label, 3);
8106c58f1c22SToby Isaac   while (next) {
8107c58f1c22SToby Isaac     if (l == n) {
8108c58f1c22SToby Isaac       *label = next->label;
8109c58f1c22SToby Isaac       PetscFunctionReturn(0);
8110c58f1c22SToby Isaac     }
8111c58f1c22SToby Isaac     ++l;
8112c58f1c22SToby Isaac     next = next->next;
8113c58f1c22SToby Isaac   }
811498921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
8115c58f1c22SToby Isaac }
8116c58f1c22SToby Isaac 
8117c58f1c22SToby Isaac /*@C
8118c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
8119c58f1c22SToby Isaac 
8120c58f1c22SToby Isaac   Not Collective
8121c58f1c22SToby Isaac 
8122c58f1c22SToby Isaac   Input Parameters:
8123c58f1c22SToby Isaac + dm   - The DM object
8124c58f1c22SToby Isaac - label - The DMLabel
8125c58f1c22SToby Isaac 
8126c58f1c22SToby Isaac   Level: developer
8127c58f1c22SToby Isaac 
8128c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8129c58f1c22SToby Isaac @*/
8130c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
8131c58f1c22SToby Isaac {
81325d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
8133c58f1c22SToby Isaac   PetscBool      hasLabel;
8134d67d17b1SMatthew G. Knepley   const char    *lname;
81355d80c0bfSVaclav Hapla   PetscBool      flg;
8136c58f1c22SToby Isaac   PetscErrorCode ierr;
8137c58f1c22SToby Isaac 
8138c58f1c22SToby Isaac   PetscFunctionBegin;
8139c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8140d67d17b1SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
8141d67d17b1SMatthew G. Knepley   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
81422c71b3e2SJacob Faibussowitsch   PetscCheckFalse(hasLabel,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
8143c58f1c22SToby Isaac   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
8144c58f1c22SToby Isaac   tmpLabel->label  = label;
8145c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
81465d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
81475d80c0bfSVaclav Hapla   *p = tmpLabel;
814808f633c4SVaclav Hapla   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
81495d80c0bfSVaclav Hapla   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
81505d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
8151ba2698f1SMatthew G. Knepley   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
8152ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
8153c58f1c22SToby Isaac   PetscFunctionReturn(0);
8154c58f1c22SToby Isaac }
8155c58f1c22SToby Isaac 
8156c58f1c22SToby Isaac /*@C
81574a7ee7d0SMatthew G. Knepley   DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present
81584a7ee7d0SMatthew G. Knepley 
81594a7ee7d0SMatthew G. Knepley   Not Collective
81604a7ee7d0SMatthew G. Knepley 
81614a7ee7d0SMatthew G. Knepley   Input Parameters:
81624a7ee7d0SMatthew G. Knepley + dm    - The DM object
81634a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute
81644a7ee7d0SMatthew G. Knepley 
81654a7ee7d0SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
81664a7ee7d0SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
81674a7ee7d0SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
81684a7ee7d0SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
81694a7ee7d0SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
81704a7ee7d0SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
81714a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
81724a7ee7d0SMatthew G. Knepley 
81734a7ee7d0SMatthew G. Knepley   Level: intermediate
81744a7ee7d0SMatthew G. Knepley 
81754a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
81764a7ee7d0SMatthew G. Knepley @*/
81774a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label)
81784a7ee7d0SMatthew G. Knepley {
81794a7ee7d0SMatthew G. Knepley   DMLabelLink    next = dm->labels;
81804a7ee7d0SMatthew G. Knepley   PetscBool      hasLabel, flg;
81814a7ee7d0SMatthew G. Knepley   const char    *name, *lname;
81824a7ee7d0SMatthew G. Knepley   PetscErrorCode ierr;
81834a7ee7d0SMatthew G. Knepley 
81844a7ee7d0SMatthew G. Knepley   PetscFunctionBegin;
81854a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
81864a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
81874a7ee7d0SMatthew G. Knepley   ierr = PetscObjectGetName((PetscObject) label, &name);CHKERRQ(ierr);
81884a7ee7d0SMatthew G. Knepley   while (next) {
81894a7ee7d0SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
81904a7ee7d0SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
81914a7ee7d0SMatthew G. Knepley     if (hasLabel) {
81924a7ee7d0SMatthew G. Knepley       ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
81934a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
81944a7ee7d0SMatthew G. Knepley       if (flg) dm->depthLabel = label;
81954a7ee7d0SMatthew G. Knepley       ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
81964a7ee7d0SMatthew G. Knepley       if (flg) dm->celltypeLabel = label;
81974a7ee7d0SMatthew G. Knepley       ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
81984a7ee7d0SMatthew G. Knepley       next->label = label;
81994a7ee7d0SMatthew G. Knepley       break;
82004a7ee7d0SMatthew G. Knepley     }
82014a7ee7d0SMatthew G. Knepley     next = next->next;
82024a7ee7d0SMatthew G. Knepley   }
82034a7ee7d0SMatthew G. Knepley   PetscFunctionReturn(0);
82044a7ee7d0SMatthew G. Knepley }
82054a7ee7d0SMatthew G. Knepley 
82064a7ee7d0SMatthew G. Knepley /*@C
8207e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
8208c58f1c22SToby Isaac 
8209c58f1c22SToby Isaac   Not Collective
8210c58f1c22SToby Isaac 
8211c58f1c22SToby Isaac   Input Parameters:
8212c58f1c22SToby Isaac + dm   - The DM object
8213c58f1c22SToby Isaac - name - The label name
8214c58f1c22SToby Isaac 
8215c58f1c22SToby Isaac   Output Parameter:
8216c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
8217c58f1c22SToby Isaac 
8218c58f1c22SToby Isaac   Level: developer
8219c58f1c22SToby Isaac 
8220e5472504SVaclav Hapla   Notes:
8221e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
8222e5472504SVaclav Hapla   DMLabelDestroy() on the label.
8223e5472504SVaclav Hapla 
8224e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
8225e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
8226e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
8227e5472504SVaclav Hapla 
8228e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
8229c58f1c22SToby Isaac @*/
8230c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
8231c58f1c22SToby Isaac {
823295d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
8233c58f1c22SToby Isaac   PetscBool      hasLabel;
8234d67d17b1SMatthew G. Knepley   const char    *lname;
8235c58f1c22SToby Isaac   PetscErrorCode ierr;
8236c58f1c22SToby Isaac 
8237c58f1c22SToby Isaac   PetscFunctionBegin;
8238c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8239e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
8240e5472504SVaclav Hapla   if (label) {
8241e5472504SVaclav Hapla     PetscValidPointer(label, 3);
8242c58f1c22SToby Isaac     *label = NULL;
8243e5472504SVaclav Hapla   }
82445d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
824595d578d6SVaclav Hapla     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
8246d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
8247c58f1c22SToby Isaac     if (hasLabel) {
824895d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
8249c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
825095d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
8251ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
8252ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
825395d578d6SVaclav Hapla       if (label) *label = link->label;
825495d578d6SVaclav Hapla       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
825595d578d6SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8256c58f1c22SToby Isaac       break;
8257c58f1c22SToby Isaac     }
8258c58f1c22SToby Isaac   }
8259c58f1c22SToby Isaac   PetscFunctionReturn(0);
8260c58f1c22SToby Isaac }
8261c58f1c22SToby Isaac 
8262306894acSVaclav Hapla /*@
8263306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
8264306894acSVaclav Hapla 
8265306894acSVaclav Hapla   Not Collective
8266306894acSVaclav Hapla 
8267306894acSVaclav Hapla   Input Parameters:
8268306894acSVaclav Hapla + dm   - The DM object
8269876aa926SVaclav Hapla . label - The DMLabel to be removed from the DM
8270306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
8271306894acSVaclav Hapla 
8272306894acSVaclav Hapla   Level: developer
8273306894acSVaclav Hapla 
8274306894acSVaclav Hapla   Notes:
8275306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
8276306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
8277306894acSVaclav Hapla   *label nullified.
8278306894acSVaclav Hapla 
8279306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
8280306894acSVaclav Hapla @*/
8281306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
8282306894acSVaclav Hapla {
828343e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
8284306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
8285306894acSVaclav Hapla   PetscErrorCode ierr;
8286306894acSVaclav Hapla 
8287306894acSVaclav Hapla   PetscFunctionBegin;
8288306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8289306894acSVaclav Hapla   PetscValidPointer(label, 2);
8290f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
8291306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
8292306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
82935d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
829443e45a93SVaclav Hapla     if (*label == link->label) {
8295306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
829643e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
8297306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
8298ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
829943e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
830043e45a93SVaclav Hapla       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
830143e45a93SVaclav Hapla       ierr = PetscFree(link);CHKERRQ(ierr);
8302306894acSVaclav Hapla       break;
8303306894acSVaclav Hapla     }
8304306894acSVaclav Hapla   }
83052c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!hasLabel && failNotFound,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
8306306894acSVaclav Hapla   PetscFunctionReturn(0);
8307306894acSVaclav Hapla }
8308306894acSVaclav Hapla 
8309c58f1c22SToby Isaac /*@C
8310c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
8311c58f1c22SToby Isaac 
8312c58f1c22SToby Isaac   Not Collective
8313c58f1c22SToby Isaac 
8314c58f1c22SToby Isaac   Input Parameters:
8315c58f1c22SToby Isaac + dm   - The DM object
8316c58f1c22SToby Isaac - name - The label name
8317c58f1c22SToby Isaac 
8318c58f1c22SToby Isaac   Output Parameter:
8319c58f1c22SToby Isaac . output - The flag for output
8320c58f1c22SToby Isaac 
8321c58f1c22SToby Isaac   Level: developer
8322c58f1c22SToby Isaac 
8323c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8324c58f1c22SToby Isaac @*/
8325c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
8326c58f1c22SToby Isaac {
83275d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8328d67d17b1SMatthew G. Knepley   const char    *lname;
8329c58f1c22SToby Isaac   PetscErrorCode ierr;
8330c58f1c22SToby Isaac 
8331c58f1c22SToby Isaac   PetscFunctionBegin;
8332c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8333c58f1c22SToby Isaac   PetscValidPointer(name, 2);
8334c58f1c22SToby Isaac   PetscValidPointer(output, 3);
8335c58f1c22SToby Isaac   while (next) {
8336c58f1c22SToby Isaac     PetscBool flg;
8337c58f1c22SToby Isaac 
8338d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8339d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8340c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
8341c58f1c22SToby Isaac     next = next->next;
8342c58f1c22SToby Isaac   }
834398921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8344c58f1c22SToby Isaac }
8345c58f1c22SToby Isaac 
8346c58f1c22SToby Isaac /*@C
8347c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
8348c58f1c22SToby Isaac 
8349c58f1c22SToby Isaac   Not Collective
8350c58f1c22SToby Isaac 
8351c58f1c22SToby Isaac   Input Parameters:
8352c58f1c22SToby Isaac + dm     - The DM object
8353c58f1c22SToby Isaac . name   - The label name
8354c58f1c22SToby Isaac - output - The flag for output
8355c58f1c22SToby Isaac 
8356c58f1c22SToby Isaac   Level: developer
8357c58f1c22SToby Isaac 
8358c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8359c58f1c22SToby Isaac @*/
8360c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
8361c58f1c22SToby Isaac {
83625d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8363d67d17b1SMatthew G. Knepley   const char    *lname;
8364c58f1c22SToby Isaac   PetscErrorCode ierr;
8365c58f1c22SToby Isaac 
8366c58f1c22SToby Isaac   PetscFunctionBegin;
8367c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8368534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
8369c58f1c22SToby Isaac   while (next) {
8370c58f1c22SToby Isaac     PetscBool flg;
8371c58f1c22SToby Isaac 
8372d67d17b1SMatthew G. Knepley     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
8373d67d17b1SMatthew G. Knepley     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
8374c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
8375c58f1c22SToby Isaac     next = next->next;
8376c58f1c22SToby Isaac   }
837798921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8378c58f1c22SToby Isaac }
8379c58f1c22SToby Isaac 
8380c58f1c22SToby Isaac /*@
8381c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
8382c58f1c22SToby Isaac 
8383d083f849SBarry Smith   Collective on dmA
8384c58f1c22SToby Isaac 
8385d8d19677SJose E. Roman   Input Parameters:
83865d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
83872cbb9b06SVaclav Hapla . dmB - The DM object to which labels are copied
83885d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
83892cbb9b06SVaclav Hapla . all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
83902cbb9b06SVaclav Hapla - emode - How to behave when a DMLabel in the source and destination DMs with the same name is encountered (see DMCopyLabelsMode)
8391c58f1c22SToby Isaac 
8392c58f1c22SToby Isaac   Level: intermediate
8393c58f1c22SToby Isaac 
83942cbb9b06SVaclav Hapla   Notes:
83952cbb9b06SVaclav Hapla   This is typically used when interpolating or otherwise adding to a mesh, or testing.
8396c58f1c22SToby Isaac 
83972cbb9b06SVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode
8398c58f1c22SToby Isaac @*/
83992cbb9b06SVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all, DMCopyLabelsMode emode)
8400c58f1c22SToby Isaac {
84012cbb9b06SVaclav Hapla   DMLabel        label, labelNew, labelOld;
8402c58f1c22SToby Isaac   const char    *name;
8403c58f1c22SToby Isaac   PetscBool      flg;
84045d80c0bfSVaclav Hapla   DMLabelLink    link;
84055d80c0bfSVaclav Hapla   PetscErrorCode ierr;
8406c58f1c22SToby Isaac 
84075d80c0bfSVaclav Hapla   PetscFunctionBegin;
84085d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
84095d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
84105d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
84115d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
84122c71b3e2SJacob Faibussowitsch   PetscCheckFalse(mode==PETSC_USE_POINTER,PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
84135d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
84145d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
84155d80c0bfSVaclav Hapla     label=link->label;
84165d80c0bfSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
84175d80c0bfSVaclav Hapla     if (!all) {
8418c58f1c22SToby Isaac       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
8419c58f1c22SToby Isaac       if (flg) continue;
84207d5acc75SStefano Zampini       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
84217d5acc75SStefano Zampini       if (flg) continue;
8422ba2698f1SMatthew G. Knepley       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
8423ba2698f1SMatthew G. Knepley       if (flg) continue;
84245d80c0bfSVaclav Hapla     }
84252cbb9b06SVaclav Hapla     ierr = DMGetLabel(dmB, name, &labelOld);CHKERRQ(ierr);
84262cbb9b06SVaclav Hapla     if (labelOld) {
84272cbb9b06SVaclav Hapla       switch (emode) {
84282cbb9b06SVaclav Hapla         case DM_COPY_LABELS_KEEP:
84292cbb9b06SVaclav Hapla           continue;
84302cbb9b06SVaclav Hapla         case DM_COPY_LABELS_REPLACE:
84312cbb9b06SVaclav Hapla           ierr = DMRemoveLabelBySelf(dmB, &labelOld, PETSC_TRUE);CHKERRQ(ierr);
84322cbb9b06SVaclav Hapla           break;
84332cbb9b06SVaclav Hapla         case DM_COPY_LABELS_FAIL:
843498921bdaSJacob Faibussowitsch           SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in destination DM", name);
84352cbb9b06SVaclav Hapla         default:
843698921bdaSJacob Faibussowitsch           SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Unhandled DMCopyLabelsMode %d", emode);
84372cbb9b06SVaclav Hapla       }
84382cbb9b06SVaclav Hapla     }
84395d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
8440c58f1c22SToby Isaac       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
84415d80c0bfSVaclav Hapla     } else {
84425d80c0bfSVaclav Hapla       labelNew = label;
84435d80c0bfSVaclav Hapla     }
8444c58f1c22SToby Isaac     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
84455d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
8446c58f1c22SToby Isaac   }
8447c58f1c22SToby Isaac   PetscFunctionReturn(0);
8448c58f1c22SToby Isaac }
8449461a15a0SLisandro Dalcin 
8450609dae6eSVaclav Hapla /*@C
8451609dae6eSVaclav Hapla   DMCompareLabels - Compare labels of two DMPlex meshes
8452609dae6eSVaclav Hapla 
84535efe38ccSVaclav Hapla   Collective
8454609dae6eSVaclav Hapla 
8455609dae6eSVaclav Hapla   Input Parameters:
8456609dae6eSVaclav Hapla + dm0 - First DM object
8457609dae6eSVaclav Hapla - dm1 - Second DM object
8458609dae6eSVaclav Hapla 
8459609dae6eSVaclav Hapla   Output Parameters
84605efe38ccSVaclav Hapla + equal   - (Optional) Flag whether labels of dm0 and dm1 are the same
8461609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference
8462609dae6eSVaclav Hapla 
8463609dae6eSVaclav Hapla   Level: intermediate
8464609dae6eSVaclav Hapla 
8465609dae6eSVaclav Hapla   Notes:
84665efe38ccSVaclav Hapla   The output flag equal is the same on all processes.
84675efe38ccSVaclav Hapla   If it is passed as NULL and difference is found, an error is thrown on all processes.
84685efe38ccSVaclav Hapla   Make sure to pass NULL on all processes.
8469609dae6eSVaclav Hapla 
84705efe38ccSVaclav Hapla   The output message is set independently on each rank.
84715efe38ccSVaclav Hapla   It is set to NULL if no difference was found on the current rank. It must be freed by user.
84725efe38ccSVaclav Hapla   If message is passed as NULL and difference is found, the difference description is printed to stderr in synchronized manner.
84735efe38ccSVaclav Hapla   Make sure to pass NULL on all processes.
8474609dae6eSVaclav Hapla 
8475609dae6eSVaclav Hapla   Labels are matched by name. If the number of labels and their names are equal,
8476609dae6eSVaclav Hapla   DMLabelCompare() is used to compare each pair of labels with the same name.
8477609dae6eSVaclav Hapla 
8478609dae6eSVaclav Hapla   Fortran Notes:
8479609dae6eSVaclav Hapla   This function is currently not available from Fortran.
8480609dae6eSVaclav Hapla 
8481609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare()
8482609dae6eSVaclav Hapla @*/
84835efe38ccSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *equal, char **message)
8484609dae6eSVaclav Hapla {
84855efe38ccSVaclav Hapla   PetscInt        n, i;
8486609dae6eSVaclav Hapla   char            msg[PETSC_MAX_PATH_LEN] = "";
84875efe38ccSVaclav Hapla   PetscBool       eq;
8488609dae6eSVaclav Hapla   MPI_Comm        comm;
84895efe38ccSVaclav Hapla   PetscMPIInt     rank;
8490609dae6eSVaclav Hapla   PetscErrorCode  ierr;
8491609dae6eSVaclav Hapla 
8492609dae6eSVaclav Hapla   PetscFunctionBegin;
8493609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm0,DM_CLASSID,1);
8494609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm1,DM_CLASSID,2);
8495609dae6eSVaclav Hapla   PetscCheckSameComm(dm0,1,dm1,2);
84965efe38ccSVaclav Hapla   if (equal) PetscValidBoolPointer(equal,3);
8497609dae6eSVaclav Hapla   if (message) PetscValidPointer(message, 4);
8498609dae6eSVaclav Hapla   ierr = PetscObjectGetComm((PetscObject)dm0, &comm);CHKERRQ(ierr);
84995efe38ccSVaclav Hapla   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
85005efe38ccSVaclav Hapla   {
85015efe38ccSVaclav Hapla     PetscInt n1;
85025efe38ccSVaclav Hapla 
85035efe38ccSVaclav Hapla     ierr = DMGetNumLabels(dm0, &n);CHKERRQ(ierr);
8504609dae6eSVaclav Hapla     ierr = DMGetNumLabels(dm1, &n1);CHKERRQ(ierr);
85055efe38ccSVaclav Hapla     eq = (PetscBool) (n == n1);
85065efe38ccSVaclav Hapla     if (!eq) {
85075efe38ccSVaclav Hapla       ierr = PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n, n1);CHKERRQ(ierr);
8508609dae6eSVaclav Hapla     }
85095efe38ccSVaclav Hapla     ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
85105efe38ccSVaclav Hapla     if (!eq) goto finish;
85115efe38ccSVaclav Hapla   }
85125efe38ccSVaclav Hapla   for (i=0; i<n; i++) {
8513609dae6eSVaclav Hapla     DMLabel     l0, l1;
8514609dae6eSVaclav Hapla     const char *name;
8515609dae6eSVaclav Hapla     char       *msgInner;
8516609dae6eSVaclav Hapla 
8517609dae6eSVaclav Hapla     /* Ignore label order */
8518609dae6eSVaclav Hapla     ierr = DMGetLabelByNum(dm0, i, &l0);CHKERRQ(ierr);
8519609dae6eSVaclav Hapla     ierr = PetscObjectGetName((PetscObject)l0, &name);CHKERRQ(ierr);
8520609dae6eSVaclav Hapla     ierr = DMGetLabel(dm1, name, &l1);CHKERRQ(ierr);
8521609dae6eSVaclav Hapla     if (!l1) {
8522609dae6eSVaclav Hapla       ierr = PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i);CHKERRQ(ierr);
85235efe38ccSVaclav Hapla       eq = PETSC_FALSE;
85245efe38ccSVaclav Hapla       break;
8525609dae6eSVaclav Hapla     }
85265efe38ccSVaclav Hapla     ierr = DMLabelCompare(comm, l0, l1, &eq, &msgInner);CHKERRQ(ierr);
8527609dae6eSVaclav Hapla     ierr = PetscStrncpy(msg, msgInner, sizeof(msg));CHKERRQ(ierr);
8528609dae6eSVaclav Hapla     ierr = PetscFree(msgInner);CHKERRQ(ierr);
85295efe38ccSVaclav Hapla     if (!eq) break;
8530609dae6eSVaclav Hapla   }
85315efe38ccSVaclav Hapla   ierr = MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
8532609dae6eSVaclav Hapla finish:
85335efe38ccSVaclav Hapla   /* If message output arg not set, print to stderr */
8534609dae6eSVaclav Hapla   if (message) {
8535609dae6eSVaclav Hapla     *message = NULL;
8536609dae6eSVaclav Hapla     if (msg[0]) {
8537609dae6eSVaclav Hapla       ierr = PetscStrallocpy(msg, message);CHKERRQ(ierr);
8538609dae6eSVaclav Hapla     }
85395efe38ccSVaclav Hapla   } else {
85405efe38ccSVaclav Hapla     if (msg[0]) {
85415efe38ccSVaclav Hapla       ierr = PetscSynchronizedFPrintf(comm, PETSC_STDERR, "[%d] %s\n", rank, msg);CHKERRQ(ierr);
8542609dae6eSVaclav Hapla     }
85435efe38ccSVaclav Hapla     ierr = PetscSynchronizedFlush(comm, PETSC_STDERR);CHKERRQ(ierr);
85445efe38ccSVaclav Hapla   }
85455efe38ccSVaclav Hapla   /* If same output arg not ser and labels are not equal, throw error */
85465efe38ccSVaclav Hapla   if (equal) *equal = eq;
85472c71b3e2SJacob Faibussowitsch   else PetscCheckFalse(!eq,comm, PETSC_ERR_ARG_INCOMP, "DMLabels are not the same in dm0 and dm1");
8548609dae6eSVaclav Hapla   PetscFunctionReturn(0);
8549609dae6eSVaclav Hapla }
8550609dae6eSVaclav Hapla 
8551461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value)
8552461a15a0SLisandro Dalcin {
8553461a15a0SLisandro Dalcin   PetscErrorCode ierr;
8554609dae6eSVaclav Hapla 
8555461a15a0SLisandro Dalcin   PetscFunctionBegin;
8556461a15a0SLisandro Dalcin   PetscValidPointer(label,2);
8557461a15a0SLisandro Dalcin   if (!*label) {
8558461a15a0SLisandro Dalcin     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
8559461a15a0SLisandro Dalcin     ierr = DMGetLabel(dm, name, label);CHKERRQ(ierr);
8560461a15a0SLisandro Dalcin   }
8561461a15a0SLisandro Dalcin   ierr = DMLabelSetValue(*label, point, value);CHKERRQ(ierr);
8562461a15a0SLisandro Dalcin   PetscFunctionReturn(0);
8563461a15a0SLisandro Dalcin }
8564461a15a0SLisandro Dalcin 
85650fdc7489SMatthew Knepley /*
85660fdc7489SMatthew Knepley   Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would
85670fdc7489SMatthew Knepley   like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every
85680fdc7489SMatthew Knepley   (label, id) pair in the DM.
85690fdc7489SMatthew Knepley 
85700fdc7489SMatthew Knepley   However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to
85710fdc7489SMatthew Knepley   each label.
85720fdc7489SMatthew Knepley */
85730fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal)
85740fdc7489SMatthew Knepley {
85750fdc7489SMatthew Knepley   DMUniversalLabel ul;
85760fdc7489SMatthew Knepley   PetscBool       *active;
85770fdc7489SMatthew Knepley   PetscInt         pStart, pEnd, p, Nl, l, m;
85780fdc7489SMatthew Knepley   PetscErrorCode   ierr;
85790fdc7489SMatthew Knepley 
85800fdc7489SMatthew Knepley   PetscFunctionBegin;
85810fdc7489SMatthew Knepley   ierr = PetscMalloc1(1, &ul);CHKERRQ(ierr);
85820fdc7489SMatthew Knepley   ierr = DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label);CHKERRQ(ierr);
85830fdc7489SMatthew Knepley   ierr = DMGetNumLabels(dm, &Nl);CHKERRQ(ierr);
85840fdc7489SMatthew Knepley   ierr = PetscCalloc1(Nl, &active);CHKERRQ(ierr);
85850fdc7489SMatthew Knepley   ul->Nl = 0;
85860fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
85870fdc7489SMatthew Knepley     PetscBool   isdepth, iscelltype;
85880fdc7489SMatthew Knepley     const char *name;
85890fdc7489SMatthew Knepley 
85900fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
85910fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "depth", 6, &isdepth);CHKERRQ(ierr);
85920fdc7489SMatthew Knepley     ierr = PetscStrncmp(name, "celltype", 9, &iscelltype);CHKERRQ(ierr);
85930fdc7489SMatthew Knepley     active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE;
85940fdc7489SMatthew Knepley     if (active[l]) ++ul->Nl;
85950fdc7489SMatthew Knepley   }
85960fdc7489SMatthew 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);
85970fdc7489SMatthew Knepley   ul->Nv = 0;
85980fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
85990fdc7489SMatthew Knepley     DMLabel     label;
86000fdc7489SMatthew Knepley     PetscInt    nv;
86010fdc7489SMatthew Knepley     const char *name;
86020fdc7489SMatthew Knepley 
86030fdc7489SMatthew Knepley     if (!active[l]) continue;
86040fdc7489SMatthew Knepley     ierr = DMGetLabelName(dm, l, &name);CHKERRQ(ierr);
86050fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
86060fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
86070fdc7489SMatthew Knepley     ierr = PetscStrallocpy(name, &ul->names[m]);CHKERRQ(ierr);
86080fdc7489SMatthew Knepley     ul->indices[m]   = l;
86090fdc7489SMatthew Knepley     ul->Nv          += nv;
86100fdc7489SMatthew Knepley     ul->offsets[m+1] = nv;
86110fdc7489SMatthew Knepley     ul->bits[m+1]    = PetscCeilReal(PetscLog2Real(nv+1));
86120fdc7489SMatthew Knepley     ++m;
86130fdc7489SMatthew Knepley   }
86140fdc7489SMatthew Knepley   for (l = 1; l <= ul->Nl; ++l) {
86150fdc7489SMatthew Knepley     ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l];
86160fdc7489SMatthew Knepley     ul->bits[l]    = ul->bits[l-1]    + ul->bits[l];
86170fdc7489SMatthew Knepley   }
86180fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
86190fdc7489SMatthew Knepley     PetscInt b;
86200fdc7489SMatthew Knepley 
86210fdc7489SMatthew Knepley     ul->masks[l] = 0;
86220fdc7489SMatthew Knepley     for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b;
86230fdc7489SMatthew Knepley   }
86240fdc7489SMatthew Knepley   ierr = PetscMalloc1(ul->Nv, &ul->values);CHKERRQ(ierr);
86250fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
86260fdc7489SMatthew Knepley     DMLabel         label;
86270fdc7489SMatthew Knepley     IS              valueIS;
86280fdc7489SMatthew Knepley     const PetscInt *varr;
86290fdc7489SMatthew Knepley     PetscInt        nv, v;
86300fdc7489SMatthew Knepley 
86310fdc7489SMatthew Knepley     if (!active[l]) continue;
86320fdc7489SMatthew Knepley     ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
86330fdc7489SMatthew Knepley     ierr = DMLabelGetNumValues(label, &nv);CHKERRQ(ierr);
86340fdc7489SMatthew Knepley     ierr = DMLabelGetValueIS(label, &valueIS);CHKERRQ(ierr);
86350fdc7489SMatthew Knepley     ierr = ISGetIndices(valueIS, &varr);CHKERRQ(ierr);
86360fdc7489SMatthew Knepley     for (v = 0; v < nv; ++v) {
86370fdc7489SMatthew Knepley       ul->values[ul->offsets[m]+v] = varr[v];
86380fdc7489SMatthew Knepley     }
86390fdc7489SMatthew Knepley     ierr = ISRestoreIndices(valueIS, &varr);CHKERRQ(ierr);
86400fdc7489SMatthew Knepley     ierr = ISDestroy(&valueIS);CHKERRQ(ierr);
86410fdc7489SMatthew Knepley     ierr = PetscSortInt(nv, &ul->values[ul->offsets[m]]);CHKERRQ(ierr);
86420fdc7489SMatthew Knepley     ++m;
86430fdc7489SMatthew Knepley   }
86440fdc7489SMatthew Knepley   ierr = DMPlexGetChart(dm, &pStart, &pEnd);CHKERRQ(ierr);
86450fdc7489SMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
86460fdc7489SMatthew Knepley     PetscInt  uval = 0;
86470fdc7489SMatthew Knepley     PetscBool marked = PETSC_FALSE;
86480fdc7489SMatthew Knepley 
86490fdc7489SMatthew Knepley     for (l = 0, m = 0; l < Nl; ++l) {
86500fdc7489SMatthew Knepley       DMLabel  label;
86510649b39aSStefano Zampini       PetscInt val, defval, loc, nv;
86520fdc7489SMatthew Knepley 
86530fdc7489SMatthew Knepley       if (!active[l]) continue;
86540fdc7489SMatthew Knepley       ierr = DMGetLabelByNum(dm, l, &label);CHKERRQ(ierr);
86550fdc7489SMatthew Knepley       ierr = DMLabelGetValue(label, p, &val);CHKERRQ(ierr);
86560fdc7489SMatthew Knepley       ierr = DMLabelGetDefaultValue(label, &defval);CHKERRQ(ierr);
86570fdc7489SMatthew Knepley       if (val == defval) {++m; continue;}
86580649b39aSStefano Zampini       nv = ul->offsets[m+1]-ul->offsets[m];
86590fdc7489SMatthew Knepley       marked = PETSC_TRUE;
86600fdc7489SMatthew Knepley       ierr = PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc);CHKERRQ(ierr);
86612c71b3e2SJacob Faibussowitsch       PetscCheckFalse(loc < 0,PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val);
86620fdc7489SMatthew Knepley       uval += (loc+1) << ul->bits[m];
86630fdc7489SMatthew Knepley       ++m;
86640fdc7489SMatthew Knepley     }
86650fdc7489SMatthew Knepley     if (marked) {ierr = DMLabelSetValue(ul->label, p, uval);CHKERRQ(ierr);}
86660fdc7489SMatthew Knepley   }
86670fdc7489SMatthew Knepley   ierr = PetscFree(active);CHKERRQ(ierr);
86680fdc7489SMatthew Knepley   *universal = ul;
86690fdc7489SMatthew Knepley   PetscFunctionReturn(0);
86700fdc7489SMatthew Knepley }
86710fdc7489SMatthew Knepley 
86720fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal)
86730fdc7489SMatthew Knepley {
86740fdc7489SMatthew Knepley   PetscInt       l;
86750fdc7489SMatthew Knepley   PetscErrorCode ierr;
86760fdc7489SMatthew Knepley 
86770fdc7489SMatthew Knepley   PetscFunctionBegin;
86780fdc7489SMatthew Knepley   for (l = 0; l < (*universal)->Nl; ++l) {ierr = PetscFree((*universal)->names[l]);CHKERRQ(ierr);}
86790fdc7489SMatthew Knepley   ierr = DMLabelDestroy(&(*universal)->label);CHKERRQ(ierr);
86800fdc7489SMatthew Knepley   ierr = PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks);CHKERRQ(ierr);
86810fdc7489SMatthew Knepley   ierr = PetscFree((*universal)->values);CHKERRQ(ierr);
86820fdc7489SMatthew Knepley   ierr = PetscFree(*universal);CHKERRQ(ierr);
86830fdc7489SMatthew Knepley   *universal = NULL;
86840fdc7489SMatthew Knepley   PetscFunctionReturn(0);
86850fdc7489SMatthew Knepley }
86860fdc7489SMatthew Knepley 
86870fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel)
86880fdc7489SMatthew Knepley {
86890fdc7489SMatthew Knepley   PetscFunctionBegin;
86900fdc7489SMatthew Knepley   PetscValidPointer(ulabel, 2);
86910fdc7489SMatthew Knepley   *ulabel = ul->label;
86920fdc7489SMatthew Knepley   PetscFunctionReturn(0);
86930fdc7489SMatthew Knepley }
86940fdc7489SMatthew Knepley 
86950fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm)
86960fdc7489SMatthew Knepley {
86970fdc7489SMatthew Knepley   PetscInt       Nl = ul->Nl, l;
86980fdc7489SMatthew Knepley   PetscErrorCode ierr;
86990fdc7489SMatthew Knepley 
87000fdc7489SMatthew Knepley   PetscFunctionBegin;
8701064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 3);
87020fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
87030fdc7489SMatthew Knepley     if (preserveOrder) {ierr = DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]);CHKERRQ(ierr);}
87040fdc7489SMatthew Knepley     else               {ierr = DMCreateLabel(dm, ul->names[l]);CHKERRQ(ierr);}
87050fdc7489SMatthew Knepley   }
87060fdc7489SMatthew Knepley   if (preserveOrder) {
87070fdc7489SMatthew Knepley     for (l = 0; l < ul->Nl; ++l) {
87080fdc7489SMatthew Knepley       const char *name;
87090fdc7489SMatthew Knepley       PetscBool   match;
87100fdc7489SMatthew Knepley 
87110fdc7489SMatthew Knepley       ierr = DMGetLabelName(dm, ul->indices[l], &name);CHKERRQ(ierr);
87120fdc7489SMatthew Knepley       ierr = PetscStrcmp(name, ul->names[l], &match);CHKERRQ(ierr);
87132c71b3e2SJacob Faibussowitsch       PetscCheckFalse(!match,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]);
87140fdc7489SMatthew Knepley     }
87150fdc7489SMatthew Knepley   }
87160fdc7489SMatthew Knepley   PetscFunctionReturn(0);
87170fdc7489SMatthew Knepley }
87180fdc7489SMatthew Knepley 
87190fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value)
87200fdc7489SMatthew Knepley {
87210fdc7489SMatthew Knepley   PetscInt       l;
87220fdc7489SMatthew Knepley   PetscErrorCode ierr;
87230fdc7489SMatthew Knepley 
87240fdc7489SMatthew Knepley   PetscFunctionBegin;
87250fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
87260fdc7489SMatthew Knepley     DMLabel  label;
87270fdc7489SMatthew Knepley     PetscInt lval = (value & ul->masks[l]) >> ul->bits[l];
87280fdc7489SMatthew Knepley 
87290fdc7489SMatthew Knepley     if (lval) {
87300fdc7489SMatthew Knepley       if (useIndex) {ierr = DMGetLabelByNum(dm, ul->indices[l], &label);CHKERRQ(ierr);}
87310fdc7489SMatthew Knepley       else          {ierr = DMGetLabel(dm, ul->names[l], &label);CHKERRQ(ierr);}
87320fdc7489SMatthew Knepley       ierr = DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]);CHKERRQ(ierr);
87330fdc7489SMatthew Knepley     }
87340fdc7489SMatthew Knepley   }
87350fdc7489SMatthew Knepley   PetscFunctionReturn(0);
87360fdc7489SMatthew Knepley }
8737a8fb8f29SToby Isaac 
8738a8fb8f29SToby Isaac /*@
8739a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
8740a8fb8f29SToby Isaac 
8741a8fb8f29SToby Isaac   Input Parameter:
8742a8fb8f29SToby Isaac . dm - The DM object
8743a8fb8f29SToby Isaac 
8744a8fb8f29SToby Isaac   Output Parameter:
8745a8fb8f29SToby Isaac . cdm - The coarse DM
8746a8fb8f29SToby Isaac 
8747a8fb8f29SToby Isaac   Level: intermediate
8748a8fb8f29SToby Isaac 
8749a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
8750a8fb8f29SToby Isaac @*/
8751a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
8752a8fb8f29SToby Isaac {
8753a8fb8f29SToby Isaac   PetscFunctionBegin;
8754a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8755a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
8756a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
8757a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8758a8fb8f29SToby Isaac }
8759a8fb8f29SToby Isaac 
8760a8fb8f29SToby Isaac /*@
8761a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
8762a8fb8f29SToby Isaac 
8763a8fb8f29SToby Isaac   Input Parameters:
8764a8fb8f29SToby Isaac + dm - The DM object
8765a8fb8f29SToby Isaac - cdm - The coarse DM
8766a8fb8f29SToby Isaac 
8767a8fb8f29SToby Isaac   Level: intermediate
8768a8fb8f29SToby Isaac 
8769a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
8770a8fb8f29SToby Isaac @*/
8771a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
8772a8fb8f29SToby Isaac {
8773a8fb8f29SToby Isaac   PetscErrorCode ierr;
8774a8fb8f29SToby Isaac 
8775a8fb8f29SToby Isaac   PetscFunctionBegin;
8776a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8777a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
8778a8fb8f29SToby Isaac   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
8779a8fb8f29SToby Isaac   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
8780a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
8781a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8782a8fb8f29SToby Isaac }
8783a8fb8f29SToby Isaac 
878488bdff64SToby Isaac /*@
878588bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
878688bdff64SToby Isaac 
878788bdff64SToby Isaac   Input Parameter:
878888bdff64SToby Isaac . dm - The DM object
878988bdff64SToby Isaac 
879088bdff64SToby Isaac   Output Parameter:
879188bdff64SToby Isaac . fdm - The fine DM
879288bdff64SToby Isaac 
879388bdff64SToby Isaac   Level: intermediate
879488bdff64SToby Isaac 
879588bdff64SToby Isaac .seealso: DMSetFineDM()
879688bdff64SToby Isaac @*/
879788bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
879888bdff64SToby Isaac {
879988bdff64SToby Isaac   PetscFunctionBegin;
880088bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
880188bdff64SToby Isaac   PetscValidPointer(fdm, 2);
880288bdff64SToby Isaac   *fdm = dm->fineMesh;
880388bdff64SToby Isaac   PetscFunctionReturn(0);
880488bdff64SToby Isaac }
880588bdff64SToby Isaac 
880688bdff64SToby Isaac /*@
880788bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
880888bdff64SToby Isaac 
880988bdff64SToby Isaac   Input Parameters:
881088bdff64SToby Isaac + dm - The DM object
881188bdff64SToby Isaac - fdm - The fine DM
881288bdff64SToby Isaac 
881388bdff64SToby Isaac   Level: intermediate
881488bdff64SToby Isaac 
881588bdff64SToby Isaac .seealso: DMGetFineDM()
881688bdff64SToby Isaac @*/
881788bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
881888bdff64SToby Isaac {
881988bdff64SToby Isaac   PetscErrorCode ierr;
882088bdff64SToby Isaac 
882188bdff64SToby Isaac   PetscFunctionBegin;
882288bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
882388bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
882488bdff64SToby Isaac   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
882588bdff64SToby Isaac   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
882688bdff64SToby Isaac   dm->fineMesh = fdm;
882788bdff64SToby Isaac   PetscFunctionReturn(0);
882888bdff64SToby Isaac }
882988bdff64SToby Isaac 
8830a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8831a6ba4734SToby Isaac 
8832a6ba4734SToby Isaac /*@C
8833a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8834a6ba4734SToby Isaac 
8835783e2ec8SMatthew G. Knepley   Collective on dm
8836783e2ec8SMatthew G. Knepley 
8837a6ba4734SToby Isaac   Input Parameters:
88384c258f51SMatthew G. Knepley + dm       - The DM, with a PetscDS that matches the problem being constrained
8839f971fd6bSMatthew G. Knepley . type     - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8840a6ba4734SToby Isaac . name     - The BC name
884145480ffeSMatthew G. Knepley . label    - The label defining constrained points
884245480ffeSMatthew G. Knepley . Nv       - The number of DMLabel values for constrained points
884345480ffeSMatthew G. Knepley . values   - An array of values for constrained points
8844a6ba4734SToby Isaac . field    - The field to constrain
884545480ffeSMatthew G. Knepley . Nc       - The number of constrained field components (0 will constrain all fields)
8846a6ba4734SToby Isaac . comps    - An array of constrained component numbers
8847a6ba4734SToby Isaac . bcFunc   - A pointwise function giving boundary values
884856cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL
8849a6ba4734SToby Isaac - ctx      - An optional user context for bcFunc
8850a6ba4734SToby Isaac 
885145480ffeSMatthew G. Knepley   Output Parameter:
885245480ffeSMatthew G. Knepley . bd          - (Optional) Boundary number
885345480ffeSMatthew G. Knepley 
8854a6ba4734SToby Isaac   Options Database Keys:
8855a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8856a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8857a6ba4734SToby Isaac 
885856cf3b9cSMatthew G. Knepley   Note:
885956cf3b9cSMatthew 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:
886056cf3b9cSMatthew G. Knepley 
886156cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
886256cf3b9cSMatthew G. Knepley 
886356cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
886456cf3b9cSMatthew G. Knepley 
886556cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
886656cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
886756cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
886856cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
886956cf3b9cSMatthew G. Knepley 
887056cf3b9cSMatthew G. Knepley + dim - the spatial dimension
887156cf3b9cSMatthew G. Knepley . Nf - the number of fields
887256cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
887356cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
887456cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
887556cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
887656cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
887756cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
887856cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
887956cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
888056cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
888156cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
888256cf3b9cSMatthew G. Knepley . t - current time
888356cf3b9cSMatthew G. Knepley . x - coordinates of the current point
888456cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
888556cf3b9cSMatthew G. Knepley . constants - constant parameters
888656cf3b9cSMatthew G. Knepley - bcval - output values at the current point
888756cf3b9cSMatthew G. Knepley 
8888ed808b8fSJed Brown   Level: intermediate
8889a6ba4734SToby Isaac 
889045480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary()
8891a6ba4734SToby Isaac @*/
889245480ffeSMatthew 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)
8893a6ba4734SToby Isaac {
8894e5e52638SMatthew G. Knepley   PetscDS        ds;
8895a6ba4734SToby Isaac   PetscErrorCode ierr;
8896a6ba4734SToby Isaac 
8897a6ba4734SToby Isaac   PetscFunctionBegin;
8898a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8899783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
890045480ffeSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
890145480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nv, 5);
890245480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 7);
890345480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 8);
8904e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
890545480ffeSMatthew G. Knepley   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label);CHKERRQ(ierr);
890645480ffeSMatthew G. Knepley   ierr = PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd);CHKERRQ(ierr);
8907a6ba4734SToby Isaac   PetscFunctionReturn(0);
8908a6ba4734SToby Isaac }
8909a6ba4734SToby Isaac 
891045480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */
8911e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8912e6f8dbb6SToby Isaac {
8913e5e52638SMatthew G. Knepley   PetscDS        ds;
8914dff059c6SToby Isaac   DMBoundary    *lastnext;
8915e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8916e6f8dbb6SToby Isaac   PetscErrorCode ierr;
8917e6f8dbb6SToby Isaac 
8918e6f8dbb6SToby Isaac   PetscFunctionBegin;
8919e5e52638SMatthew G. Knepley   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
8920e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
892147a1f5adSToby Isaac   if (dm->boundary) {
892247a1f5adSToby Isaac     DMBoundary next = dm->boundary;
892347a1f5adSToby Isaac 
892447a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
892547a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
892647a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
892747a1f5adSToby Isaac     while (next) {
892847a1f5adSToby Isaac       DMBoundary b = next;
892947a1f5adSToby Isaac 
893047a1f5adSToby Isaac       next = b->next;
893147a1f5adSToby Isaac       ierr = PetscFree(b);CHKERRQ(ierr);
8932a6ba4734SToby Isaac     }
893347a1f5adSToby Isaac     dm->boundary = NULL;
8934a6ba4734SToby Isaac   }
893547a1f5adSToby Isaac 
8936dff059c6SToby Isaac   lastnext = &(dm->boundary);
8937e6f8dbb6SToby Isaac   while (dsbound) {
8938e6f8dbb6SToby Isaac     DMBoundary dmbound;
8939e6f8dbb6SToby Isaac 
8940e6f8dbb6SToby Isaac     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
8941e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
894245480ffeSMatthew G. Knepley     dmbound->label      = dsbound->label;
894347a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8944dff059c6SToby Isaac     *lastnext = dmbound;
8945dff059c6SToby Isaac     lastnext = &(dmbound->next);
8946dff059c6SToby Isaac     dsbound = dsbound->next;
8947a6ba4734SToby Isaac   }
8948a6ba4734SToby Isaac   PetscFunctionReturn(0);
8949a6ba4734SToby Isaac }
8950a6ba4734SToby Isaac 
8951a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8952a6ba4734SToby Isaac {
8953b95f2879SToby Isaac   DMBoundary     b;
8954a6ba4734SToby Isaac   PetscErrorCode ierr;
8955a6ba4734SToby Isaac 
8956a6ba4734SToby Isaac   PetscFunctionBegin;
8957a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8958534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8959a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
8960e6f8dbb6SToby Isaac   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
8961b95f2879SToby Isaac   b = dm->boundary;
8962a6ba4734SToby Isaac   while (b && !(*isBd)) {
8963e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8964e6f8dbb6SToby Isaac     DSBoundary dsb   = b->dsboundary;
8965a6ba4734SToby Isaac     PetscInt   i;
8966a6ba4734SToby Isaac 
896745480ffeSMatthew G. Knepley     if (label) {
896845480ffeSMatthew G. Knepley       for (i = 0; i < dsb->Nv && !(*isBd); ++i) {ierr = DMLabelStratumHasPoint(label, dsb->values[i], point, isBd);CHKERRQ(ierr);}
8969a6ba4734SToby Isaac     }
8970a6ba4734SToby Isaac     b = b->next;
8971a6ba4734SToby Isaac   }
8972a6ba4734SToby Isaac   PetscFunctionReturn(0);
8973a6ba4734SToby Isaac }
89744d6f44ffSToby Isaac 
89754d6f44ffSToby Isaac /*@C
8976a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8977a6e0b375SMatthew G. Knepley 
8978a6e0b375SMatthew G. Knepley   Collective on DM
89794d6f44ffSToby Isaac 
89804d6f44ffSToby Isaac   Input Parameters:
89814d6f44ffSToby Isaac + dm      - The DM
89820709b2feSToby Isaac . time    - The time
89834d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
89844d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
89854d6f44ffSToby Isaac - mode    - The insertion mode for values
89864d6f44ffSToby Isaac 
89874d6f44ffSToby Isaac   Output Parameter:
89884d6f44ffSToby Isaac . X - vector
89894d6f44ffSToby Isaac 
89904d6f44ffSToby Isaac    Calling sequence of func:
899177b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
89924d6f44ffSToby Isaac 
89934d6f44ffSToby Isaac +  dim - The spatial dimension
89948ec8862eSJed Brown .  time - The time at which to sample
89954d6f44ffSToby Isaac .  x   - The coordinates
899677b739a6SMatthew Knepley .  Nc  - The number of components
89974d6f44ffSToby Isaac .  u   - The output field values
89984d6f44ffSToby Isaac -  ctx - optional user-defined function context
89994d6f44ffSToby Isaac 
90004d6f44ffSToby Isaac   Level: developer
90014d6f44ffSToby Isaac 
9002a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
90034d6f44ffSToby Isaac @*/
90040709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
90054d6f44ffSToby Isaac {
90064d6f44ffSToby Isaac   Vec            localX;
90074d6f44ffSToby Isaac   PetscErrorCode ierr;
90084d6f44ffSToby Isaac 
90094d6f44ffSToby Isaac   PetscFunctionBegin;
90104d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
90114d6f44ffSToby Isaac   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
90120709b2feSToby Isaac   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
90134d6f44ffSToby Isaac   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
90144d6f44ffSToby Isaac   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
90154d6f44ffSToby Isaac   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
90164d6f44ffSToby Isaac   PetscFunctionReturn(0);
90174d6f44ffSToby Isaac }
90184d6f44ffSToby Isaac 
9019a6e0b375SMatthew G. Knepley /*@C
9020a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
9021a6e0b375SMatthew G. Knepley 
9022a6e0b375SMatthew G. Knepley   Not collective
9023a6e0b375SMatthew G. Knepley 
9024a6e0b375SMatthew G. Knepley   Input Parameters:
9025a6e0b375SMatthew G. Knepley + dm      - The DM
9026a6e0b375SMatthew G. Knepley . time    - The time
9027a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
9028a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
9029a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9030a6e0b375SMatthew G. Knepley 
9031a6e0b375SMatthew G. Knepley   Output Parameter:
9032a6e0b375SMatthew G. Knepley . localX - vector
9033a6e0b375SMatthew G. Knepley 
9034a6e0b375SMatthew G. Knepley    Calling sequence of func:
903577b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
9036a6e0b375SMatthew G. Knepley 
9037a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
9038a6e0b375SMatthew G. Knepley .  x   - The coordinates
903977b739a6SMatthew Knepley .  Nc  - The number of components
9040a6e0b375SMatthew G. Knepley .  u   - The output field values
9041a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
9042a6e0b375SMatthew G. Knepley 
9043a6e0b375SMatthew G. Knepley   Level: developer
9044a6e0b375SMatthew G. Knepley 
9045a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
9046a6e0b375SMatthew G. Knepley @*/
90470709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
90484d6f44ffSToby Isaac {
90494d6f44ffSToby Isaac   PetscErrorCode ierr;
90504d6f44ffSToby Isaac 
90514d6f44ffSToby Isaac   PetscFunctionBegin;
90524d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9053064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
90542c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfunctionlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
90550709b2feSToby Isaac   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
90564d6f44ffSToby Isaac   PetscFunctionReturn(0);
90574d6f44ffSToby Isaac }
90584d6f44ffSToby Isaac 
9059a6e0b375SMatthew G. Knepley /*@C
9060a6e0b375SMatthew 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.
9061a6e0b375SMatthew G. Knepley 
9062a6e0b375SMatthew G. Knepley   Collective on DM
9063a6e0b375SMatthew G. Knepley 
9064a6e0b375SMatthew G. Knepley   Input Parameters:
9065a6e0b375SMatthew G. Knepley + dm      - The DM
9066a6e0b375SMatthew G. Knepley . time    - The time
9067a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
9068a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
9069a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
9070a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9071a6e0b375SMatthew G. Knepley 
9072a6e0b375SMatthew G. Knepley   Output Parameter:
9073a6e0b375SMatthew G. Knepley . X - vector
9074a6e0b375SMatthew G. Knepley 
9075a6e0b375SMatthew G. Knepley    Calling sequence of func:
907677b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
9077a6e0b375SMatthew G. Knepley 
9078a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
9079a6e0b375SMatthew G. Knepley .  x   - The coordinates
908077b739a6SMatthew Knepley .  Nc  - The number of components
9081a6e0b375SMatthew G. Knepley .  u   - The output field values
9082a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
9083a6e0b375SMatthew G. Knepley 
9084a6e0b375SMatthew G. Knepley   Level: developer
9085a6e0b375SMatthew G. Knepley 
9086a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
9087a6e0b375SMatthew G. Knepley @*/
90882c53366bSMatthew 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)
90892c53366bSMatthew G. Knepley {
90902c53366bSMatthew G. Knepley   Vec            localX;
90912c53366bSMatthew G. Knepley   PetscErrorCode ierr;
90922c53366bSMatthew G. Knepley 
90932c53366bSMatthew G. Knepley   PetscFunctionBegin;
90942c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
90952c53366bSMatthew G. Knepley   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
90962c53366bSMatthew G. Knepley   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
90972c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
90982c53366bSMatthew G. Knepley   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
90992c53366bSMatthew G. Knepley   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
91002c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
91012c53366bSMatthew G. Knepley }
91022c53366bSMatthew G. Knepley 
9103a6e0b375SMatthew G. Knepley /*@C
9104a6e0b375SMatthew 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.
9105a6e0b375SMatthew G. Knepley 
9106a6e0b375SMatthew G. Knepley   Not collective
9107a6e0b375SMatthew G. Knepley 
9108a6e0b375SMatthew G. Knepley   Input Parameters:
9109a6e0b375SMatthew G. Knepley + dm      - The DM
9110a6e0b375SMatthew G. Knepley . time    - The time
9111a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
9112a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
9113a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
9114a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9115a6e0b375SMatthew G. Knepley 
9116a6e0b375SMatthew G. Knepley   Output Parameter:
9117a6e0b375SMatthew G. Knepley . localX - vector
9118a6e0b375SMatthew G. Knepley 
9119a6e0b375SMatthew G. Knepley    Calling sequence of func:
912077b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
9121a6e0b375SMatthew G. Knepley 
9122a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
9123a6e0b375SMatthew G. Knepley .  x   - The coordinates
912477b739a6SMatthew Knepley .  Nc  - The number of components
9125a6e0b375SMatthew G. Knepley .  u   - The output field values
9126a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
9127a6e0b375SMatthew G. Knepley 
9128a6e0b375SMatthew G. Knepley   Level: developer
9129a6e0b375SMatthew G. Knepley 
9130a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
9131a6e0b375SMatthew G. Knepley @*/
91321c531cf8SMatthew 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)
91334d6f44ffSToby Isaac {
91344d6f44ffSToby Isaac   PetscErrorCode ierr;
91354d6f44ffSToby Isaac 
91364d6f44ffSToby Isaac   PetscFunctionBegin;
91374d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9138064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
91392c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfunctionlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
91401c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
91414d6f44ffSToby Isaac   PetscFunctionReturn(0);
91424d6f44ffSToby Isaac }
91432716604bSToby Isaac 
9144a6e0b375SMatthew G. Knepley /*@C
9145a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
9146a6e0b375SMatthew G. Knepley 
9147a6e0b375SMatthew G. Knepley   Not collective
9148a6e0b375SMatthew G. Knepley 
9149a6e0b375SMatthew G. Knepley   Input Parameters:
9150a6e0b375SMatthew G. Knepley + dm      - The DM
9151a6e0b375SMatthew G. Knepley . time    - The time
9152a6e0b375SMatthew G. Knepley . localU  - The input field vector
9153a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9154a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9155a6e0b375SMatthew G. Knepley 
9156a6e0b375SMatthew G. Knepley   Output Parameter:
9157a6e0b375SMatthew G. Knepley . localX  - The output vector
9158a6e0b375SMatthew G. Knepley 
9159a6e0b375SMatthew G. Knepley    Calling sequence of func:
9160a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9161a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9162a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9163a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9164a6e0b375SMatthew G. Knepley 
9165a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
9166a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
9167a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9168a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
9169a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9170a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
9171a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9172a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9173a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9174a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9175a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9176a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9177a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9178a6e0b375SMatthew G. Knepley .  t            - The current time
9179a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
9180a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
9181a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
9182a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
9183a6e0b375SMatthew G. Knepley 
9184a6e0b375SMatthew 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.
9185a6e0b375SMatthew 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
9186a6e0b375SMatthew 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
9187a6e0b375SMatthew 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.
9188a6e0b375SMatthew G. Knepley 
9189a6e0b375SMatthew G. Knepley   Level: intermediate
9190a6e0b375SMatthew G. Knepley 
9191a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9192a6e0b375SMatthew G. Knepley @*/
91938c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
91948c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
91958c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
91968c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9197191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
91988c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
91998c6c5593SMatthew G. Knepley {
92008c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
92018c6c5593SMatthew G. Knepley 
92028c6c5593SMatthew G. Knepley   PetscFunctionBegin;
92038c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
92048c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
92058c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
92062c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfieldlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
92078c6c5593SMatthew G. Knepley   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
92088c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
92098c6c5593SMatthew G. Knepley }
92108c6c5593SMatthew G. Knepley 
9211a6e0b375SMatthew G. Knepley /*@C
9212a6e0b375SMatthew 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.
9213a6e0b375SMatthew G. Knepley 
9214a6e0b375SMatthew G. Knepley   Not collective
9215a6e0b375SMatthew G. Knepley 
9216a6e0b375SMatthew G. Knepley   Input Parameters:
9217a6e0b375SMatthew G. Knepley + dm      - The DM
9218a6e0b375SMatthew G. Knepley . time    - The time
9219a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
9220a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
9221a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
9222a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9223a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9224a6e0b375SMatthew G. Knepley . localU  - The input field vector
9225a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9226a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9227a6e0b375SMatthew G. Knepley 
9228a6e0b375SMatthew G. Knepley   Output Parameter:
9229a6e0b375SMatthew G. Knepley . localX  - The output vector
9230a6e0b375SMatthew G. Knepley 
9231a6e0b375SMatthew G. Knepley    Calling sequence of func:
9232a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9233a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9234a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9235a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9236a6e0b375SMatthew G. Knepley 
9237a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
9238a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
9239a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9240a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
9241a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9242a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
9243a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9244a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9245a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9246a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9247a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9248a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9249a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9250a6e0b375SMatthew G. Knepley .  t            - The current time
9251a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
9252a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
9253a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
9254a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
9255a6e0b375SMatthew G. Knepley 
9256a6e0b375SMatthew 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.
9257a6e0b375SMatthew 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
9258a6e0b375SMatthew 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
9259a6e0b375SMatthew 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.
9260a6e0b375SMatthew G. Knepley 
9261a6e0b375SMatthew G. Knepley   Level: intermediate
9262a6e0b375SMatthew G. Knepley 
9263a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9264a6e0b375SMatthew G. Knepley @*/
92651c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
92668c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
92678c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
92688c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9269191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
92708c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
92718c6c5593SMatthew G. Knepley {
92728c6c5593SMatthew G. Knepley   PetscErrorCode ierr;
92738c6c5593SMatthew G. Knepley 
92748c6c5593SMatthew G. Knepley   PetscFunctionBegin;
92758c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9276064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9277064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
92782c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
92791c531cf8SMatthew G. Knepley   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
92808c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
92818c6c5593SMatthew G. Knepley }
92828c6c5593SMatthew G. Knepley 
92832716604bSToby Isaac /*@C
9284ece3a9fcSMatthew 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.
9285ece3a9fcSMatthew G. Knepley 
9286ece3a9fcSMatthew G. Knepley   Not collective
9287ece3a9fcSMatthew G. Knepley 
9288ece3a9fcSMatthew G. Knepley   Input Parameters:
9289ece3a9fcSMatthew G. Knepley + dm      - The DM
9290ece3a9fcSMatthew G. Knepley . time    - The time
9291ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
9292ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
9293ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
9294ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9295ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9296ece3a9fcSMatthew G. Knepley . localU  - The input field vector
9297ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9298ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
9299ece3a9fcSMatthew G. Knepley 
9300ece3a9fcSMatthew G. Knepley   Output Parameter:
9301ece3a9fcSMatthew G. Knepley . localX  - The output vector
9302ece3a9fcSMatthew G. Knepley 
9303ece3a9fcSMatthew G. Knepley    Calling sequence of func:
9304ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9305ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9306ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9307ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9308ece3a9fcSMatthew G. Knepley 
9309ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
9310ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
9311ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9312ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
9313ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9314ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
9315ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9316ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9317ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9318ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9319ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9320ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9321ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9322ece3a9fcSMatthew G. Knepley .  t            - The current time
9323ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
9324ece3a9fcSMatthew G. Knepley .  n            - The face normal
9325ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
9326ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
9327ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
9328ece3a9fcSMatthew G. Knepley 
9329ece3a9fcSMatthew G. Knepley   Note:
9330ece3a9fcSMatthew 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.
9331ece3a9fcSMatthew 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
9332ece3a9fcSMatthew 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
9333ece3a9fcSMatthew 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.
9334ece3a9fcSMatthew G. Knepley 
9335ece3a9fcSMatthew G. Knepley   Level: intermediate
9336ece3a9fcSMatthew G. Knepley 
9337ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9338ece3a9fcSMatthew G. Knepley @*/
9339ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
9340ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
9341ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9342ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9343ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
9344ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
9345ece3a9fcSMatthew G. Knepley {
9346ece3a9fcSMatthew G. Knepley   PetscErrorCode ierr;
9347ece3a9fcSMatthew G. Knepley 
9348ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
9349ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9350064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9351064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
93522c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->projectbdfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
9353ece3a9fcSMatthew G. Knepley   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
9354ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
9355ece3a9fcSMatthew G. Knepley }
9356ece3a9fcSMatthew G. Knepley 
9357ece3a9fcSMatthew G. Knepley /*@C
93582716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
93592716604bSToby Isaac 
93602716604bSToby Isaac   Input Parameters:
93612716604bSToby Isaac + dm    - The DM
93620709b2feSToby Isaac . time  - The time
93632716604bSToby Isaac . funcs - The functions to evaluate for each field component
93642716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9365574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
93662716604bSToby Isaac 
93672716604bSToby Isaac   Output Parameter:
93682716604bSToby Isaac . diff - The diff ||u - u_h||_2
93692716604bSToby Isaac 
93702716604bSToby Isaac   Level: developer
93712716604bSToby Isaac 
93721189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
93732716604bSToby Isaac @*/
93740709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
93752716604bSToby Isaac {
93762716604bSToby Isaac   PetscErrorCode ierr;
93772716604bSToby Isaac 
93782716604bSToby Isaac   PetscFunctionBegin;
93792716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9380b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
93812c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computel2diff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
93820709b2feSToby Isaac   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
93832716604bSToby Isaac   PetscFunctionReturn(0);
93842716604bSToby Isaac }
9385b698f381SToby Isaac 
9386b698f381SToby Isaac /*@C
9387b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
9388b698f381SToby Isaac 
9389d083f849SBarry Smith   Collective on dm
9390d083f849SBarry Smith 
9391b698f381SToby Isaac   Input Parameters:
9392b698f381SToby Isaac + dm    - The DM
9393b698f381SToby Isaac , time  - The time
9394b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
9395b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9396574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
9397b698f381SToby Isaac - n     - The vector to project along
9398b698f381SToby Isaac 
9399b698f381SToby Isaac   Output Parameter:
9400b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
9401b698f381SToby Isaac 
9402b698f381SToby Isaac   Level: developer
9403b698f381SToby Isaac 
9404b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
9405b698f381SToby Isaac @*/
9406b698f381SToby 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)
9407b698f381SToby Isaac {
9408b698f381SToby Isaac   PetscErrorCode ierr;
9409b698f381SToby Isaac 
9410b698f381SToby Isaac   PetscFunctionBegin;
9411b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9412b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
94132c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computel2gradientdiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
9414b698f381SToby Isaac   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
9415b698f381SToby Isaac   PetscFunctionReturn(0);
9416b698f381SToby Isaac }
9417b698f381SToby Isaac 
94182a16baeaSToby Isaac /*@C
94192a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
94202a16baeaSToby Isaac 
9421d083f849SBarry Smith   Collective on dm
9422d083f849SBarry Smith 
94232a16baeaSToby Isaac   Input Parameters:
94242a16baeaSToby Isaac + dm    - The DM
94252a16baeaSToby Isaac . time  - The time
94262a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
94272a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9428574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
94292a16baeaSToby Isaac 
94302a16baeaSToby Isaac   Output Parameter:
94312a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
94322a16baeaSToby Isaac 
94332a16baeaSToby Isaac   Level: developer
94342a16baeaSToby Isaac 
94351189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
94362a16baeaSToby Isaac @*/
94371189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
94382a16baeaSToby Isaac {
94392a16baeaSToby Isaac   PetscErrorCode ierr;
94402a16baeaSToby Isaac 
94412a16baeaSToby Isaac   PetscFunctionBegin;
94422a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
94432a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
94442c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->computel2fielddiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
94452a16baeaSToby Isaac   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
94462a16baeaSToby Isaac   PetscFunctionReturn(0);
94472a16baeaSToby Isaac }
94482a16baeaSToby Isaac 
9449df0b854cSToby Isaac /*@C
9450502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
9451502a2867SDave May 
9452502a2867SDave May  Not Collective
9453502a2867SDave May 
9454502a2867SDave May  Input Parameter:
9455502a2867SDave May .  dm    - The DM
9456502a2867SDave May 
94570a19bb7dSprj-  Output Parameters:
94580a19bb7dSprj- +  nranks - the number of neighbours
94590a19bb7dSprj- -  ranks - the neighbors ranks
9460502a2867SDave May 
9461502a2867SDave May  Notes:
9462502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
9463502a2867SDave May 
9464502a2867SDave May  Level: beginner
9465502a2867SDave May 
9466dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
9467502a2867SDave May @*/
9468502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
9469502a2867SDave May {
9470502a2867SDave May   PetscErrorCode ierr;
9471502a2867SDave May 
9472502a2867SDave May   PetscFunctionBegin;
9473502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
94742c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!dm->ops->getneighbors,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
9475502a2867SDave May   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
9476502a2867SDave May   PetscFunctionReturn(0);
9477502a2867SDave May }
9478502a2867SDave May 
9479531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
9480531c7667SBarry Smith 
9481531c7667SBarry Smith /*
9482531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
9483531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
9484531c7667SBarry Smith */
9485531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
9486531c7667SBarry Smith {
9487531c7667SBarry Smith   PetscErrorCode ierr;
9488531c7667SBarry Smith 
9489531c7667SBarry Smith   PetscFunctionBegin;
9490531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9491531c7667SBarry Smith     Vec x1local;
9492531c7667SBarry Smith     DM  dm;
9493531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
94942c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!dm,PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
9495531c7667SBarry Smith     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
9496531c7667SBarry Smith     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9497531c7667SBarry Smith     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
9498531c7667SBarry Smith     x1   = x1local;
9499531c7667SBarry Smith   }
9500531c7667SBarry Smith   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
9501531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9502531c7667SBarry Smith     DM  dm;
9503531c7667SBarry Smith     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
9504531c7667SBarry Smith     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
9505531c7667SBarry Smith   }
9506531c7667SBarry Smith   PetscFunctionReturn(0);
9507531c7667SBarry Smith }
9508531c7667SBarry Smith 
9509531c7667SBarry Smith /*@
9510531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
9511531c7667SBarry Smith 
9512531c7667SBarry Smith     Input Parameter:
9513531c7667SBarry Smith .    coloring - the MatFDColoring object
9514531c7667SBarry Smith 
951595452b02SPatrick Sanan     Developer Notes:
951695452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
9517531c7667SBarry Smith 
95181b266c99SBarry Smith     Level: advanced
95191b266c99SBarry Smith 
9520531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
9521531c7667SBarry Smith @*/
9522531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
9523531c7667SBarry Smith {
9524531c7667SBarry Smith   PetscFunctionBegin;
9525531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
9526531c7667SBarry Smith   PetscFunctionReturn(0);
9527531c7667SBarry Smith }
95288320bc6fSPatrick Sanan 
95298320bc6fSPatrick Sanan /*@
95308320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
95318320bc6fSPatrick Sanan 
95328320bc6fSPatrick Sanan     Collective
95338320bc6fSPatrick Sanan 
95348320bc6fSPatrick Sanan     Input Parameters:
9535a5bc1bf3SBarry Smith +    dm1 - the first DM
95368320bc6fSPatrick Sanan -    dm2 - the second DM
95378320bc6fSPatrick Sanan 
95388320bc6fSPatrick Sanan     Output Parameters:
95398320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
95408320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
95418320bc6fSPatrick Sanan 
95428320bc6fSPatrick Sanan     Notes:
95438320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
95443d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
95458320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
95463d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
95473d862458SPatrick Sanan     decomposition, but hold different data.
95488320bc6fSPatrick Sanan 
95498320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
95508320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
95518320bc6fSPatrick Sanan 
95528320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
95538320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
95548320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
95558320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
95568320bc6fSPatrick Sanan 
95578320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
95588320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
95598320bc6fSPatrick Sanan .vb
95608320bc6fSPatrick Sanan   ...
95618320bc6fSPatrick Sanan   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
95628320bc6fSPatrick Sanan   if (set && compatible)  {
95638320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
95648320bc6fSPatrick Sanan     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
95653d862458SPatrick Sanan     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
95668320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
95678320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
95688320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
95698320bc6fSPatrick Sanan       }
95708320bc6fSPatrick Sanan     }
95718320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
95728320bc6fSPatrick Sanan     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
95738320bc6fSPatrick Sanan   } else {
95748320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
95758320bc6fSPatrick Sanan   }
95768320bc6fSPatrick Sanan   ...
95778320bc6fSPatrick Sanan .ve
95788320bc6fSPatrick Sanan 
95798320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
95808320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
95818320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
95828320bc6fSPatrick Sanan     always check the "set" output parameter.
95838320bc6fSPatrick Sanan 
95848320bc6fSPatrick Sanan     A DM is always compatible with itself.
95858320bc6fSPatrick Sanan 
95868320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
95878320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
95888320bc6fSPatrick Sanan     incompatible.
95898320bc6fSPatrick Sanan 
95908320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
95918320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
95928320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
95938320bc6fSPatrick Sanan 
95948320bc6fSPatrick Sanan     Developer Notes:
95953d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
95963d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
9597a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
95988320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
95998320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
96003d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
96013d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
96028320bc6fSPatrick Sanan 
96038320bc6fSPatrick Sanan     Level: advanced
96048320bc6fSPatrick Sanan 
96053d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
96068320bc6fSPatrick Sanan @*/
96078320bc6fSPatrick Sanan 
9608a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
96098320bc6fSPatrick Sanan {
96108320bc6fSPatrick Sanan   PetscErrorCode ierr;
96118320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
96128320bc6fSPatrick Sanan   DMType         type,type2;
96138320bc6fSPatrick Sanan   PetscBool      sameType;
96148320bc6fSPatrick Sanan 
96158320bc6fSPatrick Sanan   PetscFunctionBegin;
9616a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
96178320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
96188320bc6fSPatrick Sanan 
96198320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
9620a5bc1bf3SBarry Smith   if (dm1 == dm2) {
96218320bc6fSPatrick Sanan     *set = PETSC_TRUE;
96228320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
96238320bc6fSPatrick Sanan     PetscFunctionReturn(0);
96248320bc6fSPatrick Sanan   }
96258320bc6fSPatrick Sanan 
96268320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
96278320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
96288320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
96298320bc6fSPatrick Sanan      determined by the implementation-specific logic */
9630ffc4695bSBarry Smith   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRMPI(ierr);
96318320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
96328320bc6fSPatrick Sanan     *set = PETSC_TRUE;
96338320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
96348320bc6fSPatrick Sanan     PetscFunctionReturn(0);
96358320bc6fSPatrick Sanan   }
96368320bc6fSPatrick Sanan 
96378320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
9638a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
9639a5bc1bf3SBarry Smith     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
9640b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
96418320bc6fSPatrick Sanan   }
96428320bc6fSPatrick Sanan 
9643a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
96448320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
9645a5bc1bf3SBarry Smith   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
96468320bc6fSPatrick Sanan   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
96478320bc6fSPatrick Sanan   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
96488320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
9649a5bc1bf3SBarry Smith     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
96508320bc6fSPatrick Sanan   } else {
96518320bc6fSPatrick Sanan     *set = PETSC_FALSE;
96528320bc6fSPatrick Sanan   }
96538320bc6fSPatrick Sanan   PetscFunctionReturn(0);
96548320bc6fSPatrick Sanan }
9655c0f0dcc3SMatthew G. Knepley 
9656c0f0dcc3SMatthew G. Knepley /*@C
9657c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
9658c0f0dcc3SMatthew G. Knepley 
9659c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9660c0f0dcc3SMatthew G. Knepley 
9661c0f0dcc3SMatthew G. Knepley   Input Parameters:
9662c0f0dcc3SMatthew G. Knepley + DM - the DM
9663c0f0dcc3SMatthew G. Knepley . f - the monitor function
9664c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
9665c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
9666c0f0dcc3SMatthew G. Knepley 
9667c0f0dcc3SMatthew G. Knepley   Options Database Keys:
9668c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
9669c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
9670c0f0dcc3SMatthew G. Knepley 
9671c0f0dcc3SMatthew G. Knepley   Notes:
9672c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
9673c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
9674c0f0dcc3SMatthew G. Knepley   order in which they were set.
9675c0f0dcc3SMatthew G. Knepley 
9676c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9677c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9678c0f0dcc3SMatthew G. Knepley 
9679c0f0dcc3SMatthew G. Knepley   Level: intermediate
9680c0f0dcc3SMatthew G. Knepley 
9681c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9682c0f0dcc3SMatthew G. Knepley @*/
9683c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9684c0f0dcc3SMatthew G. Knepley {
9685c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9686c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9687c0f0dcc3SMatthew G. Knepley 
9688c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9689c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9690c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9691c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9692c0f0dcc3SMatthew G. Knepley 
9693c0f0dcc3SMatthew G. Knepley     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
9694c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9695c0f0dcc3SMatthew G. Knepley   }
96962c71b3e2SJacob Faibussowitsch   PetscCheckFalse(dm->numbermonitors >= MAXDMMONITORS,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9697c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9698c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9699c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9700c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9701c0f0dcc3SMatthew G. Knepley }
9702c0f0dcc3SMatthew G. Knepley 
9703c0f0dcc3SMatthew G. Knepley /*@
9704c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9705c0f0dcc3SMatthew G. Knepley 
9706c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9707c0f0dcc3SMatthew G. Knepley 
9708c0f0dcc3SMatthew G. Knepley   Input Parameter:
9709c0f0dcc3SMatthew G. Knepley . dm - the DM
9710c0f0dcc3SMatthew G. Knepley 
9711c0f0dcc3SMatthew G. Knepley   Options Database Key:
9712c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9713c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9714c0f0dcc3SMatthew G. Knepley   set via the options database
9715c0f0dcc3SMatthew G. Knepley 
9716c0f0dcc3SMatthew G. Knepley   Notes:
9717c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9718c0f0dcc3SMatthew G. Knepley 
9719c0f0dcc3SMatthew G. Knepley   Level: intermediate
9720c0f0dcc3SMatthew G. Knepley 
9721c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9722c0f0dcc3SMatthew G. Knepley @*/
9723c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9724c0f0dcc3SMatthew G. Knepley {
9725c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9726c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9727c0f0dcc3SMatthew G. Knepley 
9728c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9729c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9730c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9731c0f0dcc3SMatthew G. Knepley     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
9732c0f0dcc3SMatthew G. Knepley   }
9733c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9734c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9735c0f0dcc3SMatthew G. Knepley }
9736c0f0dcc3SMatthew G. Knepley 
9737c0f0dcc3SMatthew G. Knepley /*@C
9738c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9739c0f0dcc3SMatthew G. Knepley 
9740c0f0dcc3SMatthew G. Knepley   Collective on DM
9741c0f0dcc3SMatthew G. Knepley 
9742c0f0dcc3SMatthew G. Knepley   Input Parameters:
9743c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9744c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9745c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9746c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9747c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9748c0f0dcc3SMatthew 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
9749c0f0dcc3SMatthew G. Knepley 
9750c0f0dcc3SMatthew G. Knepley   Output Parameter:
9751c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9752c0f0dcc3SMatthew G. Knepley 
9753c0f0dcc3SMatthew G. Knepley   Level: developer
9754c0f0dcc3SMatthew G. Knepley 
9755c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9756c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9757c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9758c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9759c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9760c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9761c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9762c0f0dcc3SMatthew G. Knepley @*/
9763c0f0dcc3SMatthew 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)
9764c0f0dcc3SMatthew G. Knepley {
9765c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9766c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9767c0f0dcc3SMatthew G. Knepley   PetscErrorCode    ierr;
9768c0f0dcc3SMatthew G. Knepley 
9769c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9770c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9771c0f0dcc3SMatthew G. Knepley   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
9772c0f0dcc3SMatthew G. Knepley   if (*flg) {
9773c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9774c0f0dcc3SMatthew G. Knepley 
9775c0f0dcc3SMatthew G. Knepley     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
9776c0f0dcc3SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
9777c0f0dcc3SMatthew G. Knepley     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
9778c0f0dcc3SMatthew G. Knepley     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
9779c0f0dcc3SMatthew G. Knepley   }
9780c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9781c0f0dcc3SMatthew G. Knepley }
9782c0f0dcc3SMatthew G. Knepley 
9783c0f0dcc3SMatthew G. Knepley /*@
9784c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9785c0f0dcc3SMatthew G. Knepley 
9786c0f0dcc3SMatthew G. Knepley    Collective on DM
9787c0f0dcc3SMatthew G. Knepley 
9788c0f0dcc3SMatthew G. Knepley    Input Parameters:
9789c0f0dcc3SMatthew G. Knepley .  dm - The DM
9790c0f0dcc3SMatthew G. Knepley 
9791c0f0dcc3SMatthew G. Knepley    Level: developer
9792c0f0dcc3SMatthew G. Knepley 
9793c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9794c0f0dcc3SMatthew G. Knepley @*/
9795c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9796c0f0dcc3SMatthew G. Knepley {
9797c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9798c0f0dcc3SMatthew G. Knepley   PetscErrorCode ierr;
9799c0f0dcc3SMatthew G. Knepley 
9800c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9801c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9802c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9803c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9804c0f0dcc3SMatthew G. Knepley     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
9805c0f0dcc3SMatthew G. Knepley   }
9806c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9807c0f0dcc3SMatthew G. Knepley }
98082e4af2aeSMatthew G. Knepley 
98092e4af2aeSMatthew G. Knepley /*@
98102e4af2aeSMatthew G. Knepley   DMComputeError - Computes the error assuming the user has given exact solution functions
98112e4af2aeSMatthew G. Knepley 
98122e4af2aeSMatthew G. Knepley   Collective on DM
98132e4af2aeSMatthew G. Knepley 
98142e4af2aeSMatthew G. Knepley   Input Parameters:
98152e4af2aeSMatthew G. Knepley + dm     - The DM
98166b867d5aSJose E. Roman - sol    - The solution vector
98172e4af2aeSMatthew G. Knepley 
98186b867d5aSJose E. Roman   Input/Output Parameter:
98196b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output
98206b867d5aSJose E. Roman            contains the error in each field
98216b867d5aSJose E. Roman 
98226b867d5aSJose E. Roman   Output Parameter:
98236b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL)
98242e4af2aeSMatthew G. Knepley 
98252e4af2aeSMatthew G. Knepley   Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber().
98262e4af2aeSMatthew G. Knepley 
98272e4af2aeSMatthew G. Knepley   Level: developer
98282e4af2aeSMatthew G. Knepley 
98292e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber()
98302e4af2aeSMatthew G. Knepley @*/
98312e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec)
98322e4af2aeSMatthew G. Knepley {
98332e4af2aeSMatthew G. Knepley   PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *);
98342e4af2aeSMatthew G. Knepley   void            **ctxs;
98352e4af2aeSMatthew G. Knepley   PetscReal         time;
98362e4af2aeSMatthew G. Knepley   PetscInt          Nf, f, Nds, s;
98372e4af2aeSMatthew G. Knepley   PetscErrorCode    ierr;
98382e4af2aeSMatthew G. Knepley 
98392e4af2aeSMatthew G. Knepley   PetscFunctionBegin;
98402e4af2aeSMatthew G. Knepley   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
98412e4af2aeSMatthew G. Knepley   ierr = PetscCalloc2(Nf, &exactSol, Nf, &ctxs);CHKERRQ(ierr);
98422e4af2aeSMatthew G. Knepley   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
98432e4af2aeSMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
98442e4af2aeSMatthew G. Knepley     PetscDS         ds;
98452e4af2aeSMatthew G. Knepley     DMLabel         label;
98462e4af2aeSMatthew G. Knepley     IS              fieldIS;
98472e4af2aeSMatthew G. Knepley     const PetscInt *fields;
98482e4af2aeSMatthew G. Knepley     PetscInt        dsNf;
98492e4af2aeSMatthew G. Knepley 
98502e4af2aeSMatthew G. Knepley     ierr = DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds);CHKERRQ(ierr);
98512e4af2aeSMatthew G. Knepley     ierr = PetscDSGetNumFields(ds, &dsNf);CHKERRQ(ierr);
98522e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISGetIndices(fieldIS, &fields);CHKERRQ(ierr);}
98532e4af2aeSMatthew G. Knepley     for (f = 0; f < dsNf; ++f) {
98542e4af2aeSMatthew G. Knepley       const PetscInt field = fields[f];
98552e4af2aeSMatthew G. Knepley       ierr = PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]);CHKERRQ(ierr);
98562e4af2aeSMatthew G. Knepley     }
98572e4af2aeSMatthew G. Knepley     if (fieldIS) {ierr = ISRestoreIndices(fieldIS, &fields);CHKERRQ(ierr);}
98582e4af2aeSMatthew G. Knepley   }
98592e4af2aeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
98602c71b3e2SJacob Faibussowitsch     PetscCheckFalse(!exactSol[f],PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "DS must contain exact solution functions in order to calculate error, missing for field %D", f);
98612e4af2aeSMatthew G. Knepley   }
98622e4af2aeSMatthew G. Knepley   ierr = DMGetOutputSequenceNumber(dm, NULL, &time);CHKERRQ(ierr);
98632e4af2aeSMatthew G. Knepley   if (errors) {ierr = DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors);CHKERRQ(ierr);}
98642e4af2aeSMatthew G. Knepley   if (errorVec) {
98652e4af2aeSMatthew G. Knepley     DM             edm;
98662e4af2aeSMatthew G. Knepley     DMPolytopeType ct;
98672e4af2aeSMatthew G. Knepley     PetscBool      simplex;
98682e4af2aeSMatthew G. Knepley     PetscInt       dim, cStart, Nf;
98692e4af2aeSMatthew G. Knepley 
98702e4af2aeSMatthew G. Knepley     ierr = DMClone(dm, &edm);CHKERRQ(ierr);
98712e4af2aeSMatthew G. Knepley     ierr = DMGetDimension(edm, &dim);CHKERRQ(ierr);
98722e4af2aeSMatthew G. Knepley     ierr = DMPlexGetHeightStratum(dm, 0, &cStart, NULL);CHKERRQ(ierr);
98732e4af2aeSMatthew G. Knepley     ierr = DMPlexGetCellType(dm, cStart, &ct);CHKERRQ(ierr);
98742e4af2aeSMatthew G. Knepley     simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
98752e4af2aeSMatthew G. Knepley     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
98762e4af2aeSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
98772e4af2aeSMatthew G. Knepley       PetscFE         fe, efe;
98782e4af2aeSMatthew G. Knepley       PetscQuadrature q;
98792e4af2aeSMatthew G. Knepley       const char     *name;
98802e4af2aeSMatthew G. Knepley 
98812e4af2aeSMatthew G. Knepley       ierr = DMGetField(dm, f, NULL, (PetscObject *) &fe);CHKERRQ(ierr);
98822e4af2aeSMatthew G. Knepley       ierr = PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe);CHKERRQ(ierr);
98832e4af2aeSMatthew G. Knepley       ierr = PetscObjectGetName((PetscObject) fe, &name);CHKERRQ(ierr);
98842e4af2aeSMatthew G. Knepley       ierr = PetscObjectSetName((PetscObject) efe, name);CHKERRQ(ierr);
98852e4af2aeSMatthew G. Knepley       ierr = PetscFEGetQuadrature(fe, &q);CHKERRQ(ierr);
98862e4af2aeSMatthew G. Knepley       ierr = PetscFESetQuadrature(efe, q);CHKERRQ(ierr);
98872e4af2aeSMatthew G. Knepley       ierr = DMSetField(edm, f, NULL, (PetscObject) efe);CHKERRQ(ierr);
98882e4af2aeSMatthew G. Knepley       ierr = PetscFEDestroy(&efe);CHKERRQ(ierr);
98892e4af2aeSMatthew G. Knepley     }
98902e4af2aeSMatthew G. Knepley     ierr = DMCreateDS(edm);CHKERRQ(ierr);
98912e4af2aeSMatthew G. Knepley 
98921e1ea65dSPierre Jolivet     ierr = DMCreateGlobalVector(edm, errorVec);CHKERRQ(ierr);
98932e4af2aeSMatthew G. Knepley     ierr = PetscObjectSetName((PetscObject) *errorVec, "Error");CHKERRQ(ierr);
98942e4af2aeSMatthew G. Knepley     ierr = DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec);CHKERRQ(ierr);
98952e4af2aeSMatthew G. Knepley     ierr = DMDestroy(&edm);CHKERRQ(ierr);
98962e4af2aeSMatthew G. Knepley   }
98972e4af2aeSMatthew G. Knepley   ierr = PetscFree2(exactSol, ctxs);CHKERRQ(ierr);
98982e4af2aeSMatthew G. Knepley   PetscFunctionReturn(0);
98992e4af2aeSMatthew G. Knepley }
99009a2a23afSMatthew G. Knepley 
99019a2a23afSMatthew G. Knepley /*@
99029a2a23afSMatthew G. Knepley   DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM
99039a2a23afSMatthew G. Knepley 
99049a2a23afSMatthew G. Knepley   Not collective
99059a2a23afSMatthew G. Knepley 
99069a2a23afSMatthew G. Knepley   Input Parameter:
99079a2a23afSMatthew G. Knepley . dm     - The DM
99089a2a23afSMatthew G. Knepley 
99099a2a23afSMatthew G. Knepley   Output Parameter:
9910a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors
99119a2a23afSMatthew G. Knepley 
99129a2a23afSMatthew G. Knepley   Level: advanced
99139a2a23afSMatthew G. Knepley 
99149a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
99159a2a23afSMatthew G. Knepley @*/
99169a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux)
99179a2a23afSMatthew G. Knepley {
99189a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
99199a2a23afSMatthew G. Knepley 
99209a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99219a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99229a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetSize(dm->auxData, numAux);CHKERRQ(ierr);
99239a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99249a2a23afSMatthew G. Knepley }
99259a2a23afSMatthew G. Knepley 
99269a2a23afSMatthew G. Knepley /*@
99279a2a23afSMatthew G. Knepley   DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value
99289a2a23afSMatthew G. Knepley 
99299a2a23afSMatthew G. Knepley   Not collective
99309a2a23afSMatthew G. Knepley 
99319a2a23afSMatthew G. Knepley   Input Parameters:
99329a2a23afSMatthew G. Knepley + dm     - The DM
99339a2a23afSMatthew G. Knepley . label  - The DMLabel
99349a2a23afSMatthew G. Knepley - value  - The label value indicating the region
99359a2a23afSMatthew G. Knepley 
99369a2a23afSMatthew G. Knepley   Output Parameter:
99379a2a23afSMatthew G. Knepley . aux    - The Vec holding auxiliary field data
99389a2a23afSMatthew G. Knepley 
993904c51a94SMatthew G. Knepley   Note: If no auxiliary vector is found for this (label, value), (NULL, 0) is checked as well.
994004c51a94SMatthew G. Knepley 
99419a2a23afSMatthew G. Knepley   Level: advanced
99429a2a23afSMatthew G. Knepley 
99439a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec()
99449a2a23afSMatthew G. Knepley @*/
99459a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec *aux)
99469a2a23afSMatthew G. Knepley {
994704c51a94SMatthew G. Knepley   PetscHashAuxKey key, wild = {NULL, 0};
994804c51a94SMatthew G. Knepley   PetscBool       has;
99499a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
99509a2a23afSMatthew G. Knepley 
99519a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99529a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99539a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
99549a2a23afSMatthew G. Knepley   key.label = label;
99559a2a23afSMatthew G. Knepley   key.value = value;
995604c51a94SMatthew G. Knepley   ierr = PetscHMapAuxHas(dm->auxData, key, &has);CHKERRQ(ierr);
995704c51a94SMatthew G. Knepley   if (has) {ierr = PetscHMapAuxGet(dm->auxData, key,  aux);CHKERRQ(ierr);}
995804c51a94SMatthew G. Knepley   else     {ierr = PetscHMapAuxGet(dm->auxData, wild, aux);CHKERRQ(ierr);}
99599a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99609a2a23afSMatthew G. Knepley }
99619a2a23afSMatthew G. Knepley 
99629a2a23afSMatthew G. Knepley /*@
99639a2a23afSMatthew G. Knepley   DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value
99649a2a23afSMatthew G. Knepley 
99659a2a23afSMatthew G. Knepley   Not collective
99669a2a23afSMatthew G. Knepley 
99679a2a23afSMatthew G. Knepley   Input Parameters:
99689a2a23afSMatthew G. Knepley + dm     - The DM
99699a2a23afSMatthew G. Knepley . label  - The DMLabel
99709a2a23afSMatthew G. Knepley . value  - The label value indicating the region
99719a2a23afSMatthew G. Knepley - aux    - The Vec holding auxiliary field data
99729a2a23afSMatthew G. Knepley 
99739a2a23afSMatthew G. Knepley   Level: advanced
99749a2a23afSMatthew G. Knepley 
99759a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec()
99769a2a23afSMatthew G. Knepley @*/
99779a2a23afSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, Vec aux)
99789a2a23afSMatthew G. Knepley {
99799a2a23afSMatthew G. Knepley   Vec             old;
99809a2a23afSMatthew G. Knepley   PetscHashAuxKey key;
99819a2a23afSMatthew G. Knepley   PetscErrorCode  ierr;
99829a2a23afSMatthew G. Knepley 
99839a2a23afSMatthew G. Knepley   PetscFunctionBegin;
99849a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
99859a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
99869a2a23afSMatthew G. Knepley   key.label = label;
99879a2a23afSMatthew G. Knepley   key.value = value;
99889a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGet(dm->auxData, key, &old);CHKERRQ(ierr);
99899a2a23afSMatthew G. Knepley   ierr = PetscObjectReference((PetscObject) aux);CHKERRQ(ierr);
99909a2a23afSMatthew G. Knepley   ierr = PetscObjectDereference((PetscObject) old);CHKERRQ(ierr);
99919a2a23afSMatthew G. Knepley   if (!aux) {ierr = PetscHMapAuxDel(dm->auxData, key);CHKERRQ(ierr);}
99929a2a23afSMatthew G. Knepley   else      {ierr = PetscHMapAuxSet(dm->auxData, key, aux);CHKERRQ(ierr);}
99939a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
99949a2a23afSMatthew G. Knepley }
99959a2a23afSMatthew G. Knepley 
99969a2a23afSMatthew G. Knepley /*@C
99979a2a23afSMatthew G. Knepley   DMGetAuxiliaryLabels - Get the labels and values for all auxiliary vectors in this DM
99989a2a23afSMatthew G. Knepley 
99999a2a23afSMatthew G. Knepley   Not collective
100009a2a23afSMatthew G. Knepley 
100019a2a23afSMatthew G. Knepley   Input Parameter:
100029a2a23afSMatthew G. Knepley . dm      - The DM
100039a2a23afSMatthew G. Knepley 
100049a2a23afSMatthew G. Knepley   Output Parameters:
100059a2a23afSMatthew G. Knepley + labels  - The DMLabels for each Vec
100069a2a23afSMatthew G. Knepley - values  - The label values for each Vec
100079a2a23afSMatthew G. Knepley 
100089a2a23afSMatthew G. Knepley   Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec().
100099a2a23afSMatthew G. Knepley 
100109a2a23afSMatthew G. Knepley   Level: advanced
100119a2a23afSMatthew G. Knepley 
100129a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
100139a2a23afSMatthew G. Knepley @*/
100149a2a23afSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[])
100159a2a23afSMatthew G. Knepley {
100169a2a23afSMatthew G. Knepley   PetscHashAuxKey *keys;
100179a2a23afSMatthew G. Knepley   PetscInt         n, i, off = 0;
100189a2a23afSMatthew G. Knepley   PetscErrorCode   ierr;
100199a2a23afSMatthew G. Knepley 
100209a2a23afSMatthew G. Knepley   PetscFunctionBegin;
100219a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
100229a2a23afSMatthew G. Knepley   PetscValidPointer(labels, 2);
100239a2a23afSMatthew G. Knepley   PetscValidPointer(values, 3);
100249a2a23afSMatthew G. Knepley   ierr = DMGetNumAuxiliaryVec(dm, &n);CHKERRQ(ierr);
100259a2a23afSMatthew G. Knepley   ierr = PetscMalloc1(n, &keys);CHKERRQ(ierr);
100269a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxGetKeys(dm->auxData, &off, keys);CHKERRQ(ierr);
100279a2a23afSMatthew G. Knepley   for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value;}
100289a2a23afSMatthew G. Knepley   ierr = PetscFree(keys);CHKERRQ(ierr);
100299a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
100309a2a23afSMatthew G. Knepley }
100319a2a23afSMatthew G. Knepley 
100329a2a23afSMatthew G. Knepley /*@
100339a2a23afSMatthew G. Knepley   DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM
100349a2a23afSMatthew G. Knepley 
100359a2a23afSMatthew G. Knepley   Not collective
100369a2a23afSMatthew G. Knepley 
100379a2a23afSMatthew G. Knepley   Input Parameter:
100389a2a23afSMatthew G. Knepley . dm    - The DM
100399a2a23afSMatthew G. Knepley 
100409a2a23afSMatthew G. Knepley   Output Parameter:
100419a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data
100429a2a23afSMatthew G. Knepley 
100439a2a23afSMatthew G. Knepley   Level: advanced
100449a2a23afSMatthew G. Knepley 
100459a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
100469a2a23afSMatthew G. Knepley @*/
100479a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew)
100489a2a23afSMatthew G. Knepley {
100499a2a23afSMatthew G. Knepley   PetscErrorCode ierr;
100509a2a23afSMatthew G. Knepley 
100519a2a23afSMatthew G. Knepley   PetscFunctionBegin;
100529a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
100539a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDestroy(&dmNew->auxData);CHKERRQ(ierr);
100549a2a23afSMatthew G. Knepley   ierr = PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData);CHKERRQ(ierr);
100559a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
100569a2a23afSMatthew G. Knepley }
10057b5a892a1SMatthew G. Knepley 
10058b5a892a1SMatthew G. Knepley /*@C
10059b5a892a1SMatthew G. Knepley   DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
10060b5a892a1SMatthew G. Knepley 
10061b5a892a1SMatthew G. Knepley   Not collective
10062b5a892a1SMatthew G. Knepley 
10063b5a892a1SMatthew G. Knepley   Input Parameters:
10064b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10065b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
10066b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
10067b5a892a1SMatthew G. Knepley 
10068b5a892a1SMatthew G. Knepley   Output Parameters:
10069b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
10070b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
10071b5a892a1SMatthew G. Knepley 
10072b5a892a1SMatthew G. Knepley   Level: advanced
10073b5a892a1SMatthew G. Knepley 
10074b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation()
10075b5a892a1SMatthew G. Knepley @*/
10076b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found)
10077b5a892a1SMatthew G. Knepley {
10078b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetConeSize(ct);
10079b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
10080b5a892a1SMatthew G. Knepley   PetscInt       o, c;
10081b5a892a1SMatthew G. Knepley 
10082b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10083b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
10084b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
10085b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o);
10086b5a892a1SMatthew G. Knepley 
10087b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break;
10088b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
10089b5a892a1SMatthew G. Knepley   }
10090b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
10091b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10092b5a892a1SMatthew G. Knepley }
10093b5a892a1SMatthew G. Knepley 
10094b5a892a1SMatthew G. Knepley /*@C
10095b5a892a1SMatthew G. Knepley   DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
10096b5a892a1SMatthew G. Knepley 
10097b5a892a1SMatthew G. Knepley   Not collective
10098b5a892a1SMatthew G. Knepley 
10099b5a892a1SMatthew G. Knepley   Input Parameters:
10100b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10101b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
10102b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
10103b5a892a1SMatthew G. Knepley 
10104b5a892a1SMatthew G. Knepley   Output Parameters:
10105b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
10106b5a892a1SMatthew G. Knepley 
10107b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
10108b5a892a1SMatthew G. Knepley 
10109b5a892a1SMatthew G. Knepley   Level: advanced
10110b5a892a1SMatthew G. Knepley 
10111b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation()
10112b5a892a1SMatthew G. Knepley @*/
10113b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
10114b5a892a1SMatthew G. Knepley {
10115b5a892a1SMatthew G. Knepley   PetscBool      found;
10116b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
10117b5a892a1SMatthew G. Knepley 
10118b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10119b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
101202c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
10121b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10122b5a892a1SMatthew G. Knepley }
10123b5a892a1SMatthew G. Knepley 
10124b5a892a1SMatthew G. Knepley /*@C
10125b5a892a1SMatthew G. Knepley   DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
10126b5a892a1SMatthew G. Knepley 
10127b5a892a1SMatthew G. Knepley   Not collective
10128b5a892a1SMatthew G. Knepley 
10129b5a892a1SMatthew G. Knepley   Input Parameters:
10130b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10131b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices
10132b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices
10133b5a892a1SMatthew G. Knepley 
10134b5a892a1SMatthew G. Knepley   Output Parameters:
10135b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
10136b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
10137b5a892a1SMatthew G. Knepley 
10138b5a892a1SMatthew G. Knepley   Level: advanced
10139b5a892a1SMatthew G. Knepley 
10140b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation()
10141b5a892a1SMatthew G. Knepley @*/
10142b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found)
10143b5a892a1SMatthew G. Knepley {
10144b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetNumVertices(ct);
10145b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
10146b5a892a1SMatthew G. Knepley   PetscInt       o, c;
10147b5a892a1SMatthew G. Knepley 
10148b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10149b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
10150b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
10151b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o);
10152b5a892a1SMatthew G. Knepley 
10153b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break;
10154b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
10155b5a892a1SMatthew G. Knepley   }
10156b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
10157b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10158b5a892a1SMatthew G. Knepley }
10159b5a892a1SMatthew G. Knepley 
10160b5a892a1SMatthew G. Knepley /*@C
10161b5a892a1SMatthew G. Knepley   DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
10162b5a892a1SMatthew G. Knepley 
10163b5a892a1SMatthew G. Knepley   Not collective
10164b5a892a1SMatthew G. Knepley 
10165b5a892a1SMatthew G. Knepley   Input Parameters:
10166b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
10167b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices
10168b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices
10169b5a892a1SMatthew G. Knepley 
10170b5a892a1SMatthew G. Knepley   Output Parameters:
10171b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
10172b5a892a1SMatthew G. Knepley 
10173b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
10174b5a892a1SMatthew G. Knepley 
10175b5a892a1SMatthew G. Knepley   Level: advanced
10176b5a892a1SMatthew G. Knepley 
10177b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation()
10178b5a892a1SMatthew G. Knepley @*/
10179b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
10180b5a892a1SMatthew G. Knepley {
10181b5a892a1SMatthew G. Knepley   PetscBool      found;
10182b5a892a1SMatthew G. Knepley   PetscErrorCode ierr;
10183b5a892a1SMatthew G. Knepley 
10184b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
10185b5a892a1SMatthew G. Knepley   ierr = DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found);CHKERRQ(ierr);
101862c71b3e2SJacob Faibussowitsch   PetscCheckFalse(!found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
10187b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
10188b5a892a1SMatthew G. Knepley }
10189012bc364SMatthew G. Knepley 
10190012bc364SMatthew G. Knepley /*@C
10191012bc364SMatthew G. Knepley   DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type
10192012bc364SMatthew G. Knepley 
10193012bc364SMatthew G. Knepley   Not collective
10194012bc364SMatthew G. Knepley 
10195012bc364SMatthew G. Knepley   Input Parameters:
10196012bc364SMatthew G. Knepley + ct    - The DMPolytopeType
10197012bc364SMatthew G. Knepley - point - Coordinates of the point
10198012bc364SMatthew G. Knepley 
10199012bc364SMatthew G. Knepley   Output Parameters:
10200012bc364SMatthew G. Knepley . inside  - Flag indicating whether the point is inside the reference cell of given type
10201012bc364SMatthew G. Knepley 
10202012bc364SMatthew G. Knepley   Level: advanced
10203012bc364SMatthew G. Knepley 
10204012bc364SMatthew G. Knepley .seealso: DMLocatePoints()
10205012bc364SMatthew G. Knepley @*/
10206012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside)
10207012bc364SMatthew G. Knepley {
10208012bc364SMatthew G. Knepley   PetscReal sum = 0.0;
10209012bc364SMatthew G. Knepley   PetscInt  d;
10210012bc364SMatthew G. Knepley 
10211012bc364SMatthew G. Knepley   PetscFunctionBegin;
10212012bc364SMatthew G. Knepley   *inside = PETSC_TRUE;
10213012bc364SMatthew G. Knepley   switch (ct) {
10214012bc364SMatthew G. Knepley   case DM_POLYTOPE_TRIANGLE:
10215012bc364SMatthew G. Knepley   case DM_POLYTOPE_TETRAHEDRON:
10216012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) {
10217012bc364SMatthew G. Knepley       if (point[d] < -1.0) {*inside = PETSC_FALSE; break;}
10218012bc364SMatthew G. Knepley       sum += point[d];
10219012bc364SMatthew G. Knepley     }
10220012bc364SMatthew G. Knepley     if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10221012bc364SMatthew G. Knepley     break;
10222012bc364SMatthew G. Knepley   case DM_POLYTOPE_QUADRILATERAL:
10223012bc364SMatthew G. Knepley   case DM_POLYTOPE_HEXAHEDRON:
10224012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d)
10225012bc364SMatthew G. Knepley       if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10226012bc364SMatthew G. Knepley     break;
10227012bc364SMatthew G. Knepley   default:
1022898921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]);
10229012bc364SMatthew G. Knepley   }
10230012bc364SMatthew G. Knepley   PetscFunctionReturn(0);
10231012bc364SMatthew G. Knepley }
10232