xref: /petsc/src/dm/interface/dm.c (revision 5b8ffe73e401e38cb7e96eff9f6101f2c297cda1)
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;
20*5b8ffe73SMark Adams PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, DM_CreateInterpolation, DM_CreateRestriction, DM_CreateInjection, DM_CreateMatrix, DM_CreateMassMatrix, 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 
50a4121054SBarry Smith   PetscFunctionBegin;
511411c6eeSJed Brown   PetscValidPointer(dm,2);
520298fd71SBarry Smith   *dm = NULL;
539566063dSJacob Faibussowitsch   PetscCall(DMInitializePackage());
54a4121054SBarry Smith 
559566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView));
56e7c4fc90SDmitry Karpeev 
5749be4549SMatthew G. Knepley   v->setupcalled              = PETSC_FALSE;
5849be4549SMatthew G. Knepley   v->setfromoptionscalled     = PETSC_FALSE;
590298fd71SBarry Smith   v->ltogmap                  = NULL;
60a4ea9b21SRichard Tran Mills   v->bind_below               = 0;
611411c6eeSJed Brown   v->bs                       = 1;
62171400e9SBarry Smith   v->coloringtype             = IS_COLORING_GLOBAL;
639566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(comm, &v->sf));
649566063dSJacob Faibussowitsch   PetscCall(PetscSFCreate(comm, &v->sectionSF));
65c58f1c22SToby Isaac   v->labels                   = NULL;
6634aa8a36SMatthew G. Knepley   v->adjacency[0]             = PETSC_FALSE;
6734aa8a36SMatthew G. Knepley   v->adjacency[1]             = PETSC_TRUE;
68c58f1c22SToby Isaac   v->depthLabel               = NULL;
69ba2698f1SMatthew G. Knepley   v->celltypeLabel            = NULL;
701bb6d2a8SBarry Smith   v->localSection             = NULL;
711bb6d2a8SBarry Smith   v->globalSection            = NULL;
723b8ba7d1SJed Brown   v->defaultConstraint.section = NULL;
733b8ba7d1SJed Brown   v->defaultConstraint.mat    = NULL;
7479769bd5SJed Brown   v->defaultConstraint.bias   = NULL;
75c6b900c6SMatthew G. Knepley   v->L                        = NULL;
76c6b900c6SMatthew G. Knepley   v->maxCell                  = NULL;
775dc8c3f7SMatthew G. Knepley   v->bdtype                   = NULL;
789a9a41abSToby Isaac   v->dimEmbed                 = PETSC_DEFAULT;
7996173672SStefano Zampini   v->dim                      = PETSC_DETERMINE;
80435a35e8SMatthew G Knepley   {
81435a35e8SMatthew G Knepley     PetscInt i;
82435a35e8SMatthew G Knepley     for (i = 0; i < 10; ++i) {
830298fd71SBarry Smith       v->nullspaceConstructors[i] = NULL;
84f9d4088aSMatthew G. Knepley       v->nearnullspaceConstructors[i] = NULL;
85435a35e8SMatthew G Knepley     }
86435a35e8SMatthew G Knepley   }
879566063dSJacob Faibussowitsch   PetscCall(PetscDSCreate(PETSC_COMM_SELF, &ds));
889566063dSJacob Faibussowitsch   PetscCall(DMSetRegionDS(v, NULL, NULL, ds));
899566063dSJacob Faibussowitsch   PetscCall(PetscDSDestroy(&ds));
909566063dSJacob Faibussowitsch   PetscCall(PetscHMapAuxCreate(&v->auxData));
9114f150ffSMatthew G. Knepley   v->dmBC = NULL;
92a8fb8f29SToby Isaac   v->coarseMesh = NULL;
93f4d763aaSMatthew G. Knepley   v->outputSequenceNum = -1;
94cdb7a50dSMatthew G. Knepley   v->outputSequenceVal = 0.0;
959566063dSJacob Faibussowitsch   PetscCall(DMSetVecType(v,VECSTANDARD));
969566063dSJacob Faibussowitsch   PetscCall(DMSetMatType(v,MATAIJ));
974a7a4c06SLawrence Mitchell 
981411c6eeSJed Brown   *dm = v;
99a4121054SBarry Smith   PetscFunctionReturn(0);
100a4121054SBarry Smith }
101a4121054SBarry Smith 
10238221697SMatthew G. Knepley /*@
10338221697SMatthew G. Knepley   DMClone - Creates a DM object with the same topology as the original.
10438221697SMatthew G. Knepley 
105d083f849SBarry Smith   Collective
10638221697SMatthew G. Knepley 
10738221697SMatthew G. Knepley   Input Parameter:
10838221697SMatthew G. Knepley . dm - The original DM object
10938221697SMatthew G. Knepley 
11038221697SMatthew G. Knepley   Output Parameter:
11138221697SMatthew G. Knepley . newdm  - The new DM object
11238221697SMatthew G. Knepley 
11338221697SMatthew G. Knepley   Level: beginner
11438221697SMatthew G. Knepley 
1151cb8cacdSPatrick Sanan   Notes:
1161cb8cacdSPatrick Sanan   For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example,
1171cb8cacdSPatrick Sanan   DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not
1181cb8cacdSPatrick Sanan   share the PetscSection of the original DM.
1191bb6d2a8SBarry Smith 
12089706ed2SPatrick Sanan   The clone is considered set up iff the original is.
12189706ed2SPatrick Sanan 
12292cfd99aSMartin Diehl .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection()
1231bb6d2a8SBarry Smith 
12438221697SMatthew G. Knepley @*/
12538221697SMatthew G. Knepley PetscErrorCode DMClone(DM dm, DM *newdm)
12638221697SMatthew G. Knepley {
12738221697SMatthew G. Knepley   PetscSF        sf;
12838221697SMatthew G. Knepley   Vec            coords;
12938221697SMatthew G. Knepley   void          *ctx;
130a3219837SMatthew G. Knepley   PetscInt       dim, cdim;
13138221697SMatthew G. Knepley 
13238221697SMatthew G. Knepley   PetscFunctionBegin;
13338221697SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
13438221697SMatthew G. Knepley   PetscValidPointer(newdm,2);
1359566063dSJacob Faibussowitsch   PetscCall(DMCreate(PetscObjectComm((PetscObject) dm), newdm));
1369566063dSJacob Faibussowitsch   PetscCall(DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE, DM_COPY_LABELS_FAIL));
137ddf8437dSMatthew G. Knepley   (*newdm)->leveldown  = dm->leveldown;
138ddf8437dSMatthew G. Knepley   (*newdm)->levelup    = dm->levelup;
139c8a6034eSMark   (*newdm)->prealloc_only = dm->prealloc_only;
1409566063dSJacob Faibussowitsch   PetscCall(PetscFree((*newdm)->vectype));
1419566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(dm->vectype,(char**)&(*newdm)->vectype));
1429566063dSJacob Faibussowitsch   PetscCall(PetscFree((*newdm)->mattype));
1439566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(dm->mattype,(char**)&(*newdm)->mattype));
1449566063dSJacob Faibussowitsch   PetscCall(DMGetDimension(dm, &dim));
1459566063dSJacob Faibussowitsch   PetscCall(DMSetDimension(*newdm, dim));
14638221697SMatthew G. Knepley   if (dm->ops->clone) {
1479566063dSJacob Faibussowitsch     PetscCall((*dm->ops->clone)(dm, newdm));
14838221697SMatthew G. Knepley   }
1493f22bcbcSToby Isaac   (*newdm)->setupcalled = dm->setupcalled;
1509566063dSJacob Faibussowitsch   PetscCall(DMGetPointSF(dm, &sf));
1519566063dSJacob Faibussowitsch   PetscCall(DMSetPointSF(*newdm, sf));
1529566063dSJacob Faibussowitsch   PetscCall(DMGetApplicationContext(dm, &ctx));
1539566063dSJacob Faibussowitsch   PetscCall(DMSetApplicationContext(*newdm, ctx));
154be4c1c3eSMatthew G. Knepley   if (dm->coordinateDM) {
155be4c1c3eSMatthew G. Knepley     DM           ncdm;
156be4c1c3eSMatthew G. Knepley     PetscSection cs;
1575a0206caSToby Isaac     PetscInt     pEnd = -1, pEndMax = -1;
158be4c1c3eSMatthew G. Knepley 
1599566063dSJacob Faibussowitsch     PetscCall(DMGetLocalSection(dm->coordinateDM, &cs));
1609566063dSJacob Faibussowitsch     if (cs) PetscCall(PetscSectionGetChart(cs, NULL, &pEnd));
1619566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm)));
1625a0206caSToby Isaac     if (pEndMax >= 0) {
1639566063dSJacob Faibussowitsch       PetscCall(DMClone(dm->coordinateDM, &ncdm));
1649566063dSJacob Faibussowitsch       PetscCall(DMCopyDisc(dm->coordinateDM, ncdm));
1659566063dSJacob Faibussowitsch       PetscCall(DMSetLocalSection(ncdm, cs));
1669566063dSJacob Faibussowitsch       PetscCall(DMSetCoordinateDM(*newdm, ncdm));
1679566063dSJacob Faibussowitsch       PetscCall(DMDestroy(&ncdm));
168be4c1c3eSMatthew G. Knepley     }
169be4c1c3eSMatthew G. Knepley   }
1709566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDim(dm, &cdim));
1719566063dSJacob Faibussowitsch   PetscCall(DMSetCoordinateDim(*newdm, cdim));
1729566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinatesLocal(dm, &coords));
17338221697SMatthew G. Knepley   if (coords) {
1749566063dSJacob Faibussowitsch     PetscCall(DMSetCoordinatesLocal(*newdm, coords));
17538221697SMatthew G. Knepley   } else {
1769566063dSJacob Faibussowitsch     PetscCall(DMGetCoordinates(dm, &coords));
1779566063dSJacob Faibussowitsch     if (coords) PetscCall(DMSetCoordinates(*newdm, coords));
17838221697SMatthew G. Knepley   }
17990b157c4SStefano Zampini   {
18090b157c4SStefano Zampini     PetscBool             isper;
181c6b900c6SMatthew G. Knepley     const PetscReal      *maxCell, *L;
1825dc8c3f7SMatthew G. Knepley     const DMBoundaryType *bd;
1839566063dSJacob Faibussowitsch     PetscCall(DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd));
1849566063dSJacob Faibussowitsch     PetscCall(DMSetPeriodicity(*newdm, isper, maxCell,  L,  bd));
185c6b900c6SMatthew G. Knepley   }
18634aa8a36SMatthew G. Knepley   {
18734aa8a36SMatthew G. Knepley     PetscBool useCone, useClosure;
18834aa8a36SMatthew G. Knepley 
1899566063dSJacob Faibussowitsch     PetscCall(DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure));
1909566063dSJacob Faibussowitsch     PetscCall(DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure));
19134aa8a36SMatthew G. Knepley   }
19238221697SMatthew G. Knepley   PetscFunctionReturn(0);
19338221697SMatthew G. Knepley }
19438221697SMatthew G. Knepley 
1959a42bb27SBarry Smith /*@C
196564755cdSBarry Smith        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
1979a42bb27SBarry Smith 
198d083f849SBarry Smith    Logically Collective on da
1999a42bb27SBarry Smith 
200147403d9SBarry Smith    Input Parameters:
2019a42bb27SBarry Smith +  da - initial distributed array
202147403d9SBarry Smith -  ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL
2039a42bb27SBarry Smith 
2049a42bb27SBarry Smith    Options Database:
205147403d9SBarry Smith .   -dm_vec_type ctype - the type of vector to create
2069a42bb27SBarry Smith 
2079a42bb27SBarry Smith    Level: intermediate
2089a42bb27SBarry Smith 
209a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType()
2109a42bb27SBarry Smith @*/
21119fd82e9SBarry Smith PetscErrorCode  DMSetVecType(DM da,VecType ctype)
2129a42bb27SBarry Smith {
2139a42bb27SBarry Smith   PetscFunctionBegin;
2149a42bb27SBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
2159566063dSJacob Faibussowitsch   PetscCall(PetscFree(da->vectype));
2169566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(ctype,(char**)&da->vectype));
2179a42bb27SBarry Smith   PetscFunctionReturn(0);
2189a42bb27SBarry Smith }
2199a42bb27SBarry Smith 
220c0dedaeaSBarry Smith /*@C
221c0dedaeaSBarry Smith        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
222c0dedaeaSBarry Smith 
223d083f849SBarry Smith    Logically Collective on da
224c0dedaeaSBarry Smith 
225c0dedaeaSBarry Smith    Input Parameter:
226c0dedaeaSBarry Smith .  da - initial distributed array
227c0dedaeaSBarry Smith 
228c0dedaeaSBarry Smith    Output Parameter:
229c0dedaeaSBarry Smith .  ctype - the vector type
230c0dedaeaSBarry Smith 
231c0dedaeaSBarry Smith    Level: intermediate
232c0dedaeaSBarry Smith 
233a2a9ebe5SBarry Smith .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType()
234c0dedaeaSBarry Smith @*/
235c0dedaeaSBarry Smith PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
236c0dedaeaSBarry Smith {
237c0dedaeaSBarry Smith   PetscFunctionBegin;
238c0dedaeaSBarry Smith   PetscValidHeaderSpecific(da,DM_CLASSID,1);
239c0dedaeaSBarry Smith   *ctype = da->vectype;
240c0dedaeaSBarry Smith   PetscFunctionReturn(0);
241c0dedaeaSBarry Smith }
242c0dedaeaSBarry Smith 
2435f1ad066SMatthew G Knepley /*@
24434f98d34SBarry Smith   VecGetDM - Gets the DM defining the data layout of the vector
2455f1ad066SMatthew G Knepley 
2465f1ad066SMatthew G Knepley   Not collective
2475f1ad066SMatthew G Knepley 
2485f1ad066SMatthew G Knepley   Input Parameter:
2495f1ad066SMatthew G Knepley . v - The Vec
2505f1ad066SMatthew G Knepley 
2515f1ad066SMatthew G Knepley   Output Parameter:
2525f1ad066SMatthew G Knepley . dm - The DM
2535f1ad066SMatthew G Knepley 
2545f1ad066SMatthew G Knepley   Level: intermediate
2555f1ad066SMatthew G Knepley 
2565f1ad066SMatthew G Knepley .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2575f1ad066SMatthew G Knepley @*/
2585f1ad066SMatthew G Knepley PetscErrorCode VecGetDM(Vec v, DM *dm)
2595f1ad066SMatthew G Knepley {
2605f1ad066SMatthew G Knepley   PetscFunctionBegin;
2615f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
2625f1ad066SMatthew G Knepley   PetscValidPointer(dm,2);
2639566063dSJacob Faibussowitsch   PetscCall(PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm));
2645f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2655f1ad066SMatthew G Knepley }
2665f1ad066SMatthew G Knepley 
2675f1ad066SMatthew G Knepley /*@
268d9805387SMatthew G. Knepley   VecSetDM - Sets the DM defining the data layout of the vector.
2695f1ad066SMatthew G Knepley 
2705f1ad066SMatthew G Knepley   Not collective
2715f1ad066SMatthew G Knepley 
2725f1ad066SMatthew G Knepley   Input Parameters:
2735f1ad066SMatthew G Knepley + v - The Vec
2745f1ad066SMatthew G Knepley - dm - The DM
2755f1ad066SMatthew G Knepley 
276d9805387SMatthew 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.
277d9805387SMatthew G. Knepley 
2785f1ad066SMatthew G Knepley   Level: intermediate
2795f1ad066SMatthew G Knepley 
2805f1ad066SMatthew G Knepley .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
2815f1ad066SMatthew G Knepley @*/
2825f1ad066SMatthew G Knepley PetscErrorCode VecSetDM(Vec v, DM dm)
2835f1ad066SMatthew G Knepley {
2845f1ad066SMatthew G Knepley   PetscFunctionBegin;
2855f1ad066SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
286d7f50e27SLisandro Dalcin   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
2879566063dSJacob Faibussowitsch   PetscCall(PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm));
2885f1ad066SMatthew G Knepley   PetscFunctionReturn(0);
2895f1ad066SMatthew G Knepley }
2905f1ad066SMatthew G Knepley 
291521d9a4cSLisandro Dalcin /*@C
2928f1509bcSBarry Smith        DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM
2938f1509bcSBarry Smith 
294d083f849SBarry Smith    Logically Collective on dm
2958f1509bcSBarry Smith 
2968f1509bcSBarry Smith    Input Parameters:
2978f1509bcSBarry Smith +  dm - the DM context
2988f1509bcSBarry Smith -  ctype - the matrix type
2998f1509bcSBarry Smith 
3008f1509bcSBarry Smith    Options Database:
3018f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3028f1509bcSBarry Smith 
3038f1509bcSBarry Smith    Level: intermediate
3048f1509bcSBarry Smith 
305*5b8ffe73SMark Adams .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMCreateMassMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3068f1509bcSBarry Smith           DMGetISColoringType()
3078f1509bcSBarry Smith @*/
3088f1509bcSBarry Smith PetscErrorCode  DMSetISColoringType(DM dm,ISColoringType ctype)
3098f1509bcSBarry Smith {
3108f1509bcSBarry Smith   PetscFunctionBegin;
3118f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3128f1509bcSBarry Smith   dm->coloringtype = ctype;
3138f1509bcSBarry Smith   PetscFunctionReturn(0);
3148f1509bcSBarry Smith }
3158f1509bcSBarry Smith 
3168f1509bcSBarry Smith /*@C
3178f1509bcSBarry Smith        DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM
318521d9a4cSLisandro Dalcin 
319d083f849SBarry Smith    Logically Collective on dm
320521d9a4cSLisandro Dalcin 
321521d9a4cSLisandro Dalcin    Input Parameter:
3228f1509bcSBarry Smith .  dm - the DM context
3238f1509bcSBarry Smith 
3248f1509bcSBarry Smith    Output Parameter:
3258f1509bcSBarry Smith .  ctype - the matrix type
3268f1509bcSBarry Smith 
3278f1509bcSBarry Smith    Options Database:
3288f1509bcSBarry Smith .   -dm_is_coloring_type - global or local
3298f1509bcSBarry Smith 
3308f1509bcSBarry Smith    Level: intermediate
3318f1509bcSBarry Smith 
332*5b8ffe73SMark Adams .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMCreateMassMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
3338f1509bcSBarry Smith           DMGetISColoringType()
3348f1509bcSBarry Smith @*/
3358f1509bcSBarry Smith PetscErrorCode  DMGetISColoringType(DM dm,ISColoringType *ctype)
3368f1509bcSBarry Smith {
3378f1509bcSBarry Smith   PetscFunctionBegin;
3388f1509bcSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3398f1509bcSBarry Smith   *ctype = dm->coloringtype;
3408f1509bcSBarry Smith   PetscFunctionReturn(0);
3418f1509bcSBarry Smith }
3428f1509bcSBarry Smith 
3438f1509bcSBarry Smith /*@C
3448f1509bcSBarry Smith        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
3458f1509bcSBarry Smith 
346d083f849SBarry Smith    Logically Collective on dm
3478f1509bcSBarry Smith 
3488f1509bcSBarry Smith    Input Parameters:
349521d9a4cSLisandro Dalcin +  dm - the DM context
350a2b5a043SBarry Smith -  ctype - the matrix type
351521d9a4cSLisandro Dalcin 
352521d9a4cSLisandro Dalcin    Options Database:
353147403d9SBarry Smith .   -dm_mat_type ctype - the type of the matrix to create
354521d9a4cSLisandro Dalcin 
355521d9a4cSLisandro Dalcin    Level: intermediate
356521d9a4cSLisandro Dalcin 
357*5b8ffe73SMark Adams .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMCreateMassMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType()
358521d9a4cSLisandro Dalcin @*/
35919fd82e9SBarry Smith PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
360521d9a4cSLisandro Dalcin {
361521d9a4cSLisandro Dalcin   PetscFunctionBegin;
362521d9a4cSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3639566063dSJacob Faibussowitsch   PetscCall(PetscFree(dm->mattype));
3649566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(ctype,(char**)&dm->mattype));
365521d9a4cSLisandro Dalcin   PetscFunctionReturn(0);
366521d9a4cSLisandro Dalcin }
367521d9a4cSLisandro Dalcin 
368c0dedaeaSBarry Smith /*@C
369c0dedaeaSBarry Smith        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
370c0dedaeaSBarry Smith 
371d083f849SBarry Smith    Logically Collective on dm
372c0dedaeaSBarry Smith 
373c0dedaeaSBarry Smith    Input Parameter:
374c0dedaeaSBarry Smith .  dm - the DM context
375c0dedaeaSBarry Smith 
376c0dedaeaSBarry Smith    Output Parameter:
377c0dedaeaSBarry Smith .  ctype - the matrix type
378c0dedaeaSBarry Smith 
379c0dedaeaSBarry Smith    Options Database:
380147403d9SBarry Smith .   -dm_mat_type ctype - the matrix type
381c0dedaeaSBarry Smith 
382c0dedaeaSBarry Smith    Level: intermediate
383c0dedaeaSBarry Smith 
384*5b8ffe73SMark Adams .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMCreateMassMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType()
385c0dedaeaSBarry Smith @*/
386c0dedaeaSBarry Smith PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
387c0dedaeaSBarry Smith {
388c0dedaeaSBarry Smith   PetscFunctionBegin;
389c0dedaeaSBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
390c0dedaeaSBarry Smith   *ctype = dm->mattype;
391c0dedaeaSBarry Smith   PetscFunctionReturn(0);
392c0dedaeaSBarry Smith }
393c0dedaeaSBarry Smith 
394c688c046SMatthew G Knepley /*@
39534f98d34SBarry Smith   MatGetDM - Gets the DM defining the data layout of the matrix
396c688c046SMatthew G Knepley 
397c688c046SMatthew G Knepley   Not collective
398c688c046SMatthew G Knepley 
399c688c046SMatthew G Knepley   Input Parameter:
400c688c046SMatthew G Knepley . A - The Mat
401c688c046SMatthew G Knepley 
402c688c046SMatthew G Knepley   Output Parameter:
403c688c046SMatthew G Knepley . dm - The DM
404c688c046SMatthew G Knepley 
405c688c046SMatthew G Knepley   Level: intermediate
406c688c046SMatthew G Knepley 
4078f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4088f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4098f1509bcSBarry Smith 
410c688c046SMatthew G Knepley .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
411c688c046SMatthew G Knepley @*/
412c688c046SMatthew G Knepley PetscErrorCode MatGetDM(Mat A, DM *dm)
413c688c046SMatthew G Knepley {
414c688c046SMatthew G Knepley   PetscFunctionBegin;
415c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
416c688c046SMatthew G Knepley   PetscValidPointer(dm,2);
4179566063dSJacob Faibussowitsch   PetscCall(PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm));
418c688c046SMatthew G Knepley   PetscFunctionReturn(0);
419c688c046SMatthew G Knepley }
420c688c046SMatthew G Knepley 
421c688c046SMatthew G Knepley /*@
422c688c046SMatthew G Knepley   MatSetDM - Sets the DM defining the data layout of the matrix
423c688c046SMatthew G Knepley 
424c688c046SMatthew G Knepley   Not collective
425c688c046SMatthew G Knepley 
426c688c046SMatthew G Knepley   Input Parameters:
427c688c046SMatthew G Knepley + A - The Mat
428c688c046SMatthew G Knepley - dm - The DM
429c688c046SMatthew G Knepley 
430c688c046SMatthew G Knepley   Level: intermediate
431c688c046SMatthew G Knepley 
4328f1509bcSBarry Smith   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
4338f1509bcSBarry Smith                   the Mat through a PetscObjectCompose() operation
4348f1509bcSBarry Smith 
435c688c046SMatthew G Knepley .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
436c688c046SMatthew G Knepley @*/
437c688c046SMatthew G Knepley PetscErrorCode MatSetDM(Mat A, DM dm)
438c688c046SMatthew G Knepley {
439c688c046SMatthew G Knepley   PetscFunctionBegin;
440c688c046SMatthew G Knepley   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
4418865f1eaSKarl Rupp   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
4429566063dSJacob Faibussowitsch   PetscCall(PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm));
443c688c046SMatthew G Knepley   PetscFunctionReturn(0);
444c688c046SMatthew G Knepley }
445c688c046SMatthew G Knepley 
4469a42bb27SBarry Smith /*@C
4479a42bb27SBarry Smith    DMSetOptionsPrefix - Sets the prefix used for searching for all
4486757b960SDave May    DM options in the database.
4499a42bb27SBarry Smith 
450d083f849SBarry Smith    Logically Collective on dm
4519a42bb27SBarry Smith 
452d8d19677SJose E. Roman    Input Parameters:
4538353ddbbSDave May +  da - the DM context
4549a42bb27SBarry Smith -  prefix - the prefix to prepend to all option names
4559a42bb27SBarry Smith 
4569a42bb27SBarry Smith    Notes:
4579a42bb27SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4589a42bb27SBarry Smith    The first character of all runtime options is AUTOMATICALLY the hyphen.
4599a42bb27SBarry Smith 
4609a42bb27SBarry Smith    Level: advanced
4619a42bb27SBarry Smith 
4629a42bb27SBarry Smith .seealso: DMSetFromOptions()
4639a42bb27SBarry Smith @*/
4647087cfbeSBarry Smith PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
4659a42bb27SBarry Smith {
4669a42bb27SBarry Smith   PetscFunctionBegin;
4679a42bb27SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
4689566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dm,prefix));
469691be533SLawrence Mitchell   if (dm->sf) {
4709566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix));
471691be533SLawrence Mitchell   }
4721bb6d2a8SBarry Smith   if (dm->sectionSF) {
4739566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix));
474691be533SLawrence Mitchell   }
4759a42bb27SBarry Smith   PetscFunctionReturn(0);
4769a42bb27SBarry Smith }
4779a42bb27SBarry Smith 
47831697293SDave May /*@C
47931697293SDave May    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
48031697293SDave May    DM options in the database.
48131697293SDave May 
482d083f849SBarry Smith    Logically Collective on dm
48331697293SDave May 
48431697293SDave May    Input Parameters:
48531697293SDave May +  dm - the DM context
48631697293SDave May -  prefix - the prefix string to prepend to all DM option requests
48731697293SDave May 
48831697293SDave May    Notes:
48931697293SDave May    A hyphen (-) must NOT be given at the beginning of the prefix name.
49031697293SDave May    The first character of all runtime options is AUTOMATICALLY the hyphen.
49131697293SDave May 
49231697293SDave May    Level: advanced
49331697293SDave May 
49431697293SDave May .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
49531697293SDave May @*/
49631697293SDave May PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
49731697293SDave May {
49831697293SDave May   PetscFunctionBegin;
49931697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5009566063dSJacob Faibussowitsch   PetscCall(PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix));
50131697293SDave May   PetscFunctionReturn(0);
50231697293SDave May }
50331697293SDave May 
50431697293SDave May /*@C
50531697293SDave May    DMGetOptionsPrefix - Gets the prefix used for searching for all
50631697293SDave May    DM options in the database.
50731697293SDave May 
50831697293SDave May    Not Collective
50931697293SDave May 
51031697293SDave May    Input Parameters:
51131697293SDave May .  dm - the DM context
51231697293SDave May 
51331697293SDave May    Output Parameters:
51431697293SDave May .  prefix - pointer to the prefix string used is returned
51531697293SDave May 
51695452b02SPatrick Sanan    Notes:
51795452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prefix' of
51831697293SDave May    sufficient length to hold the prefix.
51931697293SDave May 
52031697293SDave May    Level: advanced
52131697293SDave May 
52231697293SDave May .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
52331697293SDave May @*/
52431697293SDave May PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
52531697293SDave May {
52631697293SDave May   PetscFunctionBegin;
52731697293SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5289566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetOptionsPrefix((PetscObject)dm,prefix));
52931697293SDave May   PetscFunctionReturn(0);
53031697293SDave May }
53131697293SDave May 
53288bdff64SToby Isaac static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
53388bdff64SToby Isaac {
5346eb26441SStefano Zampini   PetscInt       refct = ((PetscObject) dm)->refct;
53588bdff64SToby Isaac 
53688bdff64SToby Isaac   PetscFunctionBegin;
537aab5bcd8SJed Brown   *ncrefct = 0;
53888bdff64SToby Isaac   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
53988bdff64SToby Isaac     refct--;
54088bdff64SToby Isaac     if (recurseCoarse) {
54188bdff64SToby Isaac       PetscInt coarseCount;
54288bdff64SToby Isaac 
5439566063dSJacob Faibussowitsch       PetscCall(DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount));
54488bdff64SToby Isaac       refct += coarseCount;
54588bdff64SToby Isaac     }
54688bdff64SToby Isaac   }
54788bdff64SToby Isaac   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
54888bdff64SToby Isaac     refct--;
54988bdff64SToby Isaac     if (recurseFine) {
55088bdff64SToby Isaac       PetscInt fineCount;
55188bdff64SToby Isaac 
5529566063dSJacob Faibussowitsch       PetscCall(DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount));
55388bdff64SToby Isaac       refct += fineCount;
55488bdff64SToby Isaac     }
55588bdff64SToby Isaac   }
55688bdff64SToby Isaac   *ncrefct = refct;
55788bdff64SToby Isaac   PetscFunctionReturn(0);
55888bdff64SToby Isaac }
55988bdff64SToby Isaac 
560f4cdcedcSVaclav Hapla PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm)
561354557abSToby Isaac {
5625d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
563354557abSToby Isaac 
564354557abSToby Isaac   PetscFunctionBegin;
565354557abSToby Isaac   /* destroy the labels */
566354557abSToby Isaac   while (next) {
567354557abSToby Isaac     DMLabelLink tmp = next->next;
568354557abSToby Isaac 
5695d80c0bfSVaclav Hapla     if (next->label == dm->depthLabel)    dm->depthLabel    = NULL;
570ba2698f1SMatthew G. Knepley     if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL;
5719566063dSJacob Faibussowitsch     PetscCall(DMLabelDestroy(&next->label));
5729566063dSJacob Faibussowitsch     PetscCall(PetscFree(next));
573354557abSToby Isaac     next = tmp;
574354557abSToby Isaac   }
5755d80c0bfSVaclav Hapla   dm->labels = NULL;
576354557abSToby Isaac   PetscFunctionReturn(0);
577354557abSToby Isaac }
578354557abSToby Isaac 
5791fb7b255SJunchao Zhang /*@C
5808472ad0fSDave May     DMDestroy - Destroys a vector packer or DM.
58147c6ae99SBarry Smith 
582d083f849SBarry Smith     Collective on dm
58347c6ae99SBarry Smith 
58447c6ae99SBarry Smith     Input Parameter:
58547c6ae99SBarry Smith .   dm - the DM object to destroy
58647c6ae99SBarry Smith 
58747c6ae99SBarry Smith     Level: developer
58847c6ae99SBarry Smith 
589e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
59047c6ae99SBarry Smith 
59147c6ae99SBarry Smith @*/
592fcfd50ebSBarry Smith PetscErrorCode  DMDestroy(DM *dm)
59347c6ae99SBarry Smith {
5946eb26441SStefano Zampini   PetscInt       cnt;
595dfe15315SJed Brown   DMNamedVecLink nlink,nnext;
59647c6ae99SBarry Smith 
59747c6ae99SBarry Smith   PetscFunctionBegin;
5986bf464f9SBarry Smith   if (!*dm) PetscFunctionReturn(0);
5996bf464f9SBarry Smith   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
60087e657c6SBarry Smith 
60188bdff64SToby Isaac   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
6029566063dSJacob Faibussowitsch   PetscCall(DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt));
60388bdff64SToby Isaac   --((PetscObject)(*dm))->refct;
604ea78f98cSLisandro Dalcin   if (--cnt > 0) {*dm = NULL; PetscFunctionReturn(0);}
6056bf464f9SBarry Smith   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
6066bf464f9SBarry Smith   ((PetscObject)(*dm))->refct = 0;
6076eb26441SStefano Zampini 
6089566063dSJacob Faibussowitsch   PetscCall(DMClearGlobalVectors(*dm));
6099566063dSJacob Faibussowitsch   PetscCall(DMClearLocalVectors(*dm));
6106eb26441SStefano Zampini 
611f490541aSPeter Brune   nnext=(*dm)->namedglobal;
6120298fd71SBarry Smith   (*dm)->namedglobal = NULL;
613f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
6142348bcf4SPeter Brune     nnext = nlink->next;
6157a8be351SBarry Smith     PetscCheck(nlink->status == DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
6169566063dSJacob Faibussowitsch     PetscCall(PetscFree(nlink->name));
6179566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&nlink->X));
6189566063dSJacob Faibussowitsch     PetscCall(PetscFree(nlink));
6192348bcf4SPeter Brune   }
620f490541aSPeter Brune   nnext=(*dm)->namedlocal;
6210298fd71SBarry Smith   (*dm)->namedlocal = NULL;
622f490541aSPeter Brune   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
623f490541aSPeter Brune     nnext = nlink->next;
6247a8be351SBarry Smith     PetscCheck(nlink->status == DMVEC_STATUS_IN,((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
6259566063dSJacob Faibussowitsch     PetscCall(PetscFree(nlink->name));
6269566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&nlink->X));
6279566063dSJacob Faibussowitsch     PetscCall(PetscFree(nlink));
628f490541aSPeter Brune   }
6292348bcf4SPeter Brune 
630b17ce1afSJed Brown   /* Destroy the list of hooks */
631c833c3b5SJed Brown   {
632c833c3b5SJed Brown     DMCoarsenHookLink link,next;
633b17ce1afSJed Brown     for (link=(*dm)->coarsenhook; link; link=next) {
634b17ce1afSJed Brown       next = link->next;
6359566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
636b17ce1afSJed Brown     }
6370298fd71SBarry Smith     (*dm)->coarsenhook = NULL;
638c833c3b5SJed Brown   }
639c833c3b5SJed Brown   {
640c833c3b5SJed Brown     DMRefineHookLink link,next;
641c833c3b5SJed Brown     for (link=(*dm)->refinehook; link; link=next) {
642c833c3b5SJed Brown       next = link->next;
6439566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
644c833c3b5SJed Brown     }
6450298fd71SBarry Smith     (*dm)->refinehook = NULL;
646c833c3b5SJed Brown   }
647be081cd6SPeter Brune   {
648be081cd6SPeter Brune     DMSubDomainHookLink link,next;
649be081cd6SPeter Brune     for (link=(*dm)->subdomainhook; link; link=next) {
650be081cd6SPeter Brune       next = link->next;
6519566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
652be081cd6SPeter Brune     }
6530298fd71SBarry Smith     (*dm)->subdomainhook = NULL;
654be081cd6SPeter Brune   }
655baf369e7SPeter Brune   {
656baf369e7SPeter Brune     DMGlobalToLocalHookLink link,next;
657baf369e7SPeter Brune     for (link=(*dm)->gtolhook; link; link=next) {
658baf369e7SPeter Brune       next = link->next;
6599566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
660baf369e7SPeter Brune     }
6610298fd71SBarry Smith     (*dm)->gtolhook = NULL;
662baf369e7SPeter Brune   }
663d4d07f1eSToby Isaac   {
664d4d07f1eSToby Isaac     DMLocalToGlobalHookLink link,next;
665d4d07f1eSToby Isaac     for (link=(*dm)->ltoghook; link; link=next) {
666d4d07f1eSToby Isaac       next = link->next;
6679566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
668d4d07f1eSToby Isaac     }
669d4d07f1eSToby Isaac     (*dm)->ltoghook = NULL;
670d4d07f1eSToby Isaac   }
671aa1993deSMatthew G Knepley   /* Destroy the work arrays */
672aa1993deSMatthew G Knepley   {
673aa1993deSMatthew G Knepley     DMWorkLink link,next;
6747a8be351SBarry Smith     PetscCheck(!(*dm)->workout,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
675aa1993deSMatthew G Knepley     for (link=(*dm)->workin; link; link=next) {
676aa1993deSMatthew G Knepley       next = link->next;
6779566063dSJacob Faibussowitsch       PetscCall(PetscFree(link->mem));
6789566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
679aa1993deSMatthew G Knepley     }
6800298fd71SBarry Smith     (*dm)->workin = NULL;
681aa1993deSMatthew G Knepley   }
682c58f1c22SToby Isaac   /* destroy the labels */
6839566063dSJacob Faibussowitsch   PetscCall(DMDestroyLabelLinkList_Internal(*dm));
684f4cdcedcSVaclav Hapla   /* destroy the fields */
6859566063dSJacob Faibussowitsch   PetscCall(DMClearFields(*dm));
686f4cdcedcSVaclav Hapla   /* destroy the boundaries */
687e6f8dbb6SToby Isaac   {
688e6f8dbb6SToby Isaac     DMBoundary next = (*dm)->boundary;
689e6f8dbb6SToby Isaac     while (next) {
690e6f8dbb6SToby Isaac       DMBoundary b = next;
691e6f8dbb6SToby Isaac 
692e6f8dbb6SToby Isaac       next = b->next;
6939566063dSJacob Faibussowitsch       PetscCall(PetscFree(b));
694e6f8dbb6SToby Isaac     }
695e6f8dbb6SToby Isaac   }
696b17ce1afSJed Brown 
6979566063dSJacob Faibussowitsch   PetscCall(PetscObjectDestroy(&(*dm)->dmksp));
6989566063dSJacob Faibussowitsch   PetscCall(PetscObjectDestroy(&(*dm)->dmsnes));
6999566063dSJacob Faibussowitsch   PetscCall(PetscObjectDestroy(&(*dm)->dmts));
70052536dc3SBarry Smith 
7011a266240SBarry Smith   if ((*dm)->ctx && (*dm)->ctxdestroy) {
7029566063dSJacob Faibussowitsch     PetscCall((*(*dm)->ctxdestroy)(&(*dm)->ctx));
7031a266240SBarry Smith   }
7049566063dSJacob Faibussowitsch   PetscCall(MatFDColoringDestroy(&(*dm)->fd));
7059566063dSJacob Faibussowitsch   PetscCall(ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap));
7069566063dSJacob Faibussowitsch   PetscCall(PetscFree((*dm)->vectype));
7079566063dSJacob Faibussowitsch   PetscCall(PetscFree((*dm)->mattype));
70888ed4aceSMatthew G Knepley 
7099566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&(*dm)->localSection));
7109566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&(*dm)->globalSection));
7119566063dSJacob Faibussowitsch   PetscCall(PetscLayoutDestroy(&(*dm)->map));
7129566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&(*dm)->defaultConstraint.section));
7139566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&(*dm)->defaultConstraint.mat));
7149566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&(*dm)->sf));
7159566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&(*dm)->sectionSF));
716736995cdSBlaise Bourdin   if ((*dm)->useNatural) {
717736995cdSBlaise Bourdin     if ((*dm)->sfNatural) {
7189566063dSJacob Faibussowitsch       PetscCall(PetscSFDestroy(&(*dm)->sfNatural));
719736995cdSBlaise Bourdin     }
7209566063dSJacob Faibussowitsch     PetscCall(PetscObjectDereference((PetscObject) (*dm)->sfMigration));
721736995cdSBlaise Bourdin   }
7229a2a23afSMatthew G. Knepley   {
7239a2a23afSMatthew G. Knepley     Vec     *auxData;
7249a2a23afSMatthew G. Knepley     PetscInt n, i, off = 0;
7259a2a23afSMatthew G. Knepley 
7269566063dSJacob Faibussowitsch     PetscCall(PetscHMapAuxGetSize((*dm)->auxData, &n));
7279566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(n, &auxData));
7289566063dSJacob Faibussowitsch     PetscCall(PetscHMapAuxGetVals((*dm)->auxData, &off, auxData));
7299566063dSJacob Faibussowitsch     for (i = 0; i < n; ++i) PetscCall(VecDestroy(&auxData[i]));
7309566063dSJacob Faibussowitsch     PetscCall(PetscFree(auxData));
7319566063dSJacob Faibussowitsch     PetscCall(PetscHMapAuxDestroy(&(*dm)->auxData));
7329a2a23afSMatthew G. Knepley   }
73388bdff64SToby Isaac   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
7349566063dSJacob Faibussowitsch     PetscCall(DMSetFineDM((*dm)->coarseMesh,NULL));
73588bdff64SToby Isaac   }
7366eb26441SStefano Zampini 
7379566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&(*dm)->coarseMesh));
73888bdff64SToby Isaac   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
7399566063dSJacob Faibussowitsch     PetscCall(DMSetCoarseDM((*dm)->fineMesh,NULL));
74088bdff64SToby Isaac   }
7419566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&(*dm)->fineMesh));
7429566063dSJacob Faibussowitsch   PetscCall(DMFieldDestroy(&(*dm)->coordinateField));
7439566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&(*dm)->coordinateDM));
7449566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&(*dm)->coordinates));
7459566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&(*dm)->coordinatesLocal));
7469566063dSJacob Faibussowitsch   PetscCall(PetscFree((*dm)->L));
7479566063dSJacob Faibussowitsch   PetscCall(PetscFree((*dm)->maxCell));
7489566063dSJacob Faibussowitsch   PetscCall(PetscFree((*dm)->bdtype));
7499566063dSJacob Faibussowitsch   if ((*dm)->transformDestroy) PetscCall((*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx));
7509566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&(*dm)->transformDM));
7519566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&(*dm)->transform));
7526636e97aSMatthew G Knepley 
7539566063dSJacob Faibussowitsch   PetscCall(DMClearDS(*dm));
7549566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&(*dm)->dmBC));
755e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
7569566063dSJacob Faibussowitsch   PetscCall(PetscObjectSAWsViewOff((PetscObject)*dm));
757732e2eb9SMatthew G Knepley 
758ed3c66a1SDave May   if ((*dm)->ops->destroy) {
7599566063dSJacob Faibussowitsch     PetscCall((*(*dm)->ops->destroy)(*dm));
760ed3c66a1SDave May   }
7619566063dSJacob Faibussowitsch   PetscCall(DMMonitorCancel(*dm));
762f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
7639566063dSJacob Faibussowitsch   PetscCallCEED(CeedElemRestrictionDestroy(&(*dm)->ceedERestrict));
7649566063dSJacob Faibussowitsch   PetscCallCEED(CeedDestroy(&(*dm)->ceed));
765f918ec44SMatthew G. Knepley #endif
766435a35e8SMatthew G Knepley   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
7679566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(dm));
76847c6ae99SBarry Smith   PetscFunctionReturn(0);
76947c6ae99SBarry Smith }
77047c6ae99SBarry Smith 
771d7bf68aeSBarry Smith /*@
772d7bf68aeSBarry Smith     DMSetUp - sets up the data structures inside a DM object
773d7bf68aeSBarry Smith 
774d083f849SBarry Smith     Collective on dm
775d7bf68aeSBarry Smith 
776d7bf68aeSBarry Smith     Input Parameter:
777d7bf68aeSBarry Smith .   dm - the DM object to setup
778d7bf68aeSBarry Smith 
779d7bf68aeSBarry Smith     Level: developer
780d7bf68aeSBarry Smith 
781e727c939SJed Brown .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
782d7bf68aeSBarry Smith 
783d7bf68aeSBarry Smith @*/
7847087cfbeSBarry Smith PetscErrorCode  DMSetUp(DM dm)
785d7bf68aeSBarry Smith {
786d7bf68aeSBarry Smith   PetscFunctionBegin;
787171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7888387afaaSJed Brown   if (dm->setupcalled) PetscFunctionReturn(0);
789d7bf68aeSBarry Smith   if (dm->ops->setup) {
7909566063dSJacob Faibussowitsch     PetscCall((*dm->ops->setup)(dm));
791d7bf68aeSBarry Smith   }
7928387afaaSJed Brown   dm->setupcalled = PETSC_TRUE;
793d7bf68aeSBarry Smith   PetscFunctionReturn(0);
794d7bf68aeSBarry Smith }
795d7bf68aeSBarry Smith 
796d7bf68aeSBarry Smith /*@
797d7bf68aeSBarry Smith     DMSetFromOptions - sets parameters in a DM from the options database
798d7bf68aeSBarry Smith 
799d083f849SBarry Smith     Collective on dm
800d7bf68aeSBarry Smith 
801d7bf68aeSBarry Smith     Input Parameter:
802d7bf68aeSBarry Smith .   dm - the DM object to set options for
803d7bf68aeSBarry Smith 
804732e2eb9SMatthew G Knepley     Options Database:
805*5b8ffe73SMark Adams +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix() and DMCreateMassMatrix(), but do not fill it with zeros
8064164ae61SDominic Meiser .   -dm_vec_type <type>  - type of vector to create inside DM
8074164ae61SDominic Meiser .   -dm_mat_type <type>  - type of matrix to create inside DM
808a4ea9b21SRichard Tran Mills .   -dm_is_coloring_type - <global or local>
809a4ea9b21SRichard 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
810732e2eb9SMatthew G Knepley 
8119318fe57SMatthew G. Knepley     DMPLEX Specific creation options
8129318fe57SMatthew G. Knepley + -dm_plex_filename <str>           - File containing a mesh
8139318fe57SMatthew G. Knepley . -dm_plex_boundary_filename <str>  - File containing a mesh boundary
814cd7e8a5eSksagiyam . -dm_plex_name <str>               - Name of the mesh in the file
8159318fe57SMatthew G. Knepley . -dm_plex_shape <shape>            - The domain shape, such as DM_SHAPE_BOX, DM_SHAPE_SPHERE, etc.
8169318fe57SMatthew G. Knepley . -dm_plex_cell <ct>                - Cell shape
8179318fe57SMatthew G. Knepley . -dm_plex_reference_cell_domain <bool> - Use a reference cell domain
8189318fe57SMatthew G. Knepley . -dm_plex_dim <dim>                - Set the topological dimension
8199318fe57SMatthew G. Knepley . -dm_plex_simplex <bool>           - PETSC_TRUE for simplex elements, PETSC_FALSE for tensor elements
8209318fe57SMatthew G. Knepley . -dm_plex_interpolate <bool>       - PETSC_TRUE turns on topological interpolation (creating edges and faces)
8219318fe57SMatthew G. Knepley . -dm_plex_scale <sc>               - Scale factor for mesh coordinates
8229318fe57SMatthew G. Knepley . -dm_plex_box_faces <m,n,p>        - Number of faces along each dimension
8239318fe57SMatthew G. Knepley . -dm_plex_box_lower <x,y,z>        - Specify lower-left-bottom coordinates for the box
8249318fe57SMatthew G. Knepley . -dm_plex_box_upper <x,y,z>        - Specify upper-right-top coordinates for the box
8259318fe57SMatthew G. Knepley . -dm_plex_box_bd <bx,by,bz>        - Specify the DMBoundaryType for each direction
8269318fe57SMatthew G. Knepley . -dm_plex_sphere_radius <r>        - The sphere radius
8279318fe57SMatthew G. Knepley . -dm_plex_ball_radius <r>          - Radius of the ball
8289318fe57SMatthew G. Knepley . -dm_plex_cylinder_bd <bz>         - Boundary type in the z direction
8299318fe57SMatthew G. Knepley . -dm_plex_cylinder_num_wedges <n>  - Number of wedges around the cylinder
830bdf63967SMatthew G. Knepley . -dm_plex_reorder <order>          - Reorder the mesh using the specified algorithm
8319318fe57SMatthew G. Knepley . -dm_refine_pre <n>                - The number of refinements before distribution
8329318fe57SMatthew G. Knepley . -dm_refine_uniform_pre <bool>     - Flag for uniform refinement before distribution
8339318fe57SMatthew G. Knepley . -dm_refine_volume_limit_pre <v>   - The maximum cell volume after refinement before distribution
8349318fe57SMatthew G. Knepley . -dm_refine <n>                    - The number of refinements after distribution
835bdf63967SMatthew G. Knepley . -dm_extrude <l>                   - Activate extrusion and specify the number of layers to extrude
836d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thickness <t>           - The total thickness of extruded layers
837d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_use_tensor <bool>       - Use tensor cells when extruding
838d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_symmetric <bool>        - Extrude layers symmetrically about the surface
839d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_normal <n0,...,nd>      - Specify the extrusion direction
840d410b0cfSMatthew G. Knepley . -dm_plex_transform_extrude_thicknesses <t0,...,tl> - Specify thickness of each layer
841909dfd52SMatthew G. Knepley . -dm_plex_create_fv_ghost_cells    - Flag to create finite volume ghost cells on the boundary
842909dfd52SMatthew G. Knepley . -dm_plex_fv_ghost_cells_label <name> - Label name for ghost cells boundary
8439318fe57SMatthew G. Knepley . -dm_distribute <bool>             - Flag to redistribute a mesh among processes
8449318fe57SMatthew G. Knepley . -dm_distribute_overlap <n>        - The size of the overlap halo
8459318fe57SMatthew G. Knepley . -dm_plex_adj_cone <bool>          - Set adjacency direction
8469318fe57SMatthew G. Knepley - -dm_plex_adj_closure <bool>       - Set adjacency size
8479318fe57SMatthew G. Knepley 
848384a6580SVaclav Hapla     DMPLEX Specific Checks
849384a6580SVaclav Hapla +   -dm_plex_check_symmetry        - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry()
850384a6580SVaclav Hapla .   -dm_plex_check_skeleton        - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton()
851384a6580SVaclav 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()
852384a6580SVaclav Hapla .   -dm_plex_check_geometry        - Check that cells have positive volume - DMPlexCheckGeometry()
853384a6580SVaclav Hapla .   -dm_plex_check_pointsf         - Check some necessary conditions for PointSF - DMPlexCheckPointSF()
854384a6580SVaclav Hapla .   -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones()
855384a6580SVaclav Hapla -   -dm_plex_check_all             - Perform all the checks above
856d7bf68aeSBarry Smith 
85795eb5ee5SVaclav Hapla     Level: intermediate
85895eb5ee5SVaclav Hapla 
85995eb5ee5SVaclav Hapla .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(),
86095eb5ee5SVaclav Hapla     DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones()
861d7bf68aeSBarry Smith 
862d7bf68aeSBarry Smith @*/
8637087cfbeSBarry Smith PetscErrorCode DMSetFromOptions(DM dm)
864d7bf68aeSBarry Smith {
8657781c08eSBarry Smith   char           typeName[256];
866ca266f36SBarry Smith   PetscBool      flg;
867d7bf68aeSBarry Smith   PetscErrorCode ierr;
868d7bf68aeSBarry Smith 
869d7bf68aeSBarry Smith   PetscFunctionBegin;
870171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
87149be4549SMatthew G. Knepley   dm->setfromoptionscalled = PETSC_TRUE;
8729566063dSJacob Faibussowitsch   if (dm->sf) PetscCall(PetscSFSetFromOptions(dm->sf));
8739566063dSJacob Faibussowitsch   if (dm->sectionSF) PetscCall(PetscSFSetFromOptions(dm->sectionSF));
8749566063dSJacob Faibussowitsch   ierr = PetscObjectOptionsBegin((PetscObject)dm);PetscCall(ierr);
8759566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-dm_preallocate_only","only preallocate matrix, but do not set column indices","DMSetMatrixPreallocateOnly",dm->prealloc_only,&dm->prealloc_only,NULL));
8769566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg));
877f9ba7244SBarry Smith   if (flg) {
8789566063dSJacob Faibussowitsch     PetscCall(DMSetVecType(dm,typeName));
879f9ba7244SBarry Smith   }
8809566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-dm_mat_type","Matrix type used for created matrices","DMSetMatType",MatList,dm->mattype ? dm->mattype : typeName,typeName,sizeof(typeName),&flg));
881073dac72SJed Brown   if (flg) {
8829566063dSJacob Faibussowitsch     PetscCall(DMSetMatType(dm,typeName));
883073dac72SJed Brown   }
8849566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL));
8859566063dSJacob Faibussowitsch   PetscCall(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));
886f9ba7244SBarry Smith   if (dm->ops->setfromoptions) {
8879566063dSJacob Faibussowitsch     PetscCall((*dm->ops->setfromoptions)(PetscOptionsObject,dm));
888f9ba7244SBarry Smith   }
889f9ba7244SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
8909566063dSJacob Faibussowitsch   PetscCall(PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm));
8919566063dSJacob Faibussowitsch   ierr = PetscOptionsEnd();PetscCall(ierr);
892d7bf68aeSBarry Smith   PetscFunctionReturn(0);
893d7bf68aeSBarry Smith }
894d7bf68aeSBarry Smith 
895fc9bc008SSatish Balay /*@C
896fe2efc57SMark    DMViewFromOptions - View from Options
897fe2efc57SMark 
898fe2efc57SMark    Collective on DM
899fe2efc57SMark 
900fe2efc57SMark    Input Parameters:
901fe2efc57SMark +  dm - the DM object
902736c3998SJose E. Roman .  obj - Optional object
903736c3998SJose E. Roman -  name - command line option
904fe2efc57SMark 
905fe2efc57SMark    Level: intermediate
906fe2efc57SMark .seealso:  DM, DMView, PetscObjectViewFromOptions(), DMCreate()
907fe2efc57SMark @*/
908fe2efc57SMark PetscErrorCode  DMViewFromOptions(DM dm,PetscObject obj,const char name[])
909fe2efc57SMark {
910fe2efc57SMark   PetscFunctionBegin;
911fe2efc57SMark   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9129566063dSJacob Faibussowitsch   PetscCall(PetscObjectViewFromOptions((PetscObject)dm,obj,name));
913fe2efc57SMark   PetscFunctionReturn(0);
914fe2efc57SMark }
915fe2efc57SMark 
916fe2efc57SMark /*@C
917224748a4SBarry Smith     DMView - Views a DM
91847c6ae99SBarry Smith 
919d083f849SBarry Smith     Collective on dm
92047c6ae99SBarry Smith 
921d8d19677SJose E. Roman     Input Parameters:
92247c6ae99SBarry Smith +   dm - the DM object to view
92347c6ae99SBarry Smith -   v - the viewer
92447c6ae99SBarry Smith 
925cd7e8a5eSksagiyam     Notes:
926cd7e8a5eSksagiyam     Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex
927cd7e8a5eSksagiyam     meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName()
928cd7e8a5eSksagiyam     before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object.
929cd7e8a5eSksagiyam 
930224748a4SBarry Smith     Level: beginner
93147c6ae99SBarry Smith 
932*5b8ffe73SMark Adams .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMLoad(), PetscObjectSetName()
93347c6ae99SBarry Smith 
93447c6ae99SBarry Smith @*/
9357087cfbeSBarry Smith PetscErrorCode  DMView(DM dm,PetscViewer v)
93647c6ae99SBarry Smith {
93732c0f0efSBarry Smith   PetscBool         isbinary;
93876a8abe0SBarry Smith   PetscMPIInt       size;
93976a8abe0SBarry Smith   PetscViewerFormat format;
94047c6ae99SBarry Smith 
94147c6ae99SBarry Smith   PetscFunctionBegin;
942171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9433014e516SBarry Smith   if (!v) {
9449566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v));
9453014e516SBarry Smith   }
946b1b135c8SBarry Smith   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2);
94774903a4fSStefano Zampini   /* Ideally, we would like to have this test on.
94874903a4fSStefano Zampini      However, it currently breaks socket viz via GLVis.
94974903a4fSStefano Zampini      During DMView(parallel_mesh,glvis_viewer), each
95074903a4fSStefano Zampini      process opens a sequential ASCII socket to visualize
95174903a4fSStefano Zampini      the local mesh, and PetscObjectView(dm,local_socket)
95274903a4fSStefano Zampini      is internally called inside VecView_GLVis, incurring
95374903a4fSStefano Zampini      in an error here */
95474903a4fSStefano Zampini   /* PetscCheckSameComm(dm,1,v,2); */
9559566063dSJacob Faibussowitsch   PetscCall(PetscViewerCheckWritable(v));
956b1b135c8SBarry Smith 
9579566063dSJacob Faibussowitsch   PetscCall(PetscViewerGetFormat(v,&format));
9589566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size));
95976a8abe0SBarry Smith   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0);
9609566063dSJacob Faibussowitsch   PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)dm,v));
9619566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary));
96232c0f0efSBarry Smith   if (isbinary) {
96355849f57SBarry Smith     PetscInt classid = DM_FILE_CLASSID;
96432c0f0efSBarry Smith     char     type[256];
96532c0f0efSBarry Smith 
9669566063dSJacob Faibussowitsch     PetscCall(PetscViewerBinaryWrite(v,&classid,1,PETSC_INT));
9679566063dSJacob Faibussowitsch     PetscCall(PetscStrncpy(type,((PetscObject)dm)->type_name,256));
9689566063dSJacob Faibussowitsch     PetscCall(PetscViewerBinaryWrite(v,type,256,PETSC_CHAR));
96932c0f0efSBarry Smith   }
9700c010503SBarry Smith   if (dm->ops->view) {
9719566063dSJacob Faibussowitsch     PetscCall((*dm->ops->view)(dm,v));
97247c6ae99SBarry Smith   }
97347c6ae99SBarry Smith   PetscFunctionReturn(0);
97447c6ae99SBarry Smith }
97547c6ae99SBarry Smith 
97647c6ae99SBarry Smith /*@
9778472ad0fSDave May     DMCreateGlobalVector - Creates a global vector from a DM object
97847c6ae99SBarry Smith 
979d083f849SBarry Smith     Collective on dm
98047c6ae99SBarry Smith 
98147c6ae99SBarry Smith     Input Parameter:
98247c6ae99SBarry Smith .   dm - the DM object
98347c6ae99SBarry Smith 
98447c6ae99SBarry Smith     Output Parameter:
98547c6ae99SBarry Smith .   vec - the global vector
98647c6ae99SBarry Smith 
987073dac72SJed Brown     Level: beginner
98847c6ae99SBarry Smith 
989ec075b9fSPatrick Sanan .seealso DMCreateLocalVector(), DMGetGlobalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
99047c6ae99SBarry Smith 
99147c6ae99SBarry Smith @*/
9927087cfbeSBarry Smith PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
99347c6ae99SBarry Smith {
99447c6ae99SBarry Smith   PetscFunctionBegin;
995171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
996b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
9977a8be351SBarry Smith   PetscCheck(dm->ops->createglobalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name);
9989566063dSJacob Faibussowitsch   PetscCall((*dm->ops->createglobalvector)(dm,vec));
99976bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1000c6b011d8SStefano Zampini     DM vdm;
1001c6b011d8SStefano Zampini 
10029566063dSJacob Faibussowitsch     PetscCall(VecGetDM(*vec,&vdm));
10037a8be351SBarry Smith     PetscCheck(vdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name);
1004c6b011d8SStefano Zampini   }
100547c6ae99SBarry Smith   PetscFunctionReturn(0);
100647c6ae99SBarry Smith }
100747c6ae99SBarry Smith 
100847c6ae99SBarry Smith /*@
10098472ad0fSDave May     DMCreateLocalVector - Creates a local vector from a DM object
101047c6ae99SBarry Smith 
101147c6ae99SBarry Smith     Not Collective
101247c6ae99SBarry Smith 
101347c6ae99SBarry Smith     Input Parameter:
101447c6ae99SBarry Smith .   dm - the DM object
101547c6ae99SBarry Smith 
101647c6ae99SBarry Smith     Output Parameter:
101747c6ae99SBarry Smith .   vec - the local vector
101847c6ae99SBarry Smith 
1019073dac72SJed Brown     Level: beginner
102047c6ae99SBarry Smith 
1021ec075b9fSPatrick Sanan .seealso DMCreateGlobalVector(), DMGetLocalVector(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
102247c6ae99SBarry Smith 
102347c6ae99SBarry Smith @*/
10247087cfbeSBarry Smith PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
102547c6ae99SBarry Smith {
102647c6ae99SBarry Smith   PetscFunctionBegin;
1027171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1028b9d85ea2SLisandro Dalcin   PetscValidPointer(vec,2);
10297a8be351SBarry Smith   PetscCheck(dm->ops->createlocalvector,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name);
10309566063dSJacob Faibussowitsch   PetscCall((*dm->ops->createlocalvector)(dm,vec));
103176bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1032c6b011d8SStefano Zampini     DM vdm;
1033c6b011d8SStefano Zampini 
10349566063dSJacob Faibussowitsch     PetscCall(VecGetDM(*vec,&vdm));
10357a8be351SBarry Smith     PetscCheck(vdm,PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector",((PetscObject)dm)->type_name);
1036c6b011d8SStefano Zampini   }
103747c6ae99SBarry Smith   PetscFunctionReturn(0);
103847c6ae99SBarry Smith }
103947c6ae99SBarry Smith 
10401411c6eeSJed Brown /*@
10411411c6eeSJed Brown    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
10421411c6eeSJed Brown 
1043d083f849SBarry Smith    Collective on dm
10441411c6eeSJed Brown 
10451411c6eeSJed Brown    Input Parameter:
10461411c6eeSJed Brown .  dm - the DM that provides the mapping
10471411c6eeSJed Brown 
10481411c6eeSJed Brown    Output Parameter:
10491411c6eeSJed Brown .  ltog - the mapping
10501411c6eeSJed Brown 
10511411c6eeSJed Brown    Level: intermediate
10521411c6eeSJed Brown 
10531411c6eeSJed Brown    Notes:
10541411c6eeSJed Brown    This mapping can then be used by VecSetLocalToGlobalMapping() or
10551411c6eeSJed Brown    MatSetLocalToGlobalMapping().
10561411c6eeSJed Brown 
1057fc31e74dSBarry Smith .seealso: DMCreateLocalVector()
10581411c6eeSJed Brown @*/
10597087cfbeSBarry Smith PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
10601411c6eeSJed Brown {
10610be3e97aSMatthew G. Knepley   PetscInt       bs = -1, bsLocal[2], bsMinMax[2];
10621411c6eeSJed Brown 
10631411c6eeSJed Brown   PetscFunctionBegin;
10641411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
10651411c6eeSJed Brown   PetscValidPointer(ltog,2);
10661411c6eeSJed Brown   if (!dm->ltogmap) {
106737d0c07bSMatthew G Knepley     PetscSection section, sectionGlobal;
106837d0c07bSMatthew G Knepley 
10699566063dSJacob Faibussowitsch     PetscCall(DMGetLocalSection(dm, &section));
107037d0c07bSMatthew G Knepley     if (section) {
1071a974ec88SMatthew G. Knepley       const PetscInt *cdofs;
107237d0c07bSMatthew G Knepley       PetscInt       *ltog;
1073ccf3bd66SMatthew G. Knepley       PetscInt        pStart, pEnd, n, p, k, l;
107437d0c07bSMatthew G Knepley 
10759566063dSJacob Faibussowitsch       PetscCall(DMGetGlobalSection(dm, &sectionGlobal));
10769566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetChart(section, &pStart, &pEnd));
10779566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetStorageSize(section, &n));
10789566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(n, &ltog)); /* We want the local+overlap size */
107937d0c07bSMatthew G Knepley       for (p = pStart, l = 0; p < pEnd; ++p) {
1080e6befd46SJed Brown         PetscInt bdof, cdof, dof, off, c, cind;
108137d0c07bSMatthew G Knepley 
108237d0c07bSMatthew G Knepley         /* Should probably use constrained dofs */
10839566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(section, p, &dof));
10849566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetConstraintDof(section, p, &cdof));
10859566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetConstraintIndices(section, p, &cdofs));
10869566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetOffset(sectionGlobal, p, &off));
10871a7dc684SMatthew G. Knepley         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
10881a7dc684SMatthew G. Knepley         bdof = cdof && (dof-cdof) ? 1 : dof;
10891a7dc684SMatthew G. Knepley         if (dof) {
10905b8243e1SJed Brown           bs = bs < 0 ? bdof : PetscGCD(bs, bdof);
10911a7dc684SMatthew G. Knepley         }
10925227eafbSStefano Zampini 
1093e6befd46SJed Brown         for (c = 0, cind = 0; c < dof; ++c, ++l) {
10945227eafbSStefano Zampini           if (cind < cdof && c == cdofs[cind]) {
1095e6befd46SJed Brown             ltog[l] = off < 0 ? off-c : -(off+c+1);
1096e6befd46SJed Brown             cind++;
1097e6befd46SJed Brown           } else {
10985227eafbSStefano Zampini             ltog[l] = (off < 0 ? -(off+1) : off) + c - cind;
1099e6befd46SJed Brown           }
110037d0c07bSMatthew G Knepley         }
110137d0c07bSMatthew G Knepley       }
1102bff27382SMatthew G. Knepley       /* Must have same blocksize on all procs (some might have no points) */
11030be3e97aSMatthew G. Knepley       bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs;
11049566063dSJacob Faibussowitsch       PetscCall(PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax));
11050be3e97aSMatthew G. Knepley       if (bsMinMax[0] != bsMinMax[1]) {bs = 1;}
11060be3e97aSMatthew G. Knepley       else                            {bs = bsMinMax[0];}
11077591dbb2SMatthew G. Knepley       bs = bs < 0 ? 1 : bs;
11087591dbb2SMatthew G. Knepley       /* Must reduce indices by blocksize */
1109ccf3bd66SMatthew G. Knepley       if (bs > 1) {
1110ca469d19SJed Brown         for (l = 0, k = 0; l < n; l += bs, ++k) {
1111ca469d19SJed Brown           // Integer division of negative values truncates toward zero(!), not toward negative infinity
1112ca469d19SJed Brown           ltog[k] = ltog[l] >= 0 ? ltog[l]/bs : -(-(ltog[l]+1)/bs + 1);
1113ca469d19SJed Brown         }
1114ccf3bd66SMatthew G. Knepley         n /= bs;
1115ccf3bd66SMatthew G. Knepley       }
11169566063dSJacob Faibussowitsch       PetscCall(ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap));
11179566063dSJacob Faibussowitsch       PetscCall(PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap));
111837d0c07bSMatthew G Knepley     } else {
11197a8be351SBarry Smith       PetscCheck(dm->ops->getlocaltoglobalmapping,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name);
11209566063dSJacob Faibussowitsch       PetscCall((*dm->ops->getlocaltoglobalmapping)(dm));
11211411c6eeSJed Brown     }
112237d0c07bSMatthew G Knepley   }
11231411c6eeSJed Brown   *ltog = dm->ltogmap;
11241411c6eeSJed Brown   PetscFunctionReturn(0);
11251411c6eeSJed Brown }
11261411c6eeSJed Brown 
11271411c6eeSJed Brown /*@
11281411c6eeSJed Brown    DMGetBlockSize - Gets the inherent block size associated with a DM
11291411c6eeSJed Brown 
11301411c6eeSJed Brown    Not Collective
11311411c6eeSJed Brown 
11321411c6eeSJed Brown    Input Parameter:
11331411c6eeSJed Brown .  dm - the DM with block structure
11341411c6eeSJed Brown 
11351411c6eeSJed Brown    Output Parameter:
11361411c6eeSJed Brown .  bs - the block size, 1 implies no exploitable block structure
11371411c6eeSJed Brown 
11381411c6eeSJed Brown    Level: intermediate
11391411c6eeSJed Brown 
1140fc31e74dSBarry Smith .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
11411411c6eeSJed Brown @*/
11427087cfbeSBarry Smith PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
11431411c6eeSJed Brown {
11441411c6eeSJed Brown   PetscFunctionBegin;
11451411c6eeSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1146534a8f05SLisandro Dalcin   PetscValidIntPointer(bs,2);
11477a8be351SBarry Smith   PetscCheck(dm->bs >= 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet");
11481411c6eeSJed Brown   *bs = dm->bs;
11491411c6eeSJed Brown   PetscFunctionReturn(0);
11501411c6eeSJed Brown }
11511411c6eeSJed Brown 
115248eeb7c8SBarry Smith /*@C
11538472ad0fSDave May     DMCreateInterpolation - Gets interpolation matrix between two DM objects
115447c6ae99SBarry Smith 
1155a5bc1bf3SBarry Smith     Collective on dmc
115647c6ae99SBarry Smith 
1157d8d19677SJose E. Roman     Input Parameters:
1158a5bc1bf3SBarry Smith +   dmc - the DM object
1159a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
116047c6ae99SBarry Smith 
1161d8d19677SJose E. Roman     Output Parameters:
116247c6ae99SBarry Smith +  mat - the interpolation
116347c6ae99SBarry Smith -  vec - the scaling (optional)
116447c6ae99SBarry Smith 
116547c6ae99SBarry Smith     Level: developer
116647c6ae99SBarry Smith 
116795452b02SPatrick Sanan     Notes:
116895452b02SPatrick 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
116985afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1170d52bd9f3SBarry Smith 
11711f588964SMatthew G Knepley         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1172d52bd9f3SBarry Smith         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
117385afcc9aSBarry Smith 
1174*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale()
117547c6ae99SBarry Smith 
117647c6ae99SBarry Smith @*/
1177a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec)
117847c6ae99SBarry Smith {
117947c6ae99SBarry Smith   PetscFunctionBegin;
1180a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1181a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1182c7d20fa0SStefano Zampini   PetscValidPointer(mat,3);
11837a8be351SBarry Smith   PetscCheck(dmc->ops->createinterpolation,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name);
11849566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0));
11859566063dSJacob Faibussowitsch   PetscCall((*dmc->ops->createinterpolation)(dmc,dmf,mat,vec));
11869566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0));
118747c6ae99SBarry Smith   PetscFunctionReturn(0);
118847c6ae99SBarry Smith }
118947c6ae99SBarry Smith 
11903ad4599aSBarry Smith /*@
1191d3e313eaSPatrick Sanan     DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction.
11922ed6491fSPatrick Sanan 
11932ed6491fSPatrick Sanan   Input Parameters:
11942ed6491fSPatrick Sanan +      dac - DM that defines a coarse mesh
11952ed6491fSPatrick Sanan .      daf - DM that defines a fine mesh
11962ed6491fSPatrick Sanan -      mat - the restriction (or interpolation operator) from fine to coarse
11972ed6491fSPatrick Sanan 
11982ed6491fSPatrick Sanan   Output Parameter:
11992ed6491fSPatrick Sanan .    scale - the scaled vector
12002ed6491fSPatrick Sanan 
12012ed6491fSPatrick Sanan   Level: developer
12022ed6491fSPatrick Sanan 
1203e9c74fd6SRichard Tran Mills   Developer Notes:
1204e9c74fd6SRichard Tran Mills   If the fine-scale DMDA has the -dm_bind_below option set to true, then DMCreateInterpolationScale() calls MatSetBindingPropagates()
1205e9c74fd6SRichard Tran Mills   on the restriction/interpolation operator to set the bindingpropagates flag to true.
1206e9c74fd6SRichard Tran Mills 
12072ed6491fSPatrick Sanan .seealso: DMCreateInterpolation()
12082ed6491fSPatrick Sanan 
12092ed6491fSPatrick Sanan @*/
12102ed6491fSPatrick Sanan PetscErrorCode  DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale)
12112ed6491fSPatrick Sanan {
12122ed6491fSPatrick Sanan   Vec            fine;
12132ed6491fSPatrick Sanan   PetscScalar    one = 1.0;
12149704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
1215e9c74fd6SRichard Tran Mills   PetscBool      bindingpropagates,isbound;
12169704db99SRichard Tran Mills #endif
12172ed6491fSPatrick Sanan 
12182ed6491fSPatrick Sanan   PetscFunctionBegin;
12199566063dSJacob Faibussowitsch   PetscCall(DMCreateGlobalVector(daf,&fine));
12209566063dSJacob Faibussowitsch   PetscCall(DMCreateGlobalVector(dac,scale));
12219566063dSJacob Faibussowitsch   PetscCall(VecSet(fine,one));
12229704db99SRichard Tran Mills #if defined(PETSC_HAVE_CUDA)
12239704db99SRichard Tran Mills   /* If the 'fine' Vec is bound to the CPU, it makes sense to bind 'mat' as well.
12249704db99SRichard Tran Mills    * Note that we only do this for the CUDA case, right now, but if we add support for MatMultTranspose() via ViennaCL,
12259704db99SRichard Tran Mills    * we'll need to do it for that case, too.*/
12269566063dSJacob Faibussowitsch   PetscCall(VecGetBindingPropagates(fine,&bindingpropagates));
1227e9c74fd6SRichard Tran Mills   if (bindingpropagates) {
12289566063dSJacob Faibussowitsch     PetscCall(MatSetBindingPropagates(mat,PETSC_TRUE));
12299566063dSJacob Faibussowitsch     PetscCall(VecBoundToCPU(fine,&isbound));
12309566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(mat,isbound));
123183aa49f4SRichard Tran Mills   }
12329704db99SRichard Tran Mills #endif
12339566063dSJacob Faibussowitsch   PetscCall(MatRestrict(mat,fine,*scale));
12349566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&fine));
12359566063dSJacob Faibussowitsch   PetscCall(VecReciprocal(*scale));
12362ed6491fSPatrick Sanan   PetscFunctionReturn(0);
12372ed6491fSPatrick Sanan }
12382ed6491fSPatrick Sanan 
12392ed6491fSPatrick Sanan /*@
12403ad4599aSBarry Smith     DMCreateRestriction - Gets restriction matrix between two DM objects
12413ad4599aSBarry Smith 
1242a5bc1bf3SBarry Smith     Collective on dmc
12433ad4599aSBarry Smith 
1244d8d19677SJose E. Roman     Input Parameters:
1245a5bc1bf3SBarry Smith +   dmc - the DM object
1246a5bc1bf3SBarry Smith -   dmf - the second, finer DM object
12473ad4599aSBarry Smith 
12483ad4599aSBarry Smith     Output Parameter:
12493ad4599aSBarry Smith .  mat - the restriction
12503ad4599aSBarry Smith 
12513ad4599aSBarry Smith     Level: developer
12523ad4599aSBarry Smith 
125395452b02SPatrick Sanan     Notes:
125495452b02SPatrick 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
12553ad4599aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
12563ad4599aSBarry Smith 
1257*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
12583ad4599aSBarry Smith 
12593ad4599aSBarry Smith @*/
1260a5bc1bf3SBarry Smith PetscErrorCode  DMCreateRestriction(DM dmc,DM dmf,Mat *mat)
12613ad4599aSBarry Smith {
12623ad4599aSBarry Smith   PetscFunctionBegin;
1263a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1264a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
12655a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
12667a8be351SBarry Smith   PetscCheck(dmc->ops->createrestriction,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name);
12679566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0));
12689566063dSJacob Faibussowitsch   PetscCall((*dmc->ops->createrestriction)(dmc,dmf,mat));
12699566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0));
12703ad4599aSBarry Smith   PetscFunctionReturn(0);
12713ad4599aSBarry Smith }
12723ad4599aSBarry Smith 
127347c6ae99SBarry Smith /*@
12748472ad0fSDave May     DMCreateInjection - Gets injection matrix between two DM objects
127547c6ae99SBarry Smith 
1276a5bc1bf3SBarry Smith     Collective on dac
127747c6ae99SBarry Smith 
1278d8d19677SJose E. Roman     Input Parameters:
1279a5bc1bf3SBarry Smith +   dac - the DM object
1280a5bc1bf3SBarry Smith -   daf - the second, finer DM object
128147c6ae99SBarry Smith 
128247c6ae99SBarry Smith     Output Parameter:
12836dbf9973SLawrence Mitchell .   mat - the injection
128447c6ae99SBarry Smith 
128547c6ae99SBarry Smith     Level: developer
128647c6ae99SBarry Smith 
128795452b02SPatrick Sanan    Notes:
128895452b02SPatrick 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
128985afcc9aSBarry Smith         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
129085afcc9aSBarry Smith 
1291*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMCreateInterpolation()
129247c6ae99SBarry Smith 
129347c6ae99SBarry Smith @*/
1294a5bc1bf3SBarry Smith PetscErrorCode  DMCreateInjection(DM dac,DM daf,Mat *mat)
129547c6ae99SBarry Smith {
129647c6ae99SBarry Smith   PetscFunctionBegin;
1297a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dac,DM_CLASSID,1);
1298a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(daf,DM_CLASSID,2);
12995a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13007a8be351SBarry Smith   PetscCheck(dac->ops->createinjection,PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name);
13019566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0));
13029566063dSJacob Faibussowitsch   PetscCall((*dac->ops->createinjection)(dac,daf,mat));
13039566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0));
130447c6ae99SBarry Smith   PetscFunctionReturn(0);
130547c6ae99SBarry Smith }
130647c6ae99SBarry Smith 
1307b412c318SBarry Smith /*@
1308bd041c0cSMatthew G. Knepley   DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j
1309bd041c0cSMatthew G. Knepley 
1310a5bc1bf3SBarry Smith   Collective on dac
1311bd041c0cSMatthew G. Knepley 
1312d8d19677SJose E. Roman   Input Parameters:
1313b4937a87SMatthew G. Knepley + dmc - the target DM object
1314b4937a87SMatthew G. Knepley - dmf - the source DM object
1315bd041c0cSMatthew G. Knepley 
1316bd041c0cSMatthew G. Knepley   Output Parameter:
1317b4937a87SMatthew G. Knepley . mat - the mass matrix
1318bd041c0cSMatthew G. Knepley 
1319bd041c0cSMatthew G. Knepley   Level: developer
1320bd041c0cSMatthew G. Knepley 
1321*5b8ffe73SMark Adams .seealso DMCreateMassMatrixLumped(), DMCreateMatrix(), DMCreateMassMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1322bd041c0cSMatthew G. Knepley @*/
1323b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrix(DM dmc, DM dmf, Mat *mat)
1324bd041c0cSMatthew G. Knepley {
1325bd041c0cSMatthew G. Knepley   PetscFunctionBegin;
1326b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dmc, DM_CLASSID, 1);
1327b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dmf, DM_CLASSID, 2);
13285a84ad33SLisandro Dalcin   PetscValidPointer(mat,3);
13292c71b3e2SJacob Faibussowitsch   PetscCheck(dmc->ops->createmassmatrix,PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dmc)->type_name);
1330*5b8ffe73SMark Adams   PetscCall(PetscLogEventBegin(DM_CreateMassMatrix,0,0,0,0));
13319566063dSJacob Faibussowitsch   PetscCall((*dmc->ops->createmassmatrix)(dmc, dmf, mat));
1332*5b8ffe73SMark Adams   PetscCall(PetscLogEventEnd(DM_CreateMassMatrix,0,0,0,0));
1333b4937a87SMatthew G. Knepley   PetscFunctionReturn(0);
1334b4937a87SMatthew G. Knepley }
1335b4937a87SMatthew G. Knepley 
1336b4937a87SMatthew G. Knepley /*@
1337b4937a87SMatthew G. Knepley   DMCreateMassMatrixLumped - Gets the lumped mass matrix for a given DM
1338b4937a87SMatthew G. Knepley 
1339b4937a87SMatthew G. Knepley   Collective on dm
1340b4937a87SMatthew G. Knepley 
1341b4937a87SMatthew G. Knepley   Input Parameter:
1342b4937a87SMatthew G. Knepley . dm - the DM object
1343b4937a87SMatthew G. Knepley 
1344b4937a87SMatthew G. Knepley   Output Parameter:
1345b4937a87SMatthew G. Knepley . lm - the lumped mass matrix
1346b4937a87SMatthew G. Knepley 
1347b4937a87SMatthew G. Knepley   Level: developer
1348b4937a87SMatthew G. Knepley 
1349*5b8ffe73SMark Adams .seealso DMCreateMassMatrix(), DMCreateMatrix(), DMCreateMassMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1350b4937a87SMatthew G. Knepley @*/
1351b4937a87SMatthew G. Knepley PetscErrorCode DMCreateMassMatrixLumped(DM dm, Vec *lm)
1352b4937a87SMatthew G. Knepley {
1353b4937a87SMatthew G. Knepley   PetscFunctionBegin;
1354b4937a87SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1355b4937a87SMatthew G. Knepley   PetscValidPointer(lm,2);
13562c71b3e2SJacob Faibussowitsch   PetscCheck(dm->ops->createmassmatrixlumped,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrixLumped",((PetscObject)dm)->type_name);
13579566063dSJacob Faibussowitsch   PetscCall((*dm->ops->createmassmatrixlumped)(dm, lm));
1358bd041c0cSMatthew G. Knepley   PetscFunctionReturn(0);
1359bd041c0cSMatthew G. Knepley }
1360bd041c0cSMatthew G. Knepley 
1361bd041c0cSMatthew G. Knepley /*@
1362b412c318SBarry Smith     DMCreateColoring - Gets coloring for a DM
136347c6ae99SBarry Smith 
1364d083f849SBarry Smith     Collective on dm
136547c6ae99SBarry Smith 
1366d8d19677SJose E. Roman     Input Parameters:
136747c6ae99SBarry Smith +   dm - the DM object
13685bdb020cSBarry Smith -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
136947c6ae99SBarry Smith 
137047c6ae99SBarry Smith     Output Parameter:
137147c6ae99SBarry Smith .   coloring - the coloring
137247c6ae99SBarry Smith 
1373ec5066bdSBarry Smith     Notes:
1374ec5066bdSBarry 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
1375ec5066bdSBarry Smith        matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors).
1376ec5066bdSBarry Smith 
1377ec5066bdSBarry Smith        This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate()
1378ec5066bdSBarry Smith 
137947c6ae99SBarry Smith     Level: developer
138047c6ae99SBarry Smith 
1381*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMCreateMassMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate()
138247c6ae99SBarry Smith 
1383aab9d709SJed Brown @*/
1384b412c318SBarry Smith PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
138547c6ae99SBarry Smith {
138647c6ae99SBarry Smith   PetscFunctionBegin;
1387171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
13885a84ad33SLisandro Dalcin   PetscValidPointer(coloring,3);
13897a8be351SBarry Smith   PetscCheck(dm->ops->getcoloring,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name);
13909566063dSJacob Faibussowitsch   PetscCall((*dm->ops->getcoloring)(dm,ctype,coloring));
139147c6ae99SBarry Smith   PetscFunctionReturn(0);
139247c6ae99SBarry Smith }
139347c6ae99SBarry Smith 
1394b412c318SBarry Smith /*@
13958472ad0fSDave May     DMCreateMatrix - Gets empty Jacobian for a DM
139647c6ae99SBarry Smith 
1397d083f849SBarry Smith     Collective on dm
139847c6ae99SBarry Smith 
139947c6ae99SBarry Smith     Input Parameter:
1400b412c318SBarry Smith .   dm - the DM object
140147c6ae99SBarry Smith 
140247c6ae99SBarry Smith     Output Parameter:
140347c6ae99SBarry Smith .   mat - the empty Jacobian
140447c6ae99SBarry Smith 
1405073dac72SJed Brown     Level: beginner
140647c6ae99SBarry Smith 
1407f27dd7c6SMatthew G. Knepley     Options Database Keys:
1408*5b8ffe73SMark Adams . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix() and DMCreateMassMatrix(), but do not fill it with zeros
1409f27dd7c6SMatthew G. Knepley 
141095452b02SPatrick Sanan     Notes:
141195452b02SPatrick Sanan     This properly preallocates the number of nonzeros in the sparse matrix so you
141294013140SBarry Smith        do not need to do it yourself.
141394013140SBarry Smith 
141494013140SBarry Smith        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
14157889ec69SBarry Smith        the nonzero pattern call DMSetMatrixPreallocateOnly()
141694013140SBarry Smith 
141794013140SBarry 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
141894013140SBarry Smith        internally by PETSc.
141994013140SBarry Smith 
142094013140SBarry Smith        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1421aa219208SBarry Smith        the indices for the global numbering for DMDAs which is complicated.
142294013140SBarry Smith 
1423*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType(), DMCreateMassMatrix()
142447c6ae99SBarry Smith 
1425aab9d709SJed Brown @*/
1426b412c318SBarry Smith PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
142747c6ae99SBarry Smith {
142847c6ae99SBarry Smith   PetscFunctionBegin;
1429171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1430064a246eSJacob Faibussowitsch   PetscValidPointer(mat,2);
14317a8be351SBarry Smith   PetscCheck(dm->ops->creatematrix,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
14329566063dSJacob Faibussowitsch   PetscCall(MatInitializePackage());
14339566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_CreateMatrix,0,0,0,0));
14349566063dSJacob Faibussowitsch   PetscCall((*dm->ops->creatematrix)(dm,mat));
143576bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1436c6b011d8SStefano Zampini     DM mdm;
1437c6b011d8SStefano Zampini 
14389566063dSJacob Faibussowitsch     PetscCall(MatGetDM(*mat,&mdm));
14397a8be351SBarry Smith     PetscCheck(mdm,PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix",((PetscObject)dm)->type_name);
1440c6b011d8SStefano Zampini   }
1441e571a35bSMatthew G. Knepley   /* Handle nullspace and near nullspace */
1442e5e52638SMatthew G. Knepley   if (dm->Nf) {
1443e571a35bSMatthew G. Knepley     MatNullSpace nullSpace;
1444649ef022SMatthew Knepley     PetscInt     Nf, f;
1445e571a35bSMatthew G. Knepley 
14469566063dSJacob Faibussowitsch     PetscCall(DMGetNumFields(dm, &Nf));
1447649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1448649ef022SMatthew Knepley       if (dm->nullspaceConstructors[f]) {
14499566063dSJacob Faibussowitsch         PetscCall((*dm->nullspaceConstructors[f])(dm, f, f, &nullSpace));
14509566063dSJacob Faibussowitsch         PetscCall(MatSetNullSpace(*mat, nullSpace));
14519566063dSJacob Faibussowitsch         PetscCall(MatNullSpaceDestroy(&nullSpace));
1452649ef022SMatthew Knepley         break;
1453e571a35bSMatthew G. Knepley       }
1454649ef022SMatthew Knepley     }
1455649ef022SMatthew Knepley     for (f = 0; f < Nf; ++f) {
1456649ef022SMatthew Knepley       if (dm->nearnullspaceConstructors[f]) {
14579566063dSJacob Faibussowitsch         PetscCall((*dm->nearnullspaceConstructors[f])(dm, f, f, &nullSpace));
14589566063dSJacob Faibussowitsch         PetscCall(MatSetNearNullSpace(*mat, nullSpace));
14599566063dSJacob Faibussowitsch         PetscCall(MatNullSpaceDestroy(&nullSpace));
1460e571a35bSMatthew G. Knepley       }
1461e571a35bSMatthew G. Knepley     }
1462e571a35bSMatthew G. Knepley   }
14639566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_CreateMatrix,0,0,0,0));
146447c6ae99SBarry Smith   PetscFunctionReturn(0);
146547c6ae99SBarry Smith }
146647c6ae99SBarry Smith 
1467732e2eb9SMatthew G Knepley /*@
1468aa0f6e3cSJed Brown   DMSetMatrixPreallocateSkip - When DMCreateMatrix() is called the matrix sizes and ISLocalToGlobalMapping will be
1469aa0f6e3cSJed Brown   properly set, but the entries will not be preallocated. This is most useful to reduce initialization costs when
1470aa0f6e3cSJed Brown   MatSetPreallocationCOO() and MatSetValuesCOO() will be used.
1471aa0f6e3cSJed Brown 
1472aa0f6e3cSJed Brown   Logically Collective on dm
1473aa0f6e3cSJed Brown 
1474aa0f6e3cSJed Brown   Input Parameters:
1475aa0f6e3cSJed Brown + dm - the DM
1476aa0f6e3cSJed Brown - skip - PETSC_TRUE to skip preallocation
1477aa0f6e3cSJed Brown 
1478aa0f6e3cSJed Brown   Level: developer
1479aa0f6e3cSJed Brown 
1480aa0f6e3cSJed Brown .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1481aa0f6e3cSJed Brown @*/
1482aa0f6e3cSJed Brown PetscErrorCode DMSetMatrixPreallocateSkip(DM dm, PetscBool skip)
1483aa0f6e3cSJed Brown {
1484aa0f6e3cSJed Brown   PetscFunctionBegin;
1485aa0f6e3cSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1486aa0f6e3cSJed Brown   dm->prealloc_skip = skip;
1487aa0f6e3cSJed Brown   PetscFunctionReturn(0);
1488aa0f6e3cSJed Brown }
1489aa0f6e3cSJed Brown 
1490aa0f6e3cSJed Brown /*@
1491950540a4SJed Brown   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1492732e2eb9SMatthew G Knepley     preallocated but the nonzero structure and zero values will not be set.
1493732e2eb9SMatthew G Knepley 
1494d083f849SBarry Smith   Logically Collective on dm
1495732e2eb9SMatthew G Knepley 
1496d8d19677SJose E. Roman   Input Parameters:
1497732e2eb9SMatthew G Knepley + dm - the DM
1498732e2eb9SMatthew G Knepley - only - PETSC_TRUE if only want preallocation
1499732e2eb9SMatthew G Knepley 
1500732e2eb9SMatthew G Knepley   Level: developer
1501f27dd7c6SMatthew G. Knepley 
1502f27dd7c6SMatthew G. Knepley   Options Database Keys:
1503*5b8ffe73SMark Adams . -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), DMCreateMassMatrix(), but do not fill it with zeros
1504f27dd7c6SMatthew G. Knepley 
1505*5b8ffe73SMark Adams .seealso DMCreateMatrix(), DMCreateMassMatrix(), DMSetMatrixStructureOnly()
1506732e2eb9SMatthew G Knepley @*/
1507732e2eb9SMatthew G Knepley PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1508732e2eb9SMatthew G Knepley {
1509732e2eb9SMatthew G Knepley   PetscFunctionBegin;
1510732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1511732e2eb9SMatthew G Knepley   dm->prealloc_only = only;
1512732e2eb9SMatthew G Knepley   PetscFunctionReturn(0);
1513732e2eb9SMatthew G Knepley }
1514732e2eb9SMatthew G Knepley 
1515b06ff27eSHong Zhang /*@
1516b06ff27eSHong Zhang   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1517b06ff27eSHong Zhang     but the array for values will not be allocated.
1518b06ff27eSHong Zhang 
1519d083f849SBarry Smith   Logically Collective on dm
1520b06ff27eSHong Zhang 
1521d8d19677SJose E. Roman   Input Parameters:
1522b06ff27eSHong Zhang + dm - the DM
1523b06ff27eSHong Zhang - only - PETSC_TRUE if only want matrix stucture
1524b06ff27eSHong Zhang 
1525b06ff27eSHong Zhang   Level: developer
1526b06ff27eSHong Zhang .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1527b06ff27eSHong Zhang @*/
1528b06ff27eSHong Zhang PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1529b06ff27eSHong Zhang {
1530b06ff27eSHong Zhang   PetscFunctionBegin;
1531b06ff27eSHong Zhang   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1532b06ff27eSHong Zhang   dm->structure_only = only;
1533b06ff27eSHong Zhang   PetscFunctionReturn(0);
1534b06ff27eSHong Zhang }
1535b06ff27eSHong Zhang 
1536a89ea682SMatthew G Knepley /*@C
1537aa1993deSMatthew G Knepley   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1538a89ea682SMatthew G Knepley 
1539a89ea682SMatthew G Knepley   Not Collective
1540a89ea682SMatthew G Knepley 
1541a89ea682SMatthew G Knepley   Input Parameters:
1542a89ea682SMatthew G Knepley + dm - the DM object
1543a5b23f4aSJose E. Roman . count - The minimum size
154469291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1545a89ea682SMatthew G Knepley 
1546a89ea682SMatthew G Knepley   Output Parameter:
1547a89ea682SMatthew G Knepley . array - the work array
1548a89ea682SMatthew G Knepley 
1549a89ea682SMatthew G Knepley   Level: developer
1550a89ea682SMatthew G Knepley 
1551a89ea682SMatthew G Knepley .seealso DMDestroy(), DMCreate()
1552a89ea682SMatthew G Knepley @*/
155369291d52SBarry Smith PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1554a89ea682SMatthew G Knepley {
1555aa1993deSMatthew G Knepley   DMWorkLink     link;
155669291d52SBarry Smith   PetscMPIInt    dsize;
1557a89ea682SMatthew G Knepley 
1558a89ea682SMatthew G Knepley   PetscFunctionBegin;
1559a89ea682SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1560aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1561aa1993deSMatthew G Knepley   if (dm->workin) {
1562aa1993deSMatthew G Knepley     link       = dm->workin;
1563aa1993deSMatthew G Knepley     dm->workin = dm->workin->next;
1564aa1993deSMatthew G Knepley   } else {
15659566063dSJacob Faibussowitsch     PetscCall(PetscNewLog(dm,&link));
1566a89ea682SMatthew G Knepley   }
15679566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Type_size(dtype,&dsize));
15685056fcd2SBarry Smith   if (((size_t)dsize*count) > link->bytes) {
15699566063dSJacob Faibussowitsch     PetscCall(PetscFree(link->mem));
15709566063dSJacob Faibussowitsch     PetscCall(PetscMalloc(dsize*count,&link->mem));
1571854ce69bSBarry Smith     link->bytes = dsize*count;
1572aa1993deSMatthew G Knepley   }
1573aa1993deSMatthew G Knepley   link->next   = dm->workout;
1574aa1993deSMatthew G Knepley   dm->workout  = link;
157500d952a4SJed Brown #if defined(PETSC_HAVE_VALGRIND)
157600d952a4SJed Brown   VALGRIND_MAKE_MEM_NOACCESS((char*)link->mem + (size_t)dsize*count, link->bytes - (size_t)dsize*count);
157700d952a4SJed Brown   VALGRIND_MAKE_MEM_UNDEFINED(link->mem, (size_t)dsize*count);
157800d952a4SJed Brown #endif
1579aa1993deSMatthew G Knepley   *(void**)mem = link->mem;
1580a89ea682SMatthew G Knepley   PetscFunctionReturn(0);
1581a89ea682SMatthew G Knepley }
1582a89ea682SMatthew G Knepley 
1583aa1993deSMatthew G Knepley /*@C
1584aa1993deSMatthew G Knepley   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1585aa1993deSMatthew G Knepley 
1586aa1993deSMatthew G Knepley   Not Collective
1587aa1993deSMatthew G Knepley 
1588aa1993deSMatthew G Knepley   Input Parameters:
1589aa1993deSMatthew G Knepley + dm - the DM object
1590a5b23f4aSJose E. Roman . count - The minimum size
159169291d52SBarry Smith - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT
1592aa1993deSMatthew G Knepley 
1593aa1993deSMatthew G Knepley   Output Parameter:
1594aa1993deSMatthew G Knepley . array - the work array
1595aa1993deSMatthew G Knepley 
1596aa1993deSMatthew G Knepley   Level: developer
1597aa1993deSMatthew G Knepley 
159895452b02SPatrick Sanan   Developer Notes:
159995452b02SPatrick Sanan     count and dtype are ignored, they are only needed for DMGetWorkArray()
1600147403d9SBarry Smith 
1601aa1993deSMatthew G Knepley .seealso DMDestroy(), DMCreate()
1602aa1993deSMatthew G Knepley @*/
160369291d52SBarry Smith PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1604aa1993deSMatthew G Knepley {
1605aa1993deSMatthew G Knepley   DMWorkLink *p,link;
1606aa1993deSMatthew G Knepley 
1607aa1993deSMatthew G Knepley   PetscFunctionBegin;
1608aa1993deSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1609aa1993deSMatthew G Knepley   PetscValidPointer(mem,4);
1610aa1993deSMatthew G Knepley   for (p=&dm->workout; (link=*p); p=&link->next) {
1611aa1993deSMatthew G Knepley     if (link->mem == *(void**)mem) {
1612aa1993deSMatthew G Knepley       *p           = link->next;
1613aa1993deSMatthew G Knepley       link->next   = dm->workin;
1614aa1993deSMatthew G Knepley       dm->workin   = link;
16150298fd71SBarry Smith       *(void**)mem = NULL;
1616aa1993deSMatthew G Knepley       PetscFunctionReturn(0);
1617aa1993deSMatthew G Knepley     }
1618aa1993deSMatthew G Knepley   }
1619aa1993deSMatthew G Knepley   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1620aa1993deSMatthew G Knepley }
1621e7c4fc90SDmitry Karpeev 
16228cda7954SMatthew G. Knepley /*@C
1623147403d9SBarry Smith   DMSetNullSpaceConstructor - Provide a callback function which constructs the nullspace for a given field when function spaces are joined or split, such as in DMCreateSubDM()
16248cda7954SMatthew G. Knepley 
16258cda7954SMatthew G. Knepley   Logically collective on DM
16268cda7954SMatthew G. Knepley 
16278cda7954SMatthew G. Knepley   Input Parameters:
16288cda7954SMatthew G. Knepley + dm     - The DM
16298cda7954SMatthew G. Knepley . field  - The field number for the nullspace
16308cda7954SMatthew G. Knepley - nullsp - A callback to create the nullspace
16318cda7954SMatthew G. Knepley 
1632147403d9SBarry Smith   Calling sequence of nullsp:
1633147403d9SBarry Smith .vb
1634147403d9SBarry Smith     PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
1635147403d9SBarry Smith .ve
1636147403d9SBarry Smith +  dm        - The present DM
1637147403d9SBarry Smith .  origField - The field number given above, in the original DM
1638147403d9SBarry Smith .  field     - The field number in dm
1639147403d9SBarry Smith -  nullSpace - The nullspace for the given field
16408cda7954SMatthew G. Knepley 
16418cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16428cda7954SMatthew G. Knepley 
164349762cbcSSatish Balay    Level: intermediate
164449762cbcSSatish Balay 
16458cda7954SMatthew G. Knepley .seealso: DMGetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
1646147403d9SBarry Smith @*/
1647147403d9SBarry Smith PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM, PetscInt, PetscInt, MatNullSpace*))
1648435a35e8SMatthew G Knepley {
1649435a35e8SMatthew G Knepley   PetscFunctionBegin;
1650435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
16517a8be351SBarry Smith   PetscCheck(field < 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %" PetscInt_FMT " >= 10 fields", field);
1652435a35e8SMatthew G Knepley   dm->nullspaceConstructors[field] = nullsp;
1653435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
1654435a35e8SMatthew G Knepley }
1655435a35e8SMatthew G Knepley 
16568cda7954SMatthew G. Knepley /*@C
16578cda7954SMatthew G. Knepley   DMGetNullSpaceConstructor - Return the callback function which constructs the nullspace for a given field, or NULL
16588cda7954SMatthew G. Knepley 
16598cda7954SMatthew G. Knepley   Not collective
16608cda7954SMatthew G. Knepley 
16618cda7954SMatthew G. Knepley   Input Parameters:
16628cda7954SMatthew G. Knepley + dm     - The DM
16638cda7954SMatthew G. Knepley - field  - The field number for the nullspace
16648cda7954SMatthew G. Knepley 
16658cda7954SMatthew G. Knepley   Output Parameter:
16668cda7954SMatthew G. Knepley . nullsp - A callback to create the nullspace
16678cda7954SMatthew G. Knepley 
1668147403d9SBarry Smith   Calling sequence of nullsp:
1669147403d9SBarry Smith .vb
1670147403d9SBarry Smith     PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
1671147403d9SBarry Smith .ve
1672147403d9SBarry Smith +  dm        - The present DM
1673147403d9SBarry Smith .  origField - The field number given above, in the original DM
1674147403d9SBarry Smith .  field     - The field number in dm
1675147403d9SBarry Smith -  nullSpace - The nullspace for the given field
16768cda7954SMatthew G. Knepley 
16778cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
16788cda7954SMatthew G. Knepley 
167949762cbcSSatish Balay    Level: intermediate
168049762cbcSSatish Balay 
16818cda7954SMatthew G. Knepley .seealso: DMSetNullSpaceConstructor(), DMSetNearNullSpaceConstructor(), DMGetNearNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
1682147403d9SBarry Smith @*/
1683147403d9SBarry Smith PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM, PetscInt, PetscInt, MatNullSpace *))
16840a50eb56SMatthew G. Knepley {
16850a50eb56SMatthew G. Knepley   PetscFunctionBegin;
16860a50eb56SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1687f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
16887a8be351SBarry Smith   PetscCheck(field < 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %" PetscInt_FMT " >= 10 fields", field);
16890a50eb56SMatthew G. Knepley   *nullsp = dm->nullspaceConstructors[field];
16900a50eb56SMatthew G. Knepley   PetscFunctionReturn(0);
16910a50eb56SMatthew G. Knepley }
16920a50eb56SMatthew G. Knepley 
16938cda7954SMatthew G. Knepley /*@C
16948cda7954SMatthew G. Knepley   DMSetNearNullSpaceConstructor - Provide a callback function which constructs the near-nullspace for a given field
16958cda7954SMatthew G. Knepley 
16968cda7954SMatthew G. Knepley   Logically collective on DM
16978cda7954SMatthew G. Knepley 
16988cda7954SMatthew G. Knepley   Input Parameters:
16998cda7954SMatthew G. Knepley + dm     - The DM
17008cda7954SMatthew G. Knepley . field  - The field number for the nullspace
17018cda7954SMatthew G. Knepley - nullsp - A callback to create the near-nullspace
17028cda7954SMatthew G. Knepley 
1703147403d9SBarry Smith   Calling sequence of nullsp:
1704147403d9SBarry Smith .vb
1705147403d9SBarry Smith     PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
1706147403d9SBarry Smith .ve
1707147403d9SBarry Smith +  dm        - The present DM
1708147403d9SBarry Smith .  origField - The field number given above, in the original DM
1709147403d9SBarry Smith .  field     - The field number in dm
1710147403d9SBarry Smith -  nullSpace - The nullspace for the given field
17118cda7954SMatthew G. Knepley 
17128cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
17138cda7954SMatthew G. Knepley 
171449762cbcSSatish Balay    Level: intermediate
171549762cbcSSatish Balay 
17168cda7954SMatthew G. Knepley .seealso: DMGetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
1717147403d9SBarry Smith @*/
1718147403d9SBarry Smith PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM, PetscInt, PetscInt, MatNullSpace *))
1719f9d4088aSMatthew G. Knepley {
1720f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1721f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
17227a8be351SBarry Smith   PetscCheck(field < 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %" PetscInt_FMT " >= 10 fields", field);
1723f9d4088aSMatthew G. Knepley   dm->nearnullspaceConstructors[field] = nullsp;
1724f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1725f9d4088aSMatthew G. Knepley }
1726f9d4088aSMatthew G. Knepley 
17278cda7954SMatthew G. Knepley /*@C
17288cda7954SMatthew G. Knepley   DMGetNearNullSpaceConstructor - Return the callback function which constructs the near-nullspace for a given field, or NULL
17298cda7954SMatthew G. Knepley 
17308cda7954SMatthew G. Knepley   Not collective
17318cda7954SMatthew G. Knepley 
17328cda7954SMatthew G. Knepley   Input Parameters:
17338cda7954SMatthew G. Knepley + dm     - The DM
17348cda7954SMatthew G. Knepley - field  - The field number for the nullspace
17358cda7954SMatthew G. Knepley 
17368cda7954SMatthew G. Knepley   Output Parameter:
17378cda7954SMatthew G. Knepley . nullsp - A callback to create the near-nullspace
17388cda7954SMatthew G. Knepley 
1739147403d9SBarry Smith   Calling sequence of nullsp:
1740147403d9SBarry Smith .vb
1741147403d9SBarry Smith     PetscErrorCode nullsp(DM dm, PetscInt origField, PetscInt field, MatNullSpace *nullSpace)
1742147403d9SBarry Smith .ve
1743147403d9SBarry Smith +  dm        - The present DM
1744147403d9SBarry Smith .  origField - The field number given above, in the original DM
1745147403d9SBarry Smith .  field     - The field number in dm
1746147403d9SBarry Smith -  nullSpace - The nullspace for the given field
17478cda7954SMatthew G. Knepley 
17488cda7954SMatthew G. Knepley   This function is currently not available from Fortran.
17498cda7954SMatthew G. Knepley 
175049762cbcSSatish Balay    Level: intermediate
175149762cbcSSatish Balay 
17528cda7954SMatthew G. Knepley .seealso: DMSetNearNullSpaceConstructor(), DMSetNullSpaceConstructor(), DMGetNullSpaceConstructor(), DMCreateSubDM(), DMCreateSuperDM()
1753147403d9SBarry Smith @*/
1754147403d9SBarry Smith PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM, PetscInt, PetscInt, MatNullSpace *))
1755f9d4088aSMatthew G. Knepley {
1756f9d4088aSMatthew G. Knepley   PetscFunctionBegin;
1757f9d4088aSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1758f9d4088aSMatthew G. Knepley   PetscValidPointer(nullsp, 3);
17597a8be351SBarry Smith   PetscCheck(field < 10,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %" PetscInt_FMT " >= 10 fields", field);
1760f9d4088aSMatthew G. Knepley   *nullsp = dm->nearnullspaceConstructors[field];
1761f9d4088aSMatthew G. Knepley   PetscFunctionReturn(0);
1762f9d4088aSMatthew G. Knepley }
1763f9d4088aSMatthew G. Knepley 
17644f3b5142SJed Brown /*@C
17654d343eeaSMatthew G Knepley   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
17664d343eeaSMatthew G Knepley 
17674d343eeaSMatthew G Knepley   Not collective
17684d343eeaSMatthew G Knepley 
17694d343eeaSMatthew G Knepley   Input Parameter:
17704d343eeaSMatthew G Knepley . dm - the DM object
17714d343eeaSMatthew G Knepley 
17724d343eeaSMatthew G Knepley   Output Parameters:
17730298fd71SBarry Smith + numFields  - The number of fields (or NULL if not requested)
17740298fd71SBarry Smith . fieldNames - The name for each field (or NULL if not requested)
17750298fd71SBarry Smith - fields     - The global indices for each field (or NULL if not requested)
17764d343eeaSMatthew G Knepley 
17774d343eeaSMatthew G Knepley   Level: intermediate
17784d343eeaSMatthew G Knepley 
177921c9b008SJed Brown   Notes:
178021c9b008SJed Brown   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
178121c9b008SJed Brown   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
178221c9b008SJed Brown   PetscFree().
178321c9b008SJed Brown 
17844d343eeaSMatthew G Knepley .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
17854d343eeaSMatthew G Knepley @*/
178637d0c07bSMatthew G Knepley PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
17874d343eeaSMatthew G Knepley {
178837d0c07bSMatthew G Knepley   PetscSection   section, sectionGlobal;
17894d343eeaSMatthew G Knepley 
17904d343eeaSMatthew G Knepley   PetscFunctionBegin;
17914d343eeaSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
179269ca1f37SDmitry Karpeev   if (numFields) {
1793534a8f05SLisandro Dalcin     PetscValidIntPointer(numFields,2);
179469ca1f37SDmitry Karpeev     *numFields = 0;
179569ca1f37SDmitry Karpeev   }
179637d0c07bSMatthew G Knepley   if (fieldNames) {
179737d0c07bSMatthew G Knepley     PetscValidPointer(fieldNames,3);
17980298fd71SBarry Smith     *fieldNames = NULL;
179969ca1f37SDmitry Karpeev   }
180069ca1f37SDmitry Karpeev   if (fields) {
180169ca1f37SDmitry Karpeev     PetscValidPointer(fields,4);
18020298fd71SBarry Smith     *fields = NULL;
180369ca1f37SDmitry Karpeev   }
18049566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(dm, &section));
180537d0c07bSMatthew G Knepley   if (section) {
18063a544194SStefano Zampini     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
180737d0c07bSMatthew G Knepley     PetscInt nF, f, pStart, pEnd, p;
180837d0c07bSMatthew G Knepley 
18099566063dSJacob Faibussowitsch     PetscCall(DMGetGlobalSection(dm, &sectionGlobal));
18109566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetNumFields(section, &nF));
18119566063dSJacob Faibussowitsch     PetscCall(PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices));
18129566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(sectionGlobal, &pStart, &pEnd));
181337d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
181437d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
18159566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldComponents(section, f, &fieldNc[f]));
181637d0c07bSMatthew G Knepley     }
181737d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
181837d0c07bSMatthew G Knepley       PetscInt gdof;
181937d0c07bSMatthew G Knepley 
18209566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(sectionGlobal, p, &gdof));
182137d0c07bSMatthew G Knepley       if (gdof > 0) {
182237d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
18233a544194SStefano Zampini           PetscInt fdof, fcdof, fpdof;
182437d0c07bSMatthew G Knepley 
18259566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldDof(section, p, f, &fdof));
18269566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintDof(section, p, f, &fcdof));
18273a544194SStefano Zampini           fpdof = fdof-fcdof;
18283a544194SStefano Zampini           if (fpdof && fpdof != fieldNc[f]) {
18293a544194SStefano Zampini             /* Layout does not admit a pointwise block size */
18303a544194SStefano Zampini             fieldNc[f] = 1;
18313a544194SStefano Zampini           }
18323a544194SStefano Zampini           fieldSizes[f] += fpdof;
183337d0c07bSMatthew G Knepley         }
183437d0c07bSMatthew G Knepley       }
183537d0c07bSMatthew G Knepley     }
183637d0c07bSMatthew G Knepley     for (f = 0; f < nF; ++f) {
18379566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(fieldSizes[f], &fieldIndices[f]));
183837d0c07bSMatthew G Knepley       fieldSizes[f] = 0;
183937d0c07bSMatthew G Knepley     }
184037d0c07bSMatthew G Knepley     for (p = pStart; p < pEnd; ++p) {
184137d0c07bSMatthew G Knepley       PetscInt gdof, goff;
184237d0c07bSMatthew G Knepley 
18439566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(sectionGlobal, p, &gdof));
184437d0c07bSMatthew G Knepley       if (gdof > 0) {
18459566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetOffset(sectionGlobal, p, &goff));
184637d0c07bSMatthew G Knepley         for (f = 0; f < nF; ++f) {
184737d0c07bSMatthew G Knepley           PetscInt fdof, fcdof, fc;
184837d0c07bSMatthew G Knepley 
18499566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldDof(section, p, f, &fdof));
18509566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldConstraintDof(section, p, f, &fcdof));
185137d0c07bSMatthew G Knepley           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
185237d0c07bSMatthew G Knepley             fieldIndices[f][fieldSizes[f]] = goff++;
185337d0c07bSMatthew G Knepley           }
185437d0c07bSMatthew G Knepley         }
185537d0c07bSMatthew G Knepley       }
185637d0c07bSMatthew G Knepley     }
18578865f1eaSKarl Rupp     if (numFields) *numFields = nF;
185837d0c07bSMatthew G Knepley     if (fieldNames) {
18599566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nF, fieldNames));
186037d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
186137d0c07bSMatthew G Knepley         const char *fieldName;
186237d0c07bSMatthew G Knepley 
18639566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetFieldName(section, f, &fieldName));
18649566063dSJacob Faibussowitsch         PetscCall(PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]));
186537d0c07bSMatthew G Knepley       }
186637d0c07bSMatthew G Knepley     }
186737d0c07bSMatthew G Knepley     if (fields) {
18689566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nF, fields));
186937d0c07bSMatthew G Knepley       for (f = 0; f < nF; ++f) {
18703a544194SStefano Zampini         PetscInt bs, in[2], out[2];
18713a544194SStefano Zampini 
18729566063dSJacob Faibussowitsch         PetscCall(ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]));
18733a544194SStefano Zampini         in[0] = -fieldNc[f];
18743a544194SStefano Zampini         in[1] = fieldNc[f];
18751c2dc1cbSBarry Smith         PetscCall(MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm)));
18763a544194SStefano Zampini         bs    = (-out[0] == out[1]) ? out[1] : 1;
18779566063dSJacob Faibussowitsch         PetscCall(ISSetBlockSize((*fields)[f], bs));
187837d0c07bSMatthew G Knepley       }
187937d0c07bSMatthew G Knepley     }
18809566063dSJacob Faibussowitsch     PetscCall(PetscFree3(fieldSizes,fieldNc,fieldIndices));
18818865f1eaSKarl Rupp   } else if (dm->ops->createfieldis) {
18829566063dSJacob Faibussowitsch     PetscCall((*dm->ops->createfieldis)(dm, numFields, fieldNames, fields));
188369ca1f37SDmitry Karpeev   }
18844d343eeaSMatthew G Knepley   PetscFunctionReturn(0);
18854d343eeaSMatthew G Knepley }
18864d343eeaSMatthew G Knepley 
188716621825SDmitry Karpeev /*@C
188816621825SDmitry Karpeev   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
188916621825SDmitry Karpeev                           corresponding to different fields: each IS contains the global indices of the dofs of the
189016621825SDmitry Karpeev                           corresponding field. The optional list of DMs define the DM for each subproblem.
1891e7c4fc90SDmitry Karpeev                           Generalizes DMCreateFieldIS().
1892e7c4fc90SDmitry Karpeev 
1893e7c4fc90SDmitry Karpeev   Not collective
1894e7c4fc90SDmitry Karpeev 
1895e7c4fc90SDmitry Karpeev   Input Parameter:
1896e7c4fc90SDmitry Karpeev . dm - the DM object
1897e7c4fc90SDmitry Karpeev 
1898e7c4fc90SDmitry Karpeev   Output Parameters:
18990298fd71SBarry Smith + len       - The number of subproblems in the field decomposition (or NULL if not requested)
19000298fd71SBarry Smith . namelist  - The name for each field (or NULL if not requested)
19010298fd71SBarry Smith . islist    - The global indices for each field (or NULL if not requested)
19020298fd71SBarry Smith - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1903e7c4fc90SDmitry Karpeev 
1904e7c4fc90SDmitry Karpeev   Level: intermediate
1905e7c4fc90SDmitry Karpeev 
1906e7c4fc90SDmitry Karpeev   Notes:
1907e7c4fc90SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1908e7c4fc90SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1909e7c4fc90SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
1910e7c4fc90SDmitry Karpeev 
1911*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMCreateFieldIS()
1912e7c4fc90SDmitry Karpeev @*/
191316621825SDmitry Karpeev PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1914e7c4fc90SDmitry Karpeev {
1915e7c4fc90SDmitry Karpeev   PetscFunctionBegin;
1916e7c4fc90SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
19178865f1eaSKarl Rupp   if (len) {
1918534a8f05SLisandro Dalcin     PetscValidIntPointer(len,2);
19198865f1eaSKarl Rupp     *len = 0;
19208865f1eaSKarl Rupp   }
19218865f1eaSKarl Rupp   if (namelist) {
19228865f1eaSKarl Rupp     PetscValidPointer(namelist,3);
1923ea78f98cSLisandro Dalcin     *namelist = NULL;
19248865f1eaSKarl Rupp   }
19258865f1eaSKarl Rupp   if (islist) {
19268865f1eaSKarl Rupp     PetscValidPointer(islist,4);
1927ea78f98cSLisandro Dalcin     *islist = NULL;
19288865f1eaSKarl Rupp   }
19298865f1eaSKarl Rupp   if (dmlist) {
19308865f1eaSKarl Rupp     PetscValidPointer(dmlist,5);
1931ea78f98cSLisandro Dalcin     *dmlist = NULL;
19328865f1eaSKarl Rupp   }
1933f3f0edfdSDmitry Karpeev   /*
1934f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
1935f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1936f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1937f3f0edfdSDmitry Karpeev    */
19387a8be351SBarry Smith   PetscCheck(dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
193916621825SDmitry Karpeev   if (!dm->ops->createfielddecomposition) {
1940435a35e8SMatthew G Knepley     PetscSection section;
1941435a35e8SMatthew G Knepley     PetscInt     numFields, f;
1942435a35e8SMatthew G Knepley 
19439566063dSJacob Faibussowitsch     PetscCall(DMGetLocalSection(dm, &section));
19449566063dSJacob Faibussowitsch     if (section) PetscCall(PetscSectionGetNumFields(section, &numFields));
1945435a35e8SMatthew G Knepley     if (section && numFields && dm->ops->createsubdm) {
1946f25d98f1SMatthew G. Knepley       if (len) *len = numFields;
19479566063dSJacob Faibussowitsch       if (namelist) PetscCall(PetscMalloc1(numFields,namelist));
19489566063dSJacob Faibussowitsch       if (islist)   PetscCall(PetscMalloc1(numFields,islist));
19499566063dSJacob Faibussowitsch       if (dmlist)   PetscCall(PetscMalloc1(numFields,dmlist));
1950435a35e8SMatthew G Knepley       for (f = 0; f < numFields; ++f) {
1951435a35e8SMatthew G Knepley         const char *fieldName;
1952435a35e8SMatthew G Knepley 
19539566063dSJacob Faibussowitsch         PetscCall(DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL));
195403dc3394SMatthew G. Knepley         if (namelist) {
19559566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetFieldName(section, f, &fieldName));
19569566063dSJacob Faibussowitsch           PetscCall(PetscStrallocpy(fieldName, (char**) &(*namelist)[f]));
1957435a35e8SMatthew G Knepley         }
195803dc3394SMatthew G. Knepley       }
1959435a35e8SMatthew G Knepley     } else {
19609566063dSJacob Faibussowitsch       PetscCall(DMCreateFieldIS(dm, len, namelist, islist));
1961e7c4fc90SDmitry Karpeev       /* By default there are no DMs associated with subproblems. */
19620298fd71SBarry Smith       if (dmlist) *dmlist = NULL;
1963e7c4fc90SDmitry Karpeev     }
19648865f1eaSKarl Rupp   } else {
19659566063dSJacob Faibussowitsch     PetscCall((*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist));
196616621825SDmitry Karpeev   }
196716621825SDmitry Karpeev   PetscFunctionReturn(0);
196816621825SDmitry Karpeev }
196916621825SDmitry Karpeev 
1970564cec59SMatthew G. Knepley /*@
1971435a35e8SMatthew G Knepley   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1972435a35e8SMatthew G Knepley                   The fields are defined by DMCreateFieldIS().
1973435a35e8SMatthew G Knepley 
1974435a35e8SMatthew G Knepley   Not collective
1975435a35e8SMatthew G Knepley 
1976435a35e8SMatthew G Knepley   Input Parameters:
19772adcc780SMatthew G. Knepley + dm        - The DM object
19782adcc780SMatthew G. Knepley . numFields - The number of fields in this subproblem
19792adcc780SMatthew G. Knepley - fields    - The field numbers of the selected fields
1980435a35e8SMatthew G Knepley 
1981435a35e8SMatthew G Knepley   Output Parameters:
19822adcc780SMatthew G. Knepley + is - The global indices for the subproblem
19832adcc780SMatthew G. Knepley - subdm - The DM for the subproblem
1984435a35e8SMatthew G Knepley 
19855d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
19865d3b26e6SMatthew G. Knepley 
1987435a35e8SMatthew G Knepley   Level: intermediate
1988435a35e8SMatthew G Knepley 
1989*5b8ffe73SMark Adams .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMCreateFieldIS()
1990435a35e8SMatthew G Knepley @*/
199137bc7515SMatthew G. Knepley PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
1992435a35e8SMatthew G Knepley {
1993435a35e8SMatthew G Knepley   PetscFunctionBegin;
1994435a35e8SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1995dadcf809SJacob Faibussowitsch   PetscValidIntPointer(fields,3);
19968865f1eaSKarl Rupp   if (is) PetscValidPointer(is,4);
19978865f1eaSKarl Rupp   if (subdm) PetscValidPointer(subdm,5);
19987a8be351SBarry Smith   PetscCheck(dm->ops->createsubdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
19999566063dSJacob Faibussowitsch   PetscCall((*dm->ops->createsubdm)(dm, numFields, fields, is, subdm));
2000435a35e8SMatthew G Knepley   PetscFunctionReturn(0);
2001435a35e8SMatthew G Knepley }
2002435a35e8SMatthew G Knepley 
20032adcc780SMatthew G. Knepley /*@C
20042adcc780SMatthew G. Knepley   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
20052adcc780SMatthew G. Knepley 
20062adcc780SMatthew G. Knepley   Not collective
20072adcc780SMatthew G. Knepley 
2008d8d19677SJose E. Roman   Input Parameters:
20092adcc780SMatthew G. Knepley + dms - The DM objects
20102adcc780SMatthew G. Knepley - len - The number of DMs
20112adcc780SMatthew G. Knepley 
20122adcc780SMatthew G. Knepley   Output Parameters:
2013a42bd24dSMatthew G. Knepley + is - The global indices for the subproblem, or NULL
20142adcc780SMatthew G. Knepley - superdm - The DM for the superproblem
20152adcc780SMatthew G. Knepley 
20165d3b26e6SMatthew G. Knepley   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
20175d3b26e6SMatthew G. Knepley 
20182adcc780SMatthew G. Knepley   Level: intermediate
20192adcc780SMatthew G. Knepley 
2020*5b8ffe73SMark Adams .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMCreateFieldIS()
20212adcc780SMatthew G. Knepley @*/
20222adcc780SMatthew G. Knepley PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
20232adcc780SMatthew G. Knepley {
20242adcc780SMatthew G. Knepley   PetscInt       i;
20252adcc780SMatthew G. Knepley 
20262adcc780SMatthew G. Knepley   PetscFunctionBegin;
20272adcc780SMatthew G. Knepley   PetscValidPointer(dms,1);
20282adcc780SMatthew G. Knepley   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
20292adcc780SMatthew G. Knepley   if (is) PetscValidPointer(is,3);
2030a42bd24dSMatthew G. Knepley   PetscValidPointer(superdm,4);
20317a8be351SBarry Smith   PetscCheck(len >= 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
20322adcc780SMatthew G. Knepley   if (len) {
2033b9d85ea2SLisandro Dalcin     DM dm = dms[0];
20347a8be351SBarry Smith     PetscCheck(dm->ops->createsuperdm,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
20359566063dSJacob Faibussowitsch     PetscCall((*dm->ops->createsuperdm)(dms, len, is, superdm));
20362adcc780SMatthew G. Knepley   }
20372adcc780SMatthew G. Knepley   PetscFunctionReturn(0);
20382adcc780SMatthew G. Knepley }
20392adcc780SMatthew G. Knepley 
204016621825SDmitry Karpeev /*@C
20418d4ac253SDmitry Karpeev   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
20428d4ac253SDmitry Karpeev                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
20438d4ac253SDmitry Karpeev                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
20448d4ac253SDmitry Karpeev                           define a nonoverlapping covering, while outer subdomains can overlap.
20458d4ac253SDmitry Karpeev                           The optional list of DMs define the DM for each subproblem.
204616621825SDmitry Karpeev 
204716621825SDmitry Karpeev   Not collective
204816621825SDmitry Karpeev 
204916621825SDmitry Karpeev   Input Parameter:
205016621825SDmitry Karpeev . dm - the DM object
205116621825SDmitry Karpeev 
205216621825SDmitry Karpeev   Output Parameters:
20530298fd71SBarry Smith + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
20540298fd71SBarry Smith . namelist    - The name for each subdomain (or NULL if not requested)
20550298fd71SBarry Smith . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
20560298fd71SBarry Smith . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
20570298fd71SBarry Smith - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
205816621825SDmitry Karpeev 
205916621825SDmitry Karpeev   Level: intermediate
206016621825SDmitry Karpeev 
206116621825SDmitry Karpeev   Notes:
206216621825SDmitry Karpeev   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
206316621825SDmitry Karpeev   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
206416621825SDmitry Karpeev   and all of the arrays should be freed with PetscFree().
206516621825SDmitry Karpeev 
2066*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMCreateFieldDecomposition()
206716621825SDmitry Karpeev @*/
20688d4ac253SDmitry Karpeev PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
206916621825SDmitry Karpeev {
2070be081cd6SPeter Brune   DMSubDomainHookLink link;
2071be081cd6SPeter Brune   PetscInt            i,l;
207216621825SDmitry Karpeev 
207316621825SDmitry Karpeev   PetscFunctionBegin;
207416621825SDmitry Karpeev   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2075dadcf809SJacob Faibussowitsch   if (len)           {PetscValidIntPointer(len,2);            *len         = 0;}
20760298fd71SBarry Smith   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
20770298fd71SBarry Smith   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
20780298fd71SBarry Smith   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
20790298fd71SBarry Smith   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
2080f3f0edfdSDmitry Karpeev   /*
2081f3f0edfdSDmitry Karpeev    Is it a good idea to apply the following check across all impls?
2082f3f0edfdSDmitry Karpeev    Perhaps some impls can have a well-defined decomposition before DMSetUp?
2083f3f0edfdSDmitry Karpeev    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
2084f3f0edfdSDmitry Karpeev    */
20857a8be351SBarry Smith   PetscCheck(dm->setupcalled,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
208616621825SDmitry Karpeev   if (dm->ops->createdomaindecomposition) {
20879566063dSJacob Faibussowitsch     PetscCall((*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist));
208814a18fd3SPeter Brune     /* copy subdomain hooks and context over to the subdomain DMs */
2089f891f5b9SPatrick Sanan     if (dmlist && *dmlist) {
2090be081cd6SPeter Brune       for (i = 0; i < l; i++) {
2091be081cd6SPeter Brune         for (link=dm->subdomainhook; link; link=link->next) {
20929566063dSJacob Faibussowitsch           if (link->ddhook) PetscCall((*link->ddhook)(dm,(*dmlist)[i],link->ctx));
2093be081cd6SPeter Brune         }
2094648262bbSPatrick Sanan         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
2095e7c4fc90SDmitry Karpeev       }
209614a18fd3SPeter Brune     }
209714a18fd3SPeter Brune     if (len) *len = l;
209814a18fd3SPeter Brune   }
2099e30e807fSPeter Brune   PetscFunctionReturn(0);
2100e30e807fSPeter Brune }
2101e30e807fSPeter Brune 
2102e30e807fSPeter Brune /*@C
2103e30e807fSPeter Brune   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
2104e30e807fSPeter Brune 
2105e30e807fSPeter Brune   Not collective
2106e30e807fSPeter Brune 
2107e30e807fSPeter Brune   Input Parameters:
2108e30e807fSPeter Brune + dm - the DM object
2109e30e807fSPeter Brune . n  - the number of subdomain scatters
2110e30e807fSPeter Brune - subdms - the local subdomains
2111e30e807fSPeter Brune 
2112e30e807fSPeter Brune   Output Parameters:
21136b867d5aSJose E. Roman + iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
2114e30e807fSPeter Brune . oscat - scatter from global vector to overlapping global vector entries on subdomain
2115e30e807fSPeter Brune - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
2116e30e807fSPeter Brune 
211795452b02SPatrick Sanan   Notes:
211895452b02SPatrick Sanan     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
2119e30e807fSPeter Brune   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
2120e30e807fSPeter Brune   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
2121e30e807fSPeter Brune   solution and residual data.
2122e30e807fSPeter Brune 
2123e30e807fSPeter Brune   Level: developer
2124e30e807fSPeter Brune 
2125*5b8ffe73SMark Adams .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMCreateFieldIS()
2126e30e807fSPeter Brune @*/
2127e30e807fSPeter Brune PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
2128e30e807fSPeter Brune {
2129e30e807fSPeter Brune   PetscFunctionBegin;
2130e30e807fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2131e30e807fSPeter Brune   PetscValidPointer(subdms,3);
21327a8be351SBarry Smith   PetscCheck(dm->ops->createddscatters,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
21339566063dSJacob Faibussowitsch   PetscCall((*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat));
2134e7c4fc90SDmitry Karpeev   PetscFunctionReturn(0);
2135e7c4fc90SDmitry Karpeev }
2136e7c4fc90SDmitry Karpeev 
213747c6ae99SBarry Smith /*@
213847c6ae99SBarry Smith   DMRefine - Refines a DM object
213947c6ae99SBarry Smith 
2140d083f849SBarry Smith   Collective on dm
214147c6ae99SBarry Smith 
2142d8d19677SJose E. Roman   Input Parameters:
214347c6ae99SBarry Smith + dm   - the DM object
214491d95f02SJed Brown - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
214547c6ae99SBarry Smith 
214647c6ae99SBarry Smith   Output Parameter:
21470298fd71SBarry Smith . dmf - the refined DM, or NULL
2148ae0a1c52SMatthew G Knepley 
2149f27dd7c6SMatthew G. Knepley   Options Database Keys:
2150412e9a14SMatthew G. Knepley . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
2151412e9a14SMatthew G. Knepley 
21520298fd71SBarry Smith   Note: If no refinement was done, the return value is NULL
215347c6ae99SBarry Smith 
215447c6ae99SBarry Smith   Level: developer
215547c6ae99SBarry Smith 
2156e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
215747c6ae99SBarry Smith @*/
21587087cfbeSBarry Smith PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
215947c6ae99SBarry Smith {
2160c833c3b5SJed Brown   DMRefineHookLink link;
216147c6ae99SBarry Smith 
216247c6ae99SBarry Smith   PetscFunctionBegin;
2163732e2eb9SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
21647a8be351SBarry Smith   PetscCheck(dm->ops->refine,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
21659566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_Refine,dm,0,0,0));
21669566063dSJacob Faibussowitsch   PetscCall((*dm->ops->refine)(dm,comm,dmf));
21674057135bSMatthew G Knepley   if (*dmf) {
216843842a1eSJed Brown     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
21698865f1eaSKarl Rupp 
21709566063dSJacob Faibussowitsch     PetscCall(PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf));
21718865f1eaSKarl Rupp 
2172644e2e5bSBarry Smith     (*dmf)->ctx       = dm->ctx;
21730598a293SJed Brown     (*dmf)->leveldown = dm->leveldown;
2174656b349aSBarry Smith     (*dmf)->levelup   = dm->levelup + 1;
21758865f1eaSKarl Rupp 
21769566063dSJacob Faibussowitsch     PetscCall(DMSetMatType(*dmf,dm->mattype));
2177c833c3b5SJed Brown     for (link=dm->refinehook; link; link=link->next) {
21788865f1eaSKarl Rupp       if (link->refinehook) {
21799566063dSJacob Faibussowitsch         PetscCall((*link->refinehook)(dm,*dmf,link->ctx));
21808865f1eaSKarl Rupp       }
2181c833c3b5SJed Brown     }
2182c833c3b5SJed Brown   }
21839566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_Refine,dm,0,0,0));
2184c833c3b5SJed Brown   PetscFunctionReturn(0);
2185c833c3b5SJed Brown }
2186c833c3b5SJed Brown 
2187bb9467b5SJed Brown /*@C
2188c833c3b5SJed Brown    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
2189c833c3b5SJed Brown 
2190c833c3b5SJed Brown    Logically Collective
2191c833c3b5SJed Brown 
21924165533cSJose E. Roman    Input Parameters:
2193c833c3b5SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2194c833c3b5SJed Brown .  refinehook - function to run when setting up a coarser level
2195c833c3b5SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
21960298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2197c833c3b5SJed Brown 
2198c833c3b5SJed Brown    Calling sequence of refinehook:
2199c833c3b5SJed Brown $    refinehook(DM coarse,DM fine,void *ctx);
2200c833c3b5SJed Brown 
2201c833c3b5SJed Brown +  coarse - coarse level DM
2202c833c3b5SJed Brown .  fine - fine level DM to interpolate problem to
2203c833c3b5SJed Brown -  ctx - optional user-defined function context
2204c833c3b5SJed Brown 
2205c833c3b5SJed Brown    Calling sequence for interphook:
2206c833c3b5SJed Brown $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2207c833c3b5SJed Brown 
2208c833c3b5SJed Brown +  coarse - coarse level DM
2209c833c3b5SJed Brown .  interp - matrix interpolating a coarse-level solution to the finer grid
2210c833c3b5SJed Brown .  fine - fine level DM to update
2211c833c3b5SJed Brown -  ctx - optional user-defined function context
2212c833c3b5SJed Brown 
2213c833c3b5SJed Brown    Level: advanced
2214c833c3b5SJed Brown 
2215c833c3b5SJed Brown    Notes:
2216c833c3b5SJed Brown    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2217c833c3b5SJed Brown 
2218c833c3b5SJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
2219c833c3b5SJed Brown 
2220bb9467b5SJed Brown    This function is currently not available from Fortran.
2221bb9467b5SJed Brown 
2222c833c3b5SJed Brown .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2223c833c3b5SJed Brown @*/
2224c833c3b5SJed Brown PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2225c833c3b5SJed Brown {
2226c833c3b5SJed Brown   DMRefineHookLink link,*p;
2227c833c3b5SJed Brown 
2228c833c3b5SJed Brown   PetscFunctionBegin;
2229c833c3b5SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22303d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
22313d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
22323d8e3701SJed Brown   }
22339566063dSJacob Faibussowitsch   PetscCall(PetscNew(&link));
2234c833c3b5SJed Brown   link->refinehook = refinehook;
2235c833c3b5SJed Brown   link->interphook = interphook;
2236c833c3b5SJed Brown   link->ctx        = ctx;
22370298fd71SBarry Smith   link->next       = NULL;
2238c833c3b5SJed Brown   *p               = link;
2239c833c3b5SJed Brown   PetscFunctionReturn(0);
2240c833c3b5SJed Brown }
2241c833c3b5SJed Brown 
22423d8e3701SJed Brown /*@C
22433d8e3701SJed Brown    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
22443d8e3701SJed Brown 
22453d8e3701SJed Brown    Logically Collective
22463d8e3701SJed Brown 
22474165533cSJose E. Roman    Input Parameters:
22483d8e3701SJed Brown +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
22493d8e3701SJed Brown .  refinehook - function to run when setting up a coarser level
22503d8e3701SJed Brown .  interphook - function to run to update data on finer levels (once per SNESSolve())
22513d8e3701SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
22523d8e3701SJed Brown 
22533d8e3701SJed Brown    Level: advanced
22543d8e3701SJed Brown 
22553d8e3701SJed Brown    Notes:
22563d8e3701SJed Brown    This function does nothing if the hook is not in the list.
22573d8e3701SJed Brown 
22583d8e3701SJed Brown    This function is currently not available from Fortran.
22593d8e3701SJed Brown 
22603d8e3701SJed Brown .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
22613d8e3701SJed Brown @*/
22623d8e3701SJed Brown PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
22633d8e3701SJed Brown {
22643d8e3701SJed Brown   DMRefineHookLink link,*p;
22653d8e3701SJed Brown 
22663d8e3701SJed Brown   PetscFunctionBegin;
22673d8e3701SJed Brown   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
22683d8e3701SJed Brown   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
22693d8e3701SJed Brown     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
22703d8e3701SJed Brown       link = *p;
22713d8e3701SJed Brown       *p = link->next;
22729566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
22733d8e3701SJed Brown       break;
22743d8e3701SJed Brown     }
22753d8e3701SJed Brown   }
22763d8e3701SJed Brown   PetscFunctionReturn(0);
22773d8e3701SJed Brown }
22783d8e3701SJed Brown 
2279c833c3b5SJed Brown /*@
2280c833c3b5SJed Brown    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2281c833c3b5SJed Brown 
2282c833c3b5SJed Brown    Collective if any hooks are
2283c833c3b5SJed Brown 
22844165533cSJose E. Roman    Input Parameters:
2285c833c3b5SJed Brown +  coarse - coarser DM to use as a base
2286e91eccc2SStefano Zampini .  interp - interpolation matrix, apply using MatInterpolate()
2287c833c3b5SJed Brown -  fine - finer DM to update
2288c833c3b5SJed Brown 
2289c833c3b5SJed Brown    Level: developer
2290c833c3b5SJed Brown 
2291c833c3b5SJed Brown .seealso: DMRefineHookAdd(), MatInterpolate()
2292c833c3b5SJed Brown @*/
2293c833c3b5SJed Brown PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2294c833c3b5SJed Brown {
2295c833c3b5SJed Brown   DMRefineHookLink link;
2296c833c3b5SJed Brown 
2297c833c3b5SJed Brown   PetscFunctionBegin;
2298c833c3b5SJed Brown   for (link=fine->refinehook; link; link=link->next) {
22998865f1eaSKarl Rupp     if (link->interphook) {
23009566063dSJacob Faibussowitsch       PetscCall((*link->interphook)(coarse,interp,fine,link->ctx));
23018865f1eaSKarl Rupp     }
23024057135bSMatthew G Knepley   }
230347c6ae99SBarry Smith   PetscFunctionReturn(0);
230447c6ae99SBarry Smith }
230547c6ae99SBarry Smith 
2306eb3f98d2SBarry Smith /*@
23071f3379b2SToby Isaac    DMInterpolateSolution - Interpolates a solution from a coarse mesh to a fine mesh.
23081f3379b2SToby Isaac 
23091f3379b2SToby Isaac    Collective on DM
23101f3379b2SToby Isaac 
23114165533cSJose E. Roman    Input Parameters:
23121f3379b2SToby Isaac +  coarse - coarse DM
23131f3379b2SToby Isaac .  fine   - fine DM
23141f3379b2SToby Isaac .  interp - (optional) the matrix computed by DMCreateInterpolation().  Implementations may not need this, but if it
23151f3379b2SToby Isaac             is available it can avoid some recomputation.  If it is provided, MatInterpolate() will be used if
23161f3379b2SToby Isaac             the coarse DM does not have a specialized implementation.
23171f3379b2SToby Isaac -  coarseSol - solution on the coarse mesh
23181f3379b2SToby Isaac 
23194165533cSJose E. Roman    Output Parameter:
23201f3379b2SToby Isaac .  fineSol - the interpolation of coarseSol to the fine mesh
23211f3379b2SToby Isaac 
23221f3379b2SToby Isaac    Level: developer
23231f3379b2SToby Isaac 
23241f3379b2SToby Isaac    Note: This function exists because the interpolation of a solution vector between meshes is not always a linear
23251f3379b2SToby Isaac    map.  For example, if a boundary value problem has an inhomogeneous Dirichlet boundary condition that is compressed
23261f3379b2SToby Isaac    out of the solution vector.  Or if interpolation is inherently a nonlinear operation, such as a method using
23271f3379b2SToby Isaac    slope-limiting reconstruction.
23281f3379b2SToby Isaac 
23291f3379b2SToby Isaac .seealso DMInterpolate(), DMCreateInterpolation()
23301f3379b2SToby Isaac @*/
23311f3379b2SToby Isaac PetscErrorCode DMInterpolateSolution(DM coarse, DM fine, Mat interp, Vec coarseSol, Vec fineSol)
23321f3379b2SToby Isaac {
23331f3379b2SToby Isaac   PetscErrorCode (*interpsol)(DM,DM,Mat,Vec,Vec) = NULL;
23341f3379b2SToby Isaac 
23351f3379b2SToby Isaac   PetscFunctionBegin;
23361f3379b2SToby Isaac   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
23371f3379b2SToby Isaac   if (interp) PetscValidHeaderSpecific(interp,MAT_CLASSID,3);
23381f3379b2SToby Isaac   PetscValidHeaderSpecific(coarseSol,VEC_CLASSID,4);
23391f3379b2SToby Isaac   PetscValidHeaderSpecific(fineSol,VEC_CLASSID,5);
23401f3379b2SToby Isaac 
23419566063dSJacob Faibussowitsch   PetscCall(PetscObjectQueryFunction((PetscObject)coarse,"DMInterpolateSolution_C", &interpsol));
23421f3379b2SToby Isaac   if (interpsol) {
23439566063dSJacob Faibussowitsch     PetscCall((*interpsol)(coarse, fine, interp, coarseSol, fineSol));
23441f3379b2SToby Isaac   } else if (interp) {
23459566063dSJacob Faibussowitsch     PetscCall(MatInterpolate(interp, coarseSol, fineSol));
234698921bdaSJacob Faibussowitsch   } else SETERRQ(PetscObjectComm((PetscObject)coarse), PETSC_ERR_SUP, "DM %s does not implement DMInterpolateSolution()", ((PetscObject)coarse)->type_name);
23471f3379b2SToby Isaac   PetscFunctionReturn(0);
23481f3379b2SToby Isaac }
23491f3379b2SToby Isaac 
23501f3379b2SToby Isaac /*@
2351aed49f88SRichard Tran Mills     DMGetRefineLevel - Gets the number of refinements that have generated this DM.
2352eb3f98d2SBarry Smith 
2353eb3f98d2SBarry Smith     Not Collective
2354eb3f98d2SBarry Smith 
2355eb3f98d2SBarry Smith     Input Parameter:
2356eb3f98d2SBarry Smith .   dm - the DM object
2357eb3f98d2SBarry Smith 
2358eb3f98d2SBarry Smith     Output Parameter:
2359eb3f98d2SBarry Smith .   level - number of refinements
2360eb3f98d2SBarry Smith 
2361eb3f98d2SBarry Smith     Level: developer
2362eb3f98d2SBarry Smith 
23636a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2364eb3f98d2SBarry Smith 
2365eb3f98d2SBarry Smith @*/
2366eb3f98d2SBarry Smith PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2367eb3f98d2SBarry Smith {
2368eb3f98d2SBarry Smith   PetscFunctionBegin;
2369eb3f98d2SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2370eb3f98d2SBarry Smith   *level = dm->levelup;
2371eb3f98d2SBarry Smith   PetscFunctionReturn(0);
2372eb3f98d2SBarry Smith }
2373eb3f98d2SBarry Smith 
2374fef3a512SBarry Smith /*@
2375aed49f88SRichard Tran Mills     DMSetRefineLevel - Sets the number of refinements that have generated this DM.
2376fef3a512SBarry Smith 
2377fef3a512SBarry Smith     Not Collective
2378fef3a512SBarry Smith 
2379d8d19677SJose E. Roman     Input Parameters:
2380fef3a512SBarry Smith +   dm - the DM object
2381fef3a512SBarry Smith -   level - number of refinements
2382fef3a512SBarry Smith 
2383fef3a512SBarry Smith     Level: advanced
2384fef3a512SBarry Smith 
238595452b02SPatrick Sanan     Notes:
238695452b02SPatrick Sanan     This value is used by PCMG to determine how many multigrid levels to use
2387fef3a512SBarry Smith 
2388fef3a512SBarry Smith .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2389fef3a512SBarry Smith 
2390fef3a512SBarry Smith @*/
2391fef3a512SBarry Smith PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2392fef3a512SBarry Smith {
2393fef3a512SBarry Smith   PetscFunctionBegin;
2394fef3a512SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2395fef3a512SBarry Smith   dm->levelup = level;
2396fef3a512SBarry Smith   PetscFunctionReturn(0);
2397fef3a512SBarry Smith }
2398fef3a512SBarry Smith 
2399d410b0cfSMatthew G. Knepley /*@
2400d410b0cfSMatthew G. Knepley   DMExtrude - Extrude a DM object from a surface
2401d410b0cfSMatthew G. Knepley 
2402d410b0cfSMatthew G. Knepley   Collective on dm
2403d410b0cfSMatthew G. Knepley 
2404f1a722f8SMatthew G. Knepley   Input Parameters:
2405d410b0cfSMatthew G. Knepley + dm     - the DM object
2406d410b0cfSMatthew G. Knepley - layers - the number of extruded cell layers
2407d410b0cfSMatthew G. Knepley 
2408d410b0cfSMatthew G. Knepley   Output Parameter:
2409d410b0cfSMatthew G. Knepley . dme - the extruded DM, or NULL
2410d410b0cfSMatthew G. Knepley 
2411d410b0cfSMatthew G. Knepley   Note: If no extrusion was done, the return value is NULL
2412d410b0cfSMatthew G. Knepley 
2413d410b0cfSMatthew G. Knepley   Level: developer
2414d410b0cfSMatthew G. Knepley 
2415d410b0cfSMatthew G. Knepley .seealso DMRefine(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector()
2416d410b0cfSMatthew G. Knepley @*/
2417d410b0cfSMatthew G. Knepley PetscErrorCode DMExtrude(DM dm, PetscInt layers, DM *dme)
2418d410b0cfSMatthew G. Knepley {
2419d410b0cfSMatthew G. Knepley   PetscFunctionBegin;
2420d410b0cfSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
24217a8be351SBarry Smith   PetscCheck(dm->ops->extrude,PetscObjectComm((PetscObject) dm), PETSC_ERR_SUP, "DM type %s does not implement DMExtrude", ((PetscObject) dm)->type_name);
24229566063dSJacob Faibussowitsch   PetscCall((*dm->ops->extrude)(dm, layers, dme));
2423d410b0cfSMatthew G. Knepley   if (*dme) {
2424d410b0cfSMatthew G. Knepley     (*dme)->ops->creatematrix = dm->ops->creatematrix;
24259566063dSJacob Faibussowitsch     PetscCall(PetscObjectCopyFortranFunctionPointers((PetscObject) dm, (PetscObject) *dme));
2426d410b0cfSMatthew G. Knepley     (*dme)->ctx = dm->ctx;
24279566063dSJacob Faibussowitsch     PetscCall(DMSetMatType(*dme, dm->mattype));
2428d410b0cfSMatthew G. Knepley   }
2429d410b0cfSMatthew G. Knepley   PetscFunctionReturn(0);
2430d410b0cfSMatthew G. Knepley }
2431d410b0cfSMatthew G. Knepley 
2432ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2433ca3d3a14SMatthew G. Knepley {
2434ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2435ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2436ca3d3a14SMatthew G. Knepley   PetscValidPointer(tdm, 2);
2437ca3d3a14SMatthew G. Knepley   *tdm = dm->transformDM;
2438ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2439ca3d3a14SMatthew G. Knepley }
2440ca3d3a14SMatthew G. Knepley 
2441ca3d3a14SMatthew G. Knepley PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2442ca3d3a14SMatthew G. Knepley {
2443ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2444ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2445ca3d3a14SMatthew G. Knepley   PetscValidPointer(tv, 2);
2446ca3d3a14SMatthew G. Knepley   *tv = dm->transform;
2447ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2448ca3d3a14SMatthew G. Knepley }
2449ca3d3a14SMatthew G. Knepley 
2450ca3d3a14SMatthew G. Knepley /*@
2451c0f8e1fdSMatthew G. Knepley   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2452ca3d3a14SMatthew G. Knepley 
2453ca3d3a14SMatthew G. Knepley   Input Parameter:
2454ca3d3a14SMatthew G. Knepley . dm - The DM
2455ca3d3a14SMatthew G. Knepley 
2456ca3d3a14SMatthew G. Knepley   Output Parameter:
2457ca3d3a14SMatthew G. Knepley . flg - PETSC_TRUE if a basis transformation should be done
2458ca3d3a14SMatthew G. Knepley 
2459ca3d3a14SMatthew G. Knepley   Level: developer
2460ca3d3a14SMatthew G. Knepley 
2461436bc73aSJed Brown .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2462ca3d3a14SMatthew G. Knepley @*/
2463ca3d3a14SMatthew G. Knepley PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2464ca3d3a14SMatthew G. Knepley {
2465ca3d3a14SMatthew G. Knepley   Vec            tv;
2466ca3d3a14SMatthew G. Knepley 
2467ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2468ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2469534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg, 2);
24709566063dSJacob Faibussowitsch   PetscCall(DMGetBasisTransformVec_Internal(dm, &tv));
2471ca3d3a14SMatthew G. Knepley   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2472ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2473ca3d3a14SMatthew G. Knepley }
2474ca3d3a14SMatthew G. Knepley 
2475ca3d3a14SMatthew G. Knepley PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2476ca3d3a14SMatthew G. Knepley {
2477ca3d3a14SMatthew G. Knepley   PetscSection   s, ts;
2478ca3d3a14SMatthew G. Knepley   PetscScalar   *ta;
2479ca3d3a14SMatthew G. Knepley   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2480ca3d3a14SMatthew G. Knepley 
2481ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
24829566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDim(dm, &cdim));
24839566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(dm, &s));
24849566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
24859566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetNumFields(s, &Nf));
24869566063dSJacob Faibussowitsch   PetscCall(DMClone(dm, &dm->transformDM));
24879566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(dm->transformDM, &ts));
24889566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(ts, Nf));
24899566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(ts, pStart, pEnd));
2490ca3d3a14SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
24919566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetFieldComponents(s, f, &Nc));
2492ca3d3a14SMatthew G. Knepley     /* We could start to label fields by their transformation properties */
2493ca3d3a14SMatthew G. Knepley     if (Nc != cdim) continue;
2494ca3d3a14SMatthew G. Knepley     for (p = pStart; p < pEnd; ++p) {
24959566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(s, p, f, &dof));
2496ca3d3a14SMatthew G. Knepley       if (!dof) continue;
24979566063dSJacob Faibussowitsch       PetscCall(PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim)));
24989566063dSJacob Faibussowitsch       PetscCall(PetscSectionAddDof(ts, p, PetscSqr(cdim)));
2499ca3d3a14SMatthew G. Knepley     }
2500ca3d3a14SMatthew G. Knepley   }
25019566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(ts));
25029566063dSJacob Faibussowitsch   PetscCall(DMCreateLocalVector(dm->transformDM, &dm->transform));
25039566063dSJacob Faibussowitsch   PetscCall(VecGetArray(dm->transform, &ta));
2504ca3d3a14SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
2505ca3d3a14SMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
25069566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldDof(ts, p, f, &dof));
2507ca3d3a14SMatthew G. Knepley       if (dof) {
2508ca3d3a14SMatthew G. Knepley         PetscReal          x[3] = {0.0, 0.0, 0.0};
2509ca3d3a14SMatthew G. Knepley         PetscScalar       *tva;
2510ca3d3a14SMatthew G. Knepley         const PetscScalar *A;
2511ca3d3a14SMatthew G. Knepley 
2512ca3d3a14SMatthew G. Knepley         /* TODO Get quadrature point for this dual basis vector for coordinate */
25139566063dSJacob Faibussowitsch         PetscCall((*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx));
25149566063dSJacob Faibussowitsch         PetscCall(DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva));
25159566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(tva, A, PetscSqr(cdim)));
2516ca3d3a14SMatthew G. Knepley       }
2517ca3d3a14SMatthew G. Knepley     }
2518ca3d3a14SMatthew G. Knepley   }
25199566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(dm->transform, &ta));
2520ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2521ca3d3a14SMatthew G. Knepley }
2522ca3d3a14SMatthew G. Knepley 
2523ca3d3a14SMatthew G. Knepley PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2524ca3d3a14SMatthew G. Knepley {
2525ca3d3a14SMatthew G. Knepley   PetscFunctionBegin;
2526ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2527ca3d3a14SMatthew G. Knepley   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2528ca3d3a14SMatthew G. Knepley   newdm->transformCtx       = dm->transformCtx;
2529ca3d3a14SMatthew G. Knepley   newdm->transformSetUp     = dm->transformSetUp;
2530ca3d3a14SMatthew G. Knepley   newdm->transformDestroy   = NULL;
2531ca3d3a14SMatthew G. Knepley   newdm->transformGetMatrix = dm->transformGetMatrix;
25329566063dSJacob Faibussowitsch   if (newdm->transformSetUp) PetscCall(DMConstructBasisTransform_Internal(newdm));
2533ca3d3a14SMatthew G. Knepley   PetscFunctionReturn(0);
2534ca3d3a14SMatthew G. Knepley }
2535ca3d3a14SMatthew G. Knepley 
2536bb9467b5SJed Brown /*@C
2537baf369e7SPeter Brune    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2538baf369e7SPeter Brune 
2539baf369e7SPeter Brune    Logically Collective
2540baf369e7SPeter Brune 
25414165533cSJose E. Roman    Input Parameters:
2542baf369e7SPeter Brune +  dm - the DM
2543baf369e7SPeter Brune .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2544baf369e7SPeter Brune .  endhook - function to run after DMGlobalToLocalEnd() has completed
25450298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2546baf369e7SPeter Brune 
2547baf369e7SPeter Brune    Calling sequence for beginhook:
2548baf369e7SPeter Brune $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2549baf369e7SPeter Brune 
2550baf369e7SPeter Brune +  dm - global DM
2551baf369e7SPeter Brune .  g - global vector
2552baf369e7SPeter Brune .  mode - mode
2553baf369e7SPeter Brune .  l - local vector
2554baf369e7SPeter Brune -  ctx - optional user-defined function context
2555baf369e7SPeter Brune 
2556baf369e7SPeter Brune    Calling sequence for endhook:
2557ec4806b8SPeter Brune $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2558baf369e7SPeter Brune 
2559baf369e7SPeter Brune +  global - global DM
2560baf369e7SPeter Brune -  ctx - optional user-defined function context
2561baf369e7SPeter Brune 
2562baf369e7SPeter Brune    Level: advanced
2563baf369e7SPeter Brune 
2564baf369e7SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2565baf369e7SPeter Brune @*/
2566baf369e7SPeter Brune PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2567baf369e7SPeter Brune {
2568baf369e7SPeter Brune   DMGlobalToLocalHookLink link,*p;
2569baf369e7SPeter Brune 
2570baf369e7SPeter Brune   PetscFunctionBegin;
2571baf369e7SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2572baf369e7SPeter Brune   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
25739566063dSJacob Faibussowitsch   PetscCall(PetscNew(&link));
2574baf369e7SPeter Brune   link->beginhook = beginhook;
2575baf369e7SPeter Brune   link->endhook   = endhook;
2576baf369e7SPeter Brune   link->ctx       = ctx;
25770298fd71SBarry Smith   link->next      = NULL;
2578baf369e7SPeter Brune   *p              = link;
2579baf369e7SPeter Brune   PetscFunctionReturn(0);
2580baf369e7SPeter Brune }
2581baf369e7SPeter Brune 
25824c274da1SToby Isaac static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
25834c274da1SToby Isaac {
25844c274da1SToby Isaac   Mat cMat;
258579769bd5SJed Brown   Vec cVec, cBias;
25864c274da1SToby Isaac   PetscSection section, cSec;
25874c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
25884c274da1SToby Isaac 
25894c274da1SToby Isaac   PetscFunctionBegin;
25904c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
25919566063dSJacob Faibussowitsch   PetscCall(DMGetDefaultConstraints(dm,&cSec,&cMat,&cBias));
25924c274da1SToby Isaac   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
25935db9a05bSToby Isaac     PetscInt nRows;
25945db9a05bSToby Isaac 
25959566063dSJacob Faibussowitsch     PetscCall(MatGetSize(cMat,&nRows,NULL));
25965db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
25979566063dSJacob Faibussowitsch     PetscCall(DMGetLocalSection(dm,&section));
25989566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(cMat,NULL,&cVec));
25999566063dSJacob Faibussowitsch     PetscCall(MatMult(cMat,l,cVec));
26009566063dSJacob Faibussowitsch     if (cBias) PetscCall(VecAXPY(cVec,1.,cBias));
26019566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(cSec,&pStart,&pEnd));
26024c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
26039566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(cSec,p,&dof));
26044c274da1SToby Isaac       if (dof) {
26054c274da1SToby Isaac         PetscScalar *vals;
26069566063dSJacob Faibussowitsch         PetscCall(VecGetValuesSection(cVec,cSec,p,&vals));
26079566063dSJacob Faibussowitsch         PetscCall(VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES));
26084c274da1SToby Isaac       }
26094c274da1SToby Isaac     }
26109566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&cVec));
26114c274da1SToby Isaac   }
26124c274da1SToby Isaac   PetscFunctionReturn(0);
26134c274da1SToby Isaac }
26144c274da1SToby Isaac 
261547c6ae99SBarry Smith /*@
261601729b5cSPatrick Sanan     DMGlobalToLocal - update local vectors from global vector
261701729b5cSPatrick Sanan 
2618d083f849SBarry Smith     Neighbor-wise Collective on dm
261901729b5cSPatrick Sanan 
262001729b5cSPatrick Sanan     Input Parameters:
262101729b5cSPatrick Sanan +   dm - the DM object
262201729b5cSPatrick Sanan .   g - the global vector
262301729b5cSPatrick Sanan .   mode - INSERT_VALUES or ADD_VALUES
262401729b5cSPatrick Sanan -   l - the local vector
262501729b5cSPatrick Sanan 
262601729b5cSPatrick Sanan     Notes:
262701729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
262801729b5cSPatrick Sanan     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
262901729b5cSPatrick Sanan 
263001729b5cSPatrick Sanan     Level: beginner
263101729b5cSPatrick Sanan 
263201729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
263301729b5cSPatrick Sanan 
263401729b5cSPatrick Sanan @*/
263501729b5cSPatrick Sanan PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
263601729b5cSPatrick Sanan {
263701729b5cSPatrick Sanan   PetscFunctionBegin;
26389566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalBegin(dm,g,mode,l));
26399566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalEnd(dm,g,mode,l));
264001729b5cSPatrick Sanan   PetscFunctionReturn(0);
264101729b5cSPatrick Sanan }
264201729b5cSPatrick Sanan 
264301729b5cSPatrick Sanan /*@
264447c6ae99SBarry Smith     DMGlobalToLocalBegin - Begins updating local vectors from global vector
264547c6ae99SBarry Smith 
2646d083f849SBarry Smith     Neighbor-wise Collective on dm
264747c6ae99SBarry Smith 
264847c6ae99SBarry Smith     Input Parameters:
264947c6ae99SBarry Smith +   dm - the DM object
265047c6ae99SBarry Smith .   g - the global vector
265147c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
265247c6ae99SBarry Smith -   l - the local vector
265347c6ae99SBarry Smith 
265401729b5cSPatrick Sanan     Level: intermediate
265547c6ae99SBarry Smith 
265601729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
265747c6ae99SBarry Smith 
265847c6ae99SBarry Smith @*/
26597087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
266047c6ae99SBarry Smith {
26617128ae9fSMatthew G Knepley   PetscSF                 sf;
2662baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
266347c6ae99SBarry Smith 
266447c6ae99SBarry Smith   PetscFunctionBegin;
2665171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2666baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
26678865f1eaSKarl Rupp     if (link->beginhook) {
26689566063dSJacob Faibussowitsch       PetscCall((*link->beginhook)(dm,g,mode,l,link->ctx));
26698865f1eaSKarl Rupp     }
2670baf369e7SPeter Brune   }
26719566063dSJacob Faibussowitsch   PetscCall(DMGetSectionSF(dm, &sf));
26727128ae9fSMatthew G Knepley   if (sf) {
2673ae5cfb4aSMatthew G. Knepley     const PetscScalar *gArray;
2674ae5cfb4aSMatthew G. Knepley     PetscScalar       *lArray;
2675d0295fc0SJunchao Zhang     PetscMemType      lmtype,gmtype;
26767128ae9fSMatthew G Knepley 
26777a8be351SBarry Smith     PetscCheck(mode != ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %d", (int)mode);
26789566063dSJacob Faibussowitsch     PetscCall(VecGetArrayAndMemType(l, &lArray, &lmtype));
26799566063dSJacob Faibussowitsch     PetscCall(VecGetArrayReadAndMemType(g, &gArray, &gmtype));
26809566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastWithMemTypeBegin(sf, MPIU_SCALAR, gmtype, gArray, lmtype, lArray, MPI_REPLACE));
26819566063dSJacob Faibussowitsch     PetscCall(VecRestoreArrayAndMemType(l, &lArray));
26829566063dSJacob Faibussowitsch     PetscCall(VecRestoreArrayReadAndMemType(g, &gArray));
26837128ae9fSMatthew G Knepley   } else {
26847a8be351SBarry Smith     PetscCheck(dm->ops->globaltolocalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
26859566063dSJacob Faibussowitsch     PetscCall((*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l));
26867128ae9fSMatthew G Knepley   }
268747c6ae99SBarry Smith   PetscFunctionReturn(0);
268847c6ae99SBarry Smith }
268947c6ae99SBarry Smith 
269047c6ae99SBarry Smith /*@
269147c6ae99SBarry Smith     DMGlobalToLocalEnd - Ends updating local vectors from global vector
269247c6ae99SBarry Smith 
2693d083f849SBarry Smith     Neighbor-wise Collective on dm
269447c6ae99SBarry Smith 
269547c6ae99SBarry Smith     Input Parameters:
269647c6ae99SBarry Smith +   dm - the DM object
269747c6ae99SBarry Smith .   g - the global vector
269847c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
269947c6ae99SBarry Smith -   l - the local vector
270047c6ae99SBarry Smith 
270101729b5cSPatrick Sanan     Level: intermediate
270247c6ae99SBarry Smith 
270301729b5cSPatrick Sanan .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
270447c6ae99SBarry Smith 
270547c6ae99SBarry Smith @*/
27067087cfbeSBarry Smith PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
270747c6ae99SBarry Smith {
27087128ae9fSMatthew G Knepley   PetscSF                 sf;
2709ae5cfb4aSMatthew G. Knepley   const PetscScalar      *gArray;
2710ae5cfb4aSMatthew G. Knepley   PetscScalar            *lArray;
2711ca3d3a14SMatthew G. Knepley   PetscBool               transform;
2712baf369e7SPeter Brune   DMGlobalToLocalHookLink link;
2713d0295fc0SJunchao Zhang   PetscMemType            lmtype,gmtype;
271447c6ae99SBarry Smith 
271547c6ae99SBarry Smith   PetscFunctionBegin;
2716171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
27179566063dSJacob Faibussowitsch   PetscCall(DMGetSectionSF(dm, &sf));
27189566063dSJacob Faibussowitsch   PetscCall(DMHasBasisTransform(dm, &transform));
27197128ae9fSMatthew G Knepley   if (sf) {
27207a8be351SBarry Smith     PetscCheck(mode != ADD_VALUES,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %d", (int)mode);
27217128ae9fSMatthew G Knepley 
27229566063dSJacob Faibussowitsch     PetscCall(VecGetArrayAndMemType(l, &lArray, &lmtype));
27239566063dSJacob Faibussowitsch     PetscCall(VecGetArrayReadAndMemType(g, &gArray, &gmtype));
27249566063dSJacob Faibussowitsch     PetscCall(PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray,MPI_REPLACE));
27259566063dSJacob Faibussowitsch     PetscCall(VecRestoreArrayAndMemType(l, &lArray));
27269566063dSJacob Faibussowitsch     PetscCall(VecRestoreArrayReadAndMemType(g, &gArray));
27279566063dSJacob Faibussowitsch     if (transform) PetscCall(DMPlexGlobalToLocalBasis(dm, l));
27287128ae9fSMatthew G Knepley   } else {
27297a8be351SBarry Smith     PetscCheck(dm->ops->globaltolocalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
27309566063dSJacob Faibussowitsch     PetscCall((*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l));
27317128ae9fSMatthew G Knepley   }
27329566063dSJacob Faibussowitsch   PetscCall(DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL));
2733baf369e7SPeter Brune   for (link=dm->gtolhook; link; link=link->next) {
27349566063dSJacob Faibussowitsch     if (link->endhook) PetscCall((*link->endhook)(dm,g,mode,l,link->ctx));
2735baf369e7SPeter Brune   }
273647c6ae99SBarry Smith   PetscFunctionReturn(0);
273747c6ae99SBarry Smith }
273847c6ae99SBarry Smith 
2739d4d07f1eSToby Isaac /*@C
2740d4d07f1eSToby Isaac    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2741d4d07f1eSToby Isaac 
2742d4d07f1eSToby Isaac    Logically Collective
2743d4d07f1eSToby Isaac 
27444165533cSJose E. Roman    Input Parameters:
2745d4d07f1eSToby Isaac +  dm - the DM
2746d4d07f1eSToby Isaac .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2747d4d07f1eSToby Isaac .  endhook - function to run after DMLocalToGlobalEnd() has completed
2748d4d07f1eSToby Isaac -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2749d4d07f1eSToby Isaac 
2750d4d07f1eSToby Isaac    Calling sequence for beginhook:
2751d4d07f1eSToby Isaac $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2752d4d07f1eSToby Isaac 
2753d4d07f1eSToby Isaac +  dm - global DM
2754d4d07f1eSToby Isaac .  l - local vector
2755d4d07f1eSToby Isaac .  mode - mode
2756d4d07f1eSToby Isaac .  g - global vector
2757d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2758d4d07f1eSToby Isaac 
2759d4d07f1eSToby Isaac    Calling sequence for endhook:
2760d4d07f1eSToby Isaac $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2761d4d07f1eSToby Isaac 
2762d4d07f1eSToby Isaac +  global - global DM
2763d4d07f1eSToby Isaac .  l - local vector
2764d4d07f1eSToby Isaac .  mode - mode
2765d4d07f1eSToby Isaac .  g - global vector
2766d4d07f1eSToby Isaac -  ctx - optional user-defined function context
2767d4d07f1eSToby Isaac 
2768d4d07f1eSToby Isaac    Level: advanced
2769d4d07f1eSToby Isaac 
2770d4d07f1eSToby Isaac .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2771d4d07f1eSToby Isaac @*/
2772d4d07f1eSToby Isaac PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2773d4d07f1eSToby Isaac {
2774d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link,*p;
2775d4d07f1eSToby Isaac 
2776d4d07f1eSToby Isaac   PetscFunctionBegin;
2777d4d07f1eSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2778d4d07f1eSToby Isaac   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
27799566063dSJacob Faibussowitsch   PetscCall(PetscNew(&link));
2780d4d07f1eSToby Isaac   link->beginhook = beginhook;
2781d4d07f1eSToby Isaac   link->endhook   = endhook;
2782d4d07f1eSToby Isaac   link->ctx       = ctx;
2783d4d07f1eSToby Isaac   link->next      = NULL;
2784d4d07f1eSToby Isaac   *p              = link;
2785d4d07f1eSToby Isaac   PetscFunctionReturn(0);
2786d4d07f1eSToby Isaac }
2787d4d07f1eSToby Isaac 
27884c274da1SToby Isaac static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
27894c274da1SToby Isaac {
27904c274da1SToby Isaac   Mat cMat;
27914c274da1SToby Isaac   Vec cVec;
27924c274da1SToby Isaac   PetscSection section, cSec;
27934c274da1SToby Isaac   PetscInt pStart, pEnd, p, dof;
27944c274da1SToby Isaac 
27954c274da1SToby Isaac   PetscFunctionBegin;
27964c274da1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
27979566063dSJacob Faibussowitsch   PetscCall(DMGetDefaultConstraints(dm,&cSec,&cMat,NULL));
27984c274da1SToby Isaac   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
27995db9a05bSToby Isaac     PetscInt nRows;
28005db9a05bSToby Isaac 
28019566063dSJacob Faibussowitsch     PetscCall(MatGetSize(cMat,&nRows,NULL));
28025db9a05bSToby Isaac     if (nRows <= 0) PetscFunctionReturn(0);
28039566063dSJacob Faibussowitsch     PetscCall(DMGetLocalSection(dm,&section));
28049566063dSJacob Faibussowitsch     PetscCall(MatCreateVecs(cMat,NULL,&cVec));
28059566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(cSec,&pStart,&pEnd));
28064c274da1SToby Isaac     for (p = pStart; p < pEnd; p++) {
28079566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(cSec,p,&dof));
28084c274da1SToby Isaac       if (dof) {
28094c274da1SToby Isaac         PetscInt d;
28104c274da1SToby Isaac         PetscScalar *vals;
28119566063dSJacob Faibussowitsch         PetscCall(VecGetValuesSection(l,section,p,&vals));
28129566063dSJacob Faibussowitsch         PetscCall(VecSetValuesSection(cVec,cSec,p,vals,mode));
28134c274da1SToby Isaac         /* for this to be the true transpose, we have to zero the values that
28144c274da1SToby Isaac          * we just extracted */
28154c274da1SToby Isaac         for (d = 0; d < dof; d++) {
28164c274da1SToby Isaac           vals[d] = 0.;
28174c274da1SToby Isaac         }
28184c274da1SToby Isaac       }
28194c274da1SToby Isaac     }
28209566063dSJacob Faibussowitsch     PetscCall(MatMultTransposeAdd(cMat,cVec,l,l));
28219566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&cVec));
28224c274da1SToby Isaac   }
28234c274da1SToby Isaac   PetscFunctionReturn(0);
28244c274da1SToby Isaac }
282501729b5cSPatrick Sanan /*@
282601729b5cSPatrick Sanan     DMLocalToGlobal - updates global vectors from local vectors
282701729b5cSPatrick Sanan 
2828d083f849SBarry Smith     Neighbor-wise Collective on dm
282901729b5cSPatrick Sanan 
283001729b5cSPatrick Sanan     Input Parameters:
283101729b5cSPatrick Sanan +   dm - the DM object
283201729b5cSPatrick Sanan .   l - the local vector
283301729b5cSPatrick 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.
283401729b5cSPatrick Sanan -   g - the global vector
283501729b5cSPatrick Sanan 
283601729b5cSPatrick Sanan     Notes:
283701729b5cSPatrick Sanan     The communication involved in this update can be overlapped with computation by using
283801729b5cSPatrick Sanan     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
283901729b5cSPatrick Sanan 
284001729b5cSPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
284101729b5cSPatrick 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.
284201729b5cSPatrick Sanan 
284301729b5cSPatrick Sanan     Level: beginner
284401729b5cSPatrick Sanan 
284501729b5cSPatrick Sanan .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
284601729b5cSPatrick Sanan 
284701729b5cSPatrick Sanan @*/
284801729b5cSPatrick Sanan PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
284901729b5cSPatrick Sanan {
285001729b5cSPatrick Sanan   PetscFunctionBegin;
28519566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(dm,l,mode,g));
28529566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(dm,l,mode,g));
285301729b5cSPatrick Sanan   PetscFunctionReturn(0);
285401729b5cSPatrick Sanan }
28554c274da1SToby Isaac 
285647c6ae99SBarry Smith /*@
285701729b5cSPatrick Sanan     DMLocalToGlobalBegin - begins updating global vectors from local vectors
28589a42bb27SBarry Smith 
2859d083f849SBarry Smith     Neighbor-wise Collective on dm
28609a42bb27SBarry Smith 
28619a42bb27SBarry Smith     Input Parameters:
28629a42bb27SBarry Smith +   dm - the DM object
2863f6813fd5SJed Brown .   l - the local vector
28641eb28f2eSBarry 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.
28651eb28f2eSBarry Smith -   g - the global vector
28669a42bb27SBarry Smith 
286795452b02SPatrick Sanan     Notes:
286895452b02SPatrick Sanan     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
286984330215SMatthew 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.
28709a42bb27SBarry Smith 
287101729b5cSPatrick Sanan     Level: intermediate
28729a42bb27SBarry Smith 
287301729b5cSPatrick Sanan .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
28749a42bb27SBarry Smith 
28759a42bb27SBarry Smith @*/
28767087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
28779a42bb27SBarry Smith {
28787128ae9fSMatthew G Knepley   PetscSF                 sf;
287984330215SMatthew G. Knepley   PetscSection            s, gs;
2880d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
2881ca3d3a14SMatthew G. Knepley   Vec                     tmpl;
2882ae5cfb4aSMatthew G. Knepley   const PetscScalar      *lArray;
2883ae5cfb4aSMatthew G. Knepley   PetscScalar            *gArray;
2884fa88e482SJed Brown   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
2885d0295fc0SJunchao Zhang   PetscMemType            lmtype=PETSC_MEMTYPE_HOST,gmtype=PETSC_MEMTYPE_HOST;
28869a42bb27SBarry Smith 
28879a42bb27SBarry Smith   PetscFunctionBegin;
2888171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2889d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
2890d4d07f1eSToby Isaac     if (link->beginhook) {
28919566063dSJacob Faibussowitsch       PetscCall((*link->beginhook)(dm,l,mode,g,link->ctx));
2892d4d07f1eSToby Isaac     }
2893d4d07f1eSToby Isaac   }
28949566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL));
28959566063dSJacob Faibussowitsch   PetscCall(DMGetSectionSF(dm, &sf));
28969566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(dm, &s));
28977128ae9fSMatthew G Knepley   switch (mode) {
28987128ae9fSMatthew G Knepley   case INSERT_VALUES:
28997128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
2900304ab55fSMatthew G. Knepley   case INSERT_BC_VALUES:
290184330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
29027128ae9fSMatthew G Knepley   case ADD_VALUES:
29037128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
2904304ab55fSMatthew G. Knepley   case ADD_BC_VALUES:
290584330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
29067128ae9fSMatthew G Knepley   default:
290798921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
29087128ae9fSMatthew G Knepley   }
2909ca3d3a14SMatthew G. Knepley   if ((sf && !isInsert) || (s && isInsert)) {
29109566063dSJacob Faibussowitsch     PetscCall(DMHasBasisTransform(dm, &transform));
2911ca3d3a14SMatthew G. Knepley     if (transform) {
29129566063dSJacob Faibussowitsch       PetscCall(DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl));
29139566063dSJacob Faibussowitsch       PetscCall(VecCopy(l, tmpl));
29149566063dSJacob Faibussowitsch       PetscCall(DMPlexLocalToGlobalBasis(dm, tmpl));
29159566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(tmpl, &lArray));
2916fa88e482SJed Brown     } else if (isInsert) {
29179566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(l, &lArray));
2918fa88e482SJed Brown     } else {
29199566063dSJacob Faibussowitsch       PetscCall(VecGetArrayReadAndMemType(l, &lArray, &lmtype));
2920fa88e482SJed Brown       l_inplace = PETSC_TRUE;
2921ca3d3a14SMatthew G. Knepley     }
2922fa88e482SJed Brown     if (s && isInsert) {
29239566063dSJacob Faibussowitsch       PetscCall(VecGetArray(g, &gArray));
2924fa88e482SJed Brown     } else {
29259566063dSJacob Faibussowitsch       PetscCall(VecGetArrayAndMemType(g, &gArray, &gmtype));
2926fa88e482SJed Brown       g_inplace = PETSC_TRUE;
2927fa88e482SJed Brown     }
2928ca3d3a14SMatthew G. Knepley     if (sf && !isInsert) {
29299566063dSJacob Faibussowitsch       PetscCall(PetscSFReduceWithMemTypeBegin(sf, MPIU_SCALAR, lmtype, lArray, gmtype, gArray, MPIU_SUM));
293084330215SMatthew G. Knepley     } else if (s && isInsert) {
293184330215SMatthew G. Knepley       PetscInt gStart, pStart, pEnd, p;
293284330215SMatthew G. Knepley 
29339566063dSJacob Faibussowitsch       PetscCall(DMGetGlobalSection(dm, &gs));
29349566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetChart(s, &pStart, &pEnd));
29359566063dSJacob Faibussowitsch       PetscCall(VecGetOwnershipRange(g, &gStart, NULL));
293684330215SMatthew G. Knepley       for (p = pStart; p < pEnd; ++p) {
2937b3b16f48SMatthew G. Knepley         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
293884330215SMatthew G. Knepley 
29399566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(s, p, &dof));
29409566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetDof(gs, p, &gdof));
29419566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetConstraintDof(s, p, &cdof));
29429566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetConstraintDof(gs, p, &gcdof));
29439566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetOffset(s, p, &off));
29449566063dSJacob Faibussowitsch         PetscCall(PetscSectionGetOffset(gs, p, &goff));
2945b3b16f48SMatthew G. Knepley         /* Ignore off-process data and points with no global data */
294603442857SMatthew G. Knepley         if (!gdof || goff < 0) continue;
29477a8be351SBarry Smith         PetscCheck(dof == gdof,PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %" PetscInt_FMT " dof: %" PetscInt_FMT " gdof: %" PetscInt_FMT " cdof: %" PetscInt_FMT " gcdof: %" PetscInt_FMT, p, dof, gdof, cdof, gcdof);
2948b3b16f48SMatthew G. Knepley         /* If no constraints are enforced in the global vector */
2949b3b16f48SMatthew G. Knepley         if (!gcdof) {
295084330215SMatthew G. Knepley           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2951b3b16f48SMatthew G. Knepley           /* If constraints are enforced in the global vector */
2952b3b16f48SMatthew G. Knepley         } else if (cdof == gcdof) {
295384330215SMatthew G. Knepley           const PetscInt *cdofs;
295484330215SMatthew G. Knepley           PetscInt        cind = 0;
295584330215SMatthew G. Knepley 
29569566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetConstraintIndices(s, p, &cdofs));
2957b3b16f48SMatthew G. Knepley           for (d = 0, e = 0; d < dof; ++d) {
295884330215SMatthew G. Knepley             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2959b3b16f48SMatthew G. Knepley             gArray[goff-gStart+e++] = lArray[off+d];
296084330215SMatthew G. Knepley           }
29617a8be351SBarry Smith         } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %" PetscInt_FMT " dof: %" PetscInt_FMT " gdof: %" PetscInt_FMT " cdof: %" PetscInt_FMT " gcdof: %" PetscInt_FMT, p, dof, gdof, cdof, gcdof);
296284330215SMatthew G. Knepley       }
2963ca3d3a14SMatthew G. Knepley     }
2964fa88e482SJed Brown     if (g_inplace) {
29659566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayAndMemType(g, &gArray));
2966fa88e482SJed Brown     } else {
29679566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(g, &gArray));
2968fa88e482SJed Brown     }
2969ca3d3a14SMatthew G. Knepley     if (transform) {
29709566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(tmpl, &lArray));
29719566063dSJacob Faibussowitsch       PetscCall(DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl));
2972fa88e482SJed Brown     } else if (l_inplace) {
29739566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayReadAndMemType(l, &lArray));
2974ca3d3a14SMatthew G. Knepley     } else {
29759566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(l, &lArray));
2976ca3d3a14SMatthew G. Knepley     }
29777128ae9fSMatthew G Knepley   } else {
29787a8be351SBarry Smith     PetscCheck(dm->ops->localtoglobalbegin,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
29799566063dSJacob Faibussowitsch     PetscCall((*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g));
29807128ae9fSMatthew G Knepley   }
29819a42bb27SBarry Smith   PetscFunctionReturn(0);
29829a42bb27SBarry Smith }
29839a42bb27SBarry Smith 
29849a42bb27SBarry Smith /*@
29859a42bb27SBarry Smith     DMLocalToGlobalEnd - updates global vectors from local vectors
298647c6ae99SBarry Smith 
2987d083f849SBarry Smith     Neighbor-wise Collective on dm
298847c6ae99SBarry Smith 
298947c6ae99SBarry Smith     Input Parameters:
299047c6ae99SBarry Smith +   dm - the DM object
2991f6813fd5SJed Brown .   l - the local vector
299247c6ae99SBarry Smith .   mode - INSERT_VALUES or ADD_VALUES
2993f6813fd5SJed Brown -   g - the global vector
299447c6ae99SBarry Smith 
299501729b5cSPatrick Sanan     Level: intermediate
299647c6ae99SBarry Smith 
2997e727c939SJed Brown .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
299847c6ae99SBarry Smith 
299947c6ae99SBarry Smith @*/
30007087cfbeSBarry Smith PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
300147c6ae99SBarry Smith {
30027128ae9fSMatthew G Knepley   PetscSF                 sf;
300384330215SMatthew G. Knepley   PetscSection            s;
3004d4d07f1eSToby Isaac   DMLocalToGlobalHookLink link;
3005ca3d3a14SMatthew G. Knepley   PetscBool               isInsert, transform;
300647c6ae99SBarry Smith 
300747c6ae99SBarry Smith   PetscFunctionBegin;
3008171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
30099566063dSJacob Faibussowitsch   PetscCall(DMGetSectionSF(dm, &sf));
30109566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(dm, &s));
30117128ae9fSMatthew G Knepley   switch (mode) {
30127128ae9fSMatthew G Knepley   case INSERT_VALUES:
30137128ae9fSMatthew G Knepley   case INSERT_ALL_VALUES:
301484330215SMatthew G. Knepley     isInsert = PETSC_TRUE; break;
30157128ae9fSMatthew G Knepley   case ADD_VALUES:
30167128ae9fSMatthew G Knepley   case ADD_ALL_VALUES:
301784330215SMatthew G. Knepley     isInsert = PETSC_FALSE; break;
30187128ae9fSMatthew G Knepley   default:
301998921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
30207128ae9fSMatthew G Knepley   }
302184330215SMatthew G. Knepley   if (sf && !isInsert) {
3022ae5cfb4aSMatthew G. Knepley     const PetscScalar *lArray;
3023ae5cfb4aSMatthew G. Knepley     PetscScalar       *gArray;
3024ca3d3a14SMatthew G. Knepley     Vec                tmpl;
302584330215SMatthew G. Knepley 
30269566063dSJacob Faibussowitsch     PetscCall(DMHasBasisTransform(dm, &transform));
3027ca3d3a14SMatthew G. Knepley     if (transform) {
30289566063dSJacob Faibussowitsch       PetscCall(DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl));
30299566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(tmpl, &lArray));
3030ca3d3a14SMatthew G. Knepley     } else {
30319566063dSJacob Faibussowitsch       PetscCall(VecGetArrayReadAndMemType(l, &lArray, NULL));
3032ca3d3a14SMatthew G. Knepley     }
30339566063dSJacob Faibussowitsch     PetscCall(VecGetArrayAndMemType(g, &gArray, NULL));
30349566063dSJacob Faibussowitsch     PetscCall(PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM));
3035ca3d3a14SMatthew G. Knepley     if (transform) {
30369566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(tmpl, &lArray));
30379566063dSJacob Faibussowitsch       PetscCall(DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl));
3038ca3d3a14SMatthew G. Knepley     } else {
30399566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayReadAndMemType(l, &lArray));
3040ca3d3a14SMatthew G. Knepley     }
30419566063dSJacob Faibussowitsch     PetscCall(VecRestoreArrayAndMemType(g, &gArray));
304284330215SMatthew G. Knepley   } else if (s && isInsert) {
30437128ae9fSMatthew G Knepley   } else {
30447a8be351SBarry Smith     PetscCheck(dm->ops->localtoglobalend,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
30459566063dSJacob Faibussowitsch     PetscCall((*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g));
30467128ae9fSMatthew G Knepley   }
3047d4d07f1eSToby Isaac   for (link=dm->ltoghook; link; link=link->next) {
30489566063dSJacob Faibussowitsch     if (link->endhook) PetscCall((*link->endhook)(dm,g,mode,l,link->ctx));
3049d4d07f1eSToby Isaac   }
305047c6ae99SBarry Smith   PetscFunctionReturn(0);
305147c6ae99SBarry Smith }
305247c6ae99SBarry Smith 
3053f089877aSRichard Tran Mills /*@
3054bc0a1609SRichard Tran Mills    DMLocalToLocalBegin - Maps from a local vector (including ghost points
3055bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3056d78e899eSRichard Tran Mills    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
3057f089877aSRichard Tran Mills 
3058d083f849SBarry Smith    Neighbor-wise Collective on dm
3059f089877aSRichard Tran Mills 
3060f089877aSRichard Tran Mills    Input Parameters:
3061f089877aSRichard Tran Mills +  dm - the DM object
3062bc0a1609SRichard Tran Mills .  g - the original local vector
3063bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3064f089877aSRichard Tran Mills 
3065bc0a1609SRichard Tran Mills    Output Parameter:
3066bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3067f089877aSRichard Tran Mills 
3068f089877aSRichard Tran Mills    Level: intermediate
3069f089877aSRichard Tran Mills 
3070bc0a1609SRichard Tran Mills    Notes:
3071bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3072bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3073bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3074bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3075bc0a1609SRichard Tran Mills 
3076bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3077f089877aSRichard Tran Mills 
3078f089877aSRichard Tran Mills @*/
3079f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
3080f089877aSRichard Tran Mills {
3081f089877aSRichard Tran Mills   PetscFunctionBegin;
3082f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
30837a8be351SBarry Smith   PetscCheck(dm->ops->localtolocalbegin,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
30849566063dSJacob Faibussowitsch   PetscCall((*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l));
3085f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3086f089877aSRichard Tran Mills }
3087f089877aSRichard Tran Mills 
3088f089877aSRichard Tran Mills /*@
3089bc0a1609SRichard Tran Mills    DMLocalToLocalEnd - Maps from a local vector (including ghost points
3090bc0a1609SRichard Tran Mills    that contain irrelevant values) to another local vector where the ghost
3091d78e899eSRichard Tran Mills    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
3092f089877aSRichard Tran Mills 
3093d083f849SBarry Smith    Neighbor-wise Collective on dm
3094f089877aSRichard Tran Mills 
3095f089877aSRichard Tran Mills    Input Parameters:
3096bc0a1609SRichard Tran Mills +  da - the DM object
3097bc0a1609SRichard Tran Mills .  g - the original local vector
3098bc0a1609SRichard Tran Mills -  mode - one of INSERT_VALUES or ADD_VALUES
3099f089877aSRichard Tran Mills 
3100bc0a1609SRichard Tran Mills    Output Parameter:
3101bc0a1609SRichard Tran Mills .  l  - the local vector with correct ghost values
3102f089877aSRichard Tran Mills 
3103f089877aSRichard Tran Mills    Level: intermediate
3104f089877aSRichard Tran Mills 
3105bc0a1609SRichard Tran Mills    Notes:
3106bc0a1609SRichard Tran Mills    The local vectors used here need not be the same as those
3107bc0a1609SRichard Tran Mills    obtained from DMCreateLocalVector(), BUT they
3108bc0a1609SRichard Tran Mills    must have the same parallel data layout; they could, for example, be
3109bc0a1609SRichard Tran Mills    obtained with VecDuplicate() from the DM originating vectors.
3110bc0a1609SRichard Tran Mills 
3111bc0a1609SRichard Tran Mills .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
3112f089877aSRichard Tran Mills 
3113f089877aSRichard Tran Mills @*/
3114f089877aSRichard Tran Mills PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
3115f089877aSRichard Tran Mills {
3116f089877aSRichard Tran Mills   PetscFunctionBegin;
3117f089877aSRichard Tran Mills   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31187a8be351SBarry Smith   PetscCheck(dm->ops->localtolocalend,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
31199566063dSJacob Faibussowitsch   PetscCall((*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l));
3120f089877aSRichard Tran Mills   PetscFunctionReturn(0);
3121f089877aSRichard Tran Mills }
3122f089877aSRichard Tran Mills 
312347c6ae99SBarry Smith /*@
312447c6ae99SBarry Smith     DMCoarsen - Coarsens a DM object
312547c6ae99SBarry Smith 
3126d083f849SBarry Smith     Collective on dm
312747c6ae99SBarry Smith 
3128d8d19677SJose E. Roman     Input Parameters:
312947c6ae99SBarry Smith +   dm - the DM object
313091d95f02SJed Brown -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
313147c6ae99SBarry Smith 
313247c6ae99SBarry Smith     Output Parameter:
313347c6ae99SBarry Smith .   dmc - the coarsened DM
313447c6ae99SBarry Smith 
313547c6ae99SBarry Smith     Level: developer
313647c6ae99SBarry Smith 
3137e727c939SJed Brown .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
313847c6ae99SBarry Smith 
313947c6ae99SBarry Smith @*/
31407087cfbeSBarry Smith PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
314147c6ae99SBarry Smith {
3142b17ce1afSJed Brown   DMCoarsenHookLink link;
314347c6ae99SBarry Smith 
314447c6ae99SBarry Smith   PetscFunctionBegin;
3145171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
31467a8be351SBarry Smith   PetscCheck(dm->ops->coarsen,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
31479566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_Coarsen,dm,0,0,0));
31489566063dSJacob Faibussowitsch   PetscCall((*dm->ops->coarsen)(dm, comm, dmc));
3149b9d85ea2SLisandro Dalcin   if (*dmc) {
3150a3574896SRichard Tran Mills     (*dmc)->bind_below = dm->bind_below; /* Propagate this from parent DM; otherwise -dm_bind_below will be useless for multigrid cases. */
31519566063dSJacob Faibussowitsch     PetscCall(DMSetCoarseDM(dm,*dmc));
315243842a1eSJed Brown     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
31539566063dSJacob Faibussowitsch     PetscCall(PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc));
3154644e2e5bSBarry Smith     (*dmc)->ctx               = dm->ctx;
31550598a293SJed Brown     (*dmc)->levelup           = dm->levelup;
3156656b349aSBarry Smith     (*dmc)->leveldown         = dm->leveldown + 1;
31579566063dSJacob Faibussowitsch     PetscCall(DMSetMatType(*dmc,dm->mattype));
3158b17ce1afSJed Brown     for (link=dm->coarsenhook; link; link=link->next) {
31599566063dSJacob Faibussowitsch       if (link->coarsenhook) PetscCall((*link->coarsenhook)(dm,*dmc,link->ctx));
3160b17ce1afSJed Brown     }
3161b9d85ea2SLisandro Dalcin   }
31629566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_Coarsen,dm,0,0,0));
31637a8be351SBarry Smith   PetscCheck(*dmc,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
3164b17ce1afSJed Brown   PetscFunctionReturn(0);
3165b17ce1afSJed Brown }
3166b17ce1afSJed Brown 
3167bb9467b5SJed Brown /*@C
3168b17ce1afSJed Brown    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
3169b17ce1afSJed Brown 
3170b17ce1afSJed Brown    Logically Collective
3171b17ce1afSJed Brown 
31724165533cSJose E. Roman    Input Parameters:
3173b17ce1afSJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3174b17ce1afSJed Brown .  coarsenhook - function to run when setting up a coarser level
3175b17ce1afSJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
31760298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3177b17ce1afSJed Brown 
3178b17ce1afSJed Brown    Calling sequence of coarsenhook:
3179b17ce1afSJed Brown $    coarsenhook(DM fine,DM coarse,void *ctx);
3180b17ce1afSJed Brown 
3181b17ce1afSJed Brown +  fine - fine level DM
3182b17ce1afSJed Brown .  coarse - coarse level DM to restrict problem to
3183b17ce1afSJed Brown -  ctx - optional user-defined function context
3184b17ce1afSJed Brown 
3185b17ce1afSJed Brown    Calling sequence for restricthook:
3186c833c3b5SJed Brown $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
3187b17ce1afSJed Brown 
3188b17ce1afSJed Brown +  fine - fine level DM
3189b17ce1afSJed Brown .  mrestrict - matrix restricting a fine-level solution to the coarse grid
3190c833c3b5SJed Brown .  rscale - scaling vector for restriction
3191c833c3b5SJed Brown .  inject - matrix restricting by injection
3192b17ce1afSJed Brown .  coarse - coarse level DM to update
3193b17ce1afSJed Brown -  ctx - optional user-defined function context
3194b17ce1afSJed Brown 
3195b17ce1afSJed Brown    Level: advanced
3196b17ce1afSJed Brown 
3197b17ce1afSJed Brown    Notes:
3198b17ce1afSJed Brown    This function is only needed if auxiliary data needs to be set up on coarse grids.
3199b17ce1afSJed Brown 
3200b17ce1afSJed Brown    If this function is called multiple times, the hooks will be run in the order they are added.
3201b17ce1afSJed Brown 
3202b17ce1afSJed Brown    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3203b17ce1afSJed Brown    extract the finest level information from its context (instead of from the SNES).
3204b17ce1afSJed Brown 
3205bb9467b5SJed Brown    This function is currently not available from Fortran.
3206bb9467b5SJed Brown 
3207dc822a44SJed Brown .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3208b17ce1afSJed Brown @*/
3209b17ce1afSJed Brown PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3210b17ce1afSJed Brown {
3211b17ce1afSJed Brown   DMCoarsenHookLink link,*p;
3212b17ce1afSJed Brown 
3213b17ce1afSJed Brown   PetscFunctionBegin;
3214b17ce1afSJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
32151e3d8eccSJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
32161e3d8eccSJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
32171e3d8eccSJed Brown   }
32189566063dSJacob Faibussowitsch   PetscCall(PetscNew(&link));
3219b17ce1afSJed Brown   link->coarsenhook  = coarsenhook;
3220b17ce1afSJed Brown   link->restricthook = restricthook;
3221b17ce1afSJed Brown   link->ctx          = ctx;
32220298fd71SBarry Smith   link->next         = NULL;
3223b17ce1afSJed Brown   *p                 = link;
3224b17ce1afSJed Brown   PetscFunctionReturn(0);
3225b17ce1afSJed Brown }
3226b17ce1afSJed Brown 
3227dc822a44SJed Brown /*@C
3228dc822a44SJed Brown    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
3229dc822a44SJed Brown 
3230dc822a44SJed Brown    Logically Collective
3231dc822a44SJed Brown 
32324165533cSJose E. Roman    Input Parameters:
3233dc822a44SJed Brown +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
3234dc822a44SJed Brown .  coarsenhook - function to run when setting up a coarser level
3235dc822a44SJed Brown .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
3236dc822a44SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3237dc822a44SJed Brown 
3238dc822a44SJed Brown    Level: advanced
3239dc822a44SJed Brown 
3240dc822a44SJed Brown    Notes:
3241dc822a44SJed Brown    This function does nothing if the hook is not in the list.
3242dc822a44SJed Brown 
3243dc822a44SJed Brown    This function is currently not available from Fortran.
3244dc822a44SJed Brown 
3245dc822a44SJed Brown .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3246dc822a44SJed Brown @*/
3247dc822a44SJed Brown PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
3248dc822a44SJed Brown {
3249dc822a44SJed Brown   DMCoarsenHookLink link,*p;
3250dc822a44SJed Brown 
3251dc822a44SJed Brown   PetscFunctionBegin;
3252dc822a44SJed Brown   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
3253dc822a44SJed Brown   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3254dc822a44SJed Brown     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3255dc822a44SJed Brown       link = *p;
3256dc822a44SJed Brown       *p = link->next;
32579566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
3258dc822a44SJed Brown       break;
3259dc822a44SJed Brown     }
3260dc822a44SJed Brown   }
3261dc822a44SJed Brown   PetscFunctionReturn(0);
3262dc822a44SJed Brown }
3263dc822a44SJed Brown 
3264b17ce1afSJed Brown /*@
3265b17ce1afSJed Brown    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3266b17ce1afSJed Brown 
3267b17ce1afSJed Brown    Collective if any hooks are
3268b17ce1afSJed Brown 
32694165533cSJose E. Roman    Input Parameters:
3270b17ce1afSJed Brown +  fine - finer DM to use as a base
3271b17ce1afSJed Brown .  restrct - restriction matrix, apply using MatRestrict()
3272e91eccc2SStefano Zampini .  rscale - scaling vector for restriction
3273b17ce1afSJed Brown .  inject - injection matrix, also use MatRestrict()
3274e91eccc2SStefano Zampini -  coarse - coarser DM to update
3275b17ce1afSJed Brown 
3276b17ce1afSJed Brown    Level: developer
3277b17ce1afSJed Brown 
3278b17ce1afSJed Brown .seealso: DMCoarsenHookAdd(), MatRestrict()
3279b17ce1afSJed Brown @*/
3280b17ce1afSJed Brown PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3281b17ce1afSJed Brown {
3282b17ce1afSJed Brown   DMCoarsenHookLink link;
3283b17ce1afSJed Brown 
3284b17ce1afSJed Brown   PetscFunctionBegin;
3285b17ce1afSJed Brown   for (link=fine->coarsenhook; link; link=link->next) {
32868865f1eaSKarl Rupp     if (link->restricthook) {
32879566063dSJacob Faibussowitsch       PetscCall((*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx));
32888865f1eaSKarl Rupp     }
3289b17ce1afSJed Brown   }
329047c6ae99SBarry Smith   PetscFunctionReturn(0);
329147c6ae99SBarry Smith }
329247c6ae99SBarry Smith 
3293bb9467b5SJed Brown /*@C
3294be081cd6SPeter Brune    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
32955dbd56e3SPeter Brune 
3296d083f849SBarry Smith    Logically Collective on global
32975dbd56e3SPeter Brune 
32984165533cSJose E. Roman    Input Parameters:
32995dbd56e3SPeter Brune +  global - global DM
3300ec4806b8SPeter Brune .  ddhook - function to run to pass data to the decomposition DM upon its creation
33015dbd56e3SPeter Brune .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
33020298fd71SBarry Smith -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
33035dbd56e3SPeter Brune 
3304ec4806b8SPeter Brune    Calling sequence for ddhook:
3305ec4806b8SPeter Brune $    ddhook(DM global,DM block,void *ctx)
3306ec4806b8SPeter Brune 
3307ec4806b8SPeter Brune +  global - global DM
3308ec4806b8SPeter Brune .  block  - block DM
3309ec4806b8SPeter Brune -  ctx - optional user-defined function context
3310ec4806b8SPeter Brune 
33115dbd56e3SPeter Brune    Calling sequence for restricthook:
3312ec4806b8SPeter Brune $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
33135dbd56e3SPeter Brune 
33145dbd56e3SPeter Brune +  global - global DM
33155dbd56e3SPeter Brune .  out    - scatter to the outer (with ghost and overlap points) block vector
33165dbd56e3SPeter Brune .  in     - scatter to block vector values only owned locally
3317ec4806b8SPeter Brune .  block  - block DM
33185dbd56e3SPeter Brune -  ctx - optional user-defined function context
33195dbd56e3SPeter Brune 
33205dbd56e3SPeter Brune    Level: advanced
33215dbd56e3SPeter Brune 
33225dbd56e3SPeter Brune    Notes:
3323ec4806b8SPeter Brune    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
33245dbd56e3SPeter Brune 
33255dbd56e3SPeter Brune    If this function is called multiple times, the hooks will be run in the order they are added.
33265dbd56e3SPeter Brune 
33275dbd56e3SPeter Brune    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3328ec4806b8SPeter Brune    extract the global information from its context (instead of from the SNES).
33295dbd56e3SPeter Brune 
3330bb9467b5SJed Brown    This function is currently not available from Fortran.
3331bb9467b5SJed Brown 
33325dbd56e3SPeter Brune .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
33335dbd56e3SPeter Brune @*/
3334be081cd6SPeter Brune PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
33355dbd56e3SPeter Brune {
3336be081cd6SPeter Brune   DMSubDomainHookLink link,*p;
33375dbd56e3SPeter Brune 
33385dbd56e3SPeter Brune   PetscFunctionBegin;
33395dbd56e3SPeter Brune   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3340b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3341b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3342b3a6b972SJed Brown   }
33439566063dSJacob Faibussowitsch   PetscCall(PetscNew(&link));
33445dbd56e3SPeter Brune   link->restricthook = restricthook;
3345be081cd6SPeter Brune   link->ddhook       = ddhook;
33465dbd56e3SPeter Brune   link->ctx          = ctx;
33470298fd71SBarry Smith   link->next         = NULL;
33485dbd56e3SPeter Brune   *p                 = link;
33495dbd56e3SPeter Brune   PetscFunctionReturn(0);
33505dbd56e3SPeter Brune }
33515dbd56e3SPeter Brune 
3352b3a6b972SJed Brown /*@C
3353b3a6b972SJed Brown    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3354b3a6b972SJed Brown 
3355b3a6b972SJed Brown    Logically Collective
3356b3a6b972SJed Brown 
33574165533cSJose E. Roman    Input Parameters:
3358b3a6b972SJed Brown +  global - global DM
3359b3a6b972SJed Brown .  ddhook - function to run to pass data to the decomposition DM upon its creation
3360b3a6b972SJed Brown .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3361b3a6b972SJed Brown -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3362b3a6b972SJed Brown 
3363b3a6b972SJed Brown    Level: advanced
3364b3a6b972SJed Brown 
3365b3a6b972SJed Brown    Notes:
3366b3a6b972SJed Brown 
3367b3a6b972SJed Brown    This function is currently not available from Fortran.
3368b3a6b972SJed Brown 
3369b3a6b972SJed Brown .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3370b3a6b972SJed Brown @*/
3371b3a6b972SJed Brown PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3372b3a6b972SJed Brown {
3373b3a6b972SJed Brown   DMSubDomainHookLink link,*p;
3374b3a6b972SJed Brown 
3375b3a6b972SJed Brown   PetscFunctionBegin;
3376b3a6b972SJed Brown   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3377b3a6b972SJed Brown   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3378b3a6b972SJed Brown     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3379b3a6b972SJed Brown       link = *p;
3380b3a6b972SJed Brown       *p = link->next;
33819566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
3382b3a6b972SJed Brown       break;
3383b3a6b972SJed Brown     }
3384b3a6b972SJed Brown   }
3385b3a6b972SJed Brown   PetscFunctionReturn(0);
3386b3a6b972SJed Brown }
3387b3a6b972SJed Brown 
33885dbd56e3SPeter Brune /*@
3389be081cd6SPeter Brune    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
33905dbd56e3SPeter Brune 
33915dbd56e3SPeter Brune    Collective if any hooks are
33925dbd56e3SPeter Brune 
33934165533cSJose E. Roman    Input Parameters:
33945dbd56e3SPeter Brune +  fine - finer DM to use as a base
3395be081cd6SPeter Brune .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3396be081cd6SPeter Brune .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
33975dbd56e3SPeter Brune -  coarse - coarer DM to update
33985dbd56e3SPeter Brune 
33995dbd56e3SPeter Brune    Level: developer
34005dbd56e3SPeter Brune 
34015dbd56e3SPeter Brune .seealso: DMCoarsenHookAdd(), MatRestrict()
34025dbd56e3SPeter Brune @*/
3403be081cd6SPeter Brune PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
34045dbd56e3SPeter Brune {
3405be081cd6SPeter Brune   DMSubDomainHookLink link;
34065dbd56e3SPeter Brune 
34075dbd56e3SPeter Brune   PetscFunctionBegin;
3408be081cd6SPeter Brune   for (link=global->subdomainhook; link; link=link->next) {
34098865f1eaSKarl Rupp     if (link->restricthook) {
34109566063dSJacob Faibussowitsch       PetscCall((*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx));
34118865f1eaSKarl Rupp     }
34125dbd56e3SPeter Brune   }
34135dbd56e3SPeter Brune   PetscFunctionReturn(0);
34145dbd56e3SPeter Brune }
34155dbd56e3SPeter Brune 
34165fe1f584SPeter Brune /*@
34176a7d9d85SPeter Brune     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
34185fe1f584SPeter Brune 
34195fe1f584SPeter Brune     Not Collective
34205fe1f584SPeter Brune 
34215fe1f584SPeter Brune     Input Parameter:
34225fe1f584SPeter Brune .   dm - the DM object
34235fe1f584SPeter Brune 
34245fe1f584SPeter Brune     Output Parameter:
34256a7d9d85SPeter Brune .   level - number of coarsenings
34265fe1f584SPeter Brune 
34275fe1f584SPeter Brune     Level: developer
34285fe1f584SPeter Brune 
34296a7d9d85SPeter Brune .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34305fe1f584SPeter Brune 
34315fe1f584SPeter Brune @*/
34325fe1f584SPeter Brune PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
34335fe1f584SPeter Brune {
34345fe1f584SPeter Brune   PetscFunctionBegin;
34355fe1f584SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3436b9d85ea2SLisandro Dalcin   PetscValidIntPointer(level,2);
34375fe1f584SPeter Brune   *level = dm->leveldown;
34385fe1f584SPeter Brune   PetscFunctionReturn(0);
34395fe1f584SPeter Brune }
34405fe1f584SPeter Brune 
34419a64c4a8SMatthew G. Knepley /*@
34429a64c4a8SMatthew G. Knepley     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
34439a64c4a8SMatthew G. Knepley 
34449a64c4a8SMatthew G. Knepley     Not Collective
34459a64c4a8SMatthew G. Knepley 
34469a64c4a8SMatthew G. Knepley     Input Parameters:
34479a64c4a8SMatthew G. Knepley +   dm - the DM object
34489a64c4a8SMatthew G. Knepley -   level - number of coarsenings
34499a64c4a8SMatthew G. Knepley 
34509a64c4a8SMatthew G. Knepley     Level: developer
34519a64c4a8SMatthew G. Knepley 
34529a64c4a8SMatthew G. Knepley .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
34539a64c4a8SMatthew G. Knepley @*/
34549a64c4a8SMatthew G. Knepley PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
34559a64c4a8SMatthew G. Knepley {
34569a64c4a8SMatthew G. Knepley   PetscFunctionBegin;
34579a64c4a8SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34589a64c4a8SMatthew G. Knepley   dm->leveldown = level;
34599a64c4a8SMatthew G. Knepley   PetscFunctionReturn(0);
34609a64c4a8SMatthew G. Knepley }
34619a64c4a8SMatthew G. Knepley 
346247c6ae99SBarry Smith /*@C
346347c6ae99SBarry Smith     DMRefineHierarchy - Refines a DM object, all levels at once
346447c6ae99SBarry Smith 
3465d083f849SBarry Smith     Collective on dm
346647c6ae99SBarry Smith 
3467d8d19677SJose E. Roman     Input Parameters:
346847c6ae99SBarry Smith +   dm - the DM object
346947c6ae99SBarry Smith -   nlevels - the number of levels of refinement
347047c6ae99SBarry Smith 
347147c6ae99SBarry Smith     Output Parameter:
347247c6ae99SBarry Smith .   dmf - the refined DM hierarchy
347347c6ae99SBarry Smith 
347447c6ae99SBarry Smith     Level: developer
347547c6ae99SBarry Smith 
3476e727c939SJed Brown .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
347747c6ae99SBarry Smith 
347847c6ae99SBarry Smith @*/
34797087cfbeSBarry Smith PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
348047c6ae99SBarry Smith {
348147c6ae99SBarry Smith   PetscFunctionBegin;
3482171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
34837a8be351SBarry Smith   PetscCheck(nlevels >= 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
348447c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
3485b9d85ea2SLisandro Dalcin   PetscValidPointer(dmf,3);
348647c6ae99SBarry Smith   if (dm->ops->refinehierarchy) {
34879566063dSJacob Faibussowitsch     PetscCall((*dm->ops->refinehierarchy)(dm,nlevels,dmf));
348847c6ae99SBarry Smith   } else if (dm->ops->refine) {
348947c6ae99SBarry Smith     PetscInt i;
349047c6ae99SBarry Smith 
34919566063dSJacob Faibussowitsch     PetscCall(DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]));
349247c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
34939566063dSJacob Faibussowitsch       PetscCall(DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]));
349447c6ae99SBarry Smith     }
3495ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
349647c6ae99SBarry Smith   PetscFunctionReturn(0);
349747c6ae99SBarry Smith }
349847c6ae99SBarry Smith 
349947c6ae99SBarry Smith /*@C
350047c6ae99SBarry Smith     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
350147c6ae99SBarry Smith 
3502d083f849SBarry Smith     Collective on dm
350347c6ae99SBarry Smith 
3504d8d19677SJose E. Roman     Input Parameters:
350547c6ae99SBarry Smith +   dm - the DM object
350647c6ae99SBarry Smith -   nlevels - the number of levels of coarsening
350747c6ae99SBarry Smith 
350847c6ae99SBarry Smith     Output Parameter:
350947c6ae99SBarry Smith .   dmc - the coarsened DM hierarchy
351047c6ae99SBarry Smith 
351147c6ae99SBarry Smith     Level: developer
351247c6ae99SBarry Smith 
3513e727c939SJed Brown .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
351447c6ae99SBarry Smith 
351547c6ae99SBarry Smith @*/
35167087cfbeSBarry Smith PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
351747c6ae99SBarry Smith {
351847c6ae99SBarry Smith   PetscFunctionBegin;
3519171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35207a8be351SBarry Smith   PetscCheck(nlevels >= 0,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
352147c6ae99SBarry Smith   if (nlevels == 0) PetscFunctionReturn(0);
352247c6ae99SBarry Smith   PetscValidPointer(dmc,3);
352347c6ae99SBarry Smith   if (dm->ops->coarsenhierarchy) {
35249566063dSJacob Faibussowitsch     PetscCall((*dm->ops->coarsenhierarchy)(dm, nlevels, dmc));
352547c6ae99SBarry Smith   } else if (dm->ops->coarsen) {
352647c6ae99SBarry Smith     PetscInt i;
352747c6ae99SBarry Smith 
35289566063dSJacob Faibussowitsch     PetscCall(DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]));
352947c6ae99SBarry Smith     for (i=1; i<nlevels; i++) {
35309566063dSJacob Faibussowitsch       PetscCall(DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]));
353147c6ae99SBarry Smith     }
3532ce94432eSBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
353347c6ae99SBarry Smith   PetscFunctionReturn(0);
353447c6ae99SBarry Smith }
353547c6ae99SBarry Smith 
35361a266240SBarry Smith /*@C
35371a266240SBarry Smith     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
35381a266240SBarry Smith 
35391a266240SBarry Smith     Not Collective
35401a266240SBarry Smith 
35411a266240SBarry Smith     Input Parameters:
35421a266240SBarry Smith +   dm - the DM object
35431a266240SBarry Smith -   destroy - the destroy function
35441a266240SBarry Smith 
35451a266240SBarry Smith     Level: intermediate
35461a266240SBarry Smith 
3547*5b8ffe73SMark Adams .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMGetApplicationContext()
35481a266240SBarry Smith 
3549f07f9ceaSJed Brown @*/
35501a266240SBarry Smith PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
35511a266240SBarry Smith {
35521a266240SBarry Smith   PetscFunctionBegin;
3553171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
35541a266240SBarry Smith   dm->ctxdestroy = destroy;
35551a266240SBarry Smith   PetscFunctionReturn(0);
35561a266240SBarry Smith }
35571a266240SBarry Smith 
3558b07ff414SBarry Smith /*@
35591b2093e4SBarry Smith     DMSetApplicationContext - Set a user context into a DM object
356047c6ae99SBarry Smith 
356147c6ae99SBarry Smith     Not Collective
356247c6ae99SBarry Smith 
356347c6ae99SBarry Smith     Input Parameters:
356447c6ae99SBarry Smith +   dm - the DM object
356547c6ae99SBarry Smith -   ctx - the user context
356647c6ae99SBarry Smith 
356747c6ae99SBarry Smith     Level: intermediate
356847c6ae99SBarry Smith 
3569*5b8ffe73SMark Adams .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMGetApplicationContext()
357047c6ae99SBarry Smith 
357147c6ae99SBarry Smith @*/
35721b2093e4SBarry Smith PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
357347c6ae99SBarry Smith {
357447c6ae99SBarry Smith   PetscFunctionBegin;
3575171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
357647c6ae99SBarry Smith   dm->ctx = ctx;
357747c6ae99SBarry Smith   PetscFunctionReturn(0);
357847c6ae99SBarry Smith }
357947c6ae99SBarry Smith 
358047c6ae99SBarry Smith /*@
35811b2093e4SBarry Smith     DMGetApplicationContext - Gets a user context from a DM object
358247c6ae99SBarry Smith 
358347c6ae99SBarry Smith     Not Collective
358447c6ae99SBarry Smith 
358547c6ae99SBarry Smith     Input Parameter:
358647c6ae99SBarry Smith .   dm - the DM object
358747c6ae99SBarry Smith 
358847c6ae99SBarry Smith     Output Parameter:
358947c6ae99SBarry Smith .   ctx - the user context
359047c6ae99SBarry Smith 
359147c6ae99SBarry Smith     Level: intermediate
359247c6ae99SBarry Smith 
3593*5b8ffe73SMark Adams .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMGetApplicationContext()
359447c6ae99SBarry Smith 
359547c6ae99SBarry Smith @*/
35961b2093e4SBarry Smith PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
359747c6ae99SBarry Smith {
359847c6ae99SBarry Smith   PetscFunctionBegin;
3599171400e9SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
36001b2093e4SBarry Smith   *(void**)ctx = dm->ctx;
360147c6ae99SBarry Smith   PetscFunctionReturn(0);
360247c6ae99SBarry Smith }
360347c6ae99SBarry Smith 
360408da532bSDmitry Karpeev /*@C
3605df3898eeSBarry Smith     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
360608da532bSDmitry Karpeev 
3607d083f849SBarry Smith     Logically Collective on dm
360808da532bSDmitry Karpeev 
3609d8d19677SJose E. Roman     Input Parameters:
361008da532bSDmitry Karpeev +   dm - the DM object
36110298fd71SBarry Smith -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
361208da532bSDmitry Karpeev 
361308da532bSDmitry Karpeev     Level: intermediate
361408da532bSDmitry Karpeev 
3615*5b8ffe73SMark Adams .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMGetApplicationContext(),
361608da532bSDmitry Karpeev          DMSetJacobian()
361708da532bSDmitry Karpeev 
361808da532bSDmitry Karpeev @*/
361908da532bSDmitry Karpeev PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
362008da532bSDmitry Karpeev {
362108da532bSDmitry Karpeev   PetscFunctionBegin;
36225a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
362308da532bSDmitry Karpeev   dm->ops->computevariablebounds = f;
362408da532bSDmitry Karpeev   PetscFunctionReturn(0);
362508da532bSDmitry Karpeev }
362608da532bSDmitry Karpeev 
362708da532bSDmitry Karpeev /*@
362808da532bSDmitry Karpeev     DMHasVariableBounds - does the DM object have a variable bounds function?
362908da532bSDmitry Karpeev 
363008da532bSDmitry Karpeev     Not Collective
363108da532bSDmitry Karpeev 
363208da532bSDmitry Karpeev     Input Parameter:
363308da532bSDmitry Karpeev .   dm - the DM object to destroy
363408da532bSDmitry Karpeev 
363508da532bSDmitry Karpeev     Output Parameter:
363608da532bSDmitry Karpeev .   flg - PETSC_TRUE if the variable bounds function exists
363708da532bSDmitry Karpeev 
363808da532bSDmitry Karpeev     Level: developer
363908da532bSDmitry Karpeev 
3640*5b8ffe73SMark Adams .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMGetApplicationContext()
364108da532bSDmitry Karpeev 
364208da532bSDmitry Karpeev @*/
364308da532bSDmitry Karpeev PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
364408da532bSDmitry Karpeev {
364508da532bSDmitry Karpeev   PetscFunctionBegin;
36465a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3647534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
364808da532bSDmitry Karpeev   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
364908da532bSDmitry Karpeev   PetscFunctionReturn(0);
365008da532bSDmitry Karpeev }
365108da532bSDmitry Karpeev 
365208da532bSDmitry Karpeev /*@C
365308da532bSDmitry Karpeev     DMComputeVariableBounds - compute variable bounds used by SNESVI.
365408da532bSDmitry Karpeev 
3655d083f849SBarry Smith     Logically Collective on dm
365608da532bSDmitry Karpeev 
3657f899ff85SJose E. Roman     Input Parameter:
3658907376e6SBarry Smith .   dm - the DM object
365908da532bSDmitry Karpeev 
366008da532bSDmitry Karpeev     Output parameters:
366108da532bSDmitry Karpeev +   xl - lower bound
366208da532bSDmitry Karpeev -   xu - upper bound
366308da532bSDmitry Karpeev 
3664907376e6SBarry Smith     Level: advanced
3665907376e6SBarry Smith 
366695452b02SPatrick Sanan     Notes:
366795452b02SPatrick Sanan     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
366808da532bSDmitry Karpeev 
3669*5b8ffe73SMark Adams .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateMassMatrix(), DMGetApplicationContext()
367008da532bSDmitry Karpeev 
367108da532bSDmitry Karpeev @*/
367208da532bSDmitry Karpeev PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
367308da532bSDmitry Karpeev {
367408da532bSDmitry Karpeev   PetscFunctionBegin;
36755a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
367608da532bSDmitry Karpeev   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
36775a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
36787a8be351SBarry Smith   PetscCheck(dm->ops->computevariablebounds,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
36799566063dSJacob Faibussowitsch   PetscCall((*dm->ops->computevariablebounds)(dm, xl,xu));
368008da532bSDmitry Karpeev   PetscFunctionReturn(0);
368108da532bSDmitry Karpeev }
368208da532bSDmitry Karpeev 
3683b0ae01b7SPeter Brune /*@
3684b0ae01b7SPeter Brune     DMHasColoring - does the DM object have a method of providing a coloring?
3685b0ae01b7SPeter Brune 
3686b0ae01b7SPeter Brune     Not Collective
3687b0ae01b7SPeter Brune 
3688b0ae01b7SPeter Brune     Input Parameter:
3689b0ae01b7SPeter Brune .   dm - the DM object
3690b0ae01b7SPeter Brune 
3691b0ae01b7SPeter Brune     Output Parameter:
3692b0ae01b7SPeter Brune .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3693b0ae01b7SPeter Brune 
3694b0ae01b7SPeter Brune     Level: developer
3695b0ae01b7SPeter Brune 
36961565f0a7SPatrick Sanan .seealso DMCreateColoring()
3697b0ae01b7SPeter Brune 
3698b0ae01b7SPeter Brune @*/
3699b0ae01b7SPeter Brune PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3700b0ae01b7SPeter Brune {
3701b0ae01b7SPeter Brune   PetscFunctionBegin;
37025a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3703534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
3704b0ae01b7SPeter Brune   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3705b0ae01b7SPeter Brune   PetscFunctionReturn(0);
3706b0ae01b7SPeter Brune }
3707b0ae01b7SPeter Brune 
37083ad4599aSBarry Smith /*@
37093ad4599aSBarry Smith     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
37103ad4599aSBarry Smith 
37113ad4599aSBarry Smith     Not Collective
37123ad4599aSBarry Smith 
37133ad4599aSBarry Smith     Input Parameter:
37143ad4599aSBarry Smith .   dm - the DM object
37153ad4599aSBarry Smith 
37163ad4599aSBarry Smith     Output Parameter:
37173ad4599aSBarry Smith .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
37183ad4599aSBarry Smith 
37193ad4599aSBarry Smith     Level: developer
37203ad4599aSBarry Smith 
37211565f0a7SPatrick Sanan .seealso DMCreateRestriction()
37223ad4599aSBarry Smith 
37233ad4599aSBarry Smith @*/
37243ad4599aSBarry Smith PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
37253ad4599aSBarry Smith {
37263ad4599aSBarry Smith   PetscFunctionBegin;
37275a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3728534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37293ad4599aSBarry Smith   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
37303ad4599aSBarry Smith   PetscFunctionReturn(0);
37313ad4599aSBarry Smith }
37323ad4599aSBarry Smith 
3733a7058e45SLawrence Mitchell /*@
3734a7058e45SLawrence Mitchell     DMHasCreateInjection - does the DM object have a method of providing an injection?
3735a7058e45SLawrence Mitchell 
3736a7058e45SLawrence Mitchell     Not Collective
3737a7058e45SLawrence Mitchell 
3738a7058e45SLawrence Mitchell     Input Parameter:
3739a7058e45SLawrence Mitchell .   dm - the DM object
3740a7058e45SLawrence Mitchell 
3741a7058e45SLawrence Mitchell     Output Parameter:
3742a7058e45SLawrence Mitchell .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3743a7058e45SLawrence Mitchell 
3744a7058e45SLawrence Mitchell     Level: developer
3745a7058e45SLawrence Mitchell 
37461565f0a7SPatrick Sanan .seealso DMCreateInjection()
3747a7058e45SLawrence Mitchell 
3748a7058e45SLawrence Mitchell @*/
3749a7058e45SLawrence Mitchell PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3750a7058e45SLawrence Mitchell {
3751a7058e45SLawrence Mitchell   PetscFunctionBegin;
37525a84ad33SLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3753534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
37545a84ad33SLisandro Dalcin   if (dm->ops->hascreateinjection) {
37559566063dSJacob Faibussowitsch     PetscCall((*dm->ops->hascreateinjection)(dm,flg));
37565a84ad33SLisandro Dalcin   } else {
37575a84ad33SLisandro Dalcin     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
37585a84ad33SLisandro Dalcin   }
3759a7058e45SLawrence Mitchell   PetscFunctionReturn(0);
3760a7058e45SLawrence Mitchell }
3761a7058e45SLawrence Mitchell 
37620298fd71SBarry Smith PetscFunctionList DMList              = NULL;
3763264ace61SBarry Smith PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3764264ace61SBarry Smith 
3765264ace61SBarry Smith /*@C
3766264ace61SBarry Smith   DMSetType - Builds a DM, for a particular DM implementation.
3767264ace61SBarry Smith 
3768d083f849SBarry Smith   Collective on dm
3769264ace61SBarry Smith 
3770264ace61SBarry Smith   Input Parameters:
3771264ace61SBarry Smith + dm     - The DM object
3772264ace61SBarry Smith - method - The name of the DM type
3773264ace61SBarry Smith 
3774264ace61SBarry Smith   Options Database Key:
3775264ace61SBarry Smith . -dm_type <type> - Sets the DM type; use -help for a list of available types
3776264ace61SBarry Smith 
3777264ace61SBarry Smith   Notes:
3778e1589f56SBarry Smith   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3779264ace61SBarry Smith 
3780264ace61SBarry Smith   Level: intermediate
3781264ace61SBarry Smith 
3782264ace61SBarry Smith .seealso: DMGetType(), DMCreate()
3783264ace61SBarry Smith @*/
378419fd82e9SBarry Smith PetscErrorCode  DMSetType(DM dm, DMType method)
3785264ace61SBarry Smith {
3786264ace61SBarry Smith   PetscErrorCode (*r)(DM);
3787264ace61SBarry Smith   PetscBool      match;
3788264ace61SBarry Smith 
3789264ace61SBarry Smith   PetscFunctionBegin;
3790264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
37919566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) dm, method, &match));
3792264ace61SBarry Smith   if (match) PetscFunctionReturn(0);
3793264ace61SBarry Smith 
37949566063dSJacob Faibussowitsch   PetscCall(DMRegisterAll());
37959566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListFind(DMList,method,&r));
37967a8be351SBarry Smith   PetscCheck(r,PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3797264ace61SBarry Smith 
3798264ace61SBarry Smith   if (dm->ops->destroy) {
37999566063dSJacob Faibussowitsch     PetscCall((*dm->ops->destroy)(dm));
3800264ace61SBarry Smith   }
38019566063dSJacob Faibussowitsch   PetscCall(PetscMemzero(dm->ops,sizeof(*dm->ops)));
38029566063dSJacob Faibussowitsch   PetscCall(PetscObjectChangeTypeName((PetscObject)dm,method));
38039566063dSJacob Faibussowitsch   PetscCall((*r)(dm));
3804264ace61SBarry Smith   PetscFunctionReturn(0);
3805264ace61SBarry Smith }
3806264ace61SBarry Smith 
3807264ace61SBarry Smith /*@C
3808264ace61SBarry Smith   DMGetType - Gets the DM type name (as a string) from the DM.
3809264ace61SBarry Smith 
3810264ace61SBarry Smith   Not Collective
3811264ace61SBarry Smith 
3812264ace61SBarry Smith   Input Parameter:
3813264ace61SBarry Smith . dm  - The DM
3814264ace61SBarry Smith 
3815264ace61SBarry Smith   Output Parameter:
3816264ace61SBarry Smith . type - The DM type name
3817264ace61SBarry Smith 
3818264ace61SBarry Smith   Level: intermediate
3819264ace61SBarry Smith 
3820264ace61SBarry Smith .seealso: DMSetType(), DMCreate()
3821264ace61SBarry Smith @*/
382219fd82e9SBarry Smith PetscErrorCode  DMGetType(DM dm, DMType *type)
3823264ace61SBarry Smith {
3824264ace61SBarry Smith   PetscFunctionBegin;
3825264ace61SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3826c959eef4SJed Brown   PetscValidPointer(type,2);
38279566063dSJacob Faibussowitsch   PetscCall(DMRegisterAll());
3828264ace61SBarry Smith   *type = ((PetscObject)dm)->type_name;
3829264ace61SBarry Smith   PetscFunctionReturn(0);
3830264ace61SBarry Smith }
3831264ace61SBarry Smith 
383267a56275SMatthew G Knepley /*@C
383367a56275SMatthew G Knepley   DMConvert - Converts a DM to another DM, either of the same or different type.
383467a56275SMatthew G Knepley 
3835d083f849SBarry Smith   Collective on dm
383667a56275SMatthew G Knepley 
383767a56275SMatthew G Knepley   Input Parameters:
383867a56275SMatthew G Knepley + dm - the DM
383967a56275SMatthew G Knepley - newtype - new DM type (use "same" for the same type)
384067a56275SMatthew G Knepley 
384167a56275SMatthew G Knepley   Output Parameter:
384267a56275SMatthew G Knepley . M - pointer to new DM
384367a56275SMatthew G Knepley 
384467a56275SMatthew G Knepley   Notes:
384567a56275SMatthew G Knepley   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
384667a56275SMatthew G Knepley   the MPI communicator of the generated DM is always the same as the communicator
384767a56275SMatthew G Knepley   of the input DM.
384867a56275SMatthew G Knepley 
384967a56275SMatthew G Knepley   Level: intermediate
385067a56275SMatthew G Knepley 
385167a56275SMatthew G Knepley .seealso: DMCreate()
385267a56275SMatthew G Knepley @*/
385319fd82e9SBarry Smith PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
385467a56275SMatthew G Knepley {
385567a56275SMatthew G Knepley   DM             B;
385667a56275SMatthew G Knepley   char           convname[256];
3857c067b6caSMatthew G. Knepley   PetscBool      sametype/*, issame */;
385867a56275SMatthew G Knepley 
385967a56275SMatthew G Knepley   PetscFunctionBegin;
386067a56275SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
386167a56275SMatthew G Knepley   PetscValidType(dm,1);
386267a56275SMatthew G Knepley   PetscValidPointer(M,3);
38639566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype));
38649566063dSJacob Faibussowitsch   /* PetscCall(PetscStrcmp(newtype, "same", &issame)); */
3865c067b6caSMatthew G. Knepley   if (sametype) {
3866c067b6caSMatthew G. Knepley     *M   = dm;
38679566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject) dm));
3868c067b6caSMatthew G. Knepley     PetscFunctionReturn(0);
3869c067b6caSMatthew G. Knepley   } else {
38700298fd71SBarry Smith     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
387167a56275SMatthew G Knepley 
387267a56275SMatthew G Knepley     /*
387367a56275SMatthew G Knepley        Order of precedence:
387467a56275SMatthew G Knepley        1) See if a specialized converter is known to the current DM.
387567a56275SMatthew G Knepley        2) See if a specialized converter is known to the desired DM class.
387667a56275SMatthew G Knepley        3) See if a good general converter is registered for the desired class
387767a56275SMatthew G Knepley        4) See if a good general converter is known for the current matrix.
387867a56275SMatthew G Knepley        5) Use a really basic converter.
387967a56275SMatthew G Knepley     */
388067a56275SMatthew G Knepley 
388167a56275SMatthew G Knepley     /* 1) See if a specialized converter is known to the current DM and the desired class */
38829566063dSJacob Faibussowitsch     PetscCall(PetscStrncpy(convname,"DMConvert_",sizeof(convname)));
38839566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname)));
38849566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,"_",sizeof(convname)));
38859566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,newtype,sizeof(convname)));
38869566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,"_C",sizeof(convname)));
38879566063dSJacob Faibussowitsch     PetscCall(PetscObjectQueryFunction((PetscObject)dm,convname,&conv));
388867a56275SMatthew G Knepley     if (conv) goto foundconv;
388967a56275SMatthew G Knepley 
389067a56275SMatthew G Knepley     /* 2)  See if a specialized converter is known to the desired DM class. */
38919566063dSJacob Faibussowitsch     PetscCall(DMCreate(PetscObjectComm((PetscObject)dm), &B));
38929566063dSJacob Faibussowitsch     PetscCall(DMSetType(B, newtype));
38939566063dSJacob Faibussowitsch     PetscCall(PetscStrncpy(convname,"DMConvert_",sizeof(convname)));
38949566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname)));
38959566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,"_",sizeof(convname)));
38969566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,newtype,sizeof(convname)));
38979566063dSJacob Faibussowitsch     PetscCall(PetscStrlcat(convname,"_C",sizeof(convname)));
38989566063dSJacob Faibussowitsch     PetscCall(PetscObjectQueryFunction((PetscObject)B,convname,&conv));
389967a56275SMatthew G Knepley     if (conv) {
39009566063dSJacob Faibussowitsch       PetscCall(DMDestroy(&B));
390167a56275SMatthew G Knepley       goto foundconv;
390267a56275SMatthew G Knepley     }
390367a56275SMatthew G Knepley 
390467a56275SMatthew G Knepley #if 0
390567a56275SMatthew G Knepley     /* 3) See if a good general converter is registered for the desired class */
390667a56275SMatthew G Knepley     conv = B->ops->convertfrom;
39079566063dSJacob Faibussowitsch     PetscCall(DMDestroy(&B));
390867a56275SMatthew G Knepley     if (conv) goto foundconv;
390967a56275SMatthew G Knepley 
391067a56275SMatthew G Knepley     /* 4) See if a good general converter is known for the current matrix */
391167a56275SMatthew G Knepley     if (dm->ops->convert) {
391267a56275SMatthew G Knepley       conv = dm->ops->convert;
391367a56275SMatthew G Knepley     }
391467a56275SMatthew G Knepley     if (conv) goto foundconv;
391567a56275SMatthew G Knepley #endif
391667a56275SMatthew G Knepley 
391767a56275SMatthew G Knepley     /* 5) Use a really basic converter. */
391898921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
391967a56275SMatthew G Knepley 
392067a56275SMatthew G Knepley foundconv:
39219566063dSJacob Faibussowitsch     PetscCall(PetscLogEventBegin(DM_Convert,dm,0,0,0));
39229566063dSJacob Faibussowitsch     PetscCall((*conv)(dm,newtype,M));
392312fa691eSMatthew G. Knepley     /* Things that are independent of DM type: We should consult DMClone() here */
392490b157c4SStefano Zampini     {
392590b157c4SStefano Zampini       PetscBool             isper;
392612fa691eSMatthew G. Knepley       const PetscReal      *maxCell, *L;
392712fa691eSMatthew G. Knepley       const DMBoundaryType *bd;
39289566063dSJacob Faibussowitsch       PetscCall(DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd));
39299566063dSJacob Faibussowitsch       PetscCall(DMSetPeriodicity(*M, isper, maxCell,  L,  bd));
3930c8a6034eSMark       (*M)->prealloc_only = dm->prealloc_only;
39319566063dSJacob Faibussowitsch       PetscCall(PetscFree((*M)->vectype));
39329566063dSJacob Faibussowitsch       PetscCall(PetscStrallocpy(dm->vectype,(char**)&(*M)->vectype));
39339566063dSJacob Faibussowitsch       PetscCall(PetscFree((*M)->mattype));
39349566063dSJacob Faibussowitsch       PetscCall(PetscStrallocpy(dm->mattype,(char**)&(*M)->mattype));
393512fa691eSMatthew G. Knepley     }
39369566063dSJacob Faibussowitsch     PetscCall(PetscLogEventEnd(DM_Convert,dm,0,0,0));
393767a56275SMatthew G Knepley   }
39389566063dSJacob Faibussowitsch   PetscCall(PetscObjectStateIncrease((PetscObject) *M));
393967a56275SMatthew G Knepley   PetscFunctionReturn(0);
394067a56275SMatthew G Knepley }
3941264ace61SBarry Smith 
3942264ace61SBarry Smith /*--------------------------------------------------------------------------------------------------------------------*/
3943264ace61SBarry Smith 
3944264ace61SBarry Smith /*@C
39451c84c290SBarry Smith   DMRegister -  Adds a new DM component implementation
39461c84c290SBarry Smith 
39471c84c290SBarry Smith   Not Collective
39481c84c290SBarry Smith 
39491c84c290SBarry Smith   Input Parameters:
39501c84c290SBarry Smith + name        - The name of a new user-defined creation routine
39511c84c290SBarry Smith - create_func - The creation routine itself
39521c84c290SBarry Smith 
39531c84c290SBarry Smith   Notes:
39541c84c290SBarry Smith   DMRegister() may be called multiple times to add several user-defined DMs
39551c84c290SBarry Smith 
39561c84c290SBarry Smith   Sample usage:
39571c84c290SBarry Smith .vb
3958bdf89e91SBarry Smith     DMRegister("my_da", MyDMCreate);
39591c84c290SBarry Smith .ve
39601c84c290SBarry Smith 
39611c84c290SBarry Smith   Then, your DM type can be chosen with the procedural interface via
39621c84c290SBarry Smith .vb
39631c84c290SBarry Smith     DMCreate(MPI_Comm, DM *);
39641c84c290SBarry Smith     DMSetType(DM,"my_da");
39651c84c290SBarry Smith .ve
39661c84c290SBarry Smith    or at runtime via the option
39671c84c290SBarry Smith .vb
39681c84c290SBarry Smith     -da_type my_da
39691c84c290SBarry Smith .ve
3970264ace61SBarry Smith 
3971264ace61SBarry Smith   Level: advanced
39721c84c290SBarry Smith 
3973bdf89e91SBarry Smith .seealso: DMRegisterAll(), DMRegisterDestroy()
39741c84c290SBarry Smith 
3975264ace61SBarry Smith @*/
3976bdf89e91SBarry Smith PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3977264ace61SBarry Smith {
3978264ace61SBarry Smith   PetscFunctionBegin;
39799566063dSJacob Faibussowitsch   PetscCall(DMInitializePackage());
39809566063dSJacob Faibussowitsch   PetscCall(PetscFunctionListAdd(&DMList,sname,function));
3981264ace61SBarry Smith   PetscFunctionReturn(0);
3982264ace61SBarry Smith }
3983264ace61SBarry Smith 
3984b859378eSBarry Smith /*@C
398555849f57SBarry Smith   DMLoad - Loads a DM that has been stored in binary  with DMView().
3986b859378eSBarry Smith 
3987d083f849SBarry Smith   Collective on viewer
3988b859378eSBarry Smith 
3989b859378eSBarry Smith   Input Parameters:
3990b859378eSBarry Smith + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3991b859378eSBarry Smith            some related function before a call to DMLoad().
3992b859378eSBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3993b859378eSBarry Smith            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3994b859378eSBarry Smith 
3995b859378eSBarry Smith    Level: intermediate
3996b859378eSBarry Smith 
3997b859378eSBarry Smith   Notes:
399855849f57SBarry Smith   The type is determined by the data in the file, any type set into the DM before this call is ignored.
3999b859378eSBarry Smith 
4000cd7e8a5eSksagiyam   Using PETSCVIEWERHDF5 type with PETSC_VIEWER_HDF5_PETSC format, one can save multiple DMPlex
4001cd7e8a5eSksagiyam   meshes in a single HDF5 file. This in turn requires one to name the DMPlex object with PetscObjectSetName()
4002cd7e8a5eSksagiyam   before saving it with DMView() and before loading it with DMLoad() for identification of the mesh object.
4003cd7e8a5eSksagiyam 
4004b859378eSBarry Smith   Notes for advanced users:
4005b859378eSBarry Smith   Most users should not need to know the details of the binary storage
4006b859378eSBarry Smith   format, since DMLoad() and DMView() completely hide these details.
4007b859378eSBarry Smith   But for anyone who's interested, the standard binary matrix storage
4008b859378eSBarry Smith   format is
4009b859378eSBarry Smith .vb
4010b859378eSBarry Smith      has not yet been determined
4011b859378eSBarry Smith .ve
4012b859378eSBarry Smith 
4013b859378eSBarry Smith .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
4014b859378eSBarry Smith @*/
4015b859378eSBarry Smith PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
4016b859378eSBarry Smith {
40179331c7a4SMatthew G. Knepley   PetscBool      isbinary, ishdf5;
4018b859378eSBarry Smith 
4019b859378eSBarry Smith   PetscFunctionBegin;
4020b859378eSBarry Smith   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
4021b859378eSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
40229566063dSJacob Faibussowitsch   PetscCall(PetscViewerCheckReadable(viewer));
40239566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary));
40249566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5));
40259566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_Load,viewer,0,0,0));
40269331c7a4SMatthew G. Knepley   if (isbinary) {
40279331c7a4SMatthew G. Knepley     PetscInt classid;
40289331c7a4SMatthew G. Knepley     char     type[256];
4029b859378eSBarry Smith 
40309566063dSJacob Faibussowitsch     PetscCall(PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT));
40317a8be351SBarry Smith     PetscCheck(classid == DM_FILE_CLASSID,PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
40329566063dSJacob Faibussowitsch     PetscCall(PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR));
40339566063dSJacob Faibussowitsch     PetscCall(DMSetType(newdm, type));
40349566063dSJacob Faibussowitsch     if (newdm->ops->load) PetscCall((*newdm->ops->load)(newdm,viewer));
40359331c7a4SMatthew G. Knepley   } else if (ishdf5) {
40369566063dSJacob Faibussowitsch     if (newdm->ops->load) PetscCall((*newdm->ops->load)(newdm,viewer));
40379331c7a4SMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
40389566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_Load,viewer,0,0,0));
4039b859378eSBarry Smith   PetscFunctionReturn(0);
4040b859378eSBarry Smith }
4041b859378eSBarry Smith 
4042b2e4378dSMatthew G. Knepley /*@
4043b2e4378dSMatthew G. Knepley   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
4044b2e4378dSMatthew G. Knepley 
4045b2e4378dSMatthew G. Knepley   Not collective
4046b2e4378dSMatthew G. Knepley 
4047b2e4378dSMatthew G. Knepley   Input Parameter:
4048b2e4378dSMatthew G. Knepley . dm - the DM
4049b2e4378dSMatthew G. Knepley 
4050b2e4378dSMatthew G. Knepley   Output Parameters:
4051b2e4378dSMatthew G. Knepley + lmin - local minimum coordinates (length coord dim, optional)
4052b2e4378dSMatthew G. Knepley - lmax - local maximim coordinates (length coord dim, optional)
4053b2e4378dSMatthew G. Knepley 
4054b2e4378dSMatthew G. Knepley   Level: beginner
4055b2e4378dSMatthew G. Knepley 
4056b2e4378dSMatthew G. Knepley   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
4057b2e4378dSMatthew G. Knepley 
4058b2e4378dSMatthew G. Knepley .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
4059b2e4378dSMatthew G. Knepley @*/
4060b2e4378dSMatthew G. Knepley PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
4061b2e4378dSMatthew G. Knepley {
4062b2e4378dSMatthew G. Knepley   Vec                coords = NULL;
4063b2e4378dSMatthew G. Knepley   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
4064b2e4378dSMatthew G. Knepley   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
4065b2e4378dSMatthew G. Knepley   const PetscScalar *local_coords;
4066b2e4378dSMatthew G. Knepley   PetscInt           N, Ni;
4067b2e4378dSMatthew G. Knepley   PetscInt           cdim, i, j;
4068b2e4378dSMatthew G. Knepley 
4069b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4070b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
40719566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDim(dm, &cdim));
40729566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinates(dm, &coords));
4073b2e4378dSMatthew G. Knepley   if (coords) {
40749566063dSJacob Faibussowitsch     PetscCall(VecGetArrayRead(coords, &local_coords));
40759566063dSJacob Faibussowitsch     PetscCall(VecGetLocalSize(coords, &N));
4076b2e4378dSMatthew G. Knepley     Ni   = N/cdim;
4077b2e4378dSMatthew G. Knepley     for (i = 0; i < Ni; ++i) {
4078b2e4378dSMatthew G. Knepley       for (j = 0; j < 3; ++j) {
4079b2e4378dSMatthew G. Knepley         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4080b2e4378dSMatthew G. Knepley         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
4081b2e4378dSMatthew G. Knepley       }
4082b2e4378dSMatthew G. Knepley     }
40839566063dSJacob Faibussowitsch     PetscCall(VecRestoreArrayRead(coords, &local_coords));
4084b2e4378dSMatthew G. Knepley   } else {
4085b2e4378dSMatthew G. Knepley     PetscBool isda;
4086b2e4378dSMatthew G. Knepley 
40879566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda));
40889566063dSJacob Faibussowitsch     if (isda) PetscCall(DMGetLocalBoundingIndices_DMDA(dm, min, max));
4089b2e4378dSMatthew G. Knepley   }
40909566063dSJacob Faibussowitsch   if (lmin) PetscCall(PetscArraycpy(lmin, min, cdim));
40919566063dSJacob Faibussowitsch   if (lmax) PetscCall(PetscArraycpy(lmax, max, cdim));
4092b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4093b2e4378dSMatthew G. Knepley }
4094b2e4378dSMatthew G. Knepley 
4095b2e4378dSMatthew G. Knepley /*@
4096b2e4378dSMatthew G. Knepley   DMGetBoundingBox - Returns the global bounding box for the DM.
4097b2e4378dSMatthew G. Knepley 
4098b2e4378dSMatthew G. Knepley   Collective
4099b2e4378dSMatthew G. Knepley 
4100b2e4378dSMatthew G. Knepley   Input Parameter:
4101b2e4378dSMatthew G. Knepley . dm - the DM
4102b2e4378dSMatthew G. Knepley 
4103b2e4378dSMatthew G. Knepley   Output Parameters:
4104b2e4378dSMatthew G. Knepley + gmin - global minimum coordinates (length coord dim, optional)
4105b2e4378dSMatthew G. Knepley - gmax - global maximim coordinates (length coord dim, optional)
4106b2e4378dSMatthew G. Knepley 
4107b2e4378dSMatthew G. Knepley   Level: beginner
4108b2e4378dSMatthew G. Knepley 
4109b2e4378dSMatthew G. Knepley .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
4110b2e4378dSMatthew G. Knepley @*/
4111b2e4378dSMatthew G. Knepley PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
4112b2e4378dSMatthew G. Knepley {
4113b2e4378dSMatthew G. Knepley   PetscReal      lmin[3], lmax[3];
41146ce308c4SMatthew G. Knepley   PetscInt       cdim;
41156ce308c4SMatthew G. Knepley   PetscMPIInt    count;
4116b2e4378dSMatthew G. Knepley 
4117b2e4378dSMatthew G. Knepley   PetscFunctionBegin;
4118b2e4378dSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
41199566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDim(dm, &cdim));
41209566063dSJacob Faibussowitsch   PetscCall(PetscMPIIntCast(cdim, &count));
41219566063dSJacob Faibussowitsch   PetscCall(DMGetLocalBoundingBox(dm, lmin, lmax));
41221c2dc1cbSBarry Smith   if (gmin) PetscCall(MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm)));
41231c2dc1cbSBarry Smith   if (gmax) PetscCall(MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm)));
4124b2e4378dSMatthew G. Knepley   PetscFunctionReturn(0);
4125b2e4378dSMatthew G. Knepley }
4126b2e4378dSMatthew G. Knepley 
41277da65231SMatthew G Knepley /******************************** FEM Support **********************************/
41287da65231SMatthew G Knepley 
4129a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
4130a6dfd86eSKarl Rupp {
41311d47ebbbSSatish Balay   PetscInt       f;
41321b30c384SMatthew G Knepley 
41337da65231SMatthew G Knepley   PetscFunctionBegin;
41349566063dSJacob Faibussowitsch   PetscCall(PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name));
41351d47ebbbSSatish Balay   for (f = 0; f < len; ++f) {
41369566063dSJacob Faibussowitsch     PetscCall(PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f])));
41377da65231SMatthew G Knepley   }
41387da65231SMatthew G Knepley   PetscFunctionReturn(0);
41397da65231SMatthew G Knepley }
41407da65231SMatthew G Knepley 
4141a6dfd86eSKarl Rupp PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
4142a6dfd86eSKarl Rupp {
41431b30c384SMatthew G Knepley   PetscInt       f, g;
41447da65231SMatthew G Knepley 
41457da65231SMatthew G Knepley   PetscFunctionBegin;
41469566063dSJacob Faibussowitsch   PetscCall(PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name));
41471d47ebbbSSatish Balay   for (f = 0; f < rows; ++f) {
41489566063dSJacob Faibussowitsch     PetscCall(PetscPrintf(PETSC_COMM_SELF, "  |"));
41491d47ebbbSSatish Balay     for (g = 0; g < cols; ++g) {
41509566063dSJacob Faibussowitsch       PetscCall(PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g])));
41517da65231SMatthew G Knepley     }
41529566063dSJacob Faibussowitsch     PetscCall(PetscPrintf(PETSC_COMM_SELF, " |\n"));
41537da65231SMatthew G Knepley   }
41547da65231SMatthew G Knepley   PetscFunctionReturn(0);
41557da65231SMatthew G Knepley }
4156e7c4fc90SDmitry Karpeev 
41576113b454SMatthew G. Knepley PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
4158e759306cSMatthew G. Knepley {
41590c5b8624SToby Isaac   PetscInt          localSize, bs;
41600c5b8624SToby Isaac   PetscMPIInt       size;
41610c5b8624SToby Isaac   Vec               x, xglob;
41620c5b8624SToby Isaac   const PetscScalar *xarray;
4163e759306cSMatthew G. Knepley 
4164e759306cSMatthew G. Knepley   PetscFunctionBegin;
41659566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size));
41669566063dSJacob Faibussowitsch   PetscCall(VecDuplicate(X, &x));
41679566063dSJacob Faibussowitsch   PetscCall(VecCopy(X, x));
41689566063dSJacob Faibussowitsch   PetscCall(VecChop(x, tol));
41699566063dSJacob Faibussowitsch   PetscCall(PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name));
41700c5b8624SToby Isaac   if (size > 1) {
41719566063dSJacob Faibussowitsch     PetscCall(VecGetLocalSize(x,&localSize));
41729566063dSJacob Faibussowitsch     PetscCall(VecGetArrayRead(x,&xarray));
41739566063dSJacob Faibussowitsch     PetscCall(VecGetBlockSize(x,&bs));
41749566063dSJacob Faibussowitsch     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob));
41750c5b8624SToby Isaac   } else {
41760c5b8624SToby Isaac     xglob = x;
41770c5b8624SToby Isaac   }
41789566063dSJacob Faibussowitsch   PetscCall(VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm))));
41790c5b8624SToby Isaac   if (size > 1) {
41809566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&xglob));
41819566063dSJacob Faibussowitsch     PetscCall(VecRestoreArrayRead(x,&xarray));
41820c5b8624SToby Isaac   }
41839566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&x));
4184e759306cSMatthew G. Knepley   PetscFunctionReturn(0);
4185e759306cSMatthew G. Knepley }
4186e759306cSMatthew G. Knepley 
418788ed4aceSMatthew G Knepley /*@
41881bb6d2a8SBarry Smith   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
4189061576a5SJed Brown 
4190061576a5SJed Brown   Input Parameter:
4191061576a5SJed Brown . dm - The DM
4192061576a5SJed Brown 
4193061576a5SJed Brown   Output Parameter:
4194061576a5SJed Brown . section - The PetscSection
4195061576a5SJed Brown 
4196061576a5SJed Brown   Options Database Keys:
4197061576a5SJed Brown . -dm_petscsection_view - View the Section created by the DM
4198061576a5SJed Brown 
4199061576a5SJed Brown   Level: advanced
4200061576a5SJed Brown 
4201061576a5SJed Brown   Notes:
4202061576a5SJed Brown   Use DMGetLocalSection() in new code.
4203061576a5SJed Brown 
4204061576a5SJed Brown   This gets a borrowed reference, so the user should not destroy this PetscSection.
4205061576a5SJed Brown 
4206061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
4207061576a5SJed Brown @*/
4208061576a5SJed Brown PetscErrorCode DMGetSection(DM dm, PetscSection *section)
4209061576a5SJed Brown {
4210061576a5SJed Brown   PetscFunctionBegin;
42119566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(dm,section));
4212061576a5SJed Brown   PetscFunctionReturn(0);
4213061576a5SJed Brown }
4214061576a5SJed Brown 
4215061576a5SJed Brown /*@
4216061576a5SJed Brown   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
421788ed4aceSMatthew G Knepley 
421888ed4aceSMatthew G Knepley   Input Parameter:
421988ed4aceSMatthew G Knepley . dm - The DM
422088ed4aceSMatthew G Knepley 
422188ed4aceSMatthew G Knepley   Output Parameter:
422288ed4aceSMatthew G Knepley . section - The PetscSection
422388ed4aceSMatthew G Knepley 
4224e5893cccSMatthew G. Knepley   Options Database Keys:
4225e5893cccSMatthew G. Knepley . -dm_petscsection_view - View the Section created by the DM
4226e5893cccSMatthew G. Knepley 
422788ed4aceSMatthew G Knepley   Level: intermediate
422888ed4aceSMatthew G Knepley 
422988ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
423088ed4aceSMatthew G Knepley 
4231061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetGlobalSection()
423288ed4aceSMatthew G Knepley @*/
4233061576a5SJed Brown PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
42340adebc6cSBarry Smith {
423588ed4aceSMatthew G Knepley   PetscFunctionBegin;
423688ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
423788ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
42381bb6d2a8SBarry Smith   if (!dm->localSection && dm->ops->createlocalsection) {
4239e5e52638SMatthew G. Knepley     PetscInt d;
4240e5e52638SMatthew G. Knepley 
424145480ffeSMatthew G. Knepley     if (dm->setfromoptionscalled) {
424245480ffeSMatthew G. Knepley       PetscObject       obj = (PetscObject) dm;
424345480ffeSMatthew G. Knepley       PetscViewer       viewer;
424445480ffeSMatthew G. Knepley       PetscViewerFormat format;
424545480ffeSMatthew G. Knepley       PetscBool         flg;
424645480ffeSMatthew G. Knepley 
42479566063dSJacob Faibussowitsch       PetscCall(PetscOptionsGetViewer(PetscObjectComm(obj), obj->options, obj->prefix, "-dm_petscds_view", &viewer, &format, &flg));
42489566063dSJacob Faibussowitsch       if (flg) PetscCall(PetscViewerPushFormat(viewer, format));
424945480ffeSMatthew G. Knepley       for (d = 0; d < dm->Nds; ++d) {
42509566063dSJacob Faibussowitsch         PetscCall(PetscDSSetFromOptions(dm->probs[d].ds));
42519566063dSJacob Faibussowitsch         if (flg) PetscCall(PetscDSView(dm->probs[d].ds, viewer));
425245480ffeSMatthew G. Knepley       }
425345480ffeSMatthew G. Knepley       if (flg) {
42549566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
42559566063dSJacob Faibussowitsch         PetscCall(PetscViewerPopFormat(viewer));
42569566063dSJacob Faibussowitsch         PetscCall(PetscViewerDestroy(&viewer));
425745480ffeSMatthew G. Knepley       }
425845480ffeSMatthew G. Knepley     }
42599566063dSJacob Faibussowitsch     PetscCall((*dm->ops->createlocalsection)(dm));
42609566063dSJacob Faibussowitsch     if (dm->localSection) PetscCall(PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view"));
42612f0f8703SMatthew G. Knepley   }
42621bb6d2a8SBarry Smith   *section = dm->localSection;
426388ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
426488ed4aceSMatthew G Knepley }
426588ed4aceSMatthew G Knepley 
426688ed4aceSMatthew G Knepley /*@
42671bb6d2a8SBarry Smith   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4268061576a5SJed Brown 
4269061576a5SJed Brown   Input Parameters:
4270061576a5SJed Brown + dm - The DM
4271061576a5SJed Brown - section - The PetscSection
4272061576a5SJed Brown 
4273061576a5SJed Brown   Level: advanced
4274061576a5SJed Brown 
4275061576a5SJed Brown   Notes:
4276061576a5SJed Brown   Use DMSetLocalSection() in new code.
4277061576a5SJed Brown 
4278061576a5SJed Brown   Any existing Section will be destroyed
4279061576a5SJed Brown 
4280061576a5SJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4281061576a5SJed Brown @*/
4282061576a5SJed Brown PetscErrorCode DMSetSection(DM dm, PetscSection section)
4283061576a5SJed Brown {
4284061576a5SJed Brown   PetscFunctionBegin;
42859566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(dm,section));
4286061576a5SJed Brown   PetscFunctionReturn(0);
4287061576a5SJed Brown }
4288061576a5SJed Brown 
4289061576a5SJed Brown /*@
4290061576a5SJed Brown   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
429188ed4aceSMatthew G Knepley 
429288ed4aceSMatthew G Knepley   Input Parameters:
429388ed4aceSMatthew G Knepley + dm - The DM
429488ed4aceSMatthew G Knepley - section - The PetscSection
429588ed4aceSMatthew G Knepley 
429688ed4aceSMatthew G Knepley   Level: intermediate
429788ed4aceSMatthew G Knepley 
429888ed4aceSMatthew G Knepley   Note: Any existing Section will be destroyed
429988ed4aceSMatthew G Knepley 
4300061576a5SJed Brown .seealso: DMGetLocalSection(), DMSetGlobalSection()
430188ed4aceSMatthew G Knepley @*/
4302061576a5SJed Brown PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
43030adebc6cSBarry Smith {
4304c473ab19SMatthew G. Knepley   PetscInt       numFields = 0;
4305af122d2aSMatthew G Knepley   PetscInt       f;
430688ed4aceSMatthew G Knepley 
430788ed4aceSMatthew G Knepley   PetscFunctionBegin;
430888ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4309b9d85ea2SLisandro Dalcin   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
43109566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)section));
43119566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&dm->localSection));
43121bb6d2a8SBarry Smith   dm->localSection = section;
43139566063dSJacob Faibussowitsch   if (section) PetscCall(PetscSectionGetNumFields(dm->localSection, &numFields));
4314af122d2aSMatthew G Knepley   if (numFields) {
43159566063dSJacob Faibussowitsch     PetscCall(DMSetNumFields(dm, numFields));
4316af122d2aSMatthew G Knepley     for (f = 0; f < numFields; ++f) {
43170f21e855SMatthew G. Knepley       PetscObject disc;
4318af122d2aSMatthew G Knepley       const char *name;
4319af122d2aSMatthew G Knepley 
43209566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetFieldName(dm->localSection, f, &name));
43219566063dSJacob Faibussowitsch       PetscCall(DMGetField(dm, f, NULL, &disc));
43229566063dSJacob Faibussowitsch       PetscCall(PetscObjectSetName(disc, name));
4323af122d2aSMatthew G Knepley     }
4324af122d2aSMatthew G Knepley   }
4325e87a4003SBarry Smith   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
43269566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&dm->globalSection));
432788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
432888ed4aceSMatthew G Knepley }
432988ed4aceSMatthew G Knepley 
43309435951eSToby Isaac /*@
4331b7385021SStefano Zampini   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
43329435951eSToby Isaac 
4333e228b242SToby Isaac   not collective
4334e228b242SToby Isaac 
43359435951eSToby Isaac   Input Parameter:
43369435951eSToby Isaac . dm - The DM
43379435951eSToby Isaac 
4338d8d19677SJose E. Roman   Output Parameters:
43399435951eSToby 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.
434079769bd5SJed 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.
434179769bd5SJed Brown - bias - Vector containing bias to be added to constrained dofs
43429435951eSToby Isaac 
43439435951eSToby Isaac   Level: advanced
43449435951eSToby Isaac 
434579769bd5SJed Brown   Note: This gets borrowed references, so the user should not destroy the PetscSection, Mat, or Vec.
43469435951eSToby Isaac 
43479435951eSToby Isaac .seealso: DMSetDefaultConstraints()
43489435951eSToby Isaac @*/
434979769bd5SJed Brown PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat, Vec *bias)
43509435951eSToby Isaac {
43519435951eSToby Isaac   PetscFunctionBegin;
43529435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
43539566063dSJacob Faibussowitsch   if (!dm->defaultConstraint.section && !dm->defaultConstraint.mat && dm->ops->createdefaultconstraints) PetscCall((*dm->ops->createdefaultconstraints)(dm));
43543b8ba7d1SJed Brown   if (section) *section = dm->defaultConstraint.section;
43553b8ba7d1SJed Brown   if (mat) *mat = dm->defaultConstraint.mat;
435679769bd5SJed Brown   if (bias) *bias = dm->defaultConstraint.bias;
43579435951eSToby Isaac   PetscFunctionReturn(0);
43589435951eSToby Isaac }
43599435951eSToby Isaac 
43609435951eSToby Isaac /*@
4361b7385021SStefano Zampini   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
43629435951eSToby Isaac 
436379769bd5SJed 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().
43649435951eSToby Isaac 
436579769bd5SJed 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.
43669435951eSToby Isaac 
4367e228b242SToby Isaac   collective on dm
4368e228b242SToby Isaac 
43699435951eSToby Isaac   Input Parameters:
43709435951eSToby Isaac + dm - The DM
437179769bd5SJed 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).
437279769bd5SJed 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).
437379769bd5SJed 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).
43749435951eSToby Isaac 
43759435951eSToby Isaac   Level: advanced
43769435951eSToby Isaac 
437779769bd5SJed Brown   Note: This increments the references of the PetscSection, Mat, and Vec, so they user can destroy them.
43789435951eSToby Isaac 
43799435951eSToby Isaac .seealso: DMGetDefaultConstraints()
43809435951eSToby Isaac @*/
438179769bd5SJed Brown PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat, Vec bias)
43829435951eSToby Isaac {
4383e228b242SToby Isaac   PetscMPIInt result;
43849435951eSToby Isaac 
43859435951eSToby Isaac   PetscFunctionBegin;
43869435951eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4387e228b242SToby Isaac   if (section) {
4388e228b242SToby Isaac     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
43899566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result));
43907a8be351SBarry Smith     PetscCheck(result == MPI_CONGRUENT || result == MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4391e228b242SToby Isaac   }
4392e228b242SToby Isaac   if (mat) {
4393e228b242SToby Isaac     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
43949566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result));
43957a8be351SBarry Smith     PetscCheck(result == MPI_CONGRUENT || result == MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4396e228b242SToby Isaac   }
439779769bd5SJed Brown   if (bias) {
439879769bd5SJed Brown     PetscValidHeaderSpecific(bias,VEC_CLASSID,4);
43999566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)bias),&result));
440079769bd5SJed Brown     PetscCheck(result == MPI_CONGRUENT || result == MPI_IDENT,PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint bias must have local communicator");
440179769bd5SJed Brown   }
44029566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)section));
44039566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&dm->defaultConstraint.section));
44043b8ba7d1SJed Brown   dm->defaultConstraint.section = section;
44059566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)mat));
44069566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&dm->defaultConstraint.mat));
44073b8ba7d1SJed Brown   dm->defaultConstraint.mat = mat;
44089566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)bias));
44099566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&dm->defaultConstraint.bias));
441079769bd5SJed Brown   dm->defaultConstraint.bias = bias;
44119435951eSToby Isaac   PetscFunctionReturn(0);
44129435951eSToby Isaac }
44139435951eSToby Isaac 
4414497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
4415507e4973SMatthew G. Knepley /*
4416507e4973SMatthew G. Knepley   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4417507e4973SMatthew G. Knepley 
4418507e4973SMatthew G. Knepley   Input Parameters:
4419507e4973SMatthew G. Knepley + dm - The DM
4420507e4973SMatthew G. Knepley . localSection - PetscSection describing the local data layout
4421507e4973SMatthew G. Knepley - globalSection - PetscSection describing the global data layout
4422507e4973SMatthew G. Knepley 
4423507e4973SMatthew G. Knepley   Level: intermediate
4424507e4973SMatthew G. Knepley 
44251bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF()
4426507e4973SMatthew G. Knepley */
4427f741bcd2SMatthew G. Knepley static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4428507e4973SMatthew G. Knepley {
4429507e4973SMatthew G. Knepley   MPI_Comm        comm;
4430507e4973SMatthew G. Knepley   PetscLayout     layout;
4431507e4973SMatthew G. Knepley   const PetscInt *ranges;
4432507e4973SMatthew G. Knepley   PetscInt        pStart, pEnd, p, nroots;
4433507e4973SMatthew G. Knepley   PetscMPIInt     size, rank;
4434507e4973SMatthew G. Knepley   PetscBool       valid = PETSC_TRUE, gvalid;
4435507e4973SMatthew G. Knepley 
4436507e4973SMatthew G. Knepley   PetscFunctionBegin;
44379566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm,&comm));
4438507e4973SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
44399566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
44409566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
44419566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(globalSection, &pStart, &pEnd));
44429566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetConstrainedStorageSize(globalSection, &nroots));
44439566063dSJacob Faibussowitsch   PetscCall(PetscLayoutCreate(comm, &layout));
44449566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetBlockSize(layout, 1));
44459566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetLocalSize(layout, nroots));
44469566063dSJacob Faibussowitsch   PetscCall(PetscLayoutSetUp(layout));
44479566063dSJacob Faibussowitsch   PetscCall(PetscLayoutGetRanges(layout, &ranges));
4448507e4973SMatthew G. Knepley   for (p = pStart; p < pEnd; ++p) {
4449f741bcd2SMatthew G. Knepley     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4450507e4973SMatthew G. Knepley 
44519566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(localSection, p, &dof));
44529566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(localSection, p, &off));
44539566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(localSection, p, &cdof));
44549566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(globalSection, p, &gdof));
44559566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetConstraintDof(globalSection, p, &gcdof));
44569566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(globalSection, p, &goff));
4457507e4973SMatthew G. Knepley     if (!gdof) continue; /* Censored point */
44589566063dSJacob Faibussowitsch     if ((gdof < 0 ? -(gdof+1) : gdof) != dof) {PetscCall(PetscSynchronizedPrintf(comm, "[%d]Global dof %d for point %d not equal to local dof %d\n", rank, gdof, p, dof)); valid = PETSC_FALSE;}
44599566063dSJacob Faibussowitsch     if (gcdof && (gcdof != cdof)) {PetscCall(PetscSynchronizedPrintf(comm, "[%d]Global constraints %d for point %d not equal to local constraints %d\n", rank, gcdof, p, cdof)); valid = PETSC_FALSE;}
4460507e4973SMatthew G. Knepley     if (gdof < 0) {
4461507e4973SMatthew G. Knepley       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4462507e4973SMatthew G. Knepley       for (d = 0; d < gsize; ++d) {
4463507e4973SMatthew G. Knepley         PetscInt offset = -(goff+1) + d, r;
4464507e4973SMatthew G. Knepley 
44659566063dSJacob Faibussowitsch         PetscCall(PetscFindInt(offset,size+1,ranges,&r));
4466507e4973SMatthew G. Knepley         if (r < 0) r = -(r+2);
44679566063dSJacob Faibussowitsch         if ((r < 0) || (r >= size)) {PetscCall(PetscSynchronizedPrintf(comm, "[%d]Point %d mapped to invalid process %d (%d, %d)\n", rank, p, r, gdof, goff)); valid = PETSC_FALSE;break;}
4468507e4973SMatthew G. Knepley       }
4469507e4973SMatthew G. Knepley     }
4470507e4973SMatthew G. Knepley   }
44719566063dSJacob Faibussowitsch   PetscCall(PetscLayoutDestroy(&layout));
44729566063dSJacob Faibussowitsch   PetscCall(PetscSynchronizedFlush(comm, NULL));
44731c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm));
4474507e4973SMatthew G. Knepley   if (!gvalid) {
44759566063dSJacob Faibussowitsch     PetscCall(DMView(dm, NULL));
4476507e4973SMatthew G. Knepley     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4477507e4973SMatthew G. Knepley   }
4478507e4973SMatthew G. Knepley   PetscFunctionReturn(0);
4479507e4973SMatthew G. Knepley }
4480f741bcd2SMatthew G. Knepley #endif
4481507e4973SMatthew G. Knepley 
448288ed4aceSMatthew G Knepley /*@
4483e87a4003SBarry Smith   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
448488ed4aceSMatthew G Knepley 
4485d083f849SBarry Smith   Collective on dm
44868b1ab98fSJed Brown 
448788ed4aceSMatthew G Knepley   Input Parameter:
448888ed4aceSMatthew G Knepley . dm - The DM
448988ed4aceSMatthew G Knepley 
449088ed4aceSMatthew G Knepley   Output Parameter:
449188ed4aceSMatthew G Knepley . section - The PetscSection
449288ed4aceSMatthew G Knepley 
449388ed4aceSMatthew G Knepley   Level: intermediate
449488ed4aceSMatthew G Knepley 
449588ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
449688ed4aceSMatthew G Knepley 
449792fd8e1eSJed Brown .seealso: DMSetLocalSection(), DMGetLocalSection()
449888ed4aceSMatthew G Knepley @*/
4499e87a4003SBarry Smith PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
45000adebc6cSBarry Smith {
450188ed4aceSMatthew G Knepley   PetscFunctionBegin;
450288ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
450388ed4aceSMatthew G Knepley   PetscValidPointer(section, 2);
45041bb6d2a8SBarry Smith   if (!dm->globalSection) {
4505fd59a867SMatthew G. Knepley     PetscSection s;
4506fd59a867SMatthew G. Knepley 
45079566063dSJacob Faibussowitsch     PetscCall(DMGetLocalSection(dm, &s));
45087a8be351SBarry Smith     PetscCheck(s,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection");
45097a8be351SBarry Smith     PetscCheck(dm->sf,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection");
45109566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection));
45119566063dSJacob Faibussowitsch     PetscCall(PetscLayoutDestroy(&dm->map));
45129566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map));
45139566063dSJacob Faibussowitsch     PetscCall(PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view"));
451488ed4aceSMatthew G Knepley   }
45151bb6d2a8SBarry Smith   *section = dm->globalSection;
451688ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
451788ed4aceSMatthew G Knepley }
451888ed4aceSMatthew G Knepley 
4519b21d0597SMatthew G Knepley /*@
4520e87a4003SBarry Smith   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4521b21d0597SMatthew G Knepley 
4522b21d0597SMatthew G Knepley   Input Parameters:
4523b21d0597SMatthew G Knepley + dm - The DM
45245080bbdbSMatthew G Knepley - section - The PetscSection, or NULL
4525b21d0597SMatthew G Knepley 
4526b21d0597SMatthew G Knepley   Level: intermediate
4527b21d0597SMatthew G Knepley 
4528b21d0597SMatthew G Knepley   Note: Any existing Section will be destroyed
4529b21d0597SMatthew G Knepley 
453092fd8e1eSJed Brown .seealso: DMGetGlobalSection(), DMSetLocalSection()
4531b21d0597SMatthew G Knepley @*/
4532e87a4003SBarry Smith PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
45330adebc6cSBarry Smith {
4534b21d0597SMatthew G Knepley   PetscFunctionBegin;
4535b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
45365080bbdbSMatthew G Knepley   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
45379566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)section));
45389566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&dm->globalSection));
45391bb6d2a8SBarry Smith   dm->globalSection = section;
4540497880caSRichard Tran Mills #if defined(PETSC_USE_DEBUG)
45419566063dSJacob Faibussowitsch   if (section) PetscCall(DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section));
4542507e4973SMatthew G. Knepley #endif
4543b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4544b21d0597SMatthew G Knepley }
4545b21d0597SMatthew G Knepley 
454688ed4aceSMatthew G Knepley /*@
45471bb6d2a8SBarry Smith   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
454888ed4aceSMatthew G Knepley   it is created from the default PetscSection layouts in the DM.
454988ed4aceSMatthew G Knepley 
455088ed4aceSMatthew G Knepley   Input Parameter:
455188ed4aceSMatthew G Knepley . dm - The DM
455288ed4aceSMatthew G Knepley 
455388ed4aceSMatthew G Knepley   Output Parameter:
455488ed4aceSMatthew G Knepley . sf - The PetscSF
455588ed4aceSMatthew G Knepley 
455688ed4aceSMatthew G Knepley   Level: intermediate
455788ed4aceSMatthew G Knepley 
455888ed4aceSMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
455988ed4aceSMatthew G Knepley 
45601bb6d2a8SBarry Smith .seealso: DMSetSectionSF(), DMCreateSectionSF()
456188ed4aceSMatthew G Knepley @*/
45621bb6d2a8SBarry Smith PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
45630adebc6cSBarry Smith {
456488ed4aceSMatthew G Knepley   PetscInt       nroots;
456588ed4aceSMatthew G Knepley 
456688ed4aceSMatthew G Knepley   PetscFunctionBegin;
456788ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
456888ed4aceSMatthew G Knepley   PetscValidPointer(sf, 2);
45691bb6d2a8SBarry Smith   if (!dm->sectionSF) {
45709566063dSJacob Faibussowitsch     PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF));
457133907cc2SStefano Zampini   }
45729566063dSJacob Faibussowitsch   PetscCall(PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL));
457388ed4aceSMatthew G Knepley   if (nroots < 0) {
457488ed4aceSMatthew G Knepley     PetscSection section, gSection;
457588ed4aceSMatthew G Knepley 
45769566063dSJacob Faibussowitsch     PetscCall(DMGetLocalSection(dm, &section));
457731ea6d37SMatthew G Knepley     if (section) {
45789566063dSJacob Faibussowitsch       PetscCall(DMGetGlobalSection(dm, &gSection));
45799566063dSJacob Faibussowitsch       PetscCall(DMCreateSectionSF(dm, section, gSection));
458031ea6d37SMatthew G Knepley     } else {
45810298fd71SBarry Smith       *sf = NULL;
458231ea6d37SMatthew G Knepley       PetscFunctionReturn(0);
458331ea6d37SMatthew G Knepley     }
458488ed4aceSMatthew G Knepley   }
45851bb6d2a8SBarry Smith   *sf = dm->sectionSF;
458688ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
458788ed4aceSMatthew G Knepley }
458888ed4aceSMatthew G Knepley 
458988ed4aceSMatthew G Knepley /*@
45901bb6d2a8SBarry Smith   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
459188ed4aceSMatthew G Knepley 
459288ed4aceSMatthew G Knepley   Input Parameters:
459388ed4aceSMatthew G Knepley + dm - The DM
459488ed4aceSMatthew G Knepley - sf - The PetscSF
459588ed4aceSMatthew G Knepley 
459688ed4aceSMatthew G Knepley   Level: intermediate
459788ed4aceSMatthew G Knepley 
459888ed4aceSMatthew G Knepley   Note: Any previous SF is destroyed
459988ed4aceSMatthew G Knepley 
46001bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMCreateSectionSF()
460188ed4aceSMatthew G Knepley @*/
46021bb6d2a8SBarry Smith PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
46030adebc6cSBarry Smith {
460488ed4aceSMatthew G Knepley   PetscFunctionBegin;
460588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4606b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
46079566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) sf));
46089566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&dm->sectionSF));
46091bb6d2a8SBarry Smith   dm->sectionSF = sf;
461088ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
461188ed4aceSMatthew G Knepley }
461288ed4aceSMatthew G Knepley 
461388ed4aceSMatthew G Knepley /*@C
46141bb6d2a8SBarry Smith   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
461588ed4aceSMatthew G Knepley   describing the data layout.
461688ed4aceSMatthew G Knepley 
461788ed4aceSMatthew G Knepley   Input Parameters:
461888ed4aceSMatthew G Knepley + dm - The DM
461988ed4aceSMatthew G Knepley . localSection - PetscSection describing the local data layout
462088ed4aceSMatthew G Knepley - globalSection - PetscSection describing the global data layout
462188ed4aceSMatthew G Knepley 
46221bb6d2a8SBarry Smith   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
462388ed4aceSMatthew G Knepley 
46241bb6d2a8SBarry Smith   Level: developer
46251bb6d2a8SBarry Smith 
46261bb6d2a8SBarry Smith   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
46271bb6d2a8SBarry Smith                   directly into the DM, perhaps this function should not take the local and global sections as
46281bb6d2a8SBarry Smith                   input and should just obtain them from the DM?
46291bb6d2a8SBarry Smith 
46301bb6d2a8SBarry Smith .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
463188ed4aceSMatthew G Knepley @*/
46321bb6d2a8SBarry Smith PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
463388ed4aceSMatthew G Knepley {
463488ed4aceSMatthew G Knepley   PetscFunctionBegin;
463588ed4aceSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
46369566063dSJacob Faibussowitsch   PetscCall(PetscSFSetGraphSection(dm->sectionSF, localSection, globalSection));
463788ed4aceSMatthew G Knepley   PetscFunctionReturn(0);
463888ed4aceSMatthew G Knepley }
4639af122d2aSMatthew G Knepley 
4640b21d0597SMatthew G Knepley /*@
4641b21d0597SMatthew G Knepley   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4642b21d0597SMatthew G Knepley 
4643b21d0597SMatthew G Knepley   Input Parameter:
4644b21d0597SMatthew G Knepley . dm - The DM
4645b21d0597SMatthew G Knepley 
4646b21d0597SMatthew G Knepley   Output Parameter:
4647b21d0597SMatthew G Knepley . sf - The PetscSF
4648b21d0597SMatthew G Knepley 
4649b21d0597SMatthew G Knepley   Level: intermediate
4650b21d0597SMatthew G Knepley 
4651b21d0597SMatthew G Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4652b21d0597SMatthew G Knepley 
46531bb6d2a8SBarry Smith .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4654b21d0597SMatthew G Knepley @*/
46550adebc6cSBarry Smith PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
46560adebc6cSBarry Smith {
4657b21d0597SMatthew G Knepley   PetscFunctionBegin;
4658b21d0597SMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4659b21d0597SMatthew G Knepley   PetscValidPointer(sf, 2);
4660b21d0597SMatthew G Knepley   *sf = dm->sf;
4661b21d0597SMatthew G Knepley   PetscFunctionReturn(0);
4662b21d0597SMatthew G Knepley }
4663b21d0597SMatthew G Knepley 
4664057b4bcdSMatthew G Knepley /*@
4665057b4bcdSMatthew G Knepley   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4666057b4bcdSMatthew G Knepley 
4667057b4bcdSMatthew G Knepley   Input Parameters:
4668057b4bcdSMatthew G Knepley + dm - The DM
4669057b4bcdSMatthew G Knepley - sf - The PetscSF
4670057b4bcdSMatthew G Knepley 
4671057b4bcdSMatthew G Knepley   Level: intermediate
4672057b4bcdSMatthew G Knepley 
46731bb6d2a8SBarry Smith .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4674057b4bcdSMatthew G Knepley @*/
46750adebc6cSBarry Smith PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
46760adebc6cSBarry Smith {
4677057b4bcdSMatthew G Knepley   PetscFunctionBegin;
4678057b4bcdSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4679b9d85ea2SLisandro Dalcin   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
46809566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) sf));
46819566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&dm->sf));
4682057b4bcdSMatthew G Knepley   dm->sf = sf;
4683057b4bcdSMatthew G Knepley   PetscFunctionReturn(0);
4684057b4bcdSMatthew G Knepley }
4685057b4bcdSMatthew G Knepley 
46864f37162bSMatthew G. Knepley /*@
46874f37162bSMatthew G. Knepley   DMGetNaturalSF - Get the PetscSF encoding the map back to the original mesh ordering
46884f37162bSMatthew G. Knepley 
46894f37162bSMatthew G. Knepley   Input Parameter:
46904f37162bSMatthew G. Knepley . dm - The DM
46914f37162bSMatthew G. Knepley 
46924f37162bSMatthew G. Knepley   Output Parameter:
46934f37162bSMatthew G. Knepley . sf - The PetscSF
46944f37162bSMatthew G. Knepley 
46954f37162bSMatthew G. Knepley   Level: intermediate
46964f37162bSMatthew G. Knepley 
46974f37162bSMatthew G. Knepley   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
46984f37162bSMatthew G. Knepley 
46994f37162bSMatthew G. Knepley .seealso: DMSetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
47004f37162bSMatthew G. Knepley @*/
47014f37162bSMatthew G. Knepley PetscErrorCode DMGetNaturalSF(DM dm, PetscSF *sf)
47024f37162bSMatthew G. Knepley {
47034f37162bSMatthew G. Knepley   PetscFunctionBegin;
47044f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
47054f37162bSMatthew G. Knepley   PetscValidPointer(sf, 2);
47064f37162bSMatthew G. Knepley   *sf = dm->sfNatural;
47074f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
47084f37162bSMatthew G. Knepley }
47094f37162bSMatthew G. Knepley 
47104f37162bSMatthew G. Knepley /*@
47114f37162bSMatthew G. Knepley   DMSetNaturalSF - Set the PetscSF encoding the map back to the original mesh ordering
47124f37162bSMatthew G. Knepley 
47134f37162bSMatthew G. Knepley   Input Parameters:
47144f37162bSMatthew G. Knepley + dm - The DM
47154f37162bSMatthew G. Knepley - sf - The PetscSF
47164f37162bSMatthew G. Knepley 
47174f37162bSMatthew G. Knepley   Level: intermediate
47184f37162bSMatthew G. Knepley 
47194f37162bSMatthew G. Knepley .seealso: DMGetNaturalSF(), DMSetUseNatural(), DMGetUseNatural(), DMPlexCreateGlobalToNaturalSF(), DMPlexDistribute()
47204f37162bSMatthew G. Knepley @*/
47214f37162bSMatthew G. Knepley PetscErrorCode DMSetNaturalSF(DM dm, PetscSF sf)
47224f37162bSMatthew G. Knepley {
47234f37162bSMatthew G. Knepley   PetscFunctionBegin;
47244f37162bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
47254f37162bSMatthew G. Knepley   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
47269566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) sf));
47279566063dSJacob Faibussowitsch   PetscCall(PetscSFDestroy(&dm->sfNatural));
47284f37162bSMatthew G. Knepley   dm->sfNatural = sf;
47294f37162bSMatthew G. Knepley   PetscFunctionReturn(0);
47304f37162bSMatthew G. Knepley }
47314f37162bSMatthew G. Knepley 
473234aa8a36SMatthew G. Knepley static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
473334aa8a36SMatthew G. Knepley {
473434aa8a36SMatthew G. Knepley   PetscClassId   id;
473534aa8a36SMatthew G. Knepley 
473634aa8a36SMatthew G. Knepley   PetscFunctionBegin;
47379566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetClassId(disc, &id));
473834aa8a36SMatthew G. Knepley   if (id == PETSCFE_CLASSID) {
47399566063dSJacob Faibussowitsch     PetscCall(DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE));
474034aa8a36SMatthew G. Knepley   } else if (id == PETSCFV_CLASSID) {
47419566063dSJacob Faibussowitsch     PetscCall(DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE));
474217c1d62eSMatthew G. Knepley   } else {
47439566063dSJacob Faibussowitsch     PetscCall(DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE));
474434aa8a36SMatthew G. Knepley   }
474534aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
474634aa8a36SMatthew G. Knepley }
474734aa8a36SMatthew G. Knepley 
474844a7f3ddSMatthew G. Knepley static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
474944a7f3ddSMatthew G. Knepley {
475044a7f3ddSMatthew G. Knepley   RegionField   *tmpr;
475144a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf, f;
475244a7f3ddSMatthew G. Knepley 
475344a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
475444a7f3ddSMatthew G. Knepley   if (Nf >= NfNew) PetscFunctionReturn(0);
47559566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(NfNew, &tmpr));
475644a7f3ddSMatthew G. Knepley   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4757e0b68406SMatthew Knepley   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL; tmpr[f].avoidTensor = PETSC_FALSE;}
47589566063dSJacob Faibussowitsch   PetscCall(PetscFree(dm->fields));
475944a7f3ddSMatthew G. Knepley   dm->Nf     = NfNew;
476044a7f3ddSMatthew G. Knepley   dm->fields = tmpr;
476144a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
476244a7f3ddSMatthew G. Knepley }
476344a7f3ddSMatthew G. Knepley 
476444a7f3ddSMatthew G. Knepley /*@
476544a7f3ddSMatthew G. Knepley   DMClearFields - Remove all fields from the DM
476644a7f3ddSMatthew G. Knepley 
4767d083f849SBarry Smith   Logically collective on dm
476844a7f3ddSMatthew G. Knepley 
476944a7f3ddSMatthew G. Knepley   Input Parameter:
477044a7f3ddSMatthew G. Knepley . dm - The DM
477144a7f3ddSMatthew G. Knepley 
477244a7f3ddSMatthew G. Knepley   Level: intermediate
477344a7f3ddSMatthew G. Knepley 
477444a7f3ddSMatthew G. Knepley .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
477544a7f3ddSMatthew G. Knepley @*/
477644a7f3ddSMatthew G. Knepley PetscErrorCode DMClearFields(DM dm)
477744a7f3ddSMatthew G. Knepley {
477844a7f3ddSMatthew G. Knepley   PetscInt       f;
477944a7f3ddSMatthew G. Knepley 
478044a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
478144a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
478244a7f3ddSMatthew G. Knepley   for (f = 0; f < dm->Nf; ++f) {
47839566063dSJacob Faibussowitsch     PetscCall(PetscObjectDestroy(&dm->fields[f].disc));
47849566063dSJacob Faibussowitsch     PetscCall(DMLabelDestroy(&dm->fields[f].label));
478544a7f3ddSMatthew G. Knepley   }
47869566063dSJacob Faibussowitsch   PetscCall(PetscFree(dm->fields));
478744a7f3ddSMatthew G. Knepley   dm->fields = NULL;
478844a7f3ddSMatthew G. Knepley   dm->Nf     = 0;
478944a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
479044a7f3ddSMatthew G. Knepley }
479144a7f3ddSMatthew G. Knepley 
4792689b5837SMatthew G. Knepley /*@
4793689b5837SMatthew G. Knepley   DMGetNumFields - Get the number of fields in the DM
4794689b5837SMatthew G. Knepley 
4795689b5837SMatthew G. Knepley   Not collective
4796689b5837SMatthew G. Knepley 
4797689b5837SMatthew G. Knepley   Input Parameter:
4798689b5837SMatthew G. Knepley . dm - The DM
4799689b5837SMatthew G. Knepley 
4800689b5837SMatthew G. Knepley   Output Parameter:
4801689b5837SMatthew G. Knepley . Nf - The number of fields
4802689b5837SMatthew G. Knepley 
4803689b5837SMatthew G. Knepley   Level: intermediate
4804689b5837SMatthew G. Knepley 
4805689b5837SMatthew G. Knepley .seealso: DMSetNumFields(), DMSetField()
4806689b5837SMatthew G. Knepley @*/
48070f21e855SMatthew G. Knepley PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
48080f21e855SMatthew G. Knepley {
48090f21e855SMatthew G. Knepley   PetscFunctionBegin;
48100f21e855SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4811534a8f05SLisandro Dalcin   PetscValidIntPointer(numFields, 2);
481244a7f3ddSMatthew G. Knepley   *numFields = dm->Nf;
4813af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4814af122d2aSMatthew G Knepley }
4815af122d2aSMatthew G Knepley 
4816689b5837SMatthew G. Knepley /*@
4817689b5837SMatthew G. Knepley   DMSetNumFields - Set the number of fields in the DM
4818689b5837SMatthew G. Knepley 
4819d083f849SBarry Smith   Logically collective on dm
4820689b5837SMatthew G. Knepley 
4821689b5837SMatthew G. Knepley   Input Parameters:
4822689b5837SMatthew G. Knepley + dm - The DM
4823689b5837SMatthew G. Knepley - Nf - The number of fields
4824689b5837SMatthew G. Knepley 
4825689b5837SMatthew G. Knepley   Level: intermediate
4826689b5837SMatthew G. Knepley 
4827689b5837SMatthew G. Knepley .seealso: DMGetNumFields(), DMSetField()
4828689b5837SMatthew G. Knepley @*/
4829af122d2aSMatthew G Knepley PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4830af122d2aSMatthew G Knepley {
48310f21e855SMatthew G. Knepley   PetscInt       Nf, f;
4832af122d2aSMatthew G Knepley 
4833af122d2aSMatthew G Knepley   PetscFunctionBegin;
4834af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
48359566063dSJacob Faibussowitsch   PetscCall(DMGetNumFields(dm, &Nf));
48360f21e855SMatthew G. Knepley   for (f = Nf; f < numFields; ++f) {
48370f21e855SMatthew G. Knepley     PetscContainer obj;
48380f21e855SMatthew G. Knepley 
48399566063dSJacob Faibussowitsch     PetscCall(PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj));
48409566063dSJacob Faibussowitsch     PetscCall(DMAddField(dm, NULL, (PetscObject) obj));
48419566063dSJacob Faibussowitsch     PetscCall(PetscContainerDestroy(&obj));
4842af122d2aSMatthew G Knepley   }
4843af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4844af122d2aSMatthew G Knepley }
4845af122d2aSMatthew G Knepley 
4846c1929be8SMatthew G. Knepley /*@
4847c1929be8SMatthew G. Knepley   DMGetField - Return the discretization object for a given DM field
4848c1929be8SMatthew G. Knepley 
4849c1929be8SMatthew G. Knepley   Not collective
4850c1929be8SMatthew G. Knepley 
4851c1929be8SMatthew G. Knepley   Input Parameters:
4852c1929be8SMatthew G. Knepley + dm - The DM
4853c1929be8SMatthew G. Knepley - f  - The field number
4854c1929be8SMatthew G. Knepley 
485544a7f3ddSMatthew G. Knepley   Output Parameters:
485644a7f3ddSMatthew G. Knepley + label - The label indicating the support of the field, or NULL for the entire mesh
485744a7f3ddSMatthew G. Knepley - field - The discretization object
4858c1929be8SMatthew G. Knepley 
485944a7f3ddSMatthew G. Knepley   Level: intermediate
4860c1929be8SMatthew G. Knepley 
486144a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMSetField()
4862c1929be8SMatthew G. Knepley @*/
486344a7f3ddSMatthew G. Knepley PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4864af122d2aSMatthew G Knepley {
4865af122d2aSMatthew G Knepley   PetscFunctionBegin;
4866af122d2aSMatthew G Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4867064a246eSJacob Faibussowitsch   PetscValidPointer(field, 4);
48687a8be351SBarry Smith   PetscCheck((f >= 0) && (f < dm->Nf),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, dm->Nf);
486944a7f3ddSMatthew G. Knepley   if (label) *label = dm->fields[f].label;
487044a7f3ddSMatthew G. Knepley   if (field) *field = dm->fields[f].disc;
4871decb47aaSMatthew G. Knepley   PetscFunctionReturn(0);
4872decb47aaSMatthew G. Knepley }
4873decb47aaSMatthew G. Knepley 
4874083401c6SMatthew G. Knepley /* Does not clear the DS */
4875083401c6SMatthew G. Knepley PetscErrorCode DMSetField_Internal(DM dm, PetscInt f, DMLabel label, PetscObject field)
4876083401c6SMatthew G. Knepley {
4877083401c6SMatthew G. Knepley   PetscFunctionBegin;
48789566063dSJacob Faibussowitsch   PetscCall(DMFieldEnlarge_Static(dm, f+1));
48799566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroy(&dm->fields[f].label));
48809566063dSJacob Faibussowitsch   PetscCall(PetscObjectDestroy(&dm->fields[f].disc));
4881083401c6SMatthew G. Knepley   dm->fields[f].label = label;
4882083401c6SMatthew G. Knepley   dm->fields[f].disc  = field;
48839566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) label));
48849566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) field));
4885083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
4886083401c6SMatthew G. Knepley }
4887083401c6SMatthew G. Knepley 
4888c1929be8SMatthew G. Knepley /*@
4889c1929be8SMatthew G. Knepley   DMSetField - Set the discretization object for a given DM field
4890c1929be8SMatthew G. Knepley 
4891d083f849SBarry Smith   Logically collective on dm
4892c1929be8SMatthew G. Knepley 
4893c1929be8SMatthew G. Knepley   Input Parameters:
4894c1929be8SMatthew G. Knepley + dm    - The DM
4895c1929be8SMatthew G. Knepley . f     - The field number
489644a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
4897c1929be8SMatthew G. Knepley - field - The discretization object
4898c1929be8SMatthew G. Knepley 
489944a7f3ddSMatthew G. Knepley   Level: intermediate
4900c1929be8SMatthew G. Knepley 
490144a7f3ddSMatthew G. Knepley .seealso: DMAddField(), DMGetField()
4902c1929be8SMatthew G. Knepley @*/
490344a7f3ddSMatthew G. Knepley PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4904decb47aaSMatthew G. Knepley {
4905decb47aaSMatthew G. Knepley   PetscFunctionBegin;
4906decb47aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4907e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
490844a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 4);
49097a8be351SBarry Smith   PetscCheck(f >= 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be non-negative", f);
49109566063dSJacob Faibussowitsch   PetscCall(DMSetField_Internal(dm, f, label, field));
49119566063dSJacob Faibussowitsch   PetscCall(DMSetDefaultAdjacency_Private(dm, f, field));
49129566063dSJacob Faibussowitsch   PetscCall(DMClearDS(dm));
491344a7f3ddSMatthew G. Knepley   PetscFunctionReturn(0);
491444a7f3ddSMatthew G. Knepley }
491544a7f3ddSMatthew G. Knepley 
491644a7f3ddSMatthew G. Knepley /*@
491744a7f3ddSMatthew G. Knepley   DMAddField - Add the discretization object for the given DM field
491844a7f3ddSMatthew G. Knepley 
4919d083f849SBarry Smith   Logically collective on dm
492044a7f3ddSMatthew G. Knepley 
492144a7f3ddSMatthew G. Knepley   Input Parameters:
492244a7f3ddSMatthew G. Knepley + dm    - The DM
492344a7f3ddSMatthew G. Knepley . label - The label indicating the support of the field, or NULL for the entire mesh
492444a7f3ddSMatthew G. Knepley - field - The discretization object
492544a7f3ddSMatthew G. Knepley 
492644a7f3ddSMatthew G. Knepley   Level: intermediate
492744a7f3ddSMatthew G. Knepley 
492844a7f3ddSMatthew G. Knepley .seealso: DMSetField(), DMGetField()
492944a7f3ddSMatthew G. Knepley @*/
493044a7f3ddSMatthew G. Knepley PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
493144a7f3ddSMatthew G. Knepley {
493244a7f3ddSMatthew G. Knepley   PetscInt       Nf = dm->Nf;
493344a7f3ddSMatthew G. Knepley 
493444a7f3ddSMatthew G. Knepley   PetscFunctionBegin;
493544a7f3ddSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4936064a246eSJacob Faibussowitsch   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
493744a7f3ddSMatthew G. Knepley   PetscValidHeader(field, 3);
49389566063dSJacob Faibussowitsch   PetscCall(DMFieldEnlarge_Static(dm, Nf+1));
493944a7f3ddSMatthew G. Knepley   dm->fields[Nf].label = label;
494044a7f3ddSMatthew G. Knepley   dm->fields[Nf].disc  = field;
49419566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) label));
49429566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) field));
49439566063dSJacob Faibussowitsch   PetscCall(DMSetDefaultAdjacency_Private(dm, Nf, field));
49449566063dSJacob Faibussowitsch   PetscCall(DMClearDS(dm));
4945af122d2aSMatthew G Knepley   PetscFunctionReturn(0);
4946af122d2aSMatthew G Knepley }
49476636e97aSMatthew G Knepley 
4948e5e52638SMatthew G. Knepley /*@
4949e0b68406SMatthew Knepley   DMSetFieldAvoidTensor - Set flag to avoid defining the field on tensor cells
4950e0b68406SMatthew Knepley 
4951e0b68406SMatthew Knepley   Logically collective on dm
4952e0b68406SMatthew Knepley 
4953e0b68406SMatthew Knepley   Input Parameters:
4954e0b68406SMatthew Knepley + dm          - The DM
4955e0b68406SMatthew Knepley . f           - The field index
4956e0b68406SMatthew Knepley - avoidTensor - The flag to avoid defining the field on tensor cells
4957e0b68406SMatthew Knepley 
4958e0b68406SMatthew Knepley   Level: intermediate
4959e0b68406SMatthew Knepley 
4960e0b68406SMatthew Knepley .seealso: DMGetFieldAvoidTensor(), DMSetField(), DMGetField()
4961e0b68406SMatthew Knepley @*/
4962e0b68406SMatthew Knepley PetscErrorCode DMSetFieldAvoidTensor(DM dm, PetscInt f, PetscBool avoidTensor)
4963e0b68406SMatthew Knepley {
4964e0b68406SMatthew Knepley   PetscFunctionBegin;
496512e84ecbSMatthew Knepley   PetscCheck((f >= 0) && (f < dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
4966e0b68406SMatthew Knepley   dm->fields[f].avoidTensor = avoidTensor;
4967e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4968e0b68406SMatthew Knepley }
4969e0b68406SMatthew Knepley 
4970e0b68406SMatthew Knepley /*@
4971e0b68406SMatthew Knepley   DMGetFieldAvoidTensor - Get flag to avoid defining the field on tensor cells
4972e0b68406SMatthew Knepley 
4973e0b68406SMatthew Knepley   Logically collective on dm
4974e0b68406SMatthew Knepley 
4975e0b68406SMatthew Knepley   Input Parameters:
4976e0b68406SMatthew Knepley + dm          - The DM
4977e0b68406SMatthew Knepley - f           - The field index
4978e0b68406SMatthew Knepley 
4979e0b68406SMatthew Knepley   Output Parameter:
4980e0b68406SMatthew Knepley . avoidTensor - The flag to avoid defining the field on tensor cells
4981e0b68406SMatthew Knepley 
4982e0b68406SMatthew Knepley   Level: intermediate
4983e0b68406SMatthew Knepley 
4984e0b68406SMatthew Knepley .seealso: DMSetFieldAvoidTensor(), DMSetField(), DMGetField()
4985e0b68406SMatthew Knepley @*/
4986e0b68406SMatthew Knepley PetscErrorCode DMGetFieldAvoidTensor(DM dm, PetscInt f, PetscBool *avoidTensor)
4987e0b68406SMatthew Knepley {
4988e0b68406SMatthew Knepley   PetscFunctionBegin;
49897a8be351SBarry Smith   PetscCheck((f >= 0) && (f < dm->Nf),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Field %D is not in [0, %D)", f, dm->Nf);
4990e0b68406SMatthew Knepley   *avoidTensor = dm->fields[f].avoidTensor;
4991e0b68406SMatthew Knepley   PetscFunctionReturn(0);
4992e0b68406SMatthew Knepley }
4993e0b68406SMatthew Knepley 
4994e0b68406SMatthew Knepley /*@
4995e5e52638SMatthew G. Knepley   DMCopyFields - Copy the discretizations for the DM into another DM
4996e5e52638SMatthew G. Knepley 
4997d083f849SBarry Smith   Collective on dm
4998e5e52638SMatthew G. Knepley 
4999e5e52638SMatthew G. Knepley   Input Parameter:
5000e5e52638SMatthew G. Knepley . dm - The DM
5001e5e52638SMatthew G. Knepley 
5002e5e52638SMatthew G. Knepley   Output Parameter:
5003e5e52638SMatthew G. Knepley . newdm - The DM
5004e5e52638SMatthew G. Knepley 
5005e5e52638SMatthew G. Knepley   Level: advanced
5006e5e52638SMatthew G. Knepley 
5007e5e52638SMatthew G. Knepley .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
5008e5e52638SMatthew G. Knepley @*/
5009e5e52638SMatthew G. Knepley PetscErrorCode DMCopyFields(DM dm, DM newdm)
5010e5e52638SMatthew G. Knepley {
5011e5e52638SMatthew G. Knepley   PetscInt       Nf, f;
5012e5e52638SMatthew G. Knepley 
5013e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5014e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
50159566063dSJacob Faibussowitsch   PetscCall(DMGetNumFields(dm, &Nf));
50169566063dSJacob Faibussowitsch   PetscCall(DMClearFields(newdm));
5017e5e52638SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5018e5e52638SMatthew G. Knepley     DMLabel     label;
5019e5e52638SMatthew G. Knepley     PetscObject field;
502034aa8a36SMatthew G. Knepley     PetscBool   useCone, useClosure;
5021e5e52638SMatthew G. Knepley 
50229566063dSJacob Faibussowitsch     PetscCall(DMGetField(dm, f, &label, &field));
50239566063dSJacob Faibussowitsch     PetscCall(DMSetField(newdm, f, label, field));
50249566063dSJacob Faibussowitsch     PetscCall(DMGetAdjacency(dm, f, &useCone, &useClosure));
50259566063dSJacob Faibussowitsch     PetscCall(DMSetAdjacency(newdm, f, useCone, useClosure));
502634aa8a36SMatthew G. Knepley   }
502734aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
502834aa8a36SMatthew G. Knepley }
502934aa8a36SMatthew G. Knepley 
503034aa8a36SMatthew G. Knepley /*@
503134aa8a36SMatthew G. Knepley   DMGetAdjacency - Returns the flags for determining variable influence
503234aa8a36SMatthew G. Knepley 
503334aa8a36SMatthew G. Knepley   Not collective
503434aa8a36SMatthew G. Knepley 
503534aa8a36SMatthew G. Knepley   Input Parameters:
503634aa8a36SMatthew G. Knepley + dm - The DM object
503734aa8a36SMatthew G. Knepley - f  - The field number, or PETSC_DEFAULT for the default adjacency
503834aa8a36SMatthew G. Knepley 
5039d8d19677SJose E. Roman   Output Parameters:
504034aa8a36SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
504134aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
504234aa8a36SMatthew G. Knepley 
504334aa8a36SMatthew G. Knepley   Notes:
504434aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
504534aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
504634aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5047979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
504834aa8a36SMatthew G. Knepley 
504934aa8a36SMatthew G. Knepley   Level: developer
505034aa8a36SMatthew G. Knepley 
505134aa8a36SMatthew G. Knepley .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
505234aa8a36SMatthew G. Knepley @*/
505334aa8a36SMatthew G. Knepley PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
505434aa8a36SMatthew G. Knepley {
505534aa8a36SMatthew G. Knepley   PetscFunctionBegin;
505634aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5057534a8f05SLisandro Dalcin   if (useCone)    PetscValidBoolPointer(useCone, 3);
5058534a8f05SLisandro Dalcin   if (useClosure) PetscValidBoolPointer(useClosure, 4);
505934aa8a36SMatthew G. Knepley   if (f < 0) {
506034aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->adjacency[0];
506134aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->adjacency[1];
506234aa8a36SMatthew G. Knepley   } else {
506334aa8a36SMatthew G. Knepley     PetscInt       Nf;
506434aa8a36SMatthew G. Knepley 
50659566063dSJacob Faibussowitsch     PetscCall(DMGetNumFields(dm, &Nf));
50667a8be351SBarry Smith     PetscCheck(f < Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, Nf);
506734aa8a36SMatthew G. Knepley     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
506834aa8a36SMatthew G. Knepley     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
506934aa8a36SMatthew G. Knepley   }
507034aa8a36SMatthew G. Knepley   PetscFunctionReturn(0);
507134aa8a36SMatthew G. Knepley }
507234aa8a36SMatthew G. Knepley 
507334aa8a36SMatthew G. Knepley /*@
507434aa8a36SMatthew G. Knepley   DMSetAdjacency - Set the flags for determining variable influence
507534aa8a36SMatthew G. Knepley 
507634aa8a36SMatthew G. Knepley   Not collective
507734aa8a36SMatthew G. Knepley 
507834aa8a36SMatthew G. Knepley   Input Parameters:
507934aa8a36SMatthew G. Knepley + dm         - The DM object
508034aa8a36SMatthew G. Knepley . f          - The field number
508134aa8a36SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
508234aa8a36SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
508334aa8a36SMatthew G. Knepley 
508434aa8a36SMatthew G. Knepley   Notes:
508534aa8a36SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
508634aa8a36SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
508734aa8a36SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5088979e053dSMatthew G. Knepley   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
508934aa8a36SMatthew G. Knepley 
509034aa8a36SMatthew G. Knepley   Level: developer
509134aa8a36SMatthew G. Knepley 
509234aa8a36SMatthew G. Knepley .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
509334aa8a36SMatthew G. Knepley @*/
509434aa8a36SMatthew G. Knepley PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
509534aa8a36SMatthew G. Knepley {
509634aa8a36SMatthew G. Knepley   PetscFunctionBegin;
509734aa8a36SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
509834aa8a36SMatthew G. Knepley   if (f < 0) {
509934aa8a36SMatthew G. Knepley     dm->adjacency[0] = useCone;
510034aa8a36SMatthew G. Knepley     dm->adjacency[1] = useClosure;
510134aa8a36SMatthew G. Knepley   } else {
510234aa8a36SMatthew G. Knepley     PetscInt       Nf;
510334aa8a36SMatthew G. Knepley 
51049566063dSJacob Faibussowitsch     PetscCall(DMGetNumFields(dm, &Nf));
51057a8be351SBarry Smith     PetscCheck(f < Nf,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", f, Nf);
510634aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[0] = useCone;
510734aa8a36SMatthew G. Knepley     dm->fields[f].adjacency[1] = useClosure;
5108e5e52638SMatthew G. Knepley   }
5109e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5110e5e52638SMatthew G. Knepley }
5111e5e52638SMatthew G. Knepley 
5112b0441da4SMatthew G. Knepley /*@
5113b0441da4SMatthew G. Knepley   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
5114b0441da4SMatthew G. Knepley 
5115b0441da4SMatthew G. Knepley   Not collective
5116b0441da4SMatthew G. Knepley 
5117f899ff85SJose E. Roman   Input Parameter:
5118b0441da4SMatthew G. Knepley . dm - The DM object
5119b0441da4SMatthew G. Knepley 
5120d8d19677SJose E. Roman   Output Parameters:
5121b0441da4SMatthew G. Knepley + useCone    - Flag for variable influence starting with the cone operation
5122b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5123b0441da4SMatthew G. Knepley 
5124b0441da4SMatthew G. Knepley   Notes:
5125b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5126b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5127b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5128b0441da4SMatthew G. Knepley 
5129b0441da4SMatthew G. Knepley   Level: developer
5130b0441da4SMatthew G. Knepley 
5131b0441da4SMatthew G. Knepley .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
5132b0441da4SMatthew G. Knepley @*/
5133b0441da4SMatthew G. Knepley PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
5134b0441da4SMatthew G. Knepley {
5135b0441da4SMatthew G. Knepley   PetscInt       Nf;
5136b0441da4SMatthew G. Knepley 
5137b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5138b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5139064a246eSJacob Faibussowitsch   if (useCone)    PetscValidBoolPointer(useCone, 2);
5140064a246eSJacob Faibussowitsch   if (useClosure) PetscValidBoolPointer(useClosure, 3);
51419566063dSJacob Faibussowitsch   PetscCall(DMGetNumFields(dm, &Nf));
5142b0441da4SMatthew G. Knepley   if (!Nf) {
51439566063dSJacob Faibussowitsch     PetscCall(DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure));
5144b0441da4SMatthew G. Knepley   } else {
51459566063dSJacob Faibussowitsch     PetscCall(DMGetAdjacency(dm, 0, useCone, useClosure));
5146b0441da4SMatthew G. Knepley   }
5147b0441da4SMatthew G. Knepley   PetscFunctionReturn(0);
5148b0441da4SMatthew G. Knepley }
5149b0441da4SMatthew G. Knepley 
5150b0441da4SMatthew G. Knepley /*@
5151b0441da4SMatthew G. Knepley   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
5152b0441da4SMatthew G. Knepley 
5153b0441da4SMatthew G. Knepley   Not collective
5154b0441da4SMatthew G. Knepley 
5155b0441da4SMatthew G. Knepley   Input Parameters:
5156b0441da4SMatthew G. Knepley + dm         - The DM object
5157b0441da4SMatthew G. Knepley . useCone    - Flag for variable influence starting with the cone operation
5158b0441da4SMatthew G. Knepley - useClosure - Flag for variable influence using transitive closure
5159b0441da4SMatthew G. Knepley 
5160b0441da4SMatthew G. Knepley   Notes:
5161b0441da4SMatthew G. Knepley $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
5162b0441da4SMatthew G. Knepley $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
5163b0441da4SMatthew G. Knepley $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
5164b0441da4SMatthew G. Knepley 
5165b0441da4SMatthew G. Knepley   Level: developer
5166b0441da4SMatthew G. Knepley 
5167b0441da4SMatthew G. Knepley .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
5168b0441da4SMatthew G. Knepley @*/
5169b0441da4SMatthew G. Knepley PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
5170b0441da4SMatthew G. Knepley {
5171b0441da4SMatthew G. Knepley   PetscInt       Nf;
5172b0441da4SMatthew G. Knepley 
5173b0441da4SMatthew G. Knepley   PetscFunctionBegin;
5174b0441da4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
51759566063dSJacob Faibussowitsch   PetscCall(DMGetNumFields(dm, &Nf));
5176b0441da4SMatthew G. Knepley   if (!Nf) {
51779566063dSJacob Faibussowitsch     PetscCall(DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure));
5178b0441da4SMatthew G. Knepley   } else {
51799566063dSJacob Faibussowitsch     PetscCall(DMSetAdjacency(dm, 0, useCone, useClosure));
5180e5e52638SMatthew G. Knepley   }
5181e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5182e5e52638SMatthew G. Knepley }
5183e5e52638SMatthew G. Knepley 
5184783e2ec8SMatthew G. Knepley /* Complete labels that are being used for FEM BC */
518545480ffeSMatthew G. Knepley static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, DMLabel label)
5186783e2ec8SMatthew G. Knepley {
5187783e2ec8SMatthew G. Knepley   PetscObject    obj;
5188783e2ec8SMatthew G. Knepley   PetscClassId   id;
5189783e2ec8SMatthew G. Knepley   PetscInt       Nbd, bd;
5190783e2ec8SMatthew G. Knepley   PetscBool      isFE      = PETSC_FALSE;
5191783e2ec8SMatthew G. Knepley   PetscBool      duplicate = PETSC_FALSE;
5192783e2ec8SMatthew G. Knepley 
5193783e2ec8SMatthew G. Knepley   PetscFunctionBegin;
51949566063dSJacob Faibussowitsch   PetscCall(DMGetField(dm, field, NULL, &obj));
51959566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetClassId(obj, &id));
5196783e2ec8SMatthew G. Knepley   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
5197783e2ec8SMatthew G. Knepley   if (isFE && label) {
5198783e2ec8SMatthew G. Knepley     /* Only want to modify label once */
51999566063dSJacob Faibussowitsch     PetscCall(PetscDSGetNumBoundary(ds, &Nbd));
5200783e2ec8SMatthew G. Knepley     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
520145480ffeSMatthew G. Knepley       DMLabel l;
5202783e2ec8SMatthew G. Knepley 
52039566063dSJacob Faibussowitsch       PetscCall(PetscDSGetBoundary(ds, bd, NULL, NULL, NULL, &l, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL));
520445480ffeSMatthew G. Knepley       duplicate = l == label ? PETSC_TRUE : PETSC_FALSE;
5205783e2ec8SMatthew G. Knepley       if (duplicate) break;
5206783e2ec8SMatthew G. Knepley     }
5207783e2ec8SMatthew G. Knepley     if (!duplicate) {
5208783e2ec8SMatthew G. Knepley       DM plex;
5209783e2ec8SMatthew G. Knepley 
52109566063dSJacob Faibussowitsch       PetscCall(DMConvert(dm, DMPLEX, &plex));
52119566063dSJacob Faibussowitsch       if (plex) PetscCall(DMPlexLabelComplete(plex, label));
52129566063dSJacob Faibussowitsch       PetscCall(DMDestroy(&plex));
5213783e2ec8SMatthew G. Knepley     }
5214783e2ec8SMatthew G. Knepley   }
5215783e2ec8SMatthew G. Knepley   PetscFunctionReturn(0);
5216783e2ec8SMatthew G. Knepley }
5217783e2ec8SMatthew G. Knepley 
5218e5e52638SMatthew G. Knepley static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
5219e5e52638SMatthew G. Knepley {
5220e5e52638SMatthew G. Knepley   DMSpace       *tmpd;
5221e5e52638SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5222e5e52638SMatthew G. Knepley 
5223e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5224e5e52638SMatthew G. Knepley   if (Nds >= NdsNew) PetscFunctionReturn(0);
52259566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(NdsNew, &tmpd));
5226e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
5227b3cf3223SMatthew G. Knepley   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
52289566063dSJacob Faibussowitsch   PetscCall(PetscFree(dm->probs));
5229e5e52638SMatthew G. Knepley   dm->Nds   = NdsNew;
5230e5e52638SMatthew G. Knepley   dm->probs = tmpd;
5231e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5232e5e52638SMatthew G. Knepley }
5233e5e52638SMatthew G. Knepley 
5234e5e52638SMatthew G. Knepley /*@
5235e5e52638SMatthew G. Knepley   DMGetNumDS - Get the number of discrete systems in the DM
5236e5e52638SMatthew G. Knepley 
5237e5e52638SMatthew G. Knepley   Not collective
5238e5e52638SMatthew G. Knepley 
5239e5e52638SMatthew G. Knepley   Input Parameter:
5240e5e52638SMatthew G. Knepley . dm - The DM
5241e5e52638SMatthew G. Knepley 
5242e5e52638SMatthew G. Knepley   Output Parameter:
5243e5e52638SMatthew G. Knepley . Nds - The number of PetscDS objects
5244e5e52638SMatthew G. Knepley 
5245e5e52638SMatthew G. Knepley   Level: intermediate
5246e5e52638SMatthew G. Knepley 
5247e5e52638SMatthew G. Knepley .seealso: DMGetDS(), DMGetCellDS()
5248e5e52638SMatthew G. Knepley @*/
5249e5e52638SMatthew G. Knepley PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
5250e5e52638SMatthew G. Knepley {
5251e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5252e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5253534a8f05SLisandro Dalcin   PetscValidIntPointer(Nds, 2);
5254e5e52638SMatthew G. Knepley   *Nds = dm->Nds;
5255e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5256e5e52638SMatthew G. Knepley }
5257e5e52638SMatthew G. Knepley 
5258e5e52638SMatthew G. Knepley /*@
5259e5e52638SMatthew G. Knepley   DMClearDS - Remove all discrete systems from the DM
5260e5e52638SMatthew G. Knepley 
5261d083f849SBarry Smith   Logically collective on dm
5262e5e52638SMatthew G. Knepley 
5263e5e52638SMatthew G. Knepley   Input Parameter:
5264e5e52638SMatthew G. Knepley . dm - The DM
5265e5e52638SMatthew G. Knepley 
5266e5e52638SMatthew G. Knepley   Level: intermediate
5267e5e52638SMatthew G. Knepley 
5268e5e52638SMatthew G. Knepley .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5269e5e52638SMatthew G. Knepley @*/
5270e5e52638SMatthew G. Knepley PetscErrorCode DMClearDS(DM dm)
5271e5e52638SMatthew G. Knepley {
5272e5e52638SMatthew G. Knepley   PetscInt       s;
5273e5e52638SMatthew G. Knepley 
5274e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5275e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5276e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
52779566063dSJacob Faibussowitsch     PetscCall(PetscDSDestroy(&dm->probs[s].ds));
52789566063dSJacob Faibussowitsch     PetscCall(DMLabelDestroy(&dm->probs[s].label));
52799566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&dm->probs[s].fields));
5280e5e52638SMatthew G. Knepley   }
52819566063dSJacob Faibussowitsch   PetscCall(PetscFree(dm->probs));
5282e5e52638SMatthew G. Knepley   dm->probs = NULL;
5283e5e52638SMatthew G. Knepley   dm->Nds   = 0;
5284e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5285e5e52638SMatthew G. Knepley }
5286e5e52638SMatthew G. Knepley 
5287e5e52638SMatthew G. Knepley /*@
5288e5e52638SMatthew G. Knepley   DMGetDS - Get the default PetscDS
5289e5e52638SMatthew G. Knepley 
5290e5e52638SMatthew G. Knepley   Not collective
5291e5e52638SMatthew G. Knepley 
5292e5e52638SMatthew G. Knepley   Input Parameter:
5293e5e52638SMatthew G. Knepley . dm    - The DM
5294e5e52638SMatthew G. Knepley 
5295e5e52638SMatthew G. Knepley   Output Parameter:
5296e5e52638SMatthew G. Knepley . prob - The default PetscDS
5297e5e52638SMatthew G. Knepley 
5298e5e52638SMatthew G. Knepley   Level: intermediate
5299e5e52638SMatthew G. Knepley 
5300e5e52638SMatthew G. Knepley .seealso: DMGetCellDS(), DMGetRegionDS()
5301e5e52638SMatthew G. Knepley @*/
5302e5e52638SMatthew G. Knepley PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5303e5e52638SMatthew G. Knepley {
5304e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5305e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5306e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 2);
5307b0143b4dSMatthew G. Knepley   if (dm->Nds <= 0) {
5308b0143b4dSMatthew G. Knepley     PetscDS ds;
5309b0143b4dSMatthew G. Knepley 
53109566063dSJacob Faibussowitsch     PetscCall(PetscDSCreate(PETSC_COMM_SELF, &ds));
53119566063dSJacob Faibussowitsch     PetscCall(DMSetRegionDS(dm, NULL, NULL, ds));
53129566063dSJacob Faibussowitsch     PetscCall(PetscDSDestroy(&ds));
5313b0143b4dSMatthew G. Knepley   }
5314b0143b4dSMatthew G. Knepley   *prob = dm->probs[0].ds;
5315e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5316e5e52638SMatthew G. Knepley }
5317e5e52638SMatthew G. Knepley 
5318e5e52638SMatthew G. Knepley /*@
5319e5e52638SMatthew G. Knepley   DMGetCellDS - Get the PetscDS defined on a given cell
5320e5e52638SMatthew G. Knepley 
5321e5e52638SMatthew G. Knepley   Not collective
5322e5e52638SMatthew G. Knepley 
5323e5e52638SMatthew G. Knepley   Input Parameters:
5324e5e52638SMatthew G. Knepley + dm    - The DM
5325e5e52638SMatthew G. Knepley - point - Cell for the DS
5326e5e52638SMatthew G. Knepley 
5327e5e52638SMatthew G. Knepley   Output Parameter:
5328e5e52638SMatthew G. Knepley . prob - The PetscDS defined on the given cell
5329e5e52638SMatthew G. Knepley 
5330e5e52638SMatthew G. Knepley   Level: developer
5331e5e52638SMatthew G. Knepley 
5332b0143b4dSMatthew G. Knepley .seealso: DMGetDS(), DMSetRegionDS()
5333e5e52638SMatthew G. Knepley @*/
5334e5e52638SMatthew G. Knepley PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5335e5e52638SMatthew G. Knepley {
5336e5e52638SMatthew G. Knepley   PetscDS        probDef = NULL;
5337e5e52638SMatthew G. Knepley   PetscInt       s;
5338e5e52638SMatthew G. Knepley 
5339e5e52638SMatthew G. Knepley   PetscFunctionBeginHot;
5340e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5341e5e52638SMatthew G. Knepley   PetscValidPointer(prob, 3);
53427a8be351SBarry Smith   PetscCheck(point >= 0,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5343e5e52638SMatthew G. Knepley   *prob = NULL;
5344e5e52638SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5345e5e52638SMatthew G. Knepley     PetscInt val;
5346e5e52638SMatthew G. Knepley 
5347e5e52638SMatthew G. Knepley     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5348e5e52638SMatthew G. Knepley     else {
53499566063dSJacob Faibussowitsch       PetscCall(DMLabelGetValue(dm->probs[s].label, point, &val));
5350e5e52638SMatthew G. Knepley       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5351e5e52638SMatthew G. Knepley     }
5352e5e52638SMatthew G. Knepley   }
5353e5e52638SMatthew G. Knepley   if (!*prob) *prob = probDef;
5354e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5355e5e52638SMatthew G. Knepley }
5356e5e52638SMatthew G. Knepley 
5357e5e52638SMatthew G. Knepley /*@
5358e5e52638SMatthew G. Knepley   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5359e5e52638SMatthew G. Knepley 
5360e5e52638SMatthew G. Knepley   Not collective
5361e5e52638SMatthew G. Knepley 
5362e5e52638SMatthew G. Knepley   Input Parameters:
5363e5e52638SMatthew G. Knepley + dm    - The DM
5364e5e52638SMatthew G. Knepley - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5365e5e52638SMatthew G. Knepley 
5366b3cf3223SMatthew G. Knepley   Output Parameters:
5367b3cf3223SMatthew G. Knepley + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5368b3cf3223SMatthew G. Knepley - prob - The PetscDS defined on the given region, or NULL
5369e5e52638SMatthew G. Knepley 
5370154ca461SJed Brown   Note:
5371154ca461SJed Brown   If a non-NULL label is given, but there is no PetscDS on that specific label,
5372154ca461SJed Brown   the PetscDS for the full domain (if present) is returned. Returns with
5373154ca461SJed Brown   fields=NULL and prob=NULL if there is no PetscDS for the full domain.
5374e5e52638SMatthew G. Knepley 
5375e5e52638SMatthew G. Knepley   Level: advanced
5376e5e52638SMatthew G. Knepley 
5377e5e52638SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5378e5e52638SMatthew G. Knepley @*/
5379b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5380e5e52638SMatthew G. Knepley {
5381e5e52638SMatthew G. Knepley   PetscInt Nds = dm->Nds, s;
5382e5e52638SMatthew G. Knepley 
5383e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5384e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5385e5e52638SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5386b3cf3223SMatthew G. Knepley   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5387b3cf3223SMatthew G. Knepley   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5388e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5389154ca461SJed Brown     if (dm->probs[s].label == label || !dm->probs[s].label) {
5390b3cf3223SMatthew G. Knepley       if (fields) *fields = dm->probs[s].fields;
5391b3cf3223SMatthew G. Knepley       if (ds)     *ds     = dm->probs[s].ds;
5392154ca461SJed Brown       if (dm->probs[s].label) PetscFunctionReturn(0);
5393b3cf3223SMatthew G. Knepley     }
5394e5e52638SMatthew G. Knepley   }
53952df9ee95SMatthew G. Knepley   PetscFunctionReturn(0);
5396e5e52638SMatthew G. Knepley }
5397e5e52638SMatthew G. Knepley 
5398e5e52638SMatthew G. Knepley /*@
5399083401c6SMatthew G. Knepley   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5400083401c6SMatthew G. Knepley 
5401083401c6SMatthew G. Knepley   Collective on dm
5402083401c6SMatthew G. Knepley 
5403083401c6SMatthew G. Knepley   Input Parameters:
5404083401c6SMatthew G. Knepley + dm     - The DM
5405083401c6SMatthew G. Knepley . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5406083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5407083401c6SMatthew G. Knepley - prob   - The PetscDS defined on the given cell
5408083401c6SMatthew G. Knepley 
5409083401c6SMatthew 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,
5410083401c6SMatthew G. Knepley   the fields argument is ignored.
5411083401c6SMatthew G. Knepley 
5412083401c6SMatthew G. Knepley   Level: advanced
5413083401c6SMatthew G. Knepley 
5414083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionNumDS(), DMGetDS(), DMGetCellDS()
5415083401c6SMatthew G. Knepley @*/
5416083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5417083401c6SMatthew G. Knepley {
5418083401c6SMatthew G. Knepley   PetscInt       Nds = dm->Nds, s;
5419083401c6SMatthew G. Knepley 
5420083401c6SMatthew G. Knepley   PetscFunctionBegin;
5421083401c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5422083401c6SMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5423064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 4);
5424083401c6SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5425083401c6SMatthew G. Knepley     if (dm->probs[s].label == label) {
54269566063dSJacob Faibussowitsch       PetscCall(PetscDSDestroy(&dm->probs[s].ds));
5427083401c6SMatthew G. Knepley       dm->probs[s].ds = ds;
5428083401c6SMatthew G. Knepley       PetscFunctionReturn(0);
5429083401c6SMatthew G. Knepley     }
5430083401c6SMatthew G. Knepley   }
54319566063dSJacob Faibussowitsch   PetscCall(DMDSEnlarge_Static(dm, Nds+1));
54329566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) label));
54339566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) fields));
54349566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) ds));
5435083401c6SMatthew G. Knepley   if (!label) {
5436083401c6SMatthew G. Knepley     /* Put the NULL label at the front, so it is returned as the default */
5437083401c6SMatthew G. Knepley     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5438083401c6SMatthew G. Knepley     Nds = 0;
5439083401c6SMatthew G. Knepley   }
5440083401c6SMatthew G. Knepley   dm->probs[Nds].label  = label;
5441083401c6SMatthew G. Knepley   dm->probs[Nds].fields = fields;
5442083401c6SMatthew G. Knepley   dm->probs[Nds].ds     = ds;
5443083401c6SMatthew G. Knepley   PetscFunctionReturn(0);
5444083401c6SMatthew G. Knepley }
5445083401c6SMatthew G. Knepley 
5446083401c6SMatthew G. Knepley /*@
5447e5e52638SMatthew G. Knepley   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5448e5e52638SMatthew G. Knepley 
5449e5e52638SMatthew G. Knepley   Not collective
5450e5e52638SMatthew G. Knepley 
5451e5e52638SMatthew G. Knepley   Input Parameters:
5452e5e52638SMatthew G. Knepley + dm  - The DM
5453e5e52638SMatthew G. Knepley - num - The region number, in [0, Nds)
5454e5e52638SMatthew G. Knepley 
5455e5e52638SMatthew G. Knepley   Output Parameters:
5456b3cf3223SMatthew G. Knepley + label  - The region label, or NULL
5457b3cf3223SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5458083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL
5459e5e52638SMatthew G. Knepley 
5460e5e52638SMatthew G. Knepley   Level: advanced
5461e5e52638SMatthew G. Knepley 
5462e5e52638SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5463e5e52638SMatthew G. Knepley @*/
5464b3cf3223SMatthew G. Knepley PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5465e5e52638SMatthew G. Knepley {
5466e5e52638SMatthew G. Knepley   PetscInt       Nds;
5467e5e52638SMatthew G. Knepley 
5468e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5469e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
54709566063dSJacob Faibussowitsch   PetscCall(DMGetNumDS(dm, &Nds));
54717a8be351SBarry Smith   PetscCheck((num >= 0) && (num < Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5472e5e52638SMatthew G. Knepley   if (label) {
5473e5e52638SMatthew G. Knepley     PetscValidPointer(label, 3);
5474e5e52638SMatthew G. Knepley     *label = dm->probs[num].label;
5475e5e52638SMatthew G. Knepley   }
5476b3cf3223SMatthew G. Knepley   if (fields) {
5477b3cf3223SMatthew G. Knepley     PetscValidPointer(fields, 4);
5478b3cf3223SMatthew G. Knepley     *fields = dm->probs[num].fields;
5479b3cf3223SMatthew G. Knepley   }
5480e5e52638SMatthew G. Knepley   if (ds) {
5481b3cf3223SMatthew G. Knepley     PetscValidPointer(ds, 5);
5482e5e52638SMatthew G. Knepley     *ds = dm->probs[num].ds;
5483e5e52638SMatthew G. Knepley   }
5484e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5485e5e52638SMatthew G. Knepley }
5486e5e52638SMatthew G. Knepley 
5487e5e52638SMatthew G. Knepley /*@
5488083401c6SMatthew G. Knepley   DMSetRegionNumDS - Set the PetscDS for a given mesh region, defined by the region number
5489e5e52638SMatthew G. Knepley 
5490083401c6SMatthew G. Knepley   Not collective
5491e5e52638SMatthew G. Knepley 
5492e5e52638SMatthew G. Knepley   Input Parameters:
5493e5e52638SMatthew G. Knepley + dm     - The DM
5494083401c6SMatthew G. Knepley . num    - The region number, in [0, Nds)
5495083401c6SMatthew G. Knepley . label  - The region label, or NULL
5496083401c6SMatthew G. Knepley . fields - The IS containing the DM field numbers for the fields in this DS, or NULL to prevent setting
5497083401c6SMatthew G. Knepley - ds     - The PetscDS defined on the given region, or NULL to prevent setting
5498e5e52638SMatthew G. Knepley 
5499e5e52638SMatthew G. Knepley   Level: advanced
5500e5e52638SMatthew G. Knepley 
5501083401c6SMatthew G. Knepley .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5502e5e52638SMatthew G. Knepley @*/
5503083401c6SMatthew G. Knepley PetscErrorCode DMSetRegionNumDS(DM dm, PetscInt num, DMLabel label, IS fields, PetscDS ds)
5504e5e52638SMatthew G. Knepley {
5505083401c6SMatthew G. Knepley   PetscInt       Nds;
5506e5e52638SMatthew G. Knepley 
5507e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5508e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5509083401c6SMatthew G. Knepley   if (label) {PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);}
55109566063dSJacob Faibussowitsch   PetscCall(DMGetNumDS(dm, &Nds));
55117a8be351SBarry Smith   PetscCheck((num >= 0) && (num < Nds),PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
55129566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) label));
55139566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroy(&dm->probs[num].label));
5514083401c6SMatthew G. Knepley   dm->probs[num].label = label;
5515083401c6SMatthew G. Knepley   if (fields) {
5516083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(fields, IS_CLASSID, 4);
55179566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject) fields));
55189566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&dm->probs[num].fields));
5519083401c6SMatthew G. Knepley     dm->probs[num].fields = fields;
5520e5e52638SMatthew G. Knepley   }
5521083401c6SMatthew G. Knepley   if (ds) {
5522083401c6SMatthew G. Knepley     PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 5);
55239566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject) ds));
55249566063dSJacob Faibussowitsch     PetscCall(PetscDSDestroy(&dm->probs[num].ds));
5525083401c6SMatthew G. Knepley     dm->probs[num].ds = ds;
5526083401c6SMatthew G. Knepley   }
5527e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5528e5e52638SMatthew G. Knepley }
5529e5e52638SMatthew G. Knepley 
5530e5e52638SMatthew G. Knepley /*@
55311d3af9e0SMatthew G. Knepley   DMFindRegionNum - Find the region number for a given PetscDS, or -1 if it is not found.
55321d3af9e0SMatthew G. Knepley 
55331d3af9e0SMatthew G. Knepley   Not collective
55341d3af9e0SMatthew G. Knepley 
55351d3af9e0SMatthew G. Knepley   Input Parameters:
55361d3af9e0SMatthew G. Knepley + dm  - The DM
55371d3af9e0SMatthew G. Knepley - ds  - The PetscDS defined on the given region
55381d3af9e0SMatthew G. Knepley 
55391d3af9e0SMatthew G. Knepley   Output Parameter:
55401d3af9e0SMatthew G. Knepley . num - The region number, in [0, Nds), or -1 if not found
55411d3af9e0SMatthew G. Knepley 
55421d3af9e0SMatthew G. Knepley   Level: advanced
55431d3af9e0SMatthew G. Knepley 
55441d3af9e0SMatthew G. Knepley .seealso: DMGetRegionNumDS(), DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
55451d3af9e0SMatthew G. Knepley @*/
55461d3af9e0SMatthew G. Knepley PetscErrorCode DMFindRegionNum(DM dm, PetscDS ds, PetscInt *num)
55471d3af9e0SMatthew G. Knepley {
55481d3af9e0SMatthew G. Knepley   PetscInt       Nds, n;
55491d3af9e0SMatthew G. Knepley 
55501d3af9e0SMatthew G. Knepley   PetscFunctionBegin;
55511d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
55521d3af9e0SMatthew G. Knepley   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 2);
5553dadcf809SJacob Faibussowitsch   PetscValidIntPointer(num, 3);
55549566063dSJacob Faibussowitsch   PetscCall(DMGetNumDS(dm, &Nds));
55551d3af9e0SMatthew G. Knepley   for (n = 0; n < Nds; ++n) if (ds == dm->probs[n].ds) break;
55561d3af9e0SMatthew G. Knepley   if (n >= Nds) *num = -1;
55571d3af9e0SMatthew G. Knepley   else          *num = n;
55581d3af9e0SMatthew G. Knepley   PetscFunctionReturn(0);
55591d3af9e0SMatthew G. Knepley }
55601d3af9e0SMatthew G. Knepley 
55612df84da0SMatthew G. Knepley /*@C
55622df84da0SMatthew G. Knepley   DMCreateFEDefault - Create a PetscFE based on the celltype for the mesh
55632df84da0SMatthew G. Knepley 
55642df84da0SMatthew G. Knepley   Not collective
55652df84da0SMatthew G. Knepley 
5566f1a722f8SMatthew G. Knepley   Input Parameters:
55672df84da0SMatthew G. Knepley + dm     - The DM
55682df84da0SMatthew G. Knepley . Nc     - The number of components for the field
55692df84da0SMatthew G. Knepley . prefix - The options prefix for the output PetscFE, or NULL
55702df84da0SMatthew G. Knepley - qorder - The quadrature order or PETSC_DETERMINE to use PetscSpace polynomial degree
55712df84da0SMatthew G. Knepley 
55722df84da0SMatthew G. Knepley   Output Parameter:
55732df84da0SMatthew G. Knepley . fem - The PetscFE
55742df84da0SMatthew G. Knepley 
55752df84da0SMatthew G. Knepley   Note: This is a convenience method that just calls PetscFECreateByCell() underneath.
55762df84da0SMatthew G. Knepley 
55772df84da0SMatthew G. Knepley   Level: intermediate
55782df84da0SMatthew G. Knepley 
55792df84da0SMatthew G. Knepley .seealso: PetscFECreateByCell(), DMAddField(), DMCreateDS(), DMGetCellDS(), DMGetRegionDS()
55802df84da0SMatthew G. Knepley @*/
55812df84da0SMatthew G. Knepley PetscErrorCode DMCreateFEDefault(DM dm, PetscInt Nc, const char prefix[], PetscInt qorder, PetscFE *fem)
55822df84da0SMatthew G. Knepley {
55832df84da0SMatthew G. Knepley   DMPolytopeType ct;
55842df84da0SMatthew G. Knepley   PetscInt       dim, cStart;
55852df84da0SMatthew G. Knepley 
55862df84da0SMatthew G. Knepley   PetscFunctionBegin;
55872df84da0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
55882df84da0SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 2);
55892df84da0SMatthew G. Knepley   if (prefix) PetscValidCharPointer(prefix, 3);
55902df84da0SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, qorder, 4);
55912df84da0SMatthew G. Knepley   PetscValidPointer(fem, 5);
55929566063dSJacob Faibussowitsch   PetscCall(DMGetDimension(dm, &dim));
55939566063dSJacob Faibussowitsch   PetscCall(DMPlexGetHeightStratum(dm, 0, &cStart, NULL));
55949566063dSJacob Faibussowitsch   PetscCall(DMPlexGetCellType(dm, cStart, &ct));
55959566063dSJacob Faibussowitsch   PetscCall(PetscFECreateByCell(PETSC_COMM_SELF, dim, Nc, ct, prefix, qorder, fem));
55962df84da0SMatthew G. Knepley   PetscFunctionReturn(0);
55972df84da0SMatthew G. Knepley }
55982df84da0SMatthew G. Knepley 
55991d3af9e0SMatthew G. Knepley /*@
5600e5e52638SMatthew G. Knepley   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5601e5e52638SMatthew G. Knepley 
5602d083f849SBarry Smith   Collective on dm
5603e5e52638SMatthew G. Knepley 
5604e5e52638SMatthew G. Knepley   Input Parameter:
5605e5e52638SMatthew G. Knepley . dm - The DM
5606e5e52638SMatthew G. Knepley 
560745480ffeSMatthew G. Knepley   Options Database Keys:
560845480ffeSMatthew G. Knepley . -dm_petscds_view - View all the PetscDS objects in this DM
560945480ffeSMatthew G. Knepley 
5610e5e52638SMatthew G. Knepley   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5611e5e52638SMatthew G. Knepley 
5612e5e52638SMatthew G. Knepley   Level: intermediate
5613e5e52638SMatthew G. Knepley 
5614e5e52638SMatthew G. Knepley .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5615e5e52638SMatthew G. Knepley @*/
5616e5e52638SMatthew G. Knepley PetscErrorCode DMCreateDS(DM dm)
5617e5e52638SMatthew G. Knepley {
5618e5e52638SMatthew G. Knepley   MPI_Comm       comm;
5619083401c6SMatthew G. Knepley   PetscDS        dsDef;
5620083401c6SMatthew G. Knepley   DMLabel       *labelSet;
5621f9244615SMatthew G. Knepley   PetscInt       dE, Nf = dm->Nf, f, s, Nl, l, Ndef, k;
5622f9244615SMatthew G. Knepley   PetscBool      doSetup = PETSC_TRUE, flg;
5623e5e52638SMatthew G. Knepley 
5624e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5625e5e52638SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5626e5e52638SMatthew G. Knepley   if (!dm->fields) PetscFunctionReturn(0);
56279566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject) dm, &comm));
56289566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDim(dm, &dE));
5629083401c6SMatthew G. Knepley   /* Determine how many regions we have */
56309566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(Nf, &labelSet));
5631083401c6SMatthew G. Knepley   Nl   = 0;
5632083401c6SMatthew G. Knepley   Ndef = 0;
5633083401c6SMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
5634083401c6SMatthew G. Knepley     DMLabel  label = dm->fields[f].label;
5635083401c6SMatthew G. Knepley     PetscInt l;
5636083401c6SMatthew G. Knepley 
5637f918ec44SMatthew G. Knepley #ifdef PETSC_HAVE_LIBCEED
5638f918ec44SMatthew G. Knepley     /* Move CEED context to discretizations */
5639f918ec44SMatthew G. Knepley     {
5640f918ec44SMatthew G. Knepley       PetscClassId id;
5641f918ec44SMatthew G. Knepley 
56429566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetClassId(dm->fields[f].disc, &id));
5643f918ec44SMatthew G. Knepley       if (id == PETSCFE_CLASSID) {
5644f918ec44SMatthew G. Knepley         Ceed ceed;
5645f918ec44SMatthew G. Knepley 
56469566063dSJacob Faibussowitsch         PetscCall(DMGetCeed(dm, &ceed));
56479566063dSJacob Faibussowitsch         PetscCall(PetscFESetCeed((PetscFE) dm->fields[f].disc, ceed));
5648f918ec44SMatthew G. Knepley       }
5649f918ec44SMatthew G. Knepley     }
5650f918ec44SMatthew G. Knepley #endif
5651083401c6SMatthew G. Knepley     if (!label) {++Ndef; continue;}
5652083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) if (label == labelSet[l]) break;
5653083401c6SMatthew G. Knepley     if (l < Nl) continue;
5654083401c6SMatthew G. Knepley     labelSet[Nl++] = label;
5655083401c6SMatthew G. Knepley   }
5656083401c6SMatthew G. Knepley   /* Create default DS if there are no labels to intersect with */
56579566063dSJacob Faibussowitsch   PetscCall(DMGetRegionDS(dm, NULL, NULL, &dsDef));
5658083401c6SMatthew G. Knepley   if (!dsDef && Ndef && !Nl) {
5659b3cf3223SMatthew G. Knepley     IS        fields;
5660b3cf3223SMatthew G. Knepley     PetscInt *fld, nf;
5661b3cf3223SMatthew G. Knepley 
5662b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
56637a8be351SBarry Smith     PetscCheck(nf,comm, PETSC_ERR_PLIB, "All fields have labels, but we are trying to create a default DS");
56649566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nf, &fld));
5665b3cf3223SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
56669566063dSJacob Faibussowitsch     PetscCall(ISCreate(PETSC_COMM_SELF, &fields));
56679566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_"));
56689566063dSJacob Faibussowitsch     PetscCall(ISSetType(fields, ISGENERAL));
56699566063dSJacob Faibussowitsch     PetscCall(ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER));
567088f0c812SMatthew G. Knepley 
56719566063dSJacob Faibussowitsch     PetscCall(PetscDSCreate(PETSC_COMM_SELF, &dsDef));
56729566063dSJacob Faibussowitsch     PetscCall(DMSetRegionDS(dm, NULL, fields, dsDef));
56739566063dSJacob Faibussowitsch     PetscCall(PetscDSDestroy(&dsDef));
56749566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&fields));
56752df9ee95SMatthew G. Knepley   }
56769566063dSJacob Faibussowitsch   PetscCall(DMGetRegionDS(dm, NULL, NULL, &dsDef));
56779566063dSJacob Faibussowitsch   if (dsDef) PetscCall(PetscDSSetCoordinateDimension(dsDef, dE));
5678083401c6SMatthew G. Knepley   /* Intersect labels with default fields */
5679083401c6SMatthew G. Knepley   if (Ndef && Nl) {
56800122748bSMatthew G. Knepley     DM              plex;
5681083401c6SMatthew G. Knepley     DMLabel         cellLabel;
5682083401c6SMatthew G. Knepley     IS              fieldIS, allcellIS, defcellIS = NULL;
5683083401c6SMatthew G. Knepley     PetscInt       *fields;
5684083401c6SMatthew G. Knepley     const PetscInt *cells;
5685083401c6SMatthew G. Knepley     PetscInt        depth, nf = 0, n, c;
56860122748bSMatthew G. Knepley 
56879566063dSJacob Faibussowitsch     PetscCall(DMConvert(dm, DMPLEX, &plex));
56889566063dSJacob Faibussowitsch     PetscCall(DMPlexGetDepth(plex, &depth));
56899566063dSJacob Faibussowitsch     PetscCall(DMGetStratumIS(plex, "dim", depth, &allcellIS));
56909566063dSJacob Faibussowitsch     if (!allcellIS) PetscCall(DMGetStratumIS(plex, "depth", depth, &allcellIS));
56915fedec97SMatthew G. Knepley     /* TODO This looks like it only works for one label */
5692083401c6SMatthew G. Knepley     for (l = 0; l < Nl; ++l) {
5693083401c6SMatthew G. Knepley       DMLabel label = labelSet[l];
5694083401c6SMatthew G. Knepley       IS      pointIS;
5695083401c6SMatthew G. Knepley 
56969566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&defcellIS));
56979566063dSJacob Faibussowitsch       PetscCall(DMLabelGetStratumIS(label, 1, &pointIS));
56989566063dSJacob Faibussowitsch       PetscCall(ISDifference(allcellIS, pointIS, &defcellIS));
56999566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&pointIS));
5700083401c6SMatthew G. Knepley     }
57019566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&allcellIS));
5702083401c6SMatthew G. Knepley 
57039566063dSJacob Faibussowitsch     PetscCall(DMLabelCreate(PETSC_COMM_SELF, "defaultCells", &cellLabel));
57049566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(defcellIS, &n));
57059566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(defcellIS, &cells));
57069566063dSJacob Faibussowitsch     for (c = 0; c < n; ++c) PetscCall(DMLabelSetValue(cellLabel, cells[c], 1));
57079566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(defcellIS, &cells));
57089566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&defcellIS));
57099566063dSJacob Faibussowitsch     PetscCall(DMPlexLabelComplete(plex, cellLabel));
5710083401c6SMatthew G. Knepley 
57119566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(Ndef, &fields));
5712083401c6SMatthew G. Knepley     for (f = 0; f < Nf; ++f) if (!dm->fields[f].label) fields[nf++] = f;
57139566063dSJacob Faibussowitsch     PetscCall(ISCreate(PETSC_COMM_SELF, &fieldIS));
57149566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptionsPrefix((PetscObject) fieldIS, "dm_fields_"));
57159566063dSJacob Faibussowitsch     PetscCall(ISSetType(fieldIS, ISGENERAL));
57169566063dSJacob Faibussowitsch     PetscCall(ISGeneralSetIndices(fieldIS, nf, fields, PETSC_OWN_POINTER));
5717083401c6SMatthew G. Knepley 
57189566063dSJacob Faibussowitsch     PetscCall(PetscDSCreate(PETSC_COMM_SELF, &dsDef));
57199566063dSJacob Faibussowitsch     PetscCall(DMSetRegionDS(dm, cellLabel, fieldIS, dsDef));
57209566063dSJacob Faibussowitsch     PetscCall(PetscDSSetCoordinateDimension(dsDef, dE));
57219566063dSJacob Faibussowitsch     PetscCall(DMLabelDestroy(&cellLabel));
57229566063dSJacob Faibussowitsch     PetscCall(PetscDSDestroy(&dsDef));
57239566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&fieldIS));
57249566063dSJacob Faibussowitsch     PetscCall(DMDestroy(&plex));
5725083401c6SMatthew G. Knepley   }
5726083401c6SMatthew G. Knepley   /* Create label DSes
5727083401c6SMatthew G. Knepley      - WE ONLY SUPPORT IDENTICAL OR DISJOINT LABELS
5728083401c6SMatthew G. Knepley   */
5729083401c6SMatthew G. Knepley   /* TODO Should check that labels are disjoint */
5730083401c6SMatthew G. Knepley   for (l = 0; l < Nl; ++l) {
5731083401c6SMatthew G. Knepley     DMLabel   label = labelSet[l];
5732083401c6SMatthew G. Knepley     PetscDS   ds;
5733083401c6SMatthew G. Knepley     IS        fields;
5734083401c6SMatthew G. Knepley     PetscInt *fld, nf;
5735083401c6SMatthew G. Knepley 
57369566063dSJacob Faibussowitsch     PetscCall(PetscDSCreate(PETSC_COMM_SELF, &ds));
5737083401c6SMatthew G. Knepley     for (f = 0, nf = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) ++nf;
57389566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nf, &fld));
5739083401c6SMatthew G. Knepley     for (f = 0, nf  = 0; f < Nf; ++f) if (label == dm->fields[f].label || !dm->fields[f].label) fld[nf++] = f;
57409566063dSJacob Faibussowitsch     PetscCall(ISCreate(PETSC_COMM_SELF, &fields));
57419566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_"));
57429566063dSJacob Faibussowitsch     PetscCall(ISSetType(fields, ISGENERAL));
57439566063dSJacob Faibussowitsch     PetscCall(ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER));
57449566063dSJacob Faibussowitsch     PetscCall(DMSetRegionDS(dm, label, fields, ds));
57459566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&fields));
57469566063dSJacob Faibussowitsch     PetscCall(PetscDSSetCoordinateDimension(ds, dE));
5747083401c6SMatthew G. Knepley     {
5748083401c6SMatthew G. Knepley       DMPolytopeType ct;
5749083401c6SMatthew G. Knepley       PetscInt       lStart, lEnd;
57505fedec97SMatthew G. Knepley       PetscBool      isCohesiveLocal = PETSC_FALSE, isCohesive;
57510122748bSMatthew G. Knepley 
57529566063dSJacob Faibussowitsch       PetscCall(DMLabelGetBounds(label, &lStart, &lEnd));
5753665f567fSMatthew G. Knepley       if (lStart >= 0) {
57549566063dSJacob Faibussowitsch         PetscCall(DMPlexGetCellType(dm, lStart, &ct));
5755412e9a14SMatthew G. Knepley         switch (ct) {
5756412e9a14SMatthew G. Knepley           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5757412e9a14SMatthew G. Knepley           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5758412e9a14SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5759412e9a14SMatthew G. Knepley           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
57605fedec97SMatthew G. Knepley             isCohesiveLocal = PETSC_TRUE;break;
5761083401c6SMatthew G. Knepley           default: break;
5762412e9a14SMatthew G. Knepley         }
5763665f567fSMatthew G. Knepley       }
57649566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&isCohesiveLocal, &isCohesive, 1, MPIU_BOOL, MPI_LOR, comm));
57655fedec97SMatthew G. Knepley       for (f = 0, nf  = 0; f < Nf; ++f) {
57665fedec97SMatthew G. Knepley         if (label == dm->fields[f].label || !dm->fields[f].label) {
57675fedec97SMatthew G. Knepley           if (label == dm->fields[f].label) {
57689566063dSJacob Faibussowitsch             PetscCall(PetscDSSetDiscretization(ds, nf, NULL));
57699566063dSJacob Faibussowitsch             PetscCall(PetscDSSetCohesive(ds, nf, isCohesive));
57705fedec97SMatthew G. Knepley           }
57715fedec97SMatthew G. Knepley           ++nf;
57725fedec97SMatthew G. Knepley         }
57735fedec97SMatthew G. Knepley       }
5774e5e52638SMatthew G. Knepley     }
57759566063dSJacob Faibussowitsch     PetscCall(PetscDSDestroy(&ds));
5776e5e52638SMatthew G. Knepley   }
57779566063dSJacob Faibussowitsch   PetscCall(PetscFree(labelSet));
5778e5e52638SMatthew G. Knepley   /* Set fields in DSes */
5779083401c6SMatthew G. Knepley   for (s = 0; s < dm->Nds; ++s) {
5780083401c6SMatthew G. Knepley     PetscDS         ds     = dm->probs[s].ds;
5781083401c6SMatthew G. Knepley     IS              fields = dm->probs[s].fields;
5782083401c6SMatthew G. Knepley     const PetscInt *fld;
57835fedec97SMatthew G. Knepley     PetscInt        nf, dsnf;
57845fedec97SMatthew G. Knepley     PetscBool       isCohesive;
5785e5e52638SMatthew G. Knepley 
57869566063dSJacob Faibussowitsch     PetscCall(PetscDSGetNumFields(ds, &dsnf));
57879566063dSJacob Faibussowitsch     PetscCall(PetscDSIsCohesive(ds, &isCohesive));
57889566063dSJacob Faibussowitsch     PetscCall(ISGetLocalSize(fields, &nf));
57899566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(fields, &fld));
5790083401c6SMatthew G. Knepley     for (f = 0; f < nf; ++f) {
5791083401c6SMatthew G. Knepley       PetscObject  disc  = dm->fields[fld[f]].disc;
57925fedec97SMatthew G. Knepley       PetscBool    isCohesiveField;
5793e5e52638SMatthew G. Knepley       PetscClassId id;
5794e5e52638SMatthew G. Knepley 
57955fedec97SMatthew G. Knepley       /* Handle DS with no fields */
57969566063dSJacob Faibussowitsch       if (dsnf) PetscCall(PetscDSGetCohesive(ds, f, &isCohesiveField));
57975fedec97SMatthew G. Knepley       /* If this is a cohesive cell, then regular fields need the lower dimensional discretization */
57989566063dSJacob Faibussowitsch       if (isCohesive && !isCohesiveField) PetscCall(PetscFEGetHeightSubspace((PetscFE) disc, 1, (PetscFE *) &disc));
57999566063dSJacob Faibussowitsch       PetscCall(PetscDSSetDiscretization(ds, f, disc));
5800083401c6SMatthew G. Knepley       /* We allow people to have placeholder fields and construct the Section by hand */
58019566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetClassId(disc, &id));
5802e5e52638SMatthew G. Knepley       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5803e5e52638SMatthew G. Knepley     }
58049566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(fields, &fld));
5805e5e52638SMatthew G. Knepley   }
5806f9244615SMatthew G. Knepley   /* Allow k-jet tabulation */
58079566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetInt(NULL, ((PetscObject) dm)->prefix, "-dm_ds_jet_degree", &k, &flg));
5808f9244615SMatthew G. Knepley   if (flg) {
58093b4aee56SMatthew G. Knepley     for (s = 0; s < dm->Nds; ++s) {
58103b4aee56SMatthew G. Knepley       PetscDS  ds = dm->probs[s].ds;
58113b4aee56SMatthew G. Knepley       PetscInt Nf, f;
58123b4aee56SMatthew G. Knepley 
58139566063dSJacob Faibussowitsch       PetscCall(PetscDSGetNumFields(ds, &Nf));
58149566063dSJacob Faibussowitsch       for (f = 0; f < Nf; ++f) PetscCall(PetscDSSetJetDegree(ds, f, k));
58153b4aee56SMatthew G. Knepley     }
5816f9244615SMatthew G. Knepley   }
5817e5e52638SMatthew G. Knepley   /* Setup DSes */
5818e5e52638SMatthew G. Knepley   if (doSetup) {
58199566063dSJacob Faibussowitsch     for (s = 0; s < dm->Nds; ++s) PetscCall(PetscDSSetUp(dm->probs[s].ds));
5820e5e52638SMatthew G. Knepley   }
5821e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5822e5e52638SMatthew G. Knepley }
5823e5e52638SMatthew G. Knepley 
5824e5e52638SMatthew G. Knepley /*@
58257f96f943SMatthew G. Knepley   DMComputeExactSolution - Compute the exact solution for a given DM, using the PetscDS information.
58267f96f943SMatthew G. Knepley 
5827f2cacb80SMatthew G. Knepley   Collective on DM
5828f2cacb80SMatthew G. Knepley 
58297f96f943SMatthew G. Knepley   Input Parameters:
58307f96f943SMatthew G. Knepley + dm   - The DM
58317f96f943SMatthew G. Knepley - time - The time
58327f96f943SMatthew G. Knepley 
58337f96f943SMatthew G. Knepley   Output Parameters:
5834f2cacb80SMatthew G. Knepley + u    - The vector will be filled with exact solution values, or NULL
5835f2cacb80SMatthew G. Knepley - u_t  - The vector will be filled with the time derivative of exact solution values, or NULL
58367f96f943SMatthew G. Knepley 
58377f96f943SMatthew G. Knepley   Note: The user must call PetscDSSetExactSolution() beforehand
58387f96f943SMatthew G. Knepley 
58397f96f943SMatthew G. Knepley   Level: developer
58407f96f943SMatthew G. Knepley 
58417f96f943SMatthew G. Knepley .seealso: PetscDSSetExactSolution()
58427f96f943SMatthew G. Knepley @*/
5843f2cacb80SMatthew G. Knepley PetscErrorCode DMComputeExactSolution(DM dm, PetscReal time, Vec u, Vec u_t)
58447f96f943SMatthew G. Knepley {
58457f96f943SMatthew G. Knepley   PetscErrorCode (**exacts)(PetscInt, PetscReal, const PetscReal x[], PetscInt, PetscScalar *u, void *ctx);
58467f96f943SMatthew G. Knepley   void            **ectxs;
58477f96f943SMatthew G. Knepley   PetscInt          Nf, Nds, s;
58487f96f943SMatthew G. Knepley 
58497f96f943SMatthew G. Knepley   PetscFunctionBegin;
5850f2cacb80SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5851f2cacb80SMatthew G. Knepley   if (u)   PetscValidHeaderSpecific(u, VEC_CLASSID, 3);
5852f2cacb80SMatthew G. Knepley   if (u_t) PetscValidHeaderSpecific(u_t, VEC_CLASSID, 4);
58539566063dSJacob Faibussowitsch   PetscCall(DMGetNumFields(dm, &Nf));
58549566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(Nf, &exacts, Nf, &ectxs));
58559566063dSJacob Faibussowitsch   PetscCall(DMGetNumDS(dm, &Nds));
58567f96f943SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
58577f96f943SMatthew G. Knepley     PetscDS         ds;
58587f96f943SMatthew G. Knepley     DMLabel         label;
58597f96f943SMatthew G. Knepley     IS              fieldIS;
58607f96f943SMatthew G. Knepley     const PetscInt *fields, id = 1;
58617f96f943SMatthew G. Knepley     PetscInt        dsNf, f;
58627f96f943SMatthew G. Knepley 
58639566063dSJacob Faibussowitsch     PetscCall(DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds));
58649566063dSJacob Faibussowitsch     PetscCall(PetscDSGetNumFields(ds, &dsNf));
58659566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(fieldIS, &fields));
58669566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(exacts, Nf));
58679566063dSJacob Faibussowitsch     PetscCall(PetscArrayzero(ectxs, Nf));
5868f2cacb80SMatthew G. Knepley     if (u) {
58697f96f943SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
58707f96f943SMatthew G. Knepley         const PetscInt field = fields[f];
58719566063dSJacob Faibussowitsch         PetscCall(PetscDSGetExactSolution(ds, field, &exacts[field], &ectxs[field]));
58727f96f943SMatthew G. Knepley       }
58739566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(fieldIS, &fields));
58747f96f943SMatthew G. Knepley       if (label) {
58759566063dSJacob Faibussowitsch         PetscCall(DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u));
58767f96f943SMatthew G. Knepley       } else {
58779566063dSJacob Faibussowitsch         PetscCall(DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u));
58787f96f943SMatthew G. Knepley       }
58797f96f943SMatthew G. Knepley     }
5880f2cacb80SMatthew G. Knepley     if (u_t) {
58819566063dSJacob Faibussowitsch       PetscCall(PetscArrayzero(exacts, Nf));
58829566063dSJacob Faibussowitsch       PetscCall(PetscArrayzero(ectxs, Nf));
5883f2cacb80SMatthew G. Knepley       for (f = 0; f < dsNf; ++f) {
5884f2cacb80SMatthew G. Knepley         const PetscInt field = fields[f];
58859566063dSJacob Faibussowitsch         PetscCall(PetscDSGetExactSolutionTimeDerivative(ds, field, &exacts[field], &ectxs[field]));
5886f2cacb80SMatthew G. Knepley       }
58879566063dSJacob Faibussowitsch       PetscCall(ISRestoreIndices(fieldIS, &fields));
5888f2cacb80SMatthew G. Knepley       if (label) {
58899566063dSJacob Faibussowitsch         PetscCall(DMProjectFunctionLabel(dm, time, label, 1, &id, 0, NULL, exacts, ectxs, INSERT_ALL_VALUES, u_t));
5890f2cacb80SMatthew G. Knepley       } else {
58919566063dSJacob Faibussowitsch         PetscCall(DMProjectFunction(dm, time, exacts, ectxs, INSERT_ALL_VALUES, u_t));
5892f2cacb80SMatthew G. Knepley       }
5893f2cacb80SMatthew G. Knepley     }
5894f2cacb80SMatthew G. Knepley   }
5895f2cacb80SMatthew G. Knepley   if (u) {
58969566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) u, "Exact Solution"));
58979566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptionsPrefix((PetscObject) u, "exact_"));
5898f2cacb80SMatthew G. Knepley   }
5899f2cacb80SMatthew G. Knepley   if (u_t) {
59009566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) u, "Exact Solution Time Derivative"));
59019566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptionsPrefix((PetscObject) u_t, "exact_t_"));
5902f2cacb80SMatthew G. Knepley   }
59039566063dSJacob Faibussowitsch   PetscCall(PetscFree2(exacts, ectxs));
59047f96f943SMatthew G. Knepley   PetscFunctionReturn(0);
59057f96f943SMatthew G. Knepley }
59067f96f943SMatthew G. Knepley 
590745480ffeSMatthew G. Knepley PetscErrorCode DMTransferDS_Internal(DM dm, DMLabel label, IS fields, PetscDS ds)
590845480ffeSMatthew G. Knepley {
590945480ffeSMatthew G. Knepley   PetscDS        dsNew;
591045480ffeSMatthew G. Knepley   DSBoundary     b;
591145480ffeSMatthew G. Knepley   PetscInt       cdim, Nf, f;
59125fedec97SMatthew G. Knepley   PetscBool      isCohesive;
591345480ffeSMatthew G. Knepley   void          *ctx;
591445480ffeSMatthew G. Knepley 
591545480ffeSMatthew G. Knepley   PetscFunctionBegin;
59169566063dSJacob Faibussowitsch   PetscCall(PetscDSCreate(PetscObjectComm((PetscObject) ds), &dsNew));
59179566063dSJacob Faibussowitsch   PetscCall(PetscDSCopyConstants(ds, dsNew));
59189566063dSJacob Faibussowitsch   PetscCall(PetscDSCopyExactSolutions(ds, dsNew));
59199566063dSJacob Faibussowitsch   PetscCall(PetscDSSelectDiscretizations(ds, PETSC_DETERMINE, NULL, dsNew));
59209566063dSJacob Faibussowitsch   PetscCall(PetscDSCopyEquations(ds, dsNew));
59219566063dSJacob Faibussowitsch   PetscCall(PetscDSGetNumFields(ds, &Nf));
592245480ffeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
59239566063dSJacob Faibussowitsch     PetscCall(PetscDSGetContext(ds, f, &ctx));
59249566063dSJacob Faibussowitsch     PetscCall(PetscDSSetContext(dsNew, f, ctx));
59259566063dSJacob Faibussowitsch     PetscCall(PetscDSGetCohesive(ds, f, &isCohesive));
59269566063dSJacob Faibussowitsch     PetscCall(PetscDSSetCohesive(dsNew, f, isCohesive));
592745480ffeSMatthew G. Knepley   }
592845480ffeSMatthew G. Knepley   if (Nf) {
59299566063dSJacob Faibussowitsch     PetscCall(PetscDSGetCoordinateDimension(ds, &cdim));
59309566063dSJacob Faibussowitsch     PetscCall(PetscDSSetCoordinateDimension(dsNew, cdim));
593145480ffeSMatthew G. Knepley   }
59329566063dSJacob Faibussowitsch   PetscCall(PetscDSCopyBoundary(ds, PETSC_DETERMINE, NULL, dsNew));
593345480ffeSMatthew G. Knepley   for (b = dsNew->boundary; b; b = b->next) {
59349566063dSJacob Faibussowitsch     PetscCall(DMGetLabel(dm, b->lname, &b->label));
593545480ffeSMatthew G. Knepley     /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
59367a8be351SBarry Smith     //PetscCheck(b->label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Label %s missing in new DM", name);
593745480ffeSMatthew G. Knepley   }
593845480ffeSMatthew G. Knepley 
59399566063dSJacob Faibussowitsch   PetscCall(DMSetRegionDS(dm, label, fields, dsNew));
59409566063dSJacob Faibussowitsch   PetscCall(PetscDSDestroy(&dsNew));
594145480ffeSMatthew G. Knepley   PetscFunctionReturn(0);
594245480ffeSMatthew G. Knepley }
594345480ffeSMatthew G. Knepley 
59447f96f943SMatthew G. Knepley /*@
5945e5e52638SMatthew G. Knepley   DMCopyDS - Copy the discrete systems for the DM into another DM
5946e5e52638SMatthew G. Knepley 
5947d083f849SBarry Smith   Collective on dm
5948e5e52638SMatthew G. Knepley 
5949e5e52638SMatthew G. Knepley   Input Parameter:
5950e5e52638SMatthew G. Knepley . dm - The DM
5951e5e52638SMatthew G. Knepley 
5952e5e52638SMatthew G. Knepley   Output Parameter:
5953e5e52638SMatthew G. Knepley . newdm - The DM
5954e5e52638SMatthew G. Knepley 
5955e5e52638SMatthew G. Knepley   Level: advanced
5956e5e52638SMatthew G. Knepley 
5957e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5958e5e52638SMatthew G. Knepley @*/
5959e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDS(DM dm, DM newdm)
5960e5e52638SMatthew G. Knepley {
5961e5e52638SMatthew G. Knepley   PetscInt       Nds, s;
5962e5e52638SMatthew G. Knepley 
5963e5e52638SMatthew G. Knepley   PetscFunctionBegin;
5964e5e52638SMatthew G. Knepley   if (dm == newdm) PetscFunctionReturn(0);
59659566063dSJacob Faibussowitsch   PetscCall(DMGetNumDS(dm, &Nds));
59669566063dSJacob Faibussowitsch   PetscCall(DMClearDS(newdm));
5967e5e52638SMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
5968e5e52638SMatthew G. Knepley     DMLabel  label;
5969b3cf3223SMatthew G. Knepley     IS       fields;
597045480ffeSMatthew G. Knepley     PetscDS  ds, newds;
5971783e2ec8SMatthew G. Knepley     PetscInt Nbd, bd;
5972e5e52638SMatthew G. Knepley 
59739566063dSJacob Faibussowitsch     PetscCall(DMGetRegionNumDS(dm, s, &label, &fields, &ds));
5974b8025e53SMatthew G. Knepley     /* TODO: We need to change all keys from labels in the old DM to labels in the new DM */
59759566063dSJacob Faibussowitsch     PetscCall(DMTransferDS_Internal(newdm, label, fields, ds));
597645480ffeSMatthew G. Knepley     /* Commplete new labels in the new DS */
59779566063dSJacob Faibussowitsch     PetscCall(DMGetRegionDS(newdm, label, NULL, &newds));
59789566063dSJacob Faibussowitsch     PetscCall(PetscDSGetNumBoundary(newds, &Nbd));
5979783e2ec8SMatthew G. Knepley     for (bd = 0; bd < Nbd; ++bd) {
5980b8025e53SMatthew G. Knepley       PetscWeakForm wf;
598145480ffeSMatthew G. Knepley       DMLabel       label;
5982783e2ec8SMatthew G. Knepley       PetscInt      field;
5983783e2ec8SMatthew G. Knepley 
59849566063dSJacob Faibussowitsch       PetscCall(PetscDSGetBoundary(newds, bd, &wf, NULL, NULL, &label, NULL, NULL, &field, NULL, NULL, NULL, NULL, NULL));
59859566063dSJacob Faibussowitsch       PetscCall(DMCompleteBoundaryLabel_Internal(newdm, newds, field, bd, label));
59869566063dSJacob Faibussowitsch       PetscCall(PetscWeakFormReplaceLabel(wf, label));
5987783e2ec8SMatthew G. Knepley     }
5988e5e52638SMatthew G. Knepley   }
5989e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
5990e5e52638SMatthew G. Knepley }
5991e5e52638SMatthew G. Knepley 
5992e5e52638SMatthew G. Knepley /*@
5993e5e52638SMatthew G. Knepley   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
5994e5e52638SMatthew G. Knepley 
5995d083f849SBarry Smith   Collective on dm
5996e5e52638SMatthew G. Knepley 
5997e5e52638SMatthew G. Knepley   Input Parameter:
5998e5e52638SMatthew G. Knepley . dm - The DM
5999e5e52638SMatthew G. Knepley 
6000e5e52638SMatthew G. Knepley   Output Parameter:
6001e5e52638SMatthew G. Knepley . newdm - The DM
6002e5e52638SMatthew G. Knepley 
6003e5e52638SMatthew G. Knepley   Level: advanced
6004e5e52638SMatthew G. Knepley 
6005e5e52638SMatthew G. Knepley .seealso: DMCopyFields(), DMCopyDS()
6006e5e52638SMatthew G. Knepley @*/
6007e5e52638SMatthew G. Knepley PetscErrorCode DMCopyDisc(DM dm, DM newdm)
6008e5e52638SMatthew G. Knepley {
6009e5e52638SMatthew G. Knepley   PetscFunctionBegin;
60109566063dSJacob Faibussowitsch   PetscCall(DMCopyFields(dm, newdm));
60119566063dSJacob Faibussowitsch   PetscCall(DMCopyDS(dm, newdm));
6012e5e52638SMatthew G. Knepley   PetscFunctionReturn(0);
6013e5e52638SMatthew G. Knepley }
6014e5e52638SMatthew G. Knepley 
6015b64e0483SPeter Brune PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
6016b64e0483SPeter Brune {
6017b64e0483SPeter Brune   DM dm_coord,dmc_coord;
6018b64e0483SPeter Brune   Vec coords,ccoords;
60196dbf9973SLawrence Mitchell   Mat inject;
6020b64e0483SPeter Brune   PetscFunctionBegin;
60219566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dm,&dm_coord));
60229566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dmc,&dmc_coord));
60239566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinates(dm,&coords));
60249566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinates(dmc,&ccoords));
6025b64e0483SPeter Brune   if (coords && !ccoords) {
60269566063dSJacob Faibussowitsch     PetscCall(DMCreateGlobalVector(dmc_coord,&ccoords));
60279566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)ccoords,"coordinates"));
60289566063dSJacob Faibussowitsch     PetscCall(DMCreateInjection(dmc_coord,dm_coord,&inject));
60299566063dSJacob Faibussowitsch     PetscCall(MatRestrict(inject,coords,ccoords));
60309566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&inject));
60319566063dSJacob Faibussowitsch     PetscCall(DMSetCoordinates(dmc,ccoords));
60329566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ccoords));
6033b64e0483SPeter Brune   }
6034b64e0483SPeter Brune   PetscFunctionReturn(0);
6035b64e0483SPeter Brune }
6036b64e0483SPeter Brune 
603703dadc2fSPeter Brune static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
603803dadc2fSPeter Brune {
603903dadc2fSPeter Brune   DM dm_coord,subdm_coord;
604003dadc2fSPeter Brune   Vec coords,ccoords,clcoords;
604103dadc2fSPeter Brune   VecScatter *scat_i,*scat_g;
604203dadc2fSPeter Brune   PetscFunctionBegin;
60439566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dm,&dm_coord));
60449566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(subdm,&subdm_coord));
60459566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinates(dm,&coords));
60469566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinates(subdm,&ccoords));
604703dadc2fSPeter Brune   if (coords && !ccoords) {
60489566063dSJacob Faibussowitsch     PetscCall(DMCreateGlobalVector(subdm_coord,&ccoords));
60499566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)ccoords,"coordinates"));
60509566063dSJacob Faibussowitsch     PetscCall(DMCreateLocalVector(subdm_coord,&clcoords));
60519566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)clcoords,"coordinates"));
60529566063dSJacob Faibussowitsch     PetscCall(DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g));
60539566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD));
60549566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD));
60559566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD));
60569566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD));
60579566063dSJacob Faibussowitsch     PetscCall(DMSetCoordinates(subdm,ccoords));
60589566063dSJacob Faibussowitsch     PetscCall(DMSetCoordinatesLocal(subdm,clcoords));
60599566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&scat_i[0]));
60609566063dSJacob Faibussowitsch     PetscCall(VecScatterDestroy(&scat_g[0]));
60619566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ccoords));
60629566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&clcoords));
60639566063dSJacob Faibussowitsch     PetscCall(PetscFree(scat_i));
60649566063dSJacob Faibussowitsch     PetscCall(PetscFree(scat_g));
606503dadc2fSPeter Brune   }
606603dadc2fSPeter Brune   PetscFunctionReturn(0);
606703dadc2fSPeter Brune }
606803dadc2fSPeter Brune 
6069c73cfb54SMatthew G. Knepley /*@
6070c73cfb54SMatthew G. Knepley   DMGetDimension - Return the topological dimension of the DM
6071c73cfb54SMatthew G. Knepley 
6072c73cfb54SMatthew G. Knepley   Not collective
6073c73cfb54SMatthew G. Knepley 
6074c73cfb54SMatthew G. Knepley   Input Parameter:
6075c73cfb54SMatthew G. Knepley . dm - The DM
6076c73cfb54SMatthew G. Knepley 
6077c73cfb54SMatthew G. Knepley   Output Parameter:
6078c73cfb54SMatthew G. Knepley . dim - The topological dimension
6079c73cfb54SMatthew G. Knepley 
6080c73cfb54SMatthew G. Knepley   Level: beginner
6081c73cfb54SMatthew G. Knepley 
6082c73cfb54SMatthew G. Knepley .seealso: DMSetDimension(), DMCreate()
6083c73cfb54SMatthew G. Knepley @*/
6084c73cfb54SMatthew G. Knepley PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
6085c73cfb54SMatthew G. Knepley {
6086c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6087c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6088534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
6089c73cfb54SMatthew G. Knepley   *dim = dm->dim;
6090c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6091c73cfb54SMatthew G. Knepley }
6092c73cfb54SMatthew G. Knepley 
6093c73cfb54SMatthew G. Knepley /*@
6094c73cfb54SMatthew G. Knepley   DMSetDimension - Set the topological dimension of the DM
6095c73cfb54SMatthew G. Knepley 
6096c73cfb54SMatthew G. Knepley   Collective on dm
6097c73cfb54SMatthew G. Knepley 
6098c73cfb54SMatthew G. Knepley   Input Parameters:
6099c73cfb54SMatthew G. Knepley + dm - The DM
6100c73cfb54SMatthew G. Knepley - dim - The topological dimension
6101c73cfb54SMatthew G. Knepley 
6102c73cfb54SMatthew G. Knepley   Level: beginner
6103c73cfb54SMatthew G. Knepley 
6104c73cfb54SMatthew G. Knepley .seealso: DMGetDimension(), DMCreate()
6105c73cfb54SMatthew G. Knepley @*/
6106c73cfb54SMatthew G. Knepley PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
6107c73cfb54SMatthew G. Knepley {
6108e5e52638SMatthew G. Knepley   PetscDS        ds;
610945480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6110f17e8794SMatthew G. Knepley 
6111c73cfb54SMatthew G. Knepley   PetscFunctionBegin;
6112c73cfb54SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6113c73cfb54SMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, dim, 2);
6114c73cfb54SMatthew G. Knepley   dm->dim = dim;
6115d17bd122SMatthew G. Knepley   if (dm->dim >= 0) {
61169566063dSJacob Faibussowitsch     PetscCall(DMGetNumDS(dm, &Nds));
611745480ffeSMatthew G. Knepley     for (n = 0; n < Nds; ++n) {
61189566063dSJacob Faibussowitsch       PetscCall(DMGetRegionNumDS(dm, n, NULL, NULL, &ds));
61199566063dSJacob Faibussowitsch       if (ds->dimEmbed < 0) PetscCall(PetscDSSetCoordinateDimension(ds, dim));
612045480ffeSMatthew G. Knepley     }
6121d17bd122SMatthew G. Knepley   }
6122c73cfb54SMatthew G. Knepley   PetscFunctionReturn(0);
6123c73cfb54SMatthew G. Knepley }
6124c73cfb54SMatthew G. Knepley 
6125793f3fe5SMatthew G. Knepley /*@
6126793f3fe5SMatthew G. Knepley   DMGetDimPoints - Get the half-open interval for all points of a given dimension
6127793f3fe5SMatthew G. Knepley 
6128d083f849SBarry Smith   Collective on dm
6129793f3fe5SMatthew G. Knepley 
6130793f3fe5SMatthew G. Knepley   Input Parameters:
6131793f3fe5SMatthew G. Knepley + dm - the DM
6132793f3fe5SMatthew G. Knepley - dim - the dimension
6133793f3fe5SMatthew G. Knepley 
6134793f3fe5SMatthew G. Knepley   Output Parameters:
6135793f3fe5SMatthew G. Knepley + pStart - The first point of the given dimension
6136aa049354SPatrick Sanan - pEnd - The first point following points of the given dimension
6137793f3fe5SMatthew G. Knepley 
6138793f3fe5SMatthew G. Knepley   Note:
6139793f3fe5SMatthew G. Knepley   The points are vertices in the Hasse diagram encoding the topology. This is explained in
6140a8d69d7bSBarry Smith   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
6141793f3fe5SMatthew G. Knepley   then the interval is empty.
6142793f3fe5SMatthew G. Knepley 
6143793f3fe5SMatthew G. Knepley   Level: intermediate
6144793f3fe5SMatthew G. Knepley 
6145793f3fe5SMatthew G. Knepley .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
6146793f3fe5SMatthew G. Knepley @*/
6147793f3fe5SMatthew G. Knepley PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
6148793f3fe5SMatthew G. Knepley {
6149793f3fe5SMatthew G. Knepley   PetscInt       d;
6150793f3fe5SMatthew G. Knepley 
6151793f3fe5SMatthew G. Knepley   PetscFunctionBegin;
6152793f3fe5SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
61539566063dSJacob Faibussowitsch   PetscCall(DMGetDimension(dm, &d));
61547a8be351SBarry Smith   PetscCheck((dim >= 0) && (dim <= d),PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %" PetscInt_FMT, dim);
61557a8be351SBarry Smith   PetscCheck(dm->ops->getdimpoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
61569566063dSJacob Faibussowitsch   PetscCall((*dm->ops->getdimpoints)(dm, dim, pStart, pEnd));
6157793f3fe5SMatthew G. Knepley   PetscFunctionReturn(0);
6158793f3fe5SMatthew G. Knepley }
6159793f3fe5SMatthew G. Knepley 
61606636e97aSMatthew G Knepley /*@
61616636e97aSMatthew G Knepley   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
61626636e97aSMatthew G Knepley 
6163d083f849SBarry Smith   Collective on dm
61646636e97aSMatthew G Knepley 
61656636e97aSMatthew G Knepley   Input Parameters:
61666636e97aSMatthew G Knepley + dm - the DM
61676636e97aSMatthew G Knepley - c - coordinate vector
61686636e97aSMatthew G Knepley 
61692dd40e9bSPatrick Sanan   Notes:
61702dd40e9bSPatrick Sanan   The coordinates do include those for ghost points, which are in the local vector.
61712dd40e9bSPatrick Sanan 
61722dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
61736636e97aSMatthew G Knepley 
61746636e97aSMatthew G Knepley   Level: intermediate
61756636e97aSMatthew G Knepley 
617660c22052SBarry Smith .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
61776636e97aSMatthew G Knepley @*/
61786636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinates(DM dm, Vec c)
61796636e97aSMatthew G Knepley {
61806636e97aSMatthew G Knepley   PetscFunctionBegin;
61816636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
618210f43869SStefano Zampini   if (c) PetscValidHeaderSpecific(c,VEC_CLASSID,2);
61839566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) c));
61849566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&dm->coordinates));
61856636e97aSMatthew G Knepley   dm->coordinates = c;
61869566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&dm->coordinatesLocal));
61879566063dSJacob Faibussowitsch   PetscCall(DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL));
61889566063dSJacob Faibussowitsch   PetscCall(DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL));
61896636e97aSMatthew G Knepley   PetscFunctionReturn(0);
61906636e97aSMatthew G Knepley }
61916636e97aSMatthew G Knepley 
61926636e97aSMatthew G Knepley /*@
61936636e97aSMatthew G Knepley   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
61946636e97aSMatthew G Knepley 
61957058e716SVaclav Hapla   Not collective
61966636e97aSMatthew G Knepley 
61976636e97aSMatthew G Knepley    Input Parameters:
61986636e97aSMatthew G Knepley +  dm - the DM
61996636e97aSMatthew G Knepley -  c - coordinate vector
62006636e97aSMatthew G Knepley 
62012dd40e9bSPatrick Sanan   Notes:
62026636e97aSMatthew G Knepley   The coordinates of ghost points can be set using DMSetCoordinates()
62036636e97aSMatthew G Knepley   followed by DMGetCoordinatesLocal(). This is intended to enable the
62046636e97aSMatthew G Knepley   setting of ghost coordinates outside of the domain.
62056636e97aSMatthew G Knepley 
62062dd40e9bSPatrick Sanan   The vector c should be destroyed by the caller.
62072dd40e9bSPatrick Sanan 
62086636e97aSMatthew G Knepley   Level: intermediate
62096636e97aSMatthew G Knepley 
62106636e97aSMatthew G Knepley .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
62116636e97aSMatthew G Knepley @*/
62126636e97aSMatthew G Knepley PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
62136636e97aSMatthew G Knepley {
62146636e97aSMatthew G Knepley   PetscFunctionBegin;
62156636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6216b7f5c055SJed Brown   if (c) PetscValidHeaderSpecific(c,VEC_CLASSID,2);
62179566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) c));
62189566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&dm->coordinatesLocal));
62198865f1eaSKarl Rupp 
62206636e97aSMatthew G Knepley   dm->coordinatesLocal = c;
62218865f1eaSKarl Rupp 
62229566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&dm->coordinates));
62236636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62246636e97aSMatthew G Knepley }
62256636e97aSMatthew G Knepley 
62266636e97aSMatthew G Knepley /*@
62276636e97aSMatthew G Knepley   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
62286636e97aSMatthew G Knepley 
6229d083f849SBarry Smith   Collective on dm
62306636e97aSMatthew G Knepley 
62316636e97aSMatthew G Knepley   Input Parameter:
62326636e97aSMatthew G Knepley . dm - the DM
62336636e97aSMatthew G Knepley 
62346636e97aSMatthew G Knepley   Output Parameter:
62356636e97aSMatthew G Knepley . c - global coordinate vector
62366636e97aSMatthew G Knepley 
62376636e97aSMatthew G Knepley   Note:
623860c22052SBarry Smith   This is a borrowed reference, so the user should NOT destroy this vector. When the DM is
623960c22052SBarry Smith   destroyed the array will no longer be valid.
62406636e97aSMatthew G Knepley 
6241959c7569SPatrick Sanan   Each process has only the locally-owned portion of the global coordinates (does NOT have the ghost coordinates).
62426636e97aSMatthew G Knepley 
62436636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
62446636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
62456636e97aSMatthew G Knepley 
62466636e97aSMatthew G Knepley   Level: intermediate
62476636e97aSMatthew G Knepley 
624860c22052SBarry Smith .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMDASetUniformCoordinates()
62496636e97aSMatthew G Knepley @*/
62506636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
62516636e97aSMatthew G Knepley {
62526636e97aSMatthew G Knepley   PetscFunctionBegin;
62536636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
62546636e97aSMatthew G Knepley   PetscValidPointer(c,2);
62551f588964SMatthew G Knepley   if (!dm->coordinates && dm->coordinatesLocal) {
62560298fd71SBarry Smith     DM        cdm = NULL;
62571970a576SMatthew G. Knepley     PetscBool localized;
62586636e97aSMatthew G Knepley 
62599566063dSJacob Faibussowitsch     PetscCall(DMGetCoordinateDM(dm, &cdm));
62609566063dSJacob Faibussowitsch     PetscCall(DMCreateGlobalVector(cdm, &dm->coordinates));
62619566063dSJacob Faibussowitsch     PetscCall(DMGetCoordinatesLocalized(dm, &localized));
62621970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
62631970a576SMatthew G. Knepley     if (localized) {
62641970a576SMatthew G. Knepley       PetscInt cdim;
62651970a576SMatthew G. Knepley 
62669566063dSJacob Faibussowitsch       PetscCall(DMGetCoordinateDim(dm, &cdim));
62679566063dSJacob Faibussowitsch       PetscCall(VecSetBlockSize(dm->coordinates, cdim));
62681970a576SMatthew G. Knepley     }
62699566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) dm->coordinates, "coordinates"));
62709566063dSJacob Faibussowitsch     PetscCall(DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates));
62719566063dSJacob Faibussowitsch     PetscCall(DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates));
62726636e97aSMatthew G Knepley   }
62736636e97aSMatthew G Knepley   *c = dm->coordinates;
62746636e97aSMatthew G Knepley   PetscFunctionReturn(0);
62756636e97aSMatthew G Knepley }
62766636e97aSMatthew G Knepley 
62776636e97aSMatthew G Knepley /*@
627881e9a530SVaclav Hapla   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
627981e9a530SVaclav Hapla 
6280d083f849SBarry Smith   Collective on dm
628181e9a530SVaclav Hapla 
628281e9a530SVaclav Hapla   Input Parameter:
628381e9a530SVaclav Hapla . dm - the DM
628481e9a530SVaclav Hapla 
628581e9a530SVaclav Hapla   Level: advanced
628681e9a530SVaclav Hapla 
628781e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalNoncollective()
628881e9a530SVaclav Hapla @*/
628981e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
629081e9a530SVaclav Hapla {
629181e9a530SVaclav Hapla   PetscFunctionBegin;
629281e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
629381e9a530SVaclav Hapla   if (!dm->coordinatesLocal && dm->coordinates) {
62941970a576SMatthew G. Knepley     DM        cdm = NULL;
62951970a576SMatthew G. Knepley     PetscBool localized;
62961970a576SMatthew G. Knepley 
62979566063dSJacob Faibussowitsch     PetscCall(DMGetCoordinateDM(dm, &cdm));
62989566063dSJacob Faibussowitsch     PetscCall(DMCreateLocalVector(cdm, &dm->coordinatesLocal));
62999566063dSJacob Faibussowitsch     PetscCall(DMGetCoordinatesLocalized(dm, &localized));
63001970a576SMatthew G. Knepley     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
63011970a576SMatthew G. Knepley     if (localized) {
63021970a576SMatthew G. Knepley       PetscInt cdim;
63031970a576SMatthew G. Knepley 
63049566063dSJacob Faibussowitsch       PetscCall(DMGetCoordinateDim(dm, &cdim));
63059566063dSJacob Faibussowitsch       PetscCall(VecSetBlockSize(dm->coordinates, cdim));
63061970a576SMatthew G. Knepley     }
63079566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates"));
63089566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal));
63099566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal));
631081e9a530SVaclav Hapla   }
631181e9a530SVaclav Hapla   PetscFunctionReturn(0);
631281e9a530SVaclav Hapla }
631381e9a530SVaclav Hapla 
631481e9a530SVaclav Hapla /*@
63156636e97aSMatthew G Knepley   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
63166636e97aSMatthew G Knepley 
6317d083f849SBarry Smith   Collective on dm
63186636e97aSMatthew G Knepley 
63196636e97aSMatthew G Knepley   Input Parameter:
63206636e97aSMatthew G Knepley . dm - the DM
63216636e97aSMatthew G Knepley 
63226636e97aSMatthew G Knepley   Output Parameter:
63236636e97aSMatthew G Knepley . c - coordinate vector
63246636e97aSMatthew G Knepley 
63256636e97aSMatthew G Knepley   Note:
63266636e97aSMatthew G Knepley   This is a borrowed reference, so the user should NOT destroy this vector
63276636e97aSMatthew G Knepley 
63286636e97aSMatthew G Knepley   Each process has the local and ghost coordinates
63296636e97aSMatthew G Knepley 
63306636e97aSMatthew G Knepley   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63316636e97aSMatthew G Knepley   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63326636e97aSMatthew G Knepley 
63336636e97aSMatthew G Knepley   Level: intermediate
63346636e97aSMatthew G Knepley 
633581e9a530SVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
63366636e97aSMatthew G Knepley @*/
63376636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
63386636e97aSMatthew G Knepley {
63396636e97aSMatthew G Knepley   PetscFunctionBegin;
63406636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
63416636e97aSMatthew G Knepley   PetscValidPointer(c,2);
63429566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinatesLocalSetUp(dm));
63436636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
63446636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63456636e97aSMatthew G Knepley }
63466636e97aSMatthew G Knepley 
634781e9a530SVaclav Hapla /*@
634881e9a530SVaclav Hapla   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
634981e9a530SVaclav Hapla 
635081e9a530SVaclav Hapla   Not collective
635181e9a530SVaclav Hapla 
635281e9a530SVaclav Hapla   Input Parameter:
635381e9a530SVaclav Hapla . dm - the DM
635481e9a530SVaclav Hapla 
635581e9a530SVaclav Hapla   Output Parameter:
635681e9a530SVaclav Hapla . c - coordinate vector
635781e9a530SVaclav Hapla 
635881e9a530SVaclav Hapla   Level: advanced
635981e9a530SVaclav Hapla 
636081e9a530SVaclav Hapla .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
636181e9a530SVaclav Hapla @*/
636281e9a530SVaclav Hapla PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
636381e9a530SVaclav Hapla {
636481e9a530SVaclav Hapla   PetscFunctionBegin;
636581e9a530SVaclav Hapla   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
636681e9a530SVaclav Hapla   PetscValidPointer(c,2);
63677a8be351SBarry Smith   PetscCheck(dm->coordinatesLocal || !dm->coordinates,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
63686636e97aSMatthew G Knepley   *c = dm->coordinatesLocal;
63696636e97aSMatthew G Knepley   PetscFunctionReturn(0);
63706636e97aSMatthew G Knepley }
63716636e97aSMatthew G Knepley 
63722db98f8dSVaclav Hapla /*@
63732db98f8dSVaclav Hapla   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
63742db98f8dSVaclav Hapla 
63752db98f8dSVaclav Hapla   Not collective
63762db98f8dSVaclav Hapla 
6377d8d19677SJose E. Roman   Input Parameters:
63782db98f8dSVaclav Hapla + dm - the DM
63792db98f8dSVaclav Hapla - p - the IS of points whose coordinates will be returned
63802db98f8dSVaclav Hapla 
6381d8d19677SJose E. Roman   Output Parameters:
63822db98f8dSVaclav Hapla + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
63832db98f8dSVaclav Hapla - pCoord - the Vec with coordinates of points in p
63842db98f8dSVaclav Hapla 
63852db98f8dSVaclav Hapla   Note:
63862db98f8dSVaclav Hapla   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
63872db98f8dSVaclav Hapla 
63882db98f8dSVaclav Hapla   This creates a new vector, so the user SHOULD destroy this vector
63892db98f8dSVaclav Hapla 
63902db98f8dSVaclav Hapla   Each process has the local and ghost coordinates
63912db98f8dSVaclav Hapla 
63922db98f8dSVaclav Hapla   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
63932db98f8dSVaclav Hapla   and (x_0,y_0,z_0,x_1,y_1,z_1...)
63942db98f8dSVaclav Hapla 
63952db98f8dSVaclav Hapla   Level: advanced
63962db98f8dSVaclav Hapla 
63972db98f8dSVaclav Hapla .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
63982db98f8dSVaclav Hapla @*/
63992db98f8dSVaclav Hapla PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
64002db98f8dSVaclav Hapla {
64012db98f8dSVaclav Hapla   PetscSection        cs, newcs;
64022db98f8dSVaclav Hapla   Vec                 coords;
64032db98f8dSVaclav Hapla   const PetscScalar   *arr;
64042db98f8dSVaclav Hapla   PetscScalar         *newarr=NULL;
64052db98f8dSVaclav Hapla   PetscInt            n;
64062db98f8dSVaclav Hapla 
64072db98f8dSVaclav Hapla   PetscFunctionBegin;
64082db98f8dSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
64092db98f8dSVaclav Hapla   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
64102db98f8dSVaclav Hapla   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
64112db98f8dSVaclav Hapla   if (pCoord) PetscValidPointer(pCoord, 4);
64127a8be351SBarry Smith   PetscCheck(dm->coordinatesLocal,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
64137a8be351SBarry Smith   PetscCheck(dm->coordinateDM && dm->coordinateDM->localSection,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
64141bb6d2a8SBarry Smith   cs = dm->coordinateDM->localSection;
64152db98f8dSVaclav Hapla   coords = dm->coordinatesLocal;
64169566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(coords, &arr));
64179566063dSJacob Faibussowitsch   PetscCall(PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL));
64189566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(coords, &arr));
64192db98f8dSVaclav Hapla   if (pCoord) {
64209566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetStorageSize(newcs, &n));
64212db98f8dSVaclav Hapla     /* set array in two steps to mimic PETSC_OWN_POINTER */
64229566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord));
64239566063dSJacob Faibussowitsch     PetscCall(VecReplaceArray(*pCoord, newarr));
6424ad9ac99dSVaclav Hapla   } else {
64259566063dSJacob Faibussowitsch     PetscCall(PetscFree(newarr));
64262db98f8dSVaclav Hapla   }
6427ad9ac99dSVaclav Hapla   if (pCoordSection) {*pCoordSection = newcs;}
64289566063dSJacob Faibussowitsch   else               PetscCall(PetscSectionDestroy(&newcs));
64292db98f8dSVaclav Hapla   PetscFunctionReturn(0);
64302db98f8dSVaclav Hapla }
64312db98f8dSVaclav Hapla 
6432f19dbd58SToby Isaac PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
6433f19dbd58SToby Isaac {
6434f19dbd58SToby Isaac   PetscFunctionBegin;
6435f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6436f19dbd58SToby Isaac   PetscValidPointer(field,2);
6437f19dbd58SToby Isaac   if (!dm->coordinateField) {
6438f19dbd58SToby Isaac     if (dm->ops->createcoordinatefield) {
64399566063dSJacob Faibussowitsch       PetscCall((*dm->ops->createcoordinatefield)(dm,&dm->coordinateField));
6440f19dbd58SToby Isaac     }
6441f19dbd58SToby Isaac   }
6442f19dbd58SToby Isaac   *field = dm->coordinateField;
6443f19dbd58SToby Isaac   PetscFunctionReturn(0);
6444f19dbd58SToby Isaac }
6445f19dbd58SToby Isaac 
6446f19dbd58SToby Isaac PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
6447f19dbd58SToby Isaac {
6448f19dbd58SToby Isaac   PetscFunctionBegin;
6449f19dbd58SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6450f19dbd58SToby Isaac   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
64519566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)field));
64529566063dSJacob Faibussowitsch   PetscCall(DMFieldDestroy(&dm->coordinateField));
6453f19dbd58SToby Isaac   dm->coordinateField = field;
6454f19dbd58SToby Isaac   PetscFunctionReturn(0);
6455f19dbd58SToby Isaac }
6456f19dbd58SToby Isaac 
64576636e97aSMatthew G Knepley /*@
64581cfe2091SMatthew G. Knepley   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
64596636e97aSMatthew G Knepley 
6460d083f849SBarry Smith   Collective on dm
64616636e97aSMatthew G Knepley 
64626636e97aSMatthew G Knepley   Input Parameter:
64636636e97aSMatthew G Knepley . dm - the DM
64646636e97aSMatthew G Knepley 
64656636e97aSMatthew G Knepley   Output Parameter:
64666636e97aSMatthew G Knepley . cdm - coordinate DM
64676636e97aSMatthew G Knepley 
64686636e97aSMatthew G Knepley   Level: intermediate
64696636e97aSMatthew G Knepley 
64701cfe2091SMatthew G. Knepley .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
64716636e97aSMatthew G Knepley @*/
64726636e97aSMatthew G Knepley PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
64736636e97aSMatthew G Knepley {
64746636e97aSMatthew G Knepley   PetscFunctionBegin;
64756636e97aSMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
64766636e97aSMatthew G Knepley   PetscValidPointer(cdm,2);
64776636e97aSMatthew G Knepley   if (!dm->coordinateDM) {
6478308f8a94SToby Isaac     DM cdm;
6479308f8a94SToby Isaac 
64807a8be351SBarry Smith     PetscCheck(dm->ops->createcoordinatedm,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
64819566063dSJacob Faibussowitsch     PetscCall((*dm->ops->createcoordinatedm)(dm, &cdm));
64829566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject)cdm, "coordinateDM"));
6483308f8a94SToby Isaac     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
6484308f8a94SToby Isaac      * until the call to CreateCoordinateDM) */
64859566063dSJacob Faibussowitsch     PetscCall(DMDestroy(&dm->coordinateDM));
6486308f8a94SToby Isaac     dm->coordinateDM = cdm;
64876636e97aSMatthew G Knepley   }
64886636e97aSMatthew G Knepley   *cdm = dm->coordinateDM;
64896636e97aSMatthew G Knepley   PetscFunctionReturn(0);
64906636e97aSMatthew G Knepley }
6491e87bb0d3SMatthew G Knepley 
64921cfe2091SMatthew G. Knepley /*@
64931cfe2091SMatthew G. Knepley   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
64941cfe2091SMatthew G. Knepley 
6495d083f849SBarry Smith   Logically Collective on dm
64961cfe2091SMatthew G. Knepley 
64971cfe2091SMatthew G. Knepley   Input Parameters:
64981cfe2091SMatthew G. Knepley + dm - the DM
64991cfe2091SMatthew G. Knepley - cdm - coordinate DM
65001cfe2091SMatthew G. Knepley 
65011cfe2091SMatthew G. Knepley   Level: intermediate
65021cfe2091SMatthew G. Knepley 
65031cfe2091SMatthew G. Knepley .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
65041cfe2091SMatthew G. Knepley @*/
65051cfe2091SMatthew G. Knepley PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
65061cfe2091SMatthew G. Knepley {
65071cfe2091SMatthew G. Knepley   PetscFunctionBegin;
65081cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
65091cfe2091SMatthew G. Knepley   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
65109566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)cdm));
65119566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&dm->coordinateDM));
65121cfe2091SMatthew G. Knepley   dm->coordinateDM = cdm;
65131cfe2091SMatthew G. Knepley   PetscFunctionReturn(0);
65141cfe2091SMatthew G. Knepley }
65151cfe2091SMatthew G. Knepley 
651646e270d4SMatthew G. Knepley /*@
651746e270d4SMatthew G. Knepley   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
651846e270d4SMatthew G. Knepley 
651946e270d4SMatthew G. Knepley   Not Collective
652046e270d4SMatthew G. Knepley 
652146e270d4SMatthew G. Knepley   Input Parameter:
652246e270d4SMatthew G. Knepley . dm - The DM object
652346e270d4SMatthew G. Knepley 
652446e270d4SMatthew G. Knepley   Output Parameter:
652546e270d4SMatthew G. Knepley . dim - The embedding dimension
652646e270d4SMatthew G. Knepley 
652746e270d4SMatthew G. Knepley   Level: intermediate
652846e270d4SMatthew G. Knepley 
652992fd8e1eSJed Brown .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
653046e270d4SMatthew G. Knepley @*/
653146e270d4SMatthew G. Knepley PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
653246e270d4SMatthew G. Knepley {
653346e270d4SMatthew G. Knepley   PetscFunctionBegin;
653446e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6535534a8f05SLisandro Dalcin   PetscValidIntPointer(dim, 2);
65369a9a41abSToby Isaac   if (dm->dimEmbed == PETSC_DEFAULT) {
65379a9a41abSToby Isaac     dm->dimEmbed = dm->dim;
65389a9a41abSToby Isaac   }
653946e270d4SMatthew G. Knepley   *dim = dm->dimEmbed;
654046e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
654146e270d4SMatthew G. Knepley }
654246e270d4SMatthew G. Knepley 
654346e270d4SMatthew G. Knepley /*@
654446e270d4SMatthew G. Knepley   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
654546e270d4SMatthew G. Knepley 
654646e270d4SMatthew G. Knepley   Not Collective
654746e270d4SMatthew G. Knepley 
654846e270d4SMatthew G. Knepley   Input Parameters:
654946e270d4SMatthew G. Knepley + dm  - The DM object
655046e270d4SMatthew G. Knepley - dim - The embedding dimension
655146e270d4SMatthew G. Knepley 
655246e270d4SMatthew G. Knepley   Level: intermediate
655346e270d4SMatthew G. Knepley 
655492fd8e1eSJed Brown .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
655546e270d4SMatthew G. Knepley @*/
655646e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
655746e270d4SMatthew G. Knepley {
6558e5e52638SMatthew G. Knepley   PetscDS        ds;
655945480ffeSMatthew G. Knepley   PetscInt       Nds, n;
6560f17e8794SMatthew G. Knepley 
656146e270d4SMatthew G. Knepley   PetscFunctionBegin;
656246e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
656346e270d4SMatthew G. Knepley   dm->dimEmbed = dim;
6564d17bd122SMatthew G. Knepley   if (dm->dim >= 0) {
65659566063dSJacob Faibussowitsch     PetscCall(DMGetNumDS(dm, &Nds));
656645480ffeSMatthew G. Knepley     for (n = 0; n < Nds; ++n) {
65679566063dSJacob Faibussowitsch       PetscCall(DMGetRegionNumDS(dm, n, NULL, NULL, &ds));
65689566063dSJacob Faibussowitsch       PetscCall(PetscDSSetCoordinateDimension(ds, dim));
656945480ffeSMatthew G. Knepley     }
6570d17bd122SMatthew G. Knepley   }
657146e270d4SMatthew G. Knepley   PetscFunctionReturn(0);
657246e270d4SMatthew G. Knepley }
657346e270d4SMatthew G. Knepley 
6574e8abe2deSMatthew G. Knepley /*@
6575e8abe2deSMatthew G. Knepley   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6576e8abe2deSMatthew G. Knepley 
6577d083f849SBarry Smith   Collective on dm
6578e8abe2deSMatthew G. Knepley 
6579e8abe2deSMatthew G. Knepley   Input Parameter:
6580e8abe2deSMatthew G. Knepley . dm - The DM object
6581e8abe2deSMatthew G. Knepley 
6582e8abe2deSMatthew G. Knepley   Output Parameter:
6583e8abe2deSMatthew G. Knepley . section - The PetscSection object
6584e8abe2deSMatthew G. Knepley 
6585e8abe2deSMatthew G. Knepley   Level: intermediate
6586e8abe2deSMatthew G. Knepley 
658792fd8e1eSJed Brown .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6588e8abe2deSMatthew G. Knepley @*/
6589e8abe2deSMatthew G. Knepley PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6590e8abe2deSMatthew G. Knepley {
6591e8abe2deSMatthew G. Knepley   DM             cdm;
6592e8abe2deSMatthew G. Knepley 
6593e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6594e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6595e8abe2deSMatthew G. Knepley   PetscValidPointer(section, 2);
65969566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dm, &cdm));
65979566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(cdm, section));
6598e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6599e8abe2deSMatthew G. Knepley }
6600e8abe2deSMatthew G. Knepley 
6601e8abe2deSMatthew G. Knepley /*@
6602e8abe2deSMatthew G. Knepley   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6603e8abe2deSMatthew G. Knepley 
6604e8abe2deSMatthew G. Knepley   Not Collective
6605e8abe2deSMatthew G. Knepley 
6606e8abe2deSMatthew G. Knepley   Input Parameters:
6607e8abe2deSMatthew G. Knepley + dm      - The DM object
660846e270d4SMatthew G. Knepley . dim     - The embedding dimension, or PETSC_DETERMINE
6609e8abe2deSMatthew G. Knepley - section - The PetscSection object
6610e8abe2deSMatthew G. Knepley 
6611e8abe2deSMatthew G. Knepley   Level: intermediate
6612e8abe2deSMatthew G. Knepley 
661392fd8e1eSJed Brown .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6614e8abe2deSMatthew G. Knepley @*/
661546e270d4SMatthew G. Knepley PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6616e8abe2deSMatthew G. Knepley {
6617e8abe2deSMatthew G. Knepley   DM             cdm;
6618e8abe2deSMatthew G. Knepley 
6619e8abe2deSMatthew G. Knepley   PetscFunctionBegin;
6620e8abe2deSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
662146e270d4SMatthew G. Knepley   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
66229566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dm, &cdm));
66239566063dSJacob Faibussowitsch   PetscCall(DMSetLocalSection(cdm, section));
662446e270d4SMatthew G. Knepley   if (dim == PETSC_DETERMINE) {
66254c1069a6SMatthew G. Knepley     PetscInt d = PETSC_DEFAULT;
662646e270d4SMatthew G. Knepley     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
662746e270d4SMatthew G. Knepley 
66289566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetChart(section, &pStart, &pEnd));
66299566063dSJacob Faibussowitsch     PetscCall(DMGetDimPoints(dm, 0, &vStart, &vEnd));
663046e270d4SMatthew G. Knepley     pStart = PetscMax(vStart, pStart);
663146e270d4SMatthew G. Knepley     pEnd   = PetscMin(vEnd, pEnd);
663246e270d4SMatthew G. Knepley     for (v = pStart; v < pEnd; ++v) {
66339566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(section, v, &dd));
663446e270d4SMatthew G. Knepley       if (dd) {d = dd; break;}
663546e270d4SMatthew G. Knepley     }
66369566063dSJacob Faibussowitsch     if (d >= 0) PetscCall(DMSetCoordinateDim(dm, d));
663746e270d4SMatthew G. Knepley   }
6638e8abe2deSMatthew G. Knepley   PetscFunctionReturn(0);
6639e8abe2deSMatthew G. Knepley }
6640e8abe2deSMatthew G. Knepley 
6641d864a3eaSLisandro Dalcin /*@
6642d864a3eaSLisandro Dalcin   DMProjectCoordinates - Project coordinates to a different space
6643d864a3eaSLisandro Dalcin 
6644d864a3eaSLisandro Dalcin   Input Parameters:
6645d864a3eaSLisandro Dalcin + dm      - The DM object
66464f9ab2b4SJed Brown - disc    - The new coordinate discretization or NULL to ensure a coordinate discretization exists
6647d864a3eaSLisandro Dalcin 
6648d864a3eaSLisandro Dalcin   Level: intermediate
6649d864a3eaSLisandro Dalcin 
6650d864a3eaSLisandro Dalcin .seealso: DMGetCoordinateField()
6651d864a3eaSLisandro Dalcin @*/
6652d864a3eaSLisandro Dalcin PetscErrorCode DMProjectCoordinates(DM dm, PetscFE disc)
6653d864a3eaSLisandro Dalcin {
66544f9ab2b4SJed Brown   PetscFE        discOld;
6655d864a3eaSLisandro Dalcin   PetscClassId   classid;
6656d864a3eaSLisandro Dalcin   DM             cdmOld,cdmNew;
6657d864a3eaSLisandro Dalcin   Vec            coordsOld,coordsNew;
6658d864a3eaSLisandro Dalcin   Mat            matInterp;
66594f9ab2b4SJed Brown   PetscBool      same_space = PETSC_TRUE;
6660d864a3eaSLisandro Dalcin 
6661d864a3eaSLisandro Dalcin   PetscFunctionBegin;
6662d864a3eaSLisandro Dalcin   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
66634f9ab2b4SJed Brown   if (disc) PetscValidHeaderSpecific(disc,PETSCFE_CLASSID,2);
6664d864a3eaSLisandro Dalcin 
66659566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dm, &cdmOld));
6666d864a3eaSLisandro Dalcin   /* Check current discretization is compatible */
66679566063dSJacob Faibussowitsch   PetscCall(DMGetField(cdmOld, 0, NULL, (PetscObject*)&discOld));
66689566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetClassId((PetscObject)discOld, &classid));
666929ad44c5SMatthew G. Knepley   if (classid != PETSCFE_CLASSID) {
667029ad44c5SMatthew G. Knepley     if (classid == PETSC_CONTAINER_CLASSID) {
667129ad44c5SMatthew G. Knepley       PetscFE        feLinear;
667229ad44c5SMatthew G. Knepley       DMPolytopeType ct;
66738c4475acSStefano Zampini       PetscInt       dim, dE, cStart, cEnd;
667429ad44c5SMatthew G. Knepley       PetscBool      simplex;
667529ad44c5SMatthew G. Knepley 
667629ad44c5SMatthew G. Knepley       /* Assume linear vertex coordinates */
66779566063dSJacob Faibussowitsch       PetscCall(DMGetDimension(dm, &dim));
66789566063dSJacob Faibussowitsch       PetscCall(DMGetCoordinateDim(dm, &dE));
66798c4475acSStefano Zampini       PetscCall(DMPlexGetHeightStratum(dm, 0, &cStart, &cEnd));
66808c4475acSStefano Zampini       if (cEnd > cStart) {
66819566063dSJacob Faibussowitsch         PetscCall(DMPlexGetCellType(dm, cStart, &ct));
668229ad44c5SMatthew G. Knepley         switch (ct) {
668329ad44c5SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM:
668429ad44c5SMatthew G. Knepley           case DM_POLYTOPE_TRI_PRISM_TENSOR:
668529ad44c5SMatthew G. Knepley             SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot autoamtically create coordinate space for prisms");
668629ad44c5SMatthew G. Knepley           default: break;
668729ad44c5SMatthew G. Knepley         }
66888c4475acSStefano Zampini       }
66898c4475acSStefano Zampini       PetscCall(DMPlexIsSimplex(dm, &simplex));
66909566063dSJacob Faibussowitsch       PetscCall(PetscFECreateLagrange(PETSC_COMM_SELF, dim, dE, simplex, 1, -1, &feLinear));
66919566063dSJacob Faibussowitsch       PetscCall(DMSetField(cdmOld, 0, NULL, (PetscObject) feLinear));
66929566063dSJacob Faibussowitsch       PetscCall(PetscFEDestroy(&feLinear));
66939566063dSJacob Faibussowitsch       PetscCall(DMCreateDS(cdmOld));
66949566063dSJacob Faibussowitsch       PetscCall(DMGetField(cdmOld, 0, NULL, (PetscObject*)&discOld));
669529ad44c5SMatthew G. Knepley     } else {
669629ad44c5SMatthew G. Knepley       const char *discname;
669729ad44c5SMatthew G. Knepley 
66989566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetType((PetscObject)discOld, &discname));
66994f9ab2b4SJed Brown       SETERRQ(PetscObjectComm((PetscObject)discOld), PETSC_ERR_SUP, "Discretization type %s not supported", discname);
670029ad44c5SMatthew G. Knepley     }
670129ad44c5SMatthew G. Knepley   }
67024f9ab2b4SJed Brown   if (!disc) PetscFunctionReturn(0);
67034f9ab2b4SJed Brown   { // Check if the new space is the same as the old modulo quadrature
67044f9ab2b4SJed Brown     PetscDualSpace dsOld, ds;
67059566063dSJacob Faibussowitsch     PetscCall(PetscFEGetDualSpace(discOld, &dsOld));
67069566063dSJacob Faibussowitsch     PetscCall(PetscFEGetDualSpace(disc, &ds));
67079566063dSJacob Faibussowitsch     PetscCall(PetscDualSpaceEqual(dsOld, ds, &same_space));
67084f9ab2b4SJed Brown   }
6709d864a3eaSLisandro Dalcin   /* Make a fresh clone of the coordinate DM */
67109566063dSJacob Faibussowitsch   PetscCall(DMClone(cdmOld, &cdmNew));
67119566063dSJacob Faibussowitsch   PetscCall(DMSetField(cdmNew, 0, NULL, (PetscObject) disc));
67129566063dSJacob Faibussowitsch   PetscCall(DMCreateDS(cdmNew));
67139566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinates(dm, &coordsOld));
67144f9ab2b4SJed Brown   if (same_space) {
67159566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)coordsOld));
67164f9ab2b4SJed Brown     coordsNew = coordsOld;
67174f9ab2b4SJed Brown   } else { // Project the coordinate vector from old to new space
67189566063dSJacob Faibussowitsch     PetscCall(DMCreateGlobalVector(cdmNew, &coordsNew));
67199566063dSJacob Faibussowitsch     PetscCall(DMCreateInterpolation(cdmOld, cdmNew, &matInterp, NULL));
67209566063dSJacob Faibussowitsch     PetscCall(MatInterpolate(matInterp, coordsOld, coordsNew));
67219566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&matInterp));
67224f9ab2b4SJed Brown   }
6723d864a3eaSLisandro Dalcin   /* Set new coordinate structures */
67249566063dSJacob Faibussowitsch   PetscCall(DMSetCoordinateField(dm, NULL));
67259566063dSJacob Faibussowitsch   PetscCall(DMSetCoordinateDM(dm, cdmNew));
67269566063dSJacob Faibussowitsch   PetscCall(DMSetCoordinates(dm, coordsNew));
67279566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&coordsNew));
67289566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&cdmNew));
6729d864a3eaSLisandro Dalcin   PetscFunctionReturn(0);
6730d864a3eaSLisandro Dalcin }
6731d864a3eaSLisandro Dalcin 
67325dc8c3f7SMatthew G. Knepley /*@C
673390b157c4SStefano Zampini   DMGetPeriodicity - Get the description of mesh periodicity
67345dc8c3f7SMatthew G. Knepley 
6735f899ff85SJose E. Roman   Input Parameter:
673690b157c4SStefano Zampini . dm      - The DM object
673790b157c4SStefano Zampini 
673890b157c4SStefano Zampini   Output Parameters:
673990b157c4SStefano Zampini + per     - Whether the DM is periodic or not
67405dc8c3f7SMatthew 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
67415dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
67425dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
67435dc8c3f7SMatthew G. Knepley 
67445dc8c3f7SMatthew G. Knepley   Level: developer
67455dc8c3f7SMatthew G. Knepley 
67465dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
67475dc8c3f7SMatthew G. Knepley @*/
674890b157c4SStefano Zampini PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6749c6b900c6SMatthew G. Knepley {
6750c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6751c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
675290b157c4SStefano Zampini   if (per)     *per     = dm->periodic;
6753c6b900c6SMatthew G. Knepley   if (L)       *L       = dm->L;
6754c6b900c6SMatthew G. Knepley   if (maxCell) *maxCell = dm->maxCell;
67555dc8c3f7SMatthew G. Knepley   if (bd)      *bd      = dm->bdtype;
6756c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6757c6b900c6SMatthew G. Knepley }
6758c6b900c6SMatthew G. Knepley 
67595dc8c3f7SMatthew G. Knepley /*@C
67605dc8c3f7SMatthew G. Knepley   DMSetPeriodicity - Set the description of mesh periodicity
67615dc8c3f7SMatthew G. Knepley 
67625dc8c3f7SMatthew G. Knepley   Input Parameters:
67635dc8c3f7SMatthew G. Knepley + dm      - The DM object
6764db2bf62eSStefano Zampini . per     - Whether the DM is periodic or not.
6765db2bf62eSStefano 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.
67665dc8c3f7SMatthew G. Knepley . L       - If we assume the mesh is a torus, this is the length of each coordinate
67675dc8c3f7SMatthew G. Knepley - bd      - This describes the type of periodicity in each topological dimension
67685dc8c3f7SMatthew G. Knepley 
6769db2bf62eSStefano 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.
6770db2bf62eSStefano Zampini 
67715dc8c3f7SMatthew G. Knepley   Level: developer
67725dc8c3f7SMatthew G. Knepley 
67735dc8c3f7SMatthew G. Knepley .seealso: DMGetPeriodicity()
67745dc8c3f7SMatthew G. Knepley @*/
677590b157c4SStefano Zampini PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6776c6b900c6SMatthew G. Knepley {
6777c6b900c6SMatthew G. Knepley   PetscInt       dim, d;
6778c6b900c6SMatthew G. Knepley 
6779c6b900c6SMatthew G. Knepley   PetscFunctionBegin;
6780c6b900c6SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
678190b157c4SStefano Zampini   PetscValidLogicalCollectiveBool(dm,per,2);
6782412e9a14SMatthew G. Knepley   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6783412e9a14SMatthew G. Knepley   if (L)       {PetscValidRealPointer(L,4);}
6784412e9a14SMatthew G. Knepley   if (bd)      {PetscValidPointer(bd,5);}
67859566063dSJacob Faibussowitsch   PetscCall(DMGetDimension(dm, &dim));
678690b157c4SStefano Zampini   if (maxCell) {
67879566063dSJacob Faibussowitsch     if (!dm->maxCell) PetscCall(PetscMalloc1(dim, &dm->maxCell));
6788412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6789db2bf62eSStefano Zampini   } else { /* remove maxCell information to disable automatic computation of localized vertices */
67909566063dSJacob Faibussowitsch     PetscCall(PetscFree(dm->maxCell));
6791412e9a14SMatthew G. Knepley   }
6792db2bf62eSStefano Zampini 
6793412e9a14SMatthew G. Knepley   if (L) {
67949566063dSJacob Faibussowitsch     if (!dm->L) PetscCall(PetscMalloc1(dim, &dm->L));
6795412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6796412e9a14SMatthew G. Knepley   }
6797412e9a14SMatthew G. Knepley   if (bd) {
67989566063dSJacob Faibussowitsch     if (!dm->bdtype) PetscCall(PetscMalloc1(dim, &dm->bdtype));
6799412e9a14SMatthew G. Knepley     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
680090b157c4SStefano Zampini   }
6801072d7d67SStefano Zampini   dm->periodic = per;
6802c6b900c6SMatthew G. Knepley   PetscFunctionReturn(0);
6803c6b900c6SMatthew G. Knepley }
6804c6b900c6SMatthew G. Knepley 
68052e17dfb7SMatthew G. Knepley /*@
68062e17dfb7SMatthew 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.
68072e17dfb7SMatthew G. Knepley 
68082e17dfb7SMatthew G. Knepley   Input Parameters:
68092e17dfb7SMatthew G. Knepley + dm     - The DM
681065da65dcSMatthew G. Knepley . in     - The input coordinate point (dim numbers)
681165da65dcSMatthew G. Knepley - endpoint - Include the endpoint L_i
68122e17dfb7SMatthew G. Knepley 
68132e17dfb7SMatthew G. Knepley   Output Parameter:
68142e17dfb7SMatthew G. Knepley . out - The localized coordinate point
68152e17dfb7SMatthew G. Knepley 
68162e17dfb7SMatthew G. Knepley   Level: developer
68172e17dfb7SMatthew G. Knepley 
68182e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
68192e17dfb7SMatthew G. Knepley @*/
682065da65dcSMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
68212e17dfb7SMatthew G. Knepley {
68222e17dfb7SMatthew G. Knepley   PetscInt       dim, d;
68232e17dfb7SMatthew G. Knepley 
68242e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68259566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDim(dm, &dim));
68262e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68272e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
68282e17dfb7SMatthew G. Knepley   } else {
682965da65dcSMatthew G. Knepley     if (endpoint) {
683065da65dcSMatthew G. Knepley       for (d = 0; d < dim; ++d) {
6831da3333bfSMatthew 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)) {
6832da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
683365da65dcSMatthew G. Knepley         } else {
6834da3333bfSMatthew G. Knepley           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
683565da65dcSMatthew G. Knepley         }
683665da65dcSMatthew G. Knepley       }
683765da65dcSMatthew G. Knepley     } else {
68382e17dfb7SMatthew G. Knepley       for (d = 0; d < dim; ++d) {
68391118d4bcSLisandro Dalcin         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
68402e17dfb7SMatthew G. Knepley       }
68412e17dfb7SMatthew G. Knepley     }
684265da65dcSMatthew G. Knepley   }
68432e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68442e17dfb7SMatthew G. Knepley }
68452e17dfb7SMatthew G. Knepley 
68462e17dfb7SMatthew G. Knepley /*
68472e17dfb7SMatthew 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.
68482e17dfb7SMatthew G. Knepley 
68492e17dfb7SMatthew G. Knepley   Input Parameters:
68502e17dfb7SMatthew G. Knepley + dm     - The DM
68512e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
68522e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
68532e17dfb7SMatthew G. Knepley - in     - The input coordinate point (dim numbers)
68542e17dfb7SMatthew G. Knepley 
68552e17dfb7SMatthew G. Knepley   Output Parameter:
68562e17dfb7SMatthew G. Knepley . out - The localized coordinate point
68572e17dfb7SMatthew G. Knepley 
68582e17dfb7SMatthew G. Knepley   Level: developer
68592e17dfb7SMatthew G. Knepley 
68602e17dfb7SMatthew 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
68612e17dfb7SMatthew G. Knepley 
68622e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
68632e17dfb7SMatthew G. Knepley */
68642e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
68652e17dfb7SMatthew G. Knepley {
68662e17dfb7SMatthew G. Knepley   PetscInt d;
68672e17dfb7SMatthew G. Knepley 
68682e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68692e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68702e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
68712e17dfb7SMatthew G. Knepley   } else {
68722e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6873908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
68742e17dfb7SMatthew G. Knepley         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
68752e17dfb7SMatthew G. Knepley       } else {
68762e17dfb7SMatthew G. Knepley         out[d] = in[d];
68772e17dfb7SMatthew G. Knepley       }
68782e17dfb7SMatthew G. Knepley     }
68792e17dfb7SMatthew G. Knepley   }
68802e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
68812e17dfb7SMatthew G. Knepley }
6882a5801f52SStefano Zampini 
68832e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
68842e17dfb7SMatthew G. Knepley {
68852e17dfb7SMatthew G. Knepley   PetscInt d;
68862e17dfb7SMatthew G. Knepley 
68872e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
68882e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
68892e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] = in[d];
68902e17dfb7SMatthew G. Knepley   } else {
68912e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6892908eca10SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
68932e17dfb7SMatthew G. Knepley         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
68942e17dfb7SMatthew G. Knepley       } else {
68952e17dfb7SMatthew G. Knepley         out[d] = in[d];
68962e17dfb7SMatthew G. Knepley       }
68972e17dfb7SMatthew G. Knepley     }
68982e17dfb7SMatthew G. Knepley   }
68992e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69002e17dfb7SMatthew G. Knepley }
69012e17dfb7SMatthew G. Knepley 
69022e17dfb7SMatthew G. Knepley /*
69032e17dfb7SMatthew 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.
69042e17dfb7SMatthew G. Knepley 
69052e17dfb7SMatthew G. Knepley   Input Parameters:
69062e17dfb7SMatthew G. Knepley + dm     - The DM
69072e17dfb7SMatthew G. Knepley . dim    - The spatial dimension
69082e17dfb7SMatthew G. Knepley . anchor - The anchor point, the input point can be no more than maxCell away from it
69092e17dfb7SMatthew G. Knepley . in     - The input coordinate delta (dim numbers)
69102e17dfb7SMatthew G. Knepley - out    - The input coordinate point (dim numbers)
69112e17dfb7SMatthew G. Knepley 
69122e17dfb7SMatthew G. Knepley   Output Parameter:
69132e17dfb7SMatthew G. Knepley . out    - The localized coordinate in + out
69142e17dfb7SMatthew G. Knepley 
69152e17dfb7SMatthew G. Knepley   Level: developer
69162e17dfb7SMatthew G. Knepley 
69172e17dfb7SMatthew 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
69182e17dfb7SMatthew G. Knepley 
69192e17dfb7SMatthew G. Knepley .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
69202e17dfb7SMatthew G. Knepley */
69212e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
69222e17dfb7SMatthew G. Knepley {
69232e17dfb7SMatthew G. Knepley   PetscInt d;
69242e17dfb7SMatthew G. Knepley 
69252e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
69262e17dfb7SMatthew G. Knepley   if (!dm->maxCell) {
69272e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) out[d] += in[d];
69282e17dfb7SMatthew G. Knepley   } else {
69292e17dfb7SMatthew G. Knepley     for (d = 0; d < dim; ++d) {
6930412e9a14SMatthew G. Knepley       const PetscReal maxC = dm->maxCell[d];
6931412e9a14SMatthew G. Knepley 
6932412e9a14SMatthew G. Knepley       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
6933412e9a14SMatthew G. Knepley         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6934412e9a14SMatthew G. Knepley 
6935412e9a14SMatthew G. Knepley         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
693698921bdaSJacob 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]));
6937412e9a14SMatthew G. Knepley         out[d] += newCoord;
69382e17dfb7SMatthew G. Knepley       } else {
69392e17dfb7SMatthew G. Knepley         out[d] += in[d];
69402e17dfb7SMatthew G. Knepley       }
69412e17dfb7SMatthew G. Knepley     }
69422e17dfb7SMatthew G. Knepley   }
69432e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
69442e17dfb7SMatthew G. Knepley }
69452e17dfb7SMatthew G. Knepley 
694636447a5eSToby Isaac /*@
69478f700142SStefano Zampini   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
69488f700142SStefano Zampini 
69498f700142SStefano Zampini   Not collective
695036447a5eSToby Isaac 
695136447a5eSToby Isaac   Input Parameter:
695236447a5eSToby Isaac . dm - The DM
695336447a5eSToby Isaac 
695436447a5eSToby Isaac   Output Parameter:
695536447a5eSToby Isaac   areLocalized - True if localized
695636447a5eSToby Isaac 
695736447a5eSToby Isaac   Level: developer
695836447a5eSToby Isaac 
69598f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
696036447a5eSToby Isaac @*/
69618f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
696236447a5eSToby Isaac {
696336447a5eSToby Isaac   DM             cdm;
696436447a5eSToby Isaac   PetscSection   coordSection;
69652ccac677SMatthew G. Knepley   PetscInt       depth, cStart, cEnd, sStart, sEnd, c, dof;
696646a3a80fSLisandro Dalcin   PetscBool      isPlex, alreadyLocalized;
696736447a5eSToby Isaac 
696836447a5eSToby Isaac   PetscFunctionBegin;
696936447a5eSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6970534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
69718b09590cSToby Isaac   *areLocalized = PETSC_FALSE;
697246a3a80fSLisandro Dalcin 
697336447a5eSToby Isaac   /* We need some generic way of refering to cells/vertices */
69749566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dm, &cdm));
69759566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex));
69769f7230bfSMatthew G. Knepley   if (!isPlex) PetscFunctionReturn(0);
69779566063dSJacob Faibussowitsch   PetscCall(DMPlexGetDepth(cdm, &depth));
69782ccac677SMatthew G. Knepley   if (!depth) PetscFunctionReturn(0);
697946a3a80fSLisandro Dalcin 
69809566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateSection(dm, &coordSection));
69819566063dSJacob Faibussowitsch   PetscCall(DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd));
69829566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(coordSection, &sStart, &sEnd));
698336447a5eSToby Isaac   alreadyLocalized = PETSC_FALSE;
698446a3a80fSLisandro Dalcin   for (c = cStart; c < cEnd; ++c) {
698546a3a80fSLisandro Dalcin     if (c < sStart || c >= sEnd) continue;
69869566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(coordSection, c, &dof));
698746a3a80fSLisandro Dalcin     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
698836447a5eSToby Isaac   }
69898f700142SStefano Zampini   *areLocalized = alreadyLocalized;
699036447a5eSToby Isaac   PetscFunctionReturn(0);
699136447a5eSToby Isaac }
699236447a5eSToby Isaac 
69938f700142SStefano Zampini /*@
69948f700142SStefano Zampini   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
69958f700142SStefano Zampini 
69968f700142SStefano Zampini   Collective on dm
69978f700142SStefano Zampini 
69988f700142SStefano Zampini   Input Parameter:
69998f700142SStefano Zampini . dm - The DM
70008f700142SStefano Zampini 
70018f700142SStefano Zampini   Output Parameter:
70028f700142SStefano Zampini   areLocalized - True if localized
70038f700142SStefano Zampini 
70048f700142SStefano Zampini   Level: developer
70058f700142SStefano Zampini 
70068f700142SStefano Zampini .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
70078f700142SStefano Zampini @*/
70088f700142SStefano Zampini PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
70098f700142SStefano Zampini {
70108f700142SStefano Zampini   PetscBool      localized;
70118f700142SStefano Zampini 
70128f700142SStefano Zampini   PetscFunctionBegin;
70138f700142SStefano Zampini   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7014534a8f05SLisandro Dalcin   PetscValidBoolPointer(areLocalized, 2);
70159566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinatesLocalizedLocal(dm,&localized));
70161c2dc1cbSBarry Smith   PetscCall(MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm)));
70178f700142SStefano Zampini   PetscFunctionReturn(0);
70188f700142SStefano Zampini }
701936447a5eSToby Isaac 
70202e17dfb7SMatthew G. Knepley /*@
7021492b8470SStefano Zampini   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
70222e17dfb7SMatthew G. Knepley 
70238f700142SStefano Zampini   Collective on dm
70248f700142SStefano Zampini 
70252e17dfb7SMatthew G. Knepley   Input Parameter:
70262e17dfb7SMatthew G. Knepley . dm - The DM
70272e17dfb7SMatthew G. Knepley 
70282e17dfb7SMatthew G. Knepley   Level: developer
70292e17dfb7SMatthew G. Knepley 
70308f700142SStefano Zampini .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
70312e17dfb7SMatthew G. Knepley @*/
70322e17dfb7SMatthew G. Knepley PetscErrorCode DMLocalizeCoordinates(DM dm)
70332e17dfb7SMatthew G. Knepley {
70342e17dfb7SMatthew G. Knepley   DM             cdm;
70352e17dfb7SMatthew G. Knepley   PetscSection   coordSection, cSection;
70362e17dfb7SMatthew G. Knepley   Vec            coordinates,  cVec;
70373e922f36SToby Isaac   PetscScalar   *coords, *coords2, *anchor, *localized;
70383e922f36SToby Isaac   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
7039e0ae35bbSToby Isaac   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
70403e922f36SToby Isaac   PetscInt       maxHeight = 0, h;
70413e922f36SToby Isaac   PetscInt       *pStart = NULL, *pEnd = NULL;
70422e17dfb7SMatthew G. Knepley 
70432e17dfb7SMatthew G. Knepley   PetscFunctionBegin;
70442e17dfb7SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
704592c9c85fSStefano Zampini   if (!dm->periodic) PetscFunctionReturn(0);
70469566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinatesLocalized(dm, &alreadyLocalized));
7047f7cbd40bSStefano Zampini   if (alreadyLocalized) PetscFunctionReturn(0);
7048f7cbd40bSStefano Zampini 
70492e17dfb7SMatthew G. Knepley   /* We need some generic way of refering to cells/vertices */
70509566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateDM(dm, &cdm));
70512e17dfb7SMatthew G. Knepley   {
70522e17dfb7SMatthew G. Knepley     PetscBool isplex;
70532e17dfb7SMatthew G. Knepley 
70549566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex));
70552e17dfb7SMatthew G. Knepley     if (isplex) {
70569566063dSJacob Faibussowitsch       PetscCall(DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd));
70579566063dSJacob Faibussowitsch       PetscCall(DMPlexGetMaxProjectionHeight(cdm,&maxHeight));
70589566063dSJacob Faibussowitsch       PetscCall(DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart));
70593e922f36SToby Isaac       pEnd = &pStart[maxHeight + 1];
70603e922f36SToby Isaac       newStart = vStart;
70613e922f36SToby Isaac       newEnd   = vEnd;
70623e922f36SToby Isaac       for (h = 0; h <= maxHeight; h++) {
70639566063dSJacob Faibussowitsch         PetscCall(DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]));
70643e922f36SToby Isaac         newStart = PetscMin(newStart,pStart[h]);
70653e922f36SToby Isaac         newEnd   = PetscMax(newEnd,pEnd[h]);
70663e922f36SToby Isaac       }
70672e17dfb7SMatthew G. Knepley     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
70682e17dfb7SMatthew G. Knepley   }
70699566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinatesLocal(dm, &coordinates));
70707a8be351SBarry Smith   PetscCheck(coordinates,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
70719566063dSJacob Faibussowitsch   PetscCall(DMGetCoordinateSection(dm, &coordSection));
70729566063dSJacob Faibussowitsch   PetscCall(VecGetBlockSize(coordinates, &bs));
70739566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetChart(coordSection,&sStart,&sEnd));
70743e922f36SToby Isaac 
70759566063dSJacob Faibussowitsch   PetscCall(PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection));
70769566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetNumFields(cSection, 1));
70779566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetFieldComponents(coordSection, 0, &Nc));
70789566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetFieldComponents(cSection, 0, Nc));
70799566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetChart(cSection, newStart, newEnd));
70803e922f36SToby Isaac 
70819566063dSJacob Faibussowitsch   PetscCall(DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor));
70823e922f36SToby Isaac   localized = &anchor[bs];
70833e922f36SToby Isaac   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
70843e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
70853e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
70863e922f36SToby Isaac 
70873e922f36SToby Isaac     for (c = cStart; c < cEnd; ++c) {
70883e922f36SToby Isaac       PetscScalar *cellCoords = NULL;
70893e922f36SToby Isaac       PetscInt     b;
70903e922f36SToby Isaac 
70913e922f36SToby Isaac       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
70929566063dSJacob Faibussowitsch       PetscCall(DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords));
70933e922f36SToby Isaac       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
70943e922f36SToby Isaac       for (d = 0; d < dof/bs; ++d) {
70959566063dSJacob Faibussowitsch         PetscCall(DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized));
70963e922f36SToby Isaac         for (b = 0; b < bs; b++) {
70973e922f36SToby Isaac           if (cellCoords[d*bs + b] != localized[b]) break;
70983e922f36SToby Isaac         }
70993e922f36SToby Isaac         if (b < bs) break;
71003e922f36SToby Isaac       }
71013e922f36SToby Isaac       if (d < dof/bs) {
71023e922f36SToby Isaac         if (c >= sStart && c < sEnd) {
71033e922f36SToby Isaac           PetscInt cdof;
71043e922f36SToby Isaac 
71059566063dSJacob Faibussowitsch           PetscCall(PetscSectionGetDof(coordSection, c, &cdof));
71063e922f36SToby Isaac           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
71073e922f36SToby Isaac         }
71089566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetDof(cSection, c, dof));
71099566063dSJacob Faibussowitsch         PetscCall(PetscSectionSetFieldDof(cSection, c, 0, dof));
71103e922f36SToby Isaac       }
71119566063dSJacob Faibussowitsch       PetscCall(DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords));
71123e922f36SToby Isaac     }
71133e922f36SToby Isaac   }
71149566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm)));
71153e922f36SToby Isaac   if (alreadyLocalizedGlobal) {
71169566063dSJacob Faibussowitsch     PetscCall(DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor));
71179566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&cSection));
71189566063dSJacob Faibussowitsch     PetscCall(DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart));
71193e922f36SToby Isaac     PetscFunctionReturn(0);
71203e922f36SToby Isaac   }
71212e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
71229566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(coordSection, v, &dof));
71239566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetDof(cSection, v, dof));
71249566063dSJacob Faibussowitsch     PetscCall(PetscSectionSetFieldDof(cSection, v, 0, dof));
71252e17dfb7SMatthew G. Knepley   }
71269566063dSJacob Faibussowitsch   PetscCall(PetscSectionSetUp(cSection));
71279566063dSJacob Faibussowitsch   PetscCall(PetscSectionGetStorageSize(cSection, &coordSize));
71289566063dSJacob Faibussowitsch   PetscCall(VecCreate(PETSC_COMM_SELF, &cVec));
71299566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetName((PetscObject)cVec,"coordinates"));
71309566063dSJacob Faibussowitsch   PetscCall(VecSetBlockSize(cVec, bs));
71319566063dSJacob Faibussowitsch   PetscCall(VecSetSizes(cVec, coordSize, PETSC_DETERMINE));
71329566063dSJacob Faibussowitsch   PetscCall(VecSetType(cVec, VECSTANDARD));
71339566063dSJacob Faibussowitsch   PetscCall(VecGetArrayRead(coordinates, (const PetscScalar**)&coords));
71349566063dSJacob Faibussowitsch   PetscCall(VecGetArray(cVec, &coords2));
71352e17dfb7SMatthew G. Knepley   for (v = vStart; v < vEnd; ++v) {
71369566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetDof(coordSection, v, &dof));
71379566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(coordSection, v, &off));
71389566063dSJacob Faibussowitsch     PetscCall(PetscSectionGetOffset(cSection,     v, &off2));
71392e17dfb7SMatthew G. Knepley     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
71402e17dfb7SMatthew G. Knepley   }
71413e922f36SToby Isaac   for (h = 0; h <= maxHeight; h++) {
71423e922f36SToby Isaac     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
71433e922f36SToby Isaac 
71442e17dfb7SMatthew G. Knepley     for (c = cStart; c < cEnd; ++c) {
71452e17dfb7SMatthew G. Knepley       PetscScalar *cellCoords = NULL;
71463e922f36SToby Isaac       PetscInt     b, cdof;
71472e17dfb7SMatthew G. Knepley 
71489566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetDof(cSection,c,&cdof));
71493e922f36SToby Isaac       if (!cdof) continue;
71509566063dSJacob Faibussowitsch       PetscCall(DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords));
71519566063dSJacob Faibussowitsch       PetscCall(PetscSectionGetOffset(cSection, c, &off2));
71522e17dfb7SMatthew G. Knepley       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
71539566063dSJacob Faibussowitsch       for (d = 0; d < dof/bs; ++d) PetscCall(DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]));
71549566063dSJacob Faibussowitsch       PetscCall(DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords));
71552e17dfb7SMatthew G. Knepley     }
71563e922f36SToby Isaac   }
71579566063dSJacob Faibussowitsch   PetscCall(DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor));
71589566063dSJacob Faibussowitsch   PetscCall(DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart));
71599566063dSJacob Faibussowitsch   PetscCall(VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords));
71609566063dSJacob Faibussowitsch   PetscCall(VecRestoreArray(cVec, &coords2));
71619566063dSJacob Faibussowitsch   PetscCall(DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection));
71629566063dSJacob Faibussowitsch   PetscCall(DMSetCoordinatesLocal(dm, cVec));
71639566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&cVec));
71649566063dSJacob Faibussowitsch   PetscCall(PetscSectionDestroy(&cSection));
71652e17dfb7SMatthew G. Knepley   PetscFunctionReturn(0);
71662e17dfb7SMatthew G. Knepley }
71672e17dfb7SMatthew G. Knepley 
7168e87bb0d3SMatthew G Knepley /*@
71693a93e3b7SToby Isaac   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
7170e87bb0d3SMatthew G Knepley 
7171d083f849SBarry Smith   Collective on v (see explanation below)
7172e87bb0d3SMatthew G Knepley 
7173e87bb0d3SMatthew G Knepley   Input Parameters:
7174e87bb0d3SMatthew G Knepley + dm - The DM
71756b867d5aSJose E. Roman - ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
7176e87bb0d3SMatthew G Knepley 
71776b867d5aSJose E. Roman   Input/Output Parameters:
71786b867d5aSJose E. Roman + v - The Vec of points, on output contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
71796b867d5aSJose E. Roman - cellSF - Points to either NULL, or a PetscSF with guesses for which cells contain each point;
71806b867d5aSJose E. Roman            on output, the PetscSF containing the ranks and local indices of the containing points
71813a93e3b7SToby Isaac 
7182e87bb0d3SMatthew G Knepley   Level: developer
718361e3bb9bSMatthew G Knepley 
718462a38674SMatthew G. Knepley   Notes:
71853a93e3b7SToby Isaac   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
718662a38674SMatthew G. Knepley   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
71873a93e3b7SToby Isaac 
71883a93e3b7SToby Isaac   If *cellSF is NULL on input, a PetscSF will be created.
718962a38674SMatthew G. Knepley   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
71903a93e3b7SToby Isaac 
71913a93e3b7SToby Isaac   An array that maps each point to its containing cell can be obtained with
71923a93e3b7SToby Isaac 
719362a38674SMatthew G. Knepley $    const PetscSFNode *cells;
719462a38674SMatthew G. Knepley $    PetscInt           nFound;
7195a6216909SToby Isaac $    const PetscInt    *found;
719662a38674SMatthew G. Knepley $
7197a6216909SToby Isaac $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
71983a93e3b7SToby Isaac 
71993a93e3b7SToby 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
72003a93e3b7SToby Isaac   the index of the cell in its rank's local numbering.
72013a93e3b7SToby Isaac 
720262a38674SMatthew G. Knepley .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
720361e3bb9bSMatthew G Knepley @*/
720462a38674SMatthew G. Knepley PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
7205e87bb0d3SMatthew G Knepley {
7206e87bb0d3SMatthew G Knepley   PetscFunctionBegin;
7207e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7208e87bb0d3SMatthew G Knepley   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
7209e0fc9d1bSMatthew G. Knepley   PetscValidPointer(cellSF,4);
72103a93e3b7SToby Isaac   if (*cellSF) {
72113a93e3b7SToby Isaac     PetscMPIInt result;
72123a93e3b7SToby Isaac 
7213e0fc9d1bSMatthew G. Knepley     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
72149566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result));
72157a8be351SBarry Smith     PetscCheck(result == MPI_IDENT || result == MPI_CONGRUENT,PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's");
7216e0fc9d1bSMatthew G. Knepley   } else {
72179566063dSJacob Faibussowitsch     PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF));
72183a93e3b7SToby Isaac   }
72197a8be351SBarry Smith   PetscCheck(dm->ops->locatepoints,PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
72209566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(DM_LocatePoints,dm,0,0,0));
72219566063dSJacob Faibussowitsch   PetscCall((*dm->ops->locatepoints)(dm,v,ltype,*cellSF));
72229566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(DM_LocatePoints,dm,0,0,0));
7223e87bb0d3SMatthew G Knepley   PetscFunctionReturn(0);
7224e87bb0d3SMatthew G Knepley }
722514f150ffSMatthew G. Knepley 
7226f4d763aaSMatthew G. Knepley /*@
7227f4d763aaSMatthew G. Knepley   DMGetOutputDM - Retrieve the DM associated with the layout for output
7228f4d763aaSMatthew G. Knepley 
72298f700142SStefano Zampini   Collective on dm
72308f700142SStefano Zampini 
7231f4d763aaSMatthew G. Knepley   Input Parameter:
7232f4d763aaSMatthew G. Knepley . dm - The original DM
7233f4d763aaSMatthew G. Knepley 
7234f4d763aaSMatthew G. Knepley   Output Parameter:
7235f4d763aaSMatthew G. Knepley . odm - The DM which provides the layout for output
7236f4d763aaSMatthew G. Knepley 
7237f4d763aaSMatthew G. Knepley   Level: intermediate
7238f4d763aaSMatthew G. Knepley 
7239e87a4003SBarry Smith .seealso: VecView(), DMGetGlobalSection()
7240f4d763aaSMatthew G. Knepley @*/
724114f150ffSMatthew G. Knepley PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
724214f150ffSMatthew G. Knepley {
7243c26acbdeSMatthew G. Knepley   PetscSection   section;
72442d4e4a49SMatthew G. Knepley   PetscBool      hasConstraints, ghasConstraints;
724514f150ffSMatthew G. Knepley 
724614f150ffSMatthew G. Knepley   PetscFunctionBegin;
724714f150ffSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
724814f150ffSMatthew G. Knepley   PetscValidPointer(odm,2);
72499566063dSJacob Faibussowitsch   PetscCall(DMGetLocalSection(dm, &section));
72509566063dSJacob Faibussowitsch   PetscCall(PetscSectionHasConstraints(section, &hasConstraints));
72519566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm)));
72522d4e4a49SMatthew G. Knepley   if (!ghasConstraints) {
7253c26acbdeSMatthew G. Knepley     *odm = dm;
7254c26acbdeSMatthew G. Knepley     PetscFunctionReturn(0);
7255c26acbdeSMatthew G. Knepley   }
725614f150ffSMatthew G. Knepley   if (!dm->dmBC) {
7257c26acbdeSMatthew G. Knepley     PetscSection newSection, gsection;
725814f150ffSMatthew G. Knepley     PetscSF      sf;
725914f150ffSMatthew G. Knepley 
72609566063dSJacob Faibussowitsch     PetscCall(DMClone(dm, &dm->dmBC));
72619566063dSJacob Faibussowitsch     PetscCall(DMCopyDisc(dm, dm->dmBC));
72629566063dSJacob Faibussowitsch     PetscCall(PetscSectionClone(section, &newSection));
72639566063dSJacob Faibussowitsch     PetscCall(DMSetLocalSection(dm->dmBC, newSection));
72649566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&newSection));
72659566063dSJacob Faibussowitsch     PetscCall(DMGetPointSF(dm->dmBC, &sf));
72669566063dSJacob Faibussowitsch     PetscCall(PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection));
72679566063dSJacob Faibussowitsch     PetscCall(DMSetGlobalSection(dm->dmBC, gsection));
72689566063dSJacob Faibussowitsch     PetscCall(PetscSectionDestroy(&gsection));
726914f150ffSMatthew G. Knepley   }
727014f150ffSMatthew G. Knepley   *odm = dm->dmBC;
727114f150ffSMatthew G. Knepley   PetscFunctionReturn(0);
727214f150ffSMatthew G. Knepley }
7273f4d763aaSMatthew G. Knepley 
7274f4d763aaSMatthew G. Knepley /*@
7275cdb7a50dSMatthew G. Knepley   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
7276f4d763aaSMatthew G. Knepley 
7277f4d763aaSMatthew G. Knepley   Input Parameter:
7278f4d763aaSMatthew G. Knepley . dm - The original DM
7279f4d763aaSMatthew G. Knepley 
7280cdb7a50dSMatthew G. Knepley   Output Parameters:
7281cdb7a50dSMatthew G. Knepley + num - The output sequence number
7282cdb7a50dSMatthew G. Knepley - val - The output sequence value
7283f4d763aaSMatthew G. Knepley 
7284f4d763aaSMatthew G. Knepley   Level: intermediate
7285f4d763aaSMatthew G. Knepley 
7286f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7287f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7288f4d763aaSMatthew G. Knepley 
7289f4d763aaSMatthew G. Knepley .seealso: VecView()
7290f4d763aaSMatthew G. Knepley @*/
7291cdb7a50dSMatthew G. Knepley PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
7292f4d763aaSMatthew G. Knepley {
7293f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7294f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7295534a8f05SLisandro Dalcin   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
7296534a8f05SLisandro Dalcin   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
7297f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7298f4d763aaSMatthew G. Knepley }
7299f4d763aaSMatthew G. Knepley 
7300f4d763aaSMatthew G. Knepley /*@
7301cdb7a50dSMatthew G. Knepley   DMSetOutputSequenceNumber - Set the sequence number/value for output
7302f4d763aaSMatthew G. Knepley 
7303f4d763aaSMatthew G. Knepley   Input Parameters:
7304f4d763aaSMatthew G. Knepley + dm - The original DM
7305cdb7a50dSMatthew G. Knepley . num - The output sequence number
7306cdb7a50dSMatthew G. Knepley - val - The output sequence value
7307f4d763aaSMatthew G. Knepley 
7308f4d763aaSMatthew G. Knepley   Level: intermediate
7309f4d763aaSMatthew G. Knepley 
7310f4d763aaSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7311f4d763aaSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7312f4d763aaSMatthew G. Knepley 
7313f4d763aaSMatthew G. Knepley .seealso: VecView()
7314f4d763aaSMatthew G. Knepley @*/
7315cdb7a50dSMatthew G. Knepley PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
7316f4d763aaSMatthew G. Knepley {
7317f4d763aaSMatthew G. Knepley   PetscFunctionBegin;
7318f4d763aaSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7319f4d763aaSMatthew G. Knepley   dm->outputSequenceNum = num;
7320cdb7a50dSMatthew G. Knepley   dm->outputSequenceVal = val;
7321cdb7a50dSMatthew G. Knepley   PetscFunctionReturn(0);
7322cdb7a50dSMatthew G. Knepley }
7323cdb7a50dSMatthew G. Knepley 
7324cdb7a50dSMatthew G. Knepley /*@C
7325cdb7a50dSMatthew G. Knepley   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
7326cdb7a50dSMatthew G. Knepley 
7327cdb7a50dSMatthew G. Knepley   Input Parameters:
7328cdb7a50dSMatthew G. Knepley + dm   - The original DM
7329cdb7a50dSMatthew G. Knepley . name - The sequence name
7330cdb7a50dSMatthew G. Knepley - num  - The output sequence number
7331cdb7a50dSMatthew G. Knepley 
7332cdb7a50dSMatthew G. Knepley   Output Parameter:
7333cdb7a50dSMatthew G. Knepley . val  - The output sequence value
7334cdb7a50dSMatthew G. Knepley 
7335cdb7a50dSMatthew G. Knepley   Level: intermediate
7336cdb7a50dSMatthew G. Knepley 
7337cdb7a50dSMatthew G. Knepley   Note: This is intended for output that should appear in sequence, for instance
7338cdb7a50dSMatthew G. Knepley   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
7339cdb7a50dSMatthew G. Knepley 
7340cdb7a50dSMatthew G. Knepley .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
7341cdb7a50dSMatthew G. Knepley @*/
7342cdb7a50dSMatthew G. Knepley PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
7343cdb7a50dSMatthew G. Knepley {
7344cdb7a50dSMatthew G. Knepley   PetscBool      ishdf5;
7345cdb7a50dSMatthew G. Knepley 
7346cdb7a50dSMatthew G. Knepley   PetscFunctionBegin;
7347cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7348cdb7a50dSMatthew G. Knepley   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
7349064a246eSJacob Faibussowitsch   PetscValidRealPointer(val,5);
73509566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5));
7351cdb7a50dSMatthew G. Knepley   if (ishdf5) {
7352cdb7a50dSMatthew G. Knepley #if defined(PETSC_HAVE_HDF5)
7353cdb7a50dSMatthew G. Knepley     PetscScalar value;
7354cdb7a50dSMatthew G. Knepley 
73559566063dSJacob Faibussowitsch     PetscCall(DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer));
73564aeb217fSMatthew G. Knepley     *val = PetscRealPart(value);
7357cdb7a50dSMatthew G. Knepley #endif
7358cdb7a50dSMatthew G. Knepley   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
7359f4d763aaSMatthew G. Knepley   PetscFunctionReturn(0);
7360f4d763aaSMatthew G. Knepley }
73618e4ac7eaSMatthew G. Knepley 
73628e4ac7eaSMatthew G. Knepley /*@
73638e4ac7eaSMatthew G. Knepley   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
73648e4ac7eaSMatthew G. Knepley 
73658e4ac7eaSMatthew G. Knepley   Not collective
73668e4ac7eaSMatthew G. Knepley 
73678e4ac7eaSMatthew G. Knepley   Input Parameter:
73688e4ac7eaSMatthew G. Knepley . dm - The DM
73698e4ac7eaSMatthew G. Knepley 
73708e4ac7eaSMatthew G. Knepley   Output Parameter:
73718e4ac7eaSMatthew G. Knepley . useNatural - The flag to build the mapping to a natural order during distribution
73728e4ac7eaSMatthew G. Knepley 
73738e4ac7eaSMatthew G. Knepley   Level: beginner
73748e4ac7eaSMatthew G. Knepley 
73758e4ac7eaSMatthew G. Knepley .seealso: DMSetUseNatural(), DMCreate()
73768e4ac7eaSMatthew G. Knepley @*/
73778e4ac7eaSMatthew G. Knepley PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
73788e4ac7eaSMatthew G. Knepley {
73798e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
73808e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7381534a8f05SLisandro Dalcin   PetscValidBoolPointer(useNatural, 2);
73828e4ac7eaSMatthew G. Knepley   *useNatural = dm->useNatural;
73838e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
73848e4ac7eaSMatthew G. Knepley }
73858e4ac7eaSMatthew G. Knepley 
73868e4ac7eaSMatthew G. Knepley /*@
73875d3b26e6SMatthew G. Knepley   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
73888e4ac7eaSMatthew G. Knepley 
73898e4ac7eaSMatthew G. Knepley   Collective on dm
73908e4ac7eaSMatthew G. Knepley 
73918e4ac7eaSMatthew G. Knepley   Input Parameters:
73928e4ac7eaSMatthew G. Knepley + dm - The DM
73938e4ac7eaSMatthew G. Knepley - useNatural - The flag to build the mapping to a natural order during distribution
73948e4ac7eaSMatthew G. Knepley 
73955d3b26e6SMatthew G. Knepley   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
73965d3b26e6SMatthew G. Knepley 
73978e4ac7eaSMatthew G. Knepley   Level: beginner
73988e4ac7eaSMatthew G. Knepley 
73995d3b26e6SMatthew G. Knepley .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
74008e4ac7eaSMatthew G. Knepley @*/
74018e4ac7eaSMatthew G. Knepley PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
74028e4ac7eaSMatthew G. Knepley {
74038e4ac7eaSMatthew G. Knepley   PetscFunctionBegin;
74048e4ac7eaSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
74058833efb5SBlaise Bourdin   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
74068e4ac7eaSMatthew G. Knepley   dm->useNatural = useNatural;
74078e4ac7eaSMatthew G. Knepley   PetscFunctionReturn(0);
74088e4ac7eaSMatthew G. Knepley }
7409c58f1c22SToby Isaac 
7410c58f1c22SToby Isaac /*@C
7411c58f1c22SToby Isaac   DMCreateLabel - Create a label of the given name if it does not already exist
7412c58f1c22SToby Isaac 
7413c58f1c22SToby Isaac   Not Collective
7414c58f1c22SToby Isaac 
7415c58f1c22SToby Isaac   Input Parameters:
7416c58f1c22SToby Isaac + dm   - The DM object
7417c58f1c22SToby Isaac - name - The label name
7418c58f1c22SToby Isaac 
7419c58f1c22SToby Isaac   Level: intermediate
7420c58f1c22SToby Isaac 
7421c58f1c22SToby Isaac .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7422c58f1c22SToby Isaac @*/
7423c58f1c22SToby Isaac PetscErrorCode DMCreateLabel(DM dm, const char name[])
7424c58f1c22SToby Isaac {
74255d80c0bfSVaclav Hapla   PetscBool      flg;
74265d80c0bfSVaclav Hapla   DMLabel        label;
7427c58f1c22SToby Isaac 
7428c58f1c22SToby Isaac   PetscFunctionBegin;
7429c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7430c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
74319566063dSJacob Faibussowitsch   PetscCall(DMHasLabel(dm, name, &flg));
7432c58f1c22SToby Isaac   if (!flg) {
74339566063dSJacob Faibussowitsch     PetscCall(DMLabelCreate(PETSC_COMM_SELF, name, &label));
74349566063dSJacob Faibussowitsch     PetscCall(DMAddLabel(dm, label));
74359566063dSJacob Faibussowitsch     PetscCall(DMLabelDestroy(&label));
7436c58f1c22SToby Isaac   }
7437c58f1c22SToby Isaac   PetscFunctionReturn(0);
7438c58f1c22SToby Isaac }
7439c58f1c22SToby Isaac 
7440c58f1c22SToby Isaac /*@C
74410fdc7489SMatthew Knepley   DMCreateLabelAtIndex - Create a label of the given name at the iven index. If it already exists, move it to this index.
74420fdc7489SMatthew Knepley 
74430fdc7489SMatthew Knepley   Not Collective
74440fdc7489SMatthew Knepley 
74450fdc7489SMatthew Knepley   Input Parameters:
74460fdc7489SMatthew Knepley + dm   - The DM object
74470fdc7489SMatthew Knepley . l    - The index for the label
74480fdc7489SMatthew Knepley - name - The label name
74490fdc7489SMatthew Knepley 
74500fdc7489SMatthew Knepley   Level: intermediate
74510fdc7489SMatthew Knepley 
74520fdc7489SMatthew Knepley .seealso: DMCreateLabel(), DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
74530fdc7489SMatthew Knepley @*/
74540fdc7489SMatthew Knepley PetscErrorCode DMCreateLabelAtIndex(DM dm, PetscInt l, const char name[])
74550fdc7489SMatthew Knepley {
74560fdc7489SMatthew Knepley   DMLabelLink    orig, prev = NULL;
74570fdc7489SMatthew Knepley   DMLabel        label;
74580fdc7489SMatthew Knepley   PetscInt       Nl, m;
74590fdc7489SMatthew Knepley   PetscBool      flg, match;
74600fdc7489SMatthew Knepley   const char    *lname;
74610fdc7489SMatthew Knepley 
74620fdc7489SMatthew Knepley   PetscFunctionBegin;
74630fdc7489SMatthew Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7464064a246eSJacob Faibussowitsch   PetscValidCharPointer(name, 3);
74659566063dSJacob Faibussowitsch   PetscCall(DMHasLabel(dm, name, &flg));
74660fdc7489SMatthew Knepley   if (!flg) {
74679566063dSJacob Faibussowitsch     PetscCall(DMLabelCreate(PETSC_COMM_SELF, name, &label));
74689566063dSJacob Faibussowitsch     PetscCall(DMAddLabel(dm, label));
74699566063dSJacob Faibussowitsch     PetscCall(DMLabelDestroy(&label));
74700fdc7489SMatthew Knepley   }
74719566063dSJacob Faibussowitsch   PetscCall(DMGetNumLabels(dm, &Nl));
74727a8be351SBarry Smith   PetscCheck(l < Nl,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label index %D must be in [0, %D)", l, Nl);
74730fdc7489SMatthew Knepley   for (m = 0, orig = dm->labels; m < Nl; ++m, prev = orig, orig = orig->next) {
74749566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject) orig->label, &lname));
74759566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(name, lname, &match));
74760fdc7489SMatthew Knepley     if (match) break;
74770fdc7489SMatthew Knepley   }
74780fdc7489SMatthew Knepley   if (m == l) PetscFunctionReturn(0);
74790fdc7489SMatthew Knepley   if (!m) dm->labels = orig->next;
74800fdc7489SMatthew Knepley   else    prev->next = orig->next;
74810fdc7489SMatthew Knepley   if (!l) {
74820fdc7489SMatthew Knepley     orig->next = dm->labels;
74830fdc7489SMatthew Knepley     dm->labels = orig;
74840fdc7489SMatthew Knepley   } else {
74850fdc7489SMatthew Knepley     for (m = 0, prev = dm->labels; m < l-1; ++m, prev = prev->next);
74860fdc7489SMatthew Knepley     orig->next = prev->next;
74870fdc7489SMatthew Knepley     prev->next = orig;
74880fdc7489SMatthew Knepley   }
74890fdc7489SMatthew Knepley   PetscFunctionReturn(0);
74900fdc7489SMatthew Knepley }
74910fdc7489SMatthew Knepley 
74920fdc7489SMatthew Knepley /*@C
7493c58f1c22SToby Isaac   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
7494c58f1c22SToby Isaac 
7495c58f1c22SToby Isaac   Not Collective
7496c58f1c22SToby Isaac 
7497c58f1c22SToby Isaac   Input Parameters:
7498c58f1c22SToby Isaac + dm   - The DM object
7499c58f1c22SToby Isaac . name - The label name
7500c58f1c22SToby Isaac - point - The mesh point
7501c58f1c22SToby Isaac 
7502c58f1c22SToby Isaac   Output Parameter:
7503c58f1c22SToby Isaac . value - The label value for this point, or -1 if the point is not in the label
7504c58f1c22SToby Isaac 
7505c58f1c22SToby Isaac   Level: beginner
7506c58f1c22SToby Isaac 
7507c58f1c22SToby Isaac .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
7508c58f1c22SToby Isaac @*/
7509c58f1c22SToby Isaac PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
7510c58f1c22SToby Isaac {
7511c58f1c22SToby Isaac   DMLabel        label;
7512c58f1c22SToby Isaac 
7513c58f1c22SToby Isaac   PetscFunctionBegin;
7514c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7515c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
75169566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
75177a8be351SBarry Smith   PetscCheck(label,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
75189566063dSJacob Faibussowitsch   PetscCall(DMLabelGetValue(label, point, value));
7519c58f1c22SToby Isaac   PetscFunctionReturn(0);
7520c58f1c22SToby Isaac }
7521c58f1c22SToby Isaac 
7522c58f1c22SToby Isaac /*@C
7523c58f1c22SToby Isaac   DMSetLabelValue - Add a point to a Sieve Label with given value
7524c58f1c22SToby Isaac 
7525c58f1c22SToby Isaac   Not Collective
7526c58f1c22SToby Isaac 
7527c58f1c22SToby Isaac   Input Parameters:
7528c58f1c22SToby Isaac + dm   - The DM object
7529c58f1c22SToby Isaac . name - The label name
7530c58f1c22SToby Isaac . point - The mesh point
7531c58f1c22SToby Isaac - value - The label value for this point
7532c58f1c22SToby Isaac 
7533c58f1c22SToby Isaac   Output Parameter:
7534c58f1c22SToby Isaac 
7535c58f1c22SToby Isaac   Level: beginner
7536c58f1c22SToby Isaac 
7537c58f1c22SToby Isaac .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
7538c58f1c22SToby Isaac @*/
7539c58f1c22SToby Isaac PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7540c58f1c22SToby Isaac {
7541c58f1c22SToby Isaac   DMLabel        label;
7542c58f1c22SToby Isaac 
7543c58f1c22SToby Isaac   PetscFunctionBegin;
7544c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7545c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
75469566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
7547c58f1c22SToby Isaac   if (!label) {
75489566063dSJacob Faibussowitsch     PetscCall(DMCreateLabel(dm, name));
75499566063dSJacob Faibussowitsch     PetscCall(DMGetLabel(dm, name, &label));
7550c58f1c22SToby Isaac   }
75519566063dSJacob Faibussowitsch   PetscCall(DMLabelSetValue(label, point, value));
7552c58f1c22SToby Isaac   PetscFunctionReturn(0);
7553c58f1c22SToby Isaac }
7554c58f1c22SToby Isaac 
7555c58f1c22SToby Isaac /*@C
7556c58f1c22SToby Isaac   DMClearLabelValue - Remove a point from a Sieve Label with given value
7557c58f1c22SToby Isaac 
7558c58f1c22SToby Isaac   Not Collective
7559c58f1c22SToby Isaac 
7560c58f1c22SToby Isaac   Input Parameters:
7561c58f1c22SToby Isaac + dm   - The DM object
7562c58f1c22SToby Isaac . name - The label name
7563c58f1c22SToby Isaac . point - The mesh point
7564c58f1c22SToby Isaac - value - The label value for this point
7565c58f1c22SToby Isaac 
7566c58f1c22SToby Isaac   Output Parameter:
7567c58f1c22SToby Isaac 
7568c58f1c22SToby Isaac   Level: beginner
7569c58f1c22SToby Isaac 
7570c58f1c22SToby Isaac .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
7571c58f1c22SToby Isaac @*/
7572c58f1c22SToby Isaac PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
7573c58f1c22SToby Isaac {
7574c58f1c22SToby Isaac   DMLabel        label;
7575c58f1c22SToby Isaac 
7576c58f1c22SToby Isaac   PetscFunctionBegin;
7577c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7578c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
75799566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
7580c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
75819566063dSJacob Faibussowitsch   PetscCall(DMLabelClearValue(label, point, value));
7582c58f1c22SToby Isaac   PetscFunctionReturn(0);
7583c58f1c22SToby Isaac }
7584c58f1c22SToby Isaac 
7585c58f1c22SToby Isaac /*@C
7586c58f1c22SToby Isaac   DMGetLabelSize - Get the number of different integer ids in a Label
7587c58f1c22SToby Isaac 
7588c58f1c22SToby Isaac   Not Collective
7589c58f1c22SToby Isaac 
7590c58f1c22SToby Isaac   Input Parameters:
7591c58f1c22SToby Isaac + dm   - The DM object
7592c58f1c22SToby Isaac - name - The label name
7593c58f1c22SToby Isaac 
7594c58f1c22SToby Isaac   Output Parameter:
7595c58f1c22SToby Isaac . size - The number of different integer ids, or 0 if the label does not exist
7596c58f1c22SToby Isaac 
7597c58f1c22SToby Isaac   Level: beginner
7598c58f1c22SToby Isaac 
7599df813f42SMatthew G. Knepley .seealso: DMLabelGetNumValues(), DMSetLabelValue()
7600c58f1c22SToby Isaac @*/
7601c58f1c22SToby Isaac PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
7602c58f1c22SToby Isaac {
7603c58f1c22SToby Isaac   DMLabel        label;
7604c58f1c22SToby Isaac 
7605c58f1c22SToby Isaac   PetscFunctionBegin;
7606c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7607c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7608534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 3);
76099566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
7610c58f1c22SToby Isaac   *size = 0;
7611c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
76129566063dSJacob Faibussowitsch   PetscCall(DMLabelGetNumValues(label, size));
7613c58f1c22SToby Isaac   PetscFunctionReturn(0);
7614c58f1c22SToby Isaac }
7615c58f1c22SToby Isaac 
7616c58f1c22SToby Isaac /*@C
7617c58f1c22SToby Isaac   DMGetLabelIdIS - Get the integer ids in a label
7618c58f1c22SToby Isaac 
7619c58f1c22SToby Isaac   Not Collective
7620c58f1c22SToby Isaac 
7621c58f1c22SToby Isaac   Input Parameters:
7622c58f1c22SToby Isaac + mesh - The DM object
7623c58f1c22SToby Isaac - name - The label name
7624c58f1c22SToby Isaac 
7625c58f1c22SToby Isaac   Output Parameter:
7626c58f1c22SToby Isaac . ids - The integer ids, or NULL if the label does not exist
7627c58f1c22SToby Isaac 
7628c58f1c22SToby Isaac   Level: beginner
7629c58f1c22SToby Isaac 
7630c58f1c22SToby Isaac .seealso: DMLabelGetValueIS(), DMGetLabelSize()
7631c58f1c22SToby Isaac @*/
7632c58f1c22SToby Isaac PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
7633c58f1c22SToby Isaac {
7634c58f1c22SToby Isaac   DMLabel        label;
7635c58f1c22SToby Isaac 
7636c58f1c22SToby Isaac   PetscFunctionBegin;
7637c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7638c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7639c58f1c22SToby Isaac   PetscValidPointer(ids, 3);
76409566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
7641c58f1c22SToby Isaac   *ids = NULL;
7642dab2e251SBlaise Bourdin  if (label) {
76439566063dSJacob Faibussowitsch     PetscCall(DMLabelGetValueIS(label, ids));
7644dab2e251SBlaise Bourdin   } else {
7645dab2e251SBlaise Bourdin     /* returning an empty IS */
76469566063dSJacob Faibussowitsch     PetscCall(ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids));
7647dab2e251SBlaise Bourdin   }
7648c58f1c22SToby Isaac   PetscFunctionReturn(0);
7649c58f1c22SToby Isaac }
7650c58f1c22SToby Isaac 
7651c58f1c22SToby Isaac /*@C
7652c58f1c22SToby Isaac   DMGetStratumSize - Get the number of points in a label stratum
7653c58f1c22SToby Isaac 
7654c58f1c22SToby Isaac   Not Collective
7655c58f1c22SToby Isaac 
7656c58f1c22SToby Isaac   Input Parameters:
7657c58f1c22SToby Isaac + dm - The DM object
7658c58f1c22SToby Isaac . name - The label name
7659c58f1c22SToby Isaac - value - The stratum value
7660c58f1c22SToby Isaac 
7661c58f1c22SToby Isaac   Output Parameter:
7662c58f1c22SToby Isaac . size - The stratum size
7663c58f1c22SToby Isaac 
7664c58f1c22SToby Isaac   Level: beginner
7665c58f1c22SToby Isaac 
7666c58f1c22SToby Isaac .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
7667c58f1c22SToby Isaac @*/
7668c58f1c22SToby Isaac PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
7669c58f1c22SToby Isaac {
7670c58f1c22SToby Isaac   DMLabel        label;
7671c58f1c22SToby Isaac 
7672c58f1c22SToby Isaac   PetscFunctionBegin;
7673c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7674c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7675534a8f05SLisandro Dalcin   PetscValidIntPointer(size, 4);
76769566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
7677c58f1c22SToby Isaac   *size = 0;
7678c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
76799566063dSJacob Faibussowitsch   PetscCall(DMLabelGetStratumSize(label, value, size));
7680c58f1c22SToby Isaac   PetscFunctionReturn(0);
7681c58f1c22SToby Isaac }
7682c58f1c22SToby Isaac 
7683c58f1c22SToby Isaac /*@C
7684c58f1c22SToby Isaac   DMGetStratumIS - Get the points in a label stratum
7685c58f1c22SToby Isaac 
7686c58f1c22SToby Isaac   Not Collective
7687c58f1c22SToby Isaac 
7688c58f1c22SToby Isaac   Input Parameters:
7689c58f1c22SToby Isaac + dm - The DM object
7690c58f1c22SToby Isaac . name - The label name
7691c58f1c22SToby Isaac - value - The stratum value
7692c58f1c22SToby Isaac 
7693c58f1c22SToby Isaac   Output Parameter:
7694c58f1c22SToby Isaac . points - The stratum points, or NULL if the label does not exist or does not have that value
7695c58f1c22SToby Isaac 
7696c58f1c22SToby Isaac   Level: beginner
7697c58f1c22SToby Isaac 
7698c58f1c22SToby Isaac .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
7699c58f1c22SToby Isaac @*/
7700c58f1c22SToby Isaac PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
7701c58f1c22SToby Isaac {
7702c58f1c22SToby Isaac   DMLabel        label;
7703c58f1c22SToby Isaac 
7704c58f1c22SToby Isaac   PetscFunctionBegin;
7705c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7706c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7707c58f1c22SToby Isaac   PetscValidPointer(points, 4);
77089566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
7709c58f1c22SToby Isaac   *points = NULL;
7710c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
77119566063dSJacob Faibussowitsch   PetscCall(DMLabelGetStratumIS(label, value, points));
7712c58f1c22SToby Isaac   PetscFunctionReturn(0);
7713c58f1c22SToby Isaac }
7714c58f1c22SToby Isaac 
77154de306b1SToby Isaac /*@C
77169044fa66SMatthew G. Knepley   DMSetStratumIS - Set the points in a label stratum
77174de306b1SToby Isaac 
77184de306b1SToby Isaac   Not Collective
77194de306b1SToby Isaac 
77204de306b1SToby Isaac   Input Parameters:
77214de306b1SToby Isaac + dm - The DM object
77224de306b1SToby Isaac . name - The label name
77234de306b1SToby Isaac . value - The stratum value
77244de306b1SToby Isaac - points - The stratum points
77254de306b1SToby Isaac 
77264de306b1SToby Isaac   Level: beginner
77274de306b1SToby Isaac 
77284de306b1SToby Isaac .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
77294de306b1SToby Isaac @*/
77304de306b1SToby Isaac PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
77314de306b1SToby Isaac {
77324de306b1SToby Isaac   DMLabel        label;
77334de306b1SToby Isaac 
77344de306b1SToby Isaac   PetscFunctionBegin;
77354de306b1SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
77364de306b1SToby Isaac   PetscValidCharPointer(name, 2);
77374de306b1SToby Isaac   PetscValidPointer(points, 4);
77389566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
77394de306b1SToby Isaac   if (!label) PetscFunctionReturn(0);
77409566063dSJacob Faibussowitsch   PetscCall(DMLabelSetStratumIS(label, value, points));
77414de306b1SToby Isaac   PetscFunctionReturn(0);
77424de306b1SToby Isaac }
77434de306b1SToby Isaac 
7744c58f1c22SToby Isaac /*@C
7745c58f1c22SToby Isaac   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7746c58f1c22SToby Isaac 
7747c58f1c22SToby Isaac   Not Collective
7748c58f1c22SToby Isaac 
7749c58f1c22SToby Isaac   Input Parameters:
7750c58f1c22SToby Isaac + dm   - The DM object
7751c58f1c22SToby Isaac . name - The label name
7752c58f1c22SToby Isaac - value - The label value for this point
7753c58f1c22SToby Isaac 
7754c58f1c22SToby Isaac   Output Parameter:
7755c58f1c22SToby Isaac 
7756c58f1c22SToby Isaac   Level: beginner
7757c58f1c22SToby Isaac 
7758c58f1c22SToby Isaac .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7759c58f1c22SToby Isaac @*/
7760c58f1c22SToby Isaac PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7761c58f1c22SToby Isaac {
7762c58f1c22SToby Isaac   DMLabel        label;
7763c58f1c22SToby Isaac 
7764c58f1c22SToby Isaac   PetscFunctionBegin;
7765c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7766c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
77679566063dSJacob Faibussowitsch   PetscCall(DMGetLabel(dm, name, &label));
7768c58f1c22SToby Isaac   if (!label) PetscFunctionReturn(0);
77699566063dSJacob Faibussowitsch   PetscCall(DMLabelClearStratum(label, value));
7770c58f1c22SToby Isaac   PetscFunctionReturn(0);
7771c58f1c22SToby Isaac }
7772c58f1c22SToby Isaac 
7773c58f1c22SToby Isaac /*@
7774c58f1c22SToby Isaac   DMGetNumLabels - Return the number of labels defined by the mesh
7775c58f1c22SToby Isaac 
7776c58f1c22SToby Isaac   Not Collective
7777c58f1c22SToby Isaac 
7778c58f1c22SToby Isaac   Input Parameter:
7779c58f1c22SToby Isaac . dm   - The DM object
7780c58f1c22SToby Isaac 
7781c58f1c22SToby Isaac   Output Parameter:
7782c58f1c22SToby Isaac . numLabels - the number of Labels
7783c58f1c22SToby Isaac 
7784c58f1c22SToby Isaac   Level: intermediate
7785c58f1c22SToby Isaac 
7786c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7787c58f1c22SToby Isaac @*/
7788c58f1c22SToby Isaac PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7789c58f1c22SToby Isaac {
77905d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7791c58f1c22SToby Isaac   PetscInt  n    = 0;
7792c58f1c22SToby Isaac 
7793c58f1c22SToby Isaac   PetscFunctionBegin;
7794c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7795534a8f05SLisandro Dalcin   PetscValidIntPointer(numLabels, 2);
7796c58f1c22SToby Isaac   while (next) {++n; next = next->next;}
7797c58f1c22SToby Isaac   *numLabels = n;
7798c58f1c22SToby Isaac   PetscFunctionReturn(0);
7799c58f1c22SToby Isaac }
7800c58f1c22SToby Isaac 
7801c58f1c22SToby Isaac /*@C
7802c58f1c22SToby Isaac   DMGetLabelName - Return the name of nth label
7803c58f1c22SToby Isaac 
7804c58f1c22SToby Isaac   Not Collective
7805c58f1c22SToby Isaac 
7806c58f1c22SToby Isaac   Input Parameters:
7807c58f1c22SToby Isaac + dm - The DM object
7808c58f1c22SToby Isaac - n  - the label number
7809c58f1c22SToby Isaac 
7810c58f1c22SToby Isaac   Output Parameter:
7811c58f1c22SToby Isaac . name - the label name
7812c58f1c22SToby Isaac 
7813c58f1c22SToby Isaac   Level: intermediate
7814c58f1c22SToby Isaac 
7815c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7816c58f1c22SToby Isaac @*/
7817c58f1c22SToby Isaac PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7818c58f1c22SToby Isaac {
78195d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7820c58f1c22SToby Isaac   PetscInt       l    = 0;
7821c58f1c22SToby Isaac 
7822c58f1c22SToby Isaac   PetscFunctionBegin;
7823c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7824c58f1c22SToby Isaac   PetscValidPointer(name, 3);
7825c58f1c22SToby Isaac   while (next) {
7826c58f1c22SToby Isaac     if (l == n) {
78279566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetName((PetscObject) next->label, name));
7828c58f1c22SToby Isaac       PetscFunctionReturn(0);
7829c58f1c22SToby Isaac     }
7830c58f1c22SToby Isaac     ++l;
7831c58f1c22SToby Isaac     next = next->next;
7832c58f1c22SToby Isaac   }
783398921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7834c58f1c22SToby Isaac }
7835c58f1c22SToby Isaac 
7836c58f1c22SToby Isaac /*@C
7837c58f1c22SToby Isaac   DMHasLabel - Determine whether the mesh has a label of a given name
7838c58f1c22SToby Isaac 
7839c58f1c22SToby Isaac   Not Collective
7840c58f1c22SToby Isaac 
7841c58f1c22SToby Isaac   Input Parameters:
7842c58f1c22SToby Isaac + dm   - The DM object
7843c58f1c22SToby Isaac - name - The label name
7844c58f1c22SToby Isaac 
7845c58f1c22SToby Isaac   Output Parameter:
7846c58f1c22SToby Isaac . hasLabel - PETSC_TRUE if the label is present
7847c58f1c22SToby Isaac 
7848c58f1c22SToby Isaac   Level: intermediate
7849c58f1c22SToby Isaac 
7850c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7851c58f1c22SToby Isaac @*/
7852c58f1c22SToby Isaac PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
7853c58f1c22SToby Isaac {
78545d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7855d67d17b1SMatthew G. Knepley   const char    *lname;
7856c58f1c22SToby Isaac 
7857c58f1c22SToby Isaac   PetscFunctionBegin;
7858c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7859c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7860534a8f05SLisandro Dalcin   PetscValidBoolPointer(hasLabel, 3);
7861c58f1c22SToby Isaac   *hasLabel = PETSC_FALSE;
7862c58f1c22SToby Isaac   while (next) {
78639566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject) next->label, &lname));
78649566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(name, lname, hasLabel));
7865c58f1c22SToby Isaac     if (*hasLabel) break;
7866c58f1c22SToby Isaac     next = next->next;
7867c58f1c22SToby Isaac   }
7868c58f1c22SToby Isaac   PetscFunctionReturn(0);
7869c58f1c22SToby Isaac }
7870c58f1c22SToby Isaac 
7871c58f1c22SToby Isaac /*@C
7872c58f1c22SToby Isaac   DMGetLabel - Return the label of a given name, or NULL
7873c58f1c22SToby Isaac 
7874c58f1c22SToby Isaac   Not Collective
7875c58f1c22SToby Isaac 
7876c58f1c22SToby Isaac   Input Parameters:
7877c58f1c22SToby Isaac + dm   - The DM object
7878c58f1c22SToby Isaac - name - The label name
7879c58f1c22SToby Isaac 
7880c58f1c22SToby Isaac   Output Parameter:
7881c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
7882c58f1c22SToby Isaac 
78836d7c9049SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
78846d7c9049SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
78856d7c9049SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
78866d7c9049SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
78876d7c9049SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
78886d7c9049SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
78896d7c9049SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
78906d7c9049SMatthew G. Knepley 
7891c58f1c22SToby Isaac   Level: intermediate
7892c58f1c22SToby Isaac 
78936d7c9049SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
7894c58f1c22SToby Isaac @*/
7895c58f1c22SToby Isaac PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
7896c58f1c22SToby Isaac {
78975d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
7898c58f1c22SToby Isaac   PetscBool      hasLabel;
7899d67d17b1SMatthew G. Knepley   const char    *lname;
7900c58f1c22SToby Isaac 
7901c58f1c22SToby Isaac   PetscFunctionBegin;
7902c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7903c58f1c22SToby Isaac   PetscValidCharPointer(name, 2);
7904c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7905c58f1c22SToby Isaac   *label = NULL;
7906c58f1c22SToby Isaac   while (next) {
79079566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject) next->label, &lname));
79089566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(name, lname, &hasLabel));
7909c58f1c22SToby Isaac     if (hasLabel) {
7910c58f1c22SToby Isaac       *label = next->label;
7911c58f1c22SToby Isaac       break;
7912c58f1c22SToby Isaac     }
7913c58f1c22SToby Isaac     next = next->next;
7914c58f1c22SToby Isaac   }
7915c58f1c22SToby Isaac   PetscFunctionReturn(0);
7916c58f1c22SToby Isaac }
7917c58f1c22SToby Isaac 
7918c58f1c22SToby Isaac /*@C
7919c58f1c22SToby Isaac   DMGetLabelByNum - Return the nth label
7920c58f1c22SToby Isaac 
7921c58f1c22SToby Isaac   Not Collective
7922c58f1c22SToby Isaac 
7923c58f1c22SToby Isaac   Input Parameters:
7924c58f1c22SToby Isaac + dm - The DM object
7925c58f1c22SToby Isaac - n  - the label number
7926c58f1c22SToby Isaac 
7927c58f1c22SToby Isaac   Output Parameter:
7928c58f1c22SToby Isaac . label - the label
7929c58f1c22SToby Isaac 
7930c58f1c22SToby Isaac   Level: intermediate
7931c58f1c22SToby Isaac 
7932c58f1c22SToby Isaac .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7933c58f1c22SToby Isaac @*/
7934c58f1c22SToby Isaac PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
7935c58f1c22SToby Isaac {
79365d80c0bfSVaclav Hapla   DMLabelLink next = dm->labels;
7937c58f1c22SToby Isaac   PetscInt    l    = 0;
7938c58f1c22SToby Isaac 
7939c58f1c22SToby Isaac   PetscFunctionBegin;
7940c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7941c58f1c22SToby Isaac   PetscValidPointer(label, 3);
7942c58f1c22SToby Isaac   while (next) {
7943c58f1c22SToby Isaac     if (l == n) {
7944c58f1c22SToby Isaac       *label = next->label;
7945c58f1c22SToby Isaac       PetscFunctionReturn(0);
7946c58f1c22SToby Isaac     }
7947c58f1c22SToby Isaac     ++l;
7948c58f1c22SToby Isaac     next = next->next;
7949c58f1c22SToby Isaac   }
795098921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7951c58f1c22SToby Isaac }
7952c58f1c22SToby Isaac 
7953c58f1c22SToby Isaac /*@C
7954c58f1c22SToby Isaac   DMAddLabel - Add the label to this mesh
7955c58f1c22SToby Isaac 
7956c58f1c22SToby Isaac   Not Collective
7957c58f1c22SToby Isaac 
7958c58f1c22SToby Isaac   Input Parameters:
7959c58f1c22SToby Isaac + dm   - The DM object
7960c58f1c22SToby Isaac - label - The DMLabel
7961c58f1c22SToby Isaac 
7962c58f1c22SToby Isaac   Level: developer
7963c58f1c22SToby Isaac 
7964c58f1c22SToby Isaac .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7965c58f1c22SToby Isaac @*/
7966c58f1c22SToby Isaac PetscErrorCode DMAddLabel(DM dm, DMLabel label)
7967c58f1c22SToby Isaac {
79685d80c0bfSVaclav Hapla   DMLabelLink    l, *p, tmpLabel;
7969c58f1c22SToby Isaac   PetscBool      hasLabel;
7970d67d17b1SMatthew G. Knepley   const char    *lname;
79715d80c0bfSVaclav Hapla   PetscBool      flg;
7972c58f1c22SToby Isaac 
7973c58f1c22SToby Isaac   PetscFunctionBegin;
7974c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
79759566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject) label, &lname));
79769566063dSJacob Faibussowitsch   PetscCall(DMHasLabel(dm, lname, &hasLabel));
79777a8be351SBarry Smith   PetscCheck(!hasLabel,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
79789566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(1, &tmpLabel));
7979c58f1c22SToby Isaac   tmpLabel->label  = label;
7980c58f1c22SToby Isaac   tmpLabel->output = PETSC_TRUE;
79815d80c0bfSVaclav Hapla   for (p=&dm->labels; (l=*p); p=&l->next) {}
79825d80c0bfSVaclav Hapla   *p = tmpLabel;
79839566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)label));
79849566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(lname, "depth", &flg));
79855d80c0bfSVaclav Hapla   if (flg) dm->depthLabel = label;
79869566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(lname, "celltype", &flg));
7987ba2698f1SMatthew G. Knepley   if (flg) dm->celltypeLabel = label;
7988c58f1c22SToby Isaac   PetscFunctionReturn(0);
7989c58f1c22SToby Isaac }
7990c58f1c22SToby Isaac 
7991c58f1c22SToby Isaac /*@C
79924a7ee7d0SMatthew G. Knepley   DMSetLabel - Replaces the label of a given name, or ignores it if the name is not present
79934a7ee7d0SMatthew G. Knepley 
79944a7ee7d0SMatthew G. Knepley   Not Collective
79954a7ee7d0SMatthew G. Knepley 
79964a7ee7d0SMatthew G. Knepley   Input Parameters:
79974a7ee7d0SMatthew G. Knepley + dm    - The DM object
79984a7ee7d0SMatthew G. Knepley - label - The DMLabel, having the same name, to substitute
79994a7ee7d0SMatthew G. Knepley 
80004a7ee7d0SMatthew G. Knepley   Note: Some of the default labels in a DMPlex will be
80014a7ee7d0SMatthew G. Knepley $ "depth"       - Holds the depth (co-dimension) of each mesh point
80024a7ee7d0SMatthew G. Knepley $ "celltype"    - Holds the topological type of each cell
80034a7ee7d0SMatthew G. Knepley $ "ghost"       - If the DM is distributed with overlap, this marks the cells and faces in the overlap
80044a7ee7d0SMatthew G. Knepley $ "Cell Sets"   - Mirrors the cell sets defined by GMsh and ExodusII
80054a7ee7d0SMatthew G. Knepley $ "Face Sets"   - Mirrors the face sets defined by GMsh and ExodusII
80064a7ee7d0SMatthew G. Knepley $ "Vertex Sets" - Mirrors the vertex sets defined by GMsh
80074a7ee7d0SMatthew G. Knepley 
80084a7ee7d0SMatthew G. Knepley   Level: intermediate
80094a7ee7d0SMatthew G. Knepley 
80104a7ee7d0SMatthew G. Knepley .seealso: DMCreateLabel(), DMHasLabel(), DMPlexGetDepthLabel(), DMPlexGetCellType()
80114a7ee7d0SMatthew G. Knepley @*/
80124a7ee7d0SMatthew G. Knepley PetscErrorCode DMSetLabel(DM dm, DMLabel label)
80134a7ee7d0SMatthew G. Knepley {
80144a7ee7d0SMatthew G. Knepley   DMLabelLink    next = dm->labels;
80154a7ee7d0SMatthew G. Knepley   PetscBool      hasLabel, flg;
80164a7ee7d0SMatthew G. Knepley   const char    *name, *lname;
80174a7ee7d0SMatthew G. Knepley 
80184a7ee7d0SMatthew G. Knepley   PetscFunctionBegin;
80194a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
80204a7ee7d0SMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
80219566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetName((PetscObject) label, &name));
80224a7ee7d0SMatthew G. Knepley   while (next) {
80239566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject) next->label, &lname));
80249566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(name, lname, &hasLabel));
80254a7ee7d0SMatthew G. Knepley     if (hasLabel) {
80269566063dSJacob Faibussowitsch       PetscCall(PetscObjectReference((PetscObject) label));
80279566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(lname, "depth", &flg));
80284a7ee7d0SMatthew G. Knepley       if (flg) dm->depthLabel = label;
80299566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(lname, "celltype", &flg));
80304a7ee7d0SMatthew G. Knepley       if (flg) dm->celltypeLabel = label;
80319566063dSJacob Faibussowitsch       PetscCall(DMLabelDestroy(&next->label));
80324a7ee7d0SMatthew G. Knepley       next->label = label;
80334a7ee7d0SMatthew G. Knepley       break;
80344a7ee7d0SMatthew G. Knepley     }
80354a7ee7d0SMatthew G. Knepley     next = next->next;
80364a7ee7d0SMatthew G. Knepley   }
80374a7ee7d0SMatthew G. Knepley   PetscFunctionReturn(0);
80384a7ee7d0SMatthew G. Knepley }
80394a7ee7d0SMatthew G. Knepley 
80404a7ee7d0SMatthew G. Knepley /*@C
8041e5472504SVaclav Hapla   DMRemoveLabel - Remove the label given by name from this mesh
8042c58f1c22SToby Isaac 
8043c58f1c22SToby Isaac   Not Collective
8044c58f1c22SToby Isaac 
8045c58f1c22SToby Isaac   Input Parameters:
8046c58f1c22SToby Isaac + dm   - The DM object
8047c58f1c22SToby Isaac - name - The label name
8048c58f1c22SToby Isaac 
8049c58f1c22SToby Isaac   Output Parameter:
8050c58f1c22SToby Isaac . label - The DMLabel, or NULL if the label is absent
8051c58f1c22SToby Isaac 
8052c58f1c22SToby Isaac   Level: developer
8053c58f1c22SToby Isaac 
8054e5472504SVaclav Hapla   Notes:
8055e5472504SVaclav Hapla   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
8056e5472504SVaclav Hapla   DMLabelDestroy() on the label.
8057e5472504SVaclav Hapla 
8058e5472504SVaclav Hapla   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
8059e5472504SVaclav Hapla   call DMLabelDestroy(). Instead, the label is returned and the user is
8060e5472504SVaclav Hapla   responsible of calling DMLabelDestroy() at some point.
8061e5472504SVaclav Hapla 
8062e5472504SVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
8063c58f1c22SToby Isaac @*/
8064c58f1c22SToby Isaac PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
8065c58f1c22SToby Isaac {
806695d578d6SVaclav Hapla   DMLabelLink    link, *pnext;
8067c58f1c22SToby Isaac   PetscBool      hasLabel;
8068d67d17b1SMatthew G. Knepley   const char    *lname;
8069c58f1c22SToby Isaac 
8070c58f1c22SToby Isaac   PetscFunctionBegin;
8071c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8072e5472504SVaclav Hapla   PetscValidCharPointer(name, 2);
8073e5472504SVaclav Hapla   if (label) {
8074e5472504SVaclav Hapla     PetscValidPointer(label, 3);
8075c58f1c22SToby Isaac     *label = NULL;
8076e5472504SVaclav Hapla   }
80775d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
80789566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject) link->label, &lname));
80799566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(name, lname, &hasLabel));
8080c58f1c22SToby Isaac     if (hasLabel) {
808195d578d6SVaclav Hapla       *pnext = link->next; /* Remove from list */
80829566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(name, "depth", &hasLabel));
808395d578d6SVaclav Hapla       if (hasLabel) dm->depthLabel = NULL;
80849566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(name, "celltype", &hasLabel));
8085ba2698f1SMatthew G. Knepley       if (hasLabel) dm->celltypeLabel = NULL;
808695d578d6SVaclav Hapla       if (label) *label = link->label;
80879566063dSJacob Faibussowitsch       else       PetscCall(DMLabelDestroy(&link->label));
80889566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
8089c58f1c22SToby Isaac       break;
8090c58f1c22SToby Isaac     }
8091c58f1c22SToby Isaac   }
8092c58f1c22SToby Isaac   PetscFunctionReturn(0);
8093c58f1c22SToby Isaac }
8094c58f1c22SToby Isaac 
8095306894acSVaclav Hapla /*@
8096306894acSVaclav Hapla   DMRemoveLabelBySelf - Remove the label from this mesh
8097306894acSVaclav Hapla 
8098306894acSVaclav Hapla   Not Collective
8099306894acSVaclav Hapla 
8100306894acSVaclav Hapla   Input Parameters:
8101306894acSVaclav Hapla + dm   - The DM object
8102876aa926SVaclav Hapla . label - The DMLabel to be removed from the DM
8103306894acSVaclav Hapla - failNotFound - Should it fail if the label is not found in the DM?
8104306894acSVaclav Hapla 
8105306894acSVaclav Hapla   Level: developer
8106306894acSVaclav Hapla 
8107306894acSVaclav Hapla   Notes:
8108306894acSVaclav Hapla   Only exactly the same instance is removed if found, name match is ignored.
8109306894acSVaclav Hapla   If the DM has an exclusive reference to the label, it gets destroyed and
8110306894acSVaclav Hapla   *label nullified.
8111306894acSVaclav Hapla 
8112306894acSVaclav Hapla .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
8113306894acSVaclav Hapla @*/
8114306894acSVaclav Hapla PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
8115306894acSVaclav Hapla {
811643e45a93SVaclav Hapla   DMLabelLink    link, *pnext;
8117306894acSVaclav Hapla   PetscBool      hasLabel = PETSC_FALSE;
8118306894acSVaclav Hapla 
8119306894acSVaclav Hapla   PetscFunctionBegin;
8120306894acSVaclav Hapla   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8121306894acSVaclav Hapla   PetscValidPointer(label, 2);
8122f39a9ae0SVaclav Hapla   if (!*label && !failNotFound) PetscFunctionReturn(0);
8123306894acSVaclav Hapla   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
8124306894acSVaclav Hapla   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
81255d80c0bfSVaclav Hapla   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
812643e45a93SVaclav Hapla     if (*label == link->label) {
8127306894acSVaclav Hapla       hasLabel = PETSC_TRUE;
812843e45a93SVaclav Hapla       *pnext = link->next; /* Remove from list */
8129306894acSVaclav Hapla       if (*label == dm->depthLabel) dm->depthLabel = NULL;
8130ba2698f1SMatthew G. Knepley       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
813143e45a93SVaclav Hapla       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
81329566063dSJacob Faibussowitsch       PetscCall(DMLabelDestroy(&link->label));
81339566063dSJacob Faibussowitsch       PetscCall(PetscFree(link));
8134306894acSVaclav Hapla       break;
8135306894acSVaclav Hapla     }
8136306894acSVaclav Hapla   }
81377a8be351SBarry Smith   PetscCheck(hasLabel || !failNotFound,PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
8138306894acSVaclav Hapla   PetscFunctionReturn(0);
8139306894acSVaclav Hapla }
8140306894acSVaclav Hapla 
8141c58f1c22SToby Isaac /*@C
8142c58f1c22SToby Isaac   DMGetLabelOutput - Get the output flag for a given label
8143c58f1c22SToby Isaac 
8144c58f1c22SToby Isaac   Not Collective
8145c58f1c22SToby Isaac 
8146c58f1c22SToby Isaac   Input Parameters:
8147c58f1c22SToby Isaac + dm   - The DM object
8148c58f1c22SToby Isaac - name - The label name
8149c58f1c22SToby Isaac 
8150c58f1c22SToby Isaac   Output Parameter:
8151c58f1c22SToby Isaac . output - The flag for output
8152c58f1c22SToby Isaac 
8153c58f1c22SToby Isaac   Level: developer
8154c58f1c22SToby Isaac 
8155c58f1c22SToby Isaac .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8156c58f1c22SToby Isaac @*/
8157c58f1c22SToby Isaac PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
8158c58f1c22SToby Isaac {
81595d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8160d67d17b1SMatthew G. Knepley   const char    *lname;
8161c58f1c22SToby Isaac 
8162c58f1c22SToby Isaac   PetscFunctionBegin;
8163c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8164dadcf809SJacob Faibussowitsch   PetscValidCharPointer(name, 2);
8165dadcf809SJacob Faibussowitsch   PetscValidBoolPointer(output, 3);
8166c58f1c22SToby Isaac   while (next) {
8167c58f1c22SToby Isaac     PetscBool flg;
8168c58f1c22SToby Isaac 
81699566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject) next->label, &lname));
81709566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(name, lname, &flg));
8171c58f1c22SToby Isaac     if (flg) {*output = next->output; PetscFunctionReturn(0);}
8172c58f1c22SToby Isaac     next = next->next;
8173c58f1c22SToby Isaac   }
817498921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8175c58f1c22SToby Isaac }
8176c58f1c22SToby Isaac 
8177c58f1c22SToby Isaac /*@C
8178c58f1c22SToby Isaac   DMSetLabelOutput - Set the output flag for a given label
8179c58f1c22SToby Isaac 
8180c58f1c22SToby Isaac   Not Collective
8181c58f1c22SToby Isaac 
8182c58f1c22SToby Isaac   Input Parameters:
8183c58f1c22SToby Isaac + dm     - The DM object
8184c58f1c22SToby Isaac . name   - The label name
8185c58f1c22SToby Isaac - output - The flag for output
8186c58f1c22SToby Isaac 
8187c58f1c22SToby Isaac   Level: developer
8188c58f1c22SToby Isaac 
8189c58f1c22SToby Isaac .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
8190c58f1c22SToby Isaac @*/
8191c58f1c22SToby Isaac PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
8192c58f1c22SToby Isaac {
81935d80c0bfSVaclav Hapla   DMLabelLink    next = dm->labels;
8194d67d17b1SMatthew G. Knepley   const char    *lname;
8195c58f1c22SToby Isaac 
8196c58f1c22SToby Isaac   PetscFunctionBegin;
8197c58f1c22SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8198534a8f05SLisandro Dalcin   PetscValidCharPointer(name, 2);
8199c58f1c22SToby Isaac   while (next) {
8200c58f1c22SToby Isaac     PetscBool flg;
8201c58f1c22SToby Isaac 
82029566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject) next->label, &lname));
82039566063dSJacob Faibussowitsch     PetscCall(PetscStrcmp(name, lname, &flg));
8204c58f1c22SToby Isaac     if (flg) {next->output = output; PetscFunctionReturn(0);}
8205c58f1c22SToby Isaac     next = next->next;
8206c58f1c22SToby Isaac   }
820798921bdaSJacob Faibussowitsch   SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
8208c58f1c22SToby Isaac }
8209c58f1c22SToby Isaac 
8210c58f1c22SToby Isaac /*@
8211c58f1c22SToby Isaac   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
8212c58f1c22SToby Isaac 
8213d083f849SBarry Smith   Collective on dmA
8214c58f1c22SToby Isaac 
8215d8d19677SJose E. Roman   Input Parameters:
82165d80c0bfSVaclav Hapla + dmA - The DM object with initial labels
82172cbb9b06SVaclav Hapla . dmB - The DM object to which labels are copied
82185d80c0bfSVaclav Hapla . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
82192cbb9b06SVaclav Hapla . all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
82202cbb9b06SVaclav Hapla - emode - How to behave when a DMLabel in the source and destination DMs with the same name is encountered (see DMCopyLabelsMode)
8221c58f1c22SToby Isaac 
8222c58f1c22SToby Isaac   Level: intermediate
8223c58f1c22SToby Isaac 
82242cbb9b06SVaclav Hapla   Notes:
82252cbb9b06SVaclav Hapla   This is typically used when interpolating or otherwise adding to a mesh, or testing.
8226c58f1c22SToby Isaac 
82272cbb9b06SVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode
8228c58f1c22SToby Isaac @*/
82292cbb9b06SVaclav Hapla PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all, DMCopyLabelsMode emode)
8230c58f1c22SToby Isaac {
82312cbb9b06SVaclav Hapla   DMLabel        label, labelNew, labelOld;
8232c58f1c22SToby Isaac   const char    *name;
8233c58f1c22SToby Isaac   PetscBool      flg;
82345d80c0bfSVaclav Hapla   DMLabelLink    link;
8235c58f1c22SToby Isaac 
82365d80c0bfSVaclav Hapla   PetscFunctionBegin;
82375d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
82385d80c0bfSVaclav Hapla   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
82395d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveEnum(dmA, mode,3);
82405d80c0bfSVaclav Hapla   PetscValidLogicalCollectiveBool(dmA, all, 4);
82417a8be351SBarry Smith   PetscCheck(mode != PETSC_USE_POINTER,PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
82425d80c0bfSVaclav Hapla   if (dmA == dmB) PetscFunctionReturn(0);
82435d80c0bfSVaclav Hapla   for (link=dmA->labels; link; link=link->next) {
82445d80c0bfSVaclav Hapla     label=link->label;
82459566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)label, &name));
82465d80c0bfSVaclav Hapla     if (!all) {
82479566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(name, "depth", &flg));
8248c58f1c22SToby Isaac       if (flg) continue;
82499566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(name, "dim", &flg));
82507d5acc75SStefano Zampini       if (flg) continue;
82519566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(name, "celltype", &flg));
8252ba2698f1SMatthew G. Knepley       if (flg) continue;
82535d80c0bfSVaclav Hapla     }
82549566063dSJacob Faibussowitsch     PetscCall(DMGetLabel(dmB, name, &labelOld));
82552cbb9b06SVaclav Hapla     if (labelOld) {
82562cbb9b06SVaclav Hapla       switch (emode) {
82572cbb9b06SVaclav Hapla         case DM_COPY_LABELS_KEEP:
82582cbb9b06SVaclav Hapla           continue;
82592cbb9b06SVaclav Hapla         case DM_COPY_LABELS_REPLACE:
82609566063dSJacob Faibussowitsch           PetscCall(DMRemoveLabelBySelf(dmB, &labelOld, PETSC_TRUE));
82612cbb9b06SVaclav Hapla           break;
82622cbb9b06SVaclav Hapla         case DM_COPY_LABELS_FAIL:
826398921bdaSJacob Faibussowitsch           SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in destination DM", name);
82642cbb9b06SVaclav Hapla         default:
82657a8be351SBarry Smith           SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_ARG_OUTOFRANGE, "Unhandled DMCopyLabelsMode %d", (int)emode);
82662cbb9b06SVaclav Hapla       }
82672cbb9b06SVaclav Hapla     }
82685d80c0bfSVaclav Hapla     if (mode==PETSC_COPY_VALUES) {
82699566063dSJacob Faibussowitsch       PetscCall(DMLabelDuplicate(label, &labelNew));
82705d80c0bfSVaclav Hapla     } else {
82715d80c0bfSVaclav Hapla       labelNew = label;
82725d80c0bfSVaclav Hapla     }
82739566063dSJacob Faibussowitsch     PetscCall(DMAddLabel(dmB, labelNew));
82749566063dSJacob Faibussowitsch     if (mode==PETSC_COPY_VALUES) PetscCall(DMLabelDestroy(&labelNew));
8275c58f1c22SToby Isaac   }
8276c58f1c22SToby Isaac   PetscFunctionReturn(0);
8277c58f1c22SToby Isaac }
8278461a15a0SLisandro Dalcin 
8279609dae6eSVaclav Hapla /*@C
8280609dae6eSVaclav Hapla   DMCompareLabels - Compare labels of two DMPlex meshes
8281609dae6eSVaclav Hapla 
82825efe38ccSVaclav Hapla   Collective
8283609dae6eSVaclav Hapla 
8284609dae6eSVaclav Hapla   Input Parameters:
8285609dae6eSVaclav Hapla + dm0 - First DM object
8286609dae6eSVaclav Hapla - dm1 - Second DM object
8287609dae6eSVaclav Hapla 
8288609dae6eSVaclav Hapla   Output Parameters
82895efe38ccSVaclav Hapla + equal   - (Optional) Flag whether labels of dm0 and dm1 are the same
8290609dae6eSVaclav Hapla - message - (Optional) Message describing the difference, or NULL if there is no difference
8291609dae6eSVaclav Hapla 
8292609dae6eSVaclav Hapla   Level: intermediate
8293609dae6eSVaclav Hapla 
8294609dae6eSVaclav Hapla   Notes:
82955efe38ccSVaclav Hapla   The output flag equal is the same on all processes.
82965efe38ccSVaclav Hapla   If it is passed as NULL and difference is found, an error is thrown on all processes.
82975efe38ccSVaclav Hapla   Make sure to pass NULL on all processes.
8298609dae6eSVaclav Hapla 
82995efe38ccSVaclav Hapla   The output message is set independently on each rank.
83005efe38ccSVaclav Hapla   It is set to NULL if no difference was found on the current rank. It must be freed by user.
83015efe38ccSVaclav Hapla   If message is passed as NULL and difference is found, the difference description is printed to stderr in synchronized manner.
83025efe38ccSVaclav Hapla   Make sure to pass NULL on all processes.
8303609dae6eSVaclav Hapla 
8304609dae6eSVaclav Hapla   Labels are matched by name. If the number of labels and their names are equal,
8305609dae6eSVaclav Hapla   DMLabelCompare() is used to compare each pair of labels with the same name.
8306609dae6eSVaclav Hapla 
8307609dae6eSVaclav Hapla   Fortran Notes:
8308609dae6eSVaclav Hapla   This function is currently not available from Fortran.
8309609dae6eSVaclav Hapla 
8310609dae6eSVaclav Hapla .seealso: DMAddLabel(), DMCopyLabelsMode, DMLabelCompare()
8311609dae6eSVaclav Hapla @*/
83125efe38ccSVaclav Hapla PetscErrorCode DMCompareLabels(DM dm0, DM dm1, PetscBool *equal, char **message)
8313609dae6eSVaclav Hapla {
83145efe38ccSVaclav Hapla   PetscInt        n, i;
8315609dae6eSVaclav Hapla   char            msg[PETSC_MAX_PATH_LEN] = "";
83165efe38ccSVaclav Hapla   PetscBool       eq;
8317609dae6eSVaclav Hapla   MPI_Comm        comm;
83185efe38ccSVaclav Hapla   PetscMPIInt     rank;
8319609dae6eSVaclav Hapla 
8320609dae6eSVaclav Hapla   PetscFunctionBegin;
8321609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm0,DM_CLASSID,1);
8322609dae6eSVaclav Hapla   PetscValidHeaderSpecific(dm1,DM_CLASSID,2);
8323609dae6eSVaclav Hapla   PetscCheckSameComm(dm0,1,dm1,2);
83245efe38ccSVaclav Hapla   if (equal) PetscValidBoolPointer(equal,3);
8325609dae6eSVaclav Hapla   if (message) PetscValidPointer(message, 4);
83269566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)dm0, &comm));
83279566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
83285efe38ccSVaclav Hapla   {
83295efe38ccSVaclav Hapla     PetscInt n1;
83305efe38ccSVaclav Hapla 
83319566063dSJacob Faibussowitsch     PetscCall(DMGetNumLabels(dm0, &n));
83329566063dSJacob Faibussowitsch     PetscCall(DMGetNumLabels(dm1, &n1));
83335efe38ccSVaclav Hapla     eq = (PetscBool) (n == n1);
83345efe38ccSVaclav Hapla     if (!eq) {
83359566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(msg, sizeof(msg), "Number of labels in dm0 = %D != %D = Number of labels in dm1", n, n1));
8336609dae6eSVaclav Hapla     }
83379566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm));
83385efe38ccSVaclav Hapla     if (!eq) goto finish;
83395efe38ccSVaclav Hapla   }
83405efe38ccSVaclav Hapla   for (i=0; i<n; i++) {
8341609dae6eSVaclav Hapla     DMLabel     l0, l1;
8342609dae6eSVaclav Hapla     const char *name;
8343609dae6eSVaclav Hapla     char       *msgInner;
8344609dae6eSVaclav Hapla 
8345609dae6eSVaclav Hapla     /* Ignore label order */
83469566063dSJacob Faibussowitsch     PetscCall(DMGetLabelByNum(dm0, i, &l0));
83479566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)l0, &name));
83489566063dSJacob Faibussowitsch     PetscCall(DMGetLabel(dm1, name, &l1));
8349609dae6eSVaclav Hapla     if (!l1) {
83509566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(msg, sizeof(msg), "Label \"%s\" (#%D in dm0) not found in dm1", name, i));
83515efe38ccSVaclav Hapla       eq = PETSC_FALSE;
83525efe38ccSVaclav Hapla       break;
8353609dae6eSVaclav Hapla     }
83549566063dSJacob Faibussowitsch     PetscCall(DMLabelCompare(comm, l0, l1, &eq, &msgInner));
83559566063dSJacob Faibussowitsch     PetscCall(PetscStrncpy(msg, msgInner, sizeof(msg)));
83569566063dSJacob Faibussowitsch     PetscCall(PetscFree(msgInner));
83575efe38ccSVaclav Hapla     if (!eq) break;
8358609dae6eSVaclav Hapla   }
83599566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(MPI_IN_PLACE, &eq, 1, MPIU_BOOL, MPI_LAND, comm));
8360609dae6eSVaclav Hapla finish:
83615efe38ccSVaclav Hapla   /* If message output arg not set, print to stderr */
8362609dae6eSVaclav Hapla   if (message) {
8363609dae6eSVaclav Hapla     *message = NULL;
8364609dae6eSVaclav Hapla     if (msg[0]) {
83659566063dSJacob Faibussowitsch       PetscCall(PetscStrallocpy(msg, message));
8366609dae6eSVaclav Hapla     }
83675efe38ccSVaclav Hapla   } else {
83685efe38ccSVaclav Hapla     if (msg[0]) {
83699566063dSJacob Faibussowitsch       PetscCall(PetscSynchronizedFPrintf(comm, PETSC_STDERR, "[%d] %s\n", rank, msg));
8370609dae6eSVaclav Hapla     }
83719566063dSJacob Faibussowitsch     PetscCall(PetscSynchronizedFlush(comm, PETSC_STDERR));
83725efe38ccSVaclav Hapla   }
83735efe38ccSVaclav Hapla   /* If same output arg not ser and labels are not equal, throw error */
83745efe38ccSVaclav Hapla   if (equal) *equal = eq;
83757a8be351SBarry Smith   else PetscCheck(eq,comm, PETSC_ERR_ARG_INCOMP, "DMLabels are not the same in dm0 and dm1");
8376609dae6eSVaclav Hapla   PetscFunctionReturn(0);
8377609dae6eSVaclav Hapla }
8378609dae6eSVaclav Hapla 
8379461a15a0SLisandro Dalcin PetscErrorCode DMSetLabelValue_Fast(DM dm, DMLabel *label, const char name[], PetscInt point, PetscInt value)
8380461a15a0SLisandro Dalcin {
8381461a15a0SLisandro Dalcin   PetscFunctionBegin;
8382461a15a0SLisandro Dalcin   PetscValidPointer(label,2);
8383461a15a0SLisandro Dalcin   if (!*label) {
83849566063dSJacob Faibussowitsch     PetscCall(DMCreateLabel(dm, name));
83859566063dSJacob Faibussowitsch     PetscCall(DMGetLabel(dm, name, label));
8386461a15a0SLisandro Dalcin   }
83879566063dSJacob Faibussowitsch   PetscCall(DMLabelSetValue(*label, point, value));
8388461a15a0SLisandro Dalcin   PetscFunctionReturn(0);
8389461a15a0SLisandro Dalcin }
8390461a15a0SLisandro Dalcin 
83910fdc7489SMatthew Knepley /*
83920fdc7489SMatthew Knepley   Many mesh programs, such as Triangle and TetGen, allow only a single label for each mesh point. Therefore, we would
83930fdc7489SMatthew Knepley   like to encode all label IDs using a single, universal label. We can do this by assigning an integer to every
83940fdc7489SMatthew Knepley   (label, id) pair in the DM.
83950fdc7489SMatthew Knepley 
83960fdc7489SMatthew Knepley   However, a mesh point can have multiple labels, so we must separate all these values. We will assign a bit range to
83970fdc7489SMatthew Knepley   each label.
83980fdc7489SMatthew Knepley */
83990fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreate(DM dm, DMUniversalLabel *universal)
84000fdc7489SMatthew Knepley {
84010fdc7489SMatthew Knepley   DMUniversalLabel ul;
84020fdc7489SMatthew Knepley   PetscBool       *active;
84030fdc7489SMatthew Knepley   PetscInt         pStart, pEnd, p, Nl, l, m;
84040fdc7489SMatthew Knepley 
84050fdc7489SMatthew Knepley   PetscFunctionBegin;
84069566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(1, &ul));
84079566063dSJacob Faibussowitsch   PetscCall(DMLabelCreate(PETSC_COMM_SELF, "universal", &ul->label));
84089566063dSJacob Faibussowitsch   PetscCall(DMGetNumLabels(dm, &Nl));
84099566063dSJacob Faibussowitsch   PetscCall(PetscCalloc1(Nl, &active));
84100fdc7489SMatthew Knepley   ul->Nl = 0;
84110fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
84120fdc7489SMatthew Knepley     PetscBool   isdepth, iscelltype;
84130fdc7489SMatthew Knepley     const char *name;
84140fdc7489SMatthew Knepley 
84159566063dSJacob Faibussowitsch     PetscCall(DMGetLabelName(dm, l, &name));
84169566063dSJacob Faibussowitsch     PetscCall(PetscStrncmp(name, "depth", 6, &isdepth));
84179566063dSJacob Faibussowitsch     PetscCall(PetscStrncmp(name, "celltype", 9, &iscelltype));
84180fdc7489SMatthew Knepley     active[l] = !(isdepth || iscelltype) ? PETSC_TRUE : PETSC_FALSE;
84190fdc7489SMatthew Knepley     if (active[l]) ++ul->Nl;
84200fdc7489SMatthew Knepley   }
84219566063dSJacob Faibussowitsch   PetscCall(PetscCalloc5(ul->Nl, &ul->names, ul->Nl, &ul->indices, ul->Nl+1, &ul->offsets, ul->Nl+1, &ul->bits, ul->Nl, &ul->masks));
84220fdc7489SMatthew Knepley   ul->Nv = 0;
84230fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
84240fdc7489SMatthew Knepley     DMLabel     label;
84250fdc7489SMatthew Knepley     PetscInt    nv;
84260fdc7489SMatthew Knepley     const char *name;
84270fdc7489SMatthew Knepley 
84280fdc7489SMatthew Knepley     if (!active[l]) continue;
84299566063dSJacob Faibussowitsch     PetscCall(DMGetLabelName(dm, l, &name));
84309566063dSJacob Faibussowitsch     PetscCall(DMGetLabelByNum(dm, l, &label));
84319566063dSJacob Faibussowitsch     PetscCall(DMLabelGetNumValues(label, &nv));
84329566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(name, &ul->names[m]));
84330fdc7489SMatthew Knepley     ul->indices[m]   = l;
84340fdc7489SMatthew Knepley     ul->Nv          += nv;
84350fdc7489SMatthew Knepley     ul->offsets[m+1] = nv;
84360fdc7489SMatthew Knepley     ul->bits[m+1]    = PetscCeilReal(PetscLog2Real(nv+1));
84370fdc7489SMatthew Knepley     ++m;
84380fdc7489SMatthew Knepley   }
84390fdc7489SMatthew Knepley   for (l = 1; l <= ul->Nl; ++l) {
84400fdc7489SMatthew Knepley     ul->offsets[l] = ul->offsets[l-1] + ul->offsets[l];
84410fdc7489SMatthew Knepley     ul->bits[l]    = ul->bits[l-1]    + ul->bits[l];
84420fdc7489SMatthew Knepley   }
84430fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
84440fdc7489SMatthew Knepley     PetscInt b;
84450fdc7489SMatthew Knepley 
84460fdc7489SMatthew Knepley     ul->masks[l] = 0;
84470fdc7489SMatthew Knepley     for (b = ul->bits[l]; b < ul->bits[l+1]; ++b) ul->masks[l] |= 1 << b;
84480fdc7489SMatthew Knepley   }
84499566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(ul->Nv, &ul->values));
84500fdc7489SMatthew Knepley   for (l = 0, m = 0; l < Nl; ++l) {
84510fdc7489SMatthew Knepley     DMLabel         label;
84520fdc7489SMatthew Knepley     IS              valueIS;
84530fdc7489SMatthew Knepley     const PetscInt *varr;
84540fdc7489SMatthew Knepley     PetscInt        nv, v;
84550fdc7489SMatthew Knepley 
84560fdc7489SMatthew Knepley     if (!active[l]) continue;
84579566063dSJacob Faibussowitsch     PetscCall(DMGetLabelByNum(dm, l, &label));
84589566063dSJacob Faibussowitsch     PetscCall(DMLabelGetNumValues(label, &nv));
84599566063dSJacob Faibussowitsch     PetscCall(DMLabelGetValueIS(label, &valueIS));
84609566063dSJacob Faibussowitsch     PetscCall(ISGetIndices(valueIS, &varr));
84610fdc7489SMatthew Knepley     for (v = 0; v < nv; ++v) {
84620fdc7489SMatthew Knepley       ul->values[ul->offsets[m]+v] = varr[v];
84630fdc7489SMatthew Knepley     }
84649566063dSJacob Faibussowitsch     PetscCall(ISRestoreIndices(valueIS, &varr));
84659566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&valueIS));
84669566063dSJacob Faibussowitsch     PetscCall(PetscSortInt(nv, &ul->values[ul->offsets[m]]));
84670fdc7489SMatthew Knepley     ++m;
84680fdc7489SMatthew Knepley   }
84699566063dSJacob Faibussowitsch   PetscCall(DMPlexGetChart(dm, &pStart, &pEnd));
84700fdc7489SMatthew Knepley   for (p = pStart; p < pEnd; ++p) {
84710fdc7489SMatthew Knepley     PetscInt  uval = 0;
84720fdc7489SMatthew Knepley     PetscBool marked = PETSC_FALSE;
84730fdc7489SMatthew Knepley 
84740fdc7489SMatthew Knepley     for (l = 0, m = 0; l < Nl; ++l) {
84750fdc7489SMatthew Knepley       DMLabel  label;
84760649b39aSStefano Zampini       PetscInt val, defval, loc, nv;
84770fdc7489SMatthew Knepley 
84780fdc7489SMatthew Knepley       if (!active[l]) continue;
84799566063dSJacob Faibussowitsch       PetscCall(DMGetLabelByNum(dm, l, &label));
84809566063dSJacob Faibussowitsch       PetscCall(DMLabelGetValue(label, p, &val));
84819566063dSJacob Faibussowitsch       PetscCall(DMLabelGetDefaultValue(label, &defval));
84820fdc7489SMatthew Knepley       if (val == defval) {++m; continue;}
84830649b39aSStefano Zampini       nv = ul->offsets[m+1]-ul->offsets[m];
84840fdc7489SMatthew Knepley       marked = PETSC_TRUE;
84859566063dSJacob Faibussowitsch       PetscCall(PetscFindInt(val, nv, &ul->values[ul->offsets[m]], &loc));
84867a8be351SBarry Smith       PetscCheck(loc >= 0,PETSC_COMM_SELF, PETSC_ERR_PLIB, "Label value %D not found in compression array", val);
84870fdc7489SMatthew Knepley       uval += (loc+1) << ul->bits[m];
84880fdc7489SMatthew Knepley       ++m;
84890fdc7489SMatthew Knepley     }
84909566063dSJacob Faibussowitsch     if (marked) PetscCall(DMLabelSetValue(ul->label, p, uval));
84910fdc7489SMatthew Knepley   }
84929566063dSJacob Faibussowitsch   PetscCall(PetscFree(active));
84930fdc7489SMatthew Knepley   *universal = ul;
84940fdc7489SMatthew Knepley   PetscFunctionReturn(0);
84950fdc7489SMatthew Knepley }
84960fdc7489SMatthew Knepley 
84970fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelDestroy(DMUniversalLabel *universal)
84980fdc7489SMatthew Knepley {
84990fdc7489SMatthew Knepley   PetscInt       l;
85000fdc7489SMatthew Knepley 
85010fdc7489SMatthew Knepley   PetscFunctionBegin;
85029566063dSJacob Faibussowitsch   for (l = 0; l < (*universal)->Nl; ++l) PetscCall(PetscFree((*universal)->names[l]));
85039566063dSJacob Faibussowitsch   PetscCall(DMLabelDestroy(&(*universal)->label));
85049566063dSJacob Faibussowitsch   PetscCall(PetscFree5((*universal)->names, (*universal)->indices, (*universal)->offsets, (*universal)->bits, (*universal)->masks));
85059566063dSJacob Faibussowitsch   PetscCall(PetscFree((*universal)->values));
85069566063dSJacob Faibussowitsch   PetscCall(PetscFree(*universal));
85070fdc7489SMatthew Knepley   *universal = NULL;
85080fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85090fdc7489SMatthew Knepley }
85100fdc7489SMatthew Knepley 
85110fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelGetLabel(DMUniversalLabel ul, DMLabel *ulabel)
85120fdc7489SMatthew Knepley {
85130fdc7489SMatthew Knepley   PetscFunctionBegin;
85140fdc7489SMatthew Knepley   PetscValidPointer(ulabel, 2);
85150fdc7489SMatthew Knepley   *ulabel = ul->label;
85160fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85170fdc7489SMatthew Knepley }
85180fdc7489SMatthew Knepley 
85190fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelCreateLabels(DMUniversalLabel ul, PetscBool preserveOrder, DM dm)
85200fdc7489SMatthew Knepley {
85210fdc7489SMatthew Knepley   PetscInt       Nl = ul->Nl, l;
85220fdc7489SMatthew Knepley 
85230fdc7489SMatthew Knepley   PetscFunctionBegin;
8524064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(dm, DM_CLASSID, 3);
85250fdc7489SMatthew Knepley   for (l = 0; l < Nl; ++l) {
85269566063dSJacob Faibussowitsch     if (preserveOrder) PetscCall(DMCreateLabelAtIndex(dm, ul->indices[l], ul->names[l]));
85279566063dSJacob Faibussowitsch     else               PetscCall(DMCreateLabel(dm, ul->names[l]));
85280fdc7489SMatthew Knepley   }
85290fdc7489SMatthew Knepley   if (preserveOrder) {
85300fdc7489SMatthew Knepley     for (l = 0; l < ul->Nl; ++l) {
85310fdc7489SMatthew Knepley       const char *name;
85320fdc7489SMatthew Knepley       PetscBool   match;
85330fdc7489SMatthew Knepley 
85349566063dSJacob Faibussowitsch       PetscCall(DMGetLabelName(dm, ul->indices[l], &name));
85359566063dSJacob Faibussowitsch       PetscCall(PetscStrcmp(name, ul->names[l], &match));
85367a8be351SBarry Smith       PetscCheck(match,PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONG, "Label %D name %s does not match new name %s", l, name, ul->names[l]);
85370fdc7489SMatthew Knepley     }
85380fdc7489SMatthew Knepley   }
85390fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85400fdc7489SMatthew Knepley }
85410fdc7489SMatthew Knepley 
85420fdc7489SMatthew Knepley PetscErrorCode DMUniversalLabelSetLabelValue(DMUniversalLabel ul, DM dm, PetscBool useIndex, PetscInt p, PetscInt value)
85430fdc7489SMatthew Knepley {
85440fdc7489SMatthew Knepley   PetscInt       l;
85450fdc7489SMatthew Knepley 
85460fdc7489SMatthew Knepley   PetscFunctionBegin;
85470fdc7489SMatthew Knepley   for (l = 0; l < ul->Nl; ++l) {
85480fdc7489SMatthew Knepley     DMLabel  label;
85490fdc7489SMatthew Knepley     PetscInt lval = (value & ul->masks[l]) >> ul->bits[l];
85500fdc7489SMatthew Knepley 
85510fdc7489SMatthew Knepley     if (lval) {
85529566063dSJacob Faibussowitsch       if (useIndex) PetscCall(DMGetLabelByNum(dm, ul->indices[l], &label));
85539566063dSJacob Faibussowitsch       else          PetscCall(DMGetLabel(dm, ul->names[l], &label));
85549566063dSJacob Faibussowitsch       PetscCall(DMLabelSetValue(label, p, ul->values[ul->offsets[l]+lval-1]));
85550fdc7489SMatthew Knepley     }
85560fdc7489SMatthew Knepley   }
85570fdc7489SMatthew Knepley   PetscFunctionReturn(0);
85580fdc7489SMatthew Knepley }
8559a8fb8f29SToby Isaac 
8560a8fb8f29SToby Isaac /*@
8561a8fb8f29SToby Isaac   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
8562a8fb8f29SToby Isaac 
8563a8fb8f29SToby Isaac   Input Parameter:
8564a8fb8f29SToby Isaac . dm - The DM object
8565a8fb8f29SToby Isaac 
8566a8fb8f29SToby Isaac   Output Parameter:
8567a8fb8f29SToby Isaac . cdm - The coarse DM
8568a8fb8f29SToby Isaac 
8569a8fb8f29SToby Isaac   Level: intermediate
8570a8fb8f29SToby Isaac 
8571a8fb8f29SToby Isaac .seealso: DMSetCoarseDM()
8572a8fb8f29SToby Isaac @*/
8573a8fb8f29SToby Isaac PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
8574a8fb8f29SToby Isaac {
8575a8fb8f29SToby Isaac   PetscFunctionBegin;
8576a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8577a8fb8f29SToby Isaac   PetscValidPointer(cdm, 2);
8578a8fb8f29SToby Isaac   *cdm = dm->coarseMesh;
8579a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8580a8fb8f29SToby Isaac }
8581a8fb8f29SToby Isaac 
8582a8fb8f29SToby Isaac /*@
8583a8fb8f29SToby Isaac   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
8584a8fb8f29SToby Isaac 
8585a8fb8f29SToby Isaac   Input Parameters:
8586a8fb8f29SToby Isaac + dm - The DM object
8587a8fb8f29SToby Isaac - cdm - The coarse DM
8588a8fb8f29SToby Isaac 
8589a8fb8f29SToby Isaac   Level: intermediate
8590a8fb8f29SToby Isaac 
8591a8fb8f29SToby Isaac .seealso: DMGetCoarseDM()
8592a8fb8f29SToby Isaac @*/
8593a8fb8f29SToby Isaac PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
8594a8fb8f29SToby Isaac {
8595a8fb8f29SToby Isaac   PetscFunctionBegin;
8596a8fb8f29SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8597a8fb8f29SToby Isaac   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
85989566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)cdm));
85999566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&dm->coarseMesh));
8600a8fb8f29SToby Isaac   dm->coarseMesh = cdm;
8601a8fb8f29SToby Isaac   PetscFunctionReturn(0);
8602a8fb8f29SToby Isaac }
8603a8fb8f29SToby Isaac 
860488bdff64SToby Isaac /*@
860588bdff64SToby Isaac   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
860688bdff64SToby Isaac 
860788bdff64SToby Isaac   Input Parameter:
860888bdff64SToby Isaac . dm - The DM object
860988bdff64SToby Isaac 
861088bdff64SToby Isaac   Output Parameter:
861188bdff64SToby Isaac . fdm - The fine DM
861288bdff64SToby Isaac 
861388bdff64SToby Isaac   Level: intermediate
861488bdff64SToby Isaac 
861588bdff64SToby Isaac .seealso: DMSetFineDM()
861688bdff64SToby Isaac @*/
861788bdff64SToby Isaac PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
861888bdff64SToby Isaac {
861988bdff64SToby Isaac   PetscFunctionBegin;
862088bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
862188bdff64SToby Isaac   PetscValidPointer(fdm, 2);
862288bdff64SToby Isaac   *fdm = dm->fineMesh;
862388bdff64SToby Isaac   PetscFunctionReturn(0);
862488bdff64SToby Isaac }
862588bdff64SToby Isaac 
862688bdff64SToby Isaac /*@
862788bdff64SToby Isaac   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
862888bdff64SToby Isaac 
862988bdff64SToby Isaac   Input Parameters:
863088bdff64SToby Isaac + dm - The DM object
863188bdff64SToby Isaac - fdm - The fine DM
863288bdff64SToby Isaac 
863388bdff64SToby Isaac   Level: intermediate
863488bdff64SToby Isaac 
863588bdff64SToby Isaac .seealso: DMGetFineDM()
863688bdff64SToby Isaac @*/
863788bdff64SToby Isaac PetscErrorCode DMSetFineDM(DM dm, DM fdm)
863888bdff64SToby Isaac {
863988bdff64SToby Isaac   PetscFunctionBegin;
864088bdff64SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
864188bdff64SToby Isaac   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
86429566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)fdm));
86439566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&dm->fineMesh));
864488bdff64SToby Isaac   dm->fineMesh = fdm;
864588bdff64SToby Isaac   PetscFunctionReturn(0);
864688bdff64SToby Isaac }
864788bdff64SToby Isaac 
8648a6ba4734SToby Isaac /*=== DMBoundary code ===*/
8649a6ba4734SToby Isaac 
8650a6ba4734SToby Isaac /*@C
8651a6ba4734SToby Isaac   DMAddBoundary - Add a boundary condition to the model
8652a6ba4734SToby Isaac 
8653783e2ec8SMatthew G. Knepley   Collective on dm
8654783e2ec8SMatthew G. Knepley 
8655a6ba4734SToby Isaac   Input Parameters:
86564c258f51SMatthew G. Knepley + dm       - The DM, with a PetscDS that matches the problem being constrained
8657f971fd6bSMatthew G. Knepley . type     - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
8658a6ba4734SToby Isaac . name     - The BC name
865945480ffeSMatthew G. Knepley . label    - The label defining constrained points
866045480ffeSMatthew G. Knepley . Nv       - The number of DMLabel values for constrained points
866145480ffeSMatthew G. Knepley . values   - An array of values for constrained points
8662a6ba4734SToby Isaac . field    - The field to constrain
866345480ffeSMatthew G. Knepley . Nc       - The number of constrained field components (0 will constrain all fields)
8664a6ba4734SToby Isaac . comps    - An array of constrained component numbers
8665a6ba4734SToby Isaac . bcFunc   - A pointwise function giving boundary values
866656cf3b9cSMatthew G. Knepley . bcFunc_t - A pointwise function giving the time deriative of the boundary values, or NULL
8667a6ba4734SToby Isaac - ctx      - An optional user context for bcFunc
8668a6ba4734SToby Isaac 
866945480ffeSMatthew G. Knepley   Output Parameter:
867045480ffeSMatthew G. Knepley . bd          - (Optional) Boundary number
867145480ffeSMatthew G. Knepley 
8672a6ba4734SToby Isaac   Options Database Keys:
8673a6ba4734SToby Isaac + -bc_<boundary name> <num> - Overrides the boundary ids
8674a6ba4734SToby Isaac - -bc_<boundary name>_comp <num> - Overrides the boundary components
8675a6ba4734SToby Isaac 
867656cf3b9cSMatthew G. Knepley   Note:
867756cf3b9cSMatthew 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:
867856cf3b9cSMatthew G. Knepley 
867956cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar bcval[])
868056cf3b9cSMatthew G. Knepley 
868156cf3b9cSMatthew G. Knepley   If the type is DM_BC_ESSENTIAL_FIELD or other _FIELD value, then the calling sequence is:
868256cf3b9cSMatthew G. Knepley 
868356cf3b9cSMatthew G. Knepley $ bcFunc(PetscInt dim, PetscInt Nf, PetscInt NfAux,
868456cf3b9cSMatthew G. Knepley $        const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
868556cf3b9cSMatthew G. Knepley $        const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
868656cf3b9cSMatthew G. Knepley $        PetscReal time, const PetscReal x[], PetscScalar bcval[])
868756cf3b9cSMatthew G. Knepley 
868856cf3b9cSMatthew G. Knepley + dim - the spatial dimension
868956cf3b9cSMatthew G. Knepley . Nf - the number of fields
869056cf3b9cSMatthew G. Knepley . uOff - the offset into u[] and u_t[] for each field
869156cf3b9cSMatthew G. Knepley . uOff_x - the offset into u_x[] for each field
869256cf3b9cSMatthew G. Knepley . u - each field evaluated at the current point
869356cf3b9cSMatthew G. Knepley . u_t - the time derivative of each field evaluated at the current point
869456cf3b9cSMatthew G. Knepley . u_x - the gradient of each field evaluated at the current point
869556cf3b9cSMatthew G. Knepley . aOff - the offset into a[] and a_t[] for each auxiliary field
869656cf3b9cSMatthew G. Knepley . aOff_x - the offset into a_x[] for each auxiliary field
869756cf3b9cSMatthew G. Knepley . a - each auxiliary field evaluated at the current point
869856cf3b9cSMatthew G. Knepley . a_t - the time derivative of each auxiliary field evaluated at the current point
869956cf3b9cSMatthew G. Knepley . a_x - the gradient of auxiliary each field evaluated at the current point
870056cf3b9cSMatthew G. Knepley . t - current time
870156cf3b9cSMatthew G. Knepley . x - coordinates of the current point
870256cf3b9cSMatthew G. Knepley . numConstants - number of constant parameters
870356cf3b9cSMatthew G. Knepley . constants - constant parameters
870456cf3b9cSMatthew G. Knepley - bcval - output values at the current point
870556cf3b9cSMatthew G. Knepley 
8706ed808b8fSJed Brown   Level: intermediate
8707a6ba4734SToby Isaac 
870845480ffeSMatthew G. Knepley .seealso: DSGetBoundary(), PetscDSAddBoundary()
8709a6ba4734SToby Isaac @*/
871045480ffeSMatthew 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)
8711a6ba4734SToby Isaac {
8712e5e52638SMatthew G. Knepley   PetscDS        ds;
8713a6ba4734SToby Isaac 
8714a6ba4734SToby Isaac   PetscFunctionBegin;
8715a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8716783e2ec8SMatthew G. Knepley   PetscValidLogicalCollectiveEnum(dm, type, 2);
871745480ffeSMatthew G. Knepley   PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 4);
871845480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nv, 5);
871945480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, field, 7);
872045480ffeSMatthew G. Knepley   PetscValidLogicalCollectiveInt(dm, Nc, 8);
87219566063dSJacob Faibussowitsch   PetscCall(DMGetDS(dm, &ds));
87229566063dSJacob Faibussowitsch   PetscCall(DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, label));
87239566063dSJacob Faibussowitsch   PetscCall(PetscDSAddBoundary(ds, type, name, label, Nv, values, field, Nc, comps, bcFunc, bcFunc_t, ctx, bd));
8724a6ba4734SToby Isaac   PetscFunctionReturn(0);
8725a6ba4734SToby Isaac }
8726a6ba4734SToby Isaac 
872745480ffeSMatthew G. Knepley /* TODO Remove this since now the structures are the same */
8728e6f8dbb6SToby Isaac static PetscErrorCode DMPopulateBoundary(DM dm)
8729e6f8dbb6SToby Isaac {
8730e5e52638SMatthew G. Knepley   PetscDS        ds;
8731dff059c6SToby Isaac   DMBoundary    *lastnext;
8732e6f8dbb6SToby Isaac   DSBoundary     dsbound;
8733e6f8dbb6SToby Isaac 
8734e6f8dbb6SToby Isaac   PetscFunctionBegin;
87359566063dSJacob Faibussowitsch   PetscCall(DMGetDS(dm, &ds));
8736e5e52638SMatthew G. Knepley   dsbound = ds->boundary;
873747a1f5adSToby Isaac   if (dm->boundary) {
873847a1f5adSToby Isaac     DMBoundary next = dm->boundary;
873947a1f5adSToby Isaac 
874047a1f5adSToby Isaac     /* quick check to see if the PetscDS has changed */
874147a1f5adSToby Isaac     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
874247a1f5adSToby Isaac     /* the PetscDS has changed: tear down and rebuild */
874347a1f5adSToby Isaac     while (next) {
874447a1f5adSToby Isaac       DMBoundary b = next;
874547a1f5adSToby Isaac 
874647a1f5adSToby Isaac       next = b->next;
87479566063dSJacob Faibussowitsch       PetscCall(PetscFree(b));
8748a6ba4734SToby Isaac     }
874947a1f5adSToby Isaac     dm->boundary = NULL;
8750a6ba4734SToby Isaac   }
875147a1f5adSToby Isaac 
8752dff059c6SToby Isaac   lastnext = &(dm->boundary);
8753e6f8dbb6SToby Isaac   while (dsbound) {
8754e6f8dbb6SToby Isaac     DMBoundary dmbound;
8755e6f8dbb6SToby Isaac 
87569566063dSJacob Faibussowitsch     PetscCall(PetscNew(&dmbound));
8757e6f8dbb6SToby Isaac     dmbound->dsboundary = dsbound;
875845480ffeSMatthew G. Knepley     dmbound->label      = dsbound->label;
875947a1f5adSToby Isaac     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
8760dff059c6SToby Isaac     *lastnext = dmbound;
8761dff059c6SToby Isaac     lastnext = &(dmbound->next);
8762dff059c6SToby Isaac     dsbound = dsbound->next;
8763a6ba4734SToby Isaac   }
8764a6ba4734SToby Isaac   PetscFunctionReturn(0);
8765a6ba4734SToby Isaac }
8766a6ba4734SToby Isaac 
8767a6ba4734SToby Isaac PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
8768a6ba4734SToby Isaac {
8769b95f2879SToby Isaac   DMBoundary     b;
8770a6ba4734SToby Isaac 
8771a6ba4734SToby Isaac   PetscFunctionBegin;
8772a6ba4734SToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8773534a8f05SLisandro Dalcin   PetscValidBoolPointer(isBd, 3);
8774a6ba4734SToby Isaac   *isBd = PETSC_FALSE;
87759566063dSJacob Faibussowitsch   PetscCall(DMPopulateBoundary(dm));
8776b95f2879SToby Isaac   b = dm->boundary;
8777a6ba4734SToby Isaac   while (b && !(*isBd)) {
8778e6f8dbb6SToby Isaac     DMLabel    label = b->label;
8779e6f8dbb6SToby Isaac     DSBoundary dsb   = b->dsboundary;
8780a6ba4734SToby Isaac     PetscInt   i;
8781a6ba4734SToby Isaac 
878245480ffeSMatthew G. Knepley     if (label) {
87839566063dSJacob Faibussowitsch       for (i = 0; i < dsb->Nv && !(*isBd); ++i) PetscCall(DMLabelStratumHasPoint(label, dsb->values[i], point, isBd));
8784a6ba4734SToby Isaac     }
8785a6ba4734SToby Isaac     b = b->next;
8786a6ba4734SToby Isaac   }
8787a6ba4734SToby Isaac   PetscFunctionReturn(0);
8788a6ba4734SToby Isaac }
87894d6f44ffSToby Isaac 
87904d6f44ffSToby Isaac /*@C
8791a6e0b375SMatthew G. Knepley   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
8792a6e0b375SMatthew G. Knepley 
8793a6e0b375SMatthew G. Knepley   Collective on DM
87944d6f44ffSToby Isaac 
87954d6f44ffSToby Isaac   Input Parameters:
87964d6f44ffSToby Isaac + dm      - The DM
87970709b2feSToby Isaac . time    - The time
87984d6f44ffSToby Isaac . funcs   - The coordinate functions to evaluate, one per field
87994d6f44ffSToby Isaac . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
88004d6f44ffSToby Isaac - mode    - The insertion mode for values
88014d6f44ffSToby Isaac 
88024d6f44ffSToby Isaac   Output Parameter:
88034d6f44ffSToby Isaac . X - vector
88044d6f44ffSToby Isaac 
88054d6f44ffSToby Isaac    Calling sequence of func:
880677b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
88074d6f44ffSToby Isaac 
88084d6f44ffSToby Isaac +  dim - The spatial dimension
88098ec8862eSJed Brown .  time - The time at which to sample
88104d6f44ffSToby Isaac .  x   - The coordinates
881177b739a6SMatthew Knepley .  Nc  - The number of components
88124d6f44ffSToby Isaac .  u   - The output field values
88134d6f44ffSToby Isaac -  ctx - optional user-defined function context
88144d6f44ffSToby Isaac 
88154d6f44ffSToby Isaac   Level: developer
88164d6f44ffSToby Isaac 
8817a6e0b375SMatthew G. Knepley .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
88184d6f44ffSToby Isaac @*/
88190709b2feSToby Isaac PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
88204d6f44ffSToby Isaac {
88214d6f44ffSToby Isaac   Vec            localX;
88224d6f44ffSToby Isaac 
88234d6f44ffSToby Isaac   PetscFunctionBegin;
88244d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
88259566063dSJacob Faibussowitsch   PetscCall(DMGetLocalVector(dm, &localX));
88269566063dSJacob Faibussowitsch   PetscCall(DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX));
88279566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(dm, localX, mode, X));
88289566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(dm, localX, mode, X));
88299566063dSJacob Faibussowitsch   PetscCall(DMRestoreLocalVector(dm, &localX));
88304d6f44ffSToby Isaac   PetscFunctionReturn(0);
88314d6f44ffSToby Isaac }
88324d6f44ffSToby Isaac 
8833a6e0b375SMatthew G. Knepley /*@C
8834a6e0b375SMatthew G. Knepley   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
8835a6e0b375SMatthew G. Knepley 
8836a6e0b375SMatthew G. Knepley   Not collective
8837a6e0b375SMatthew G. Knepley 
8838a6e0b375SMatthew G. Knepley   Input Parameters:
8839a6e0b375SMatthew G. Knepley + dm      - The DM
8840a6e0b375SMatthew G. Knepley . time    - The time
8841a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8842a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8843a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8844a6e0b375SMatthew G. Knepley 
8845a6e0b375SMatthew G. Knepley   Output Parameter:
8846a6e0b375SMatthew G. Knepley . localX - vector
8847a6e0b375SMatthew G. Knepley 
8848a6e0b375SMatthew G. Knepley    Calling sequence of func:
884977b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
8850a6e0b375SMatthew G. Knepley 
8851a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8852a6e0b375SMatthew G. Knepley .  x   - The coordinates
885377b739a6SMatthew Knepley .  Nc  - The number of components
8854a6e0b375SMatthew G. Knepley .  u   - The output field values
8855a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8856a6e0b375SMatthew G. Knepley 
8857a6e0b375SMatthew G. Knepley   Level: developer
8858a6e0b375SMatthew G. Knepley 
8859a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
8860a6e0b375SMatthew G. Knepley @*/
88610709b2feSToby Isaac PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
88624d6f44ffSToby Isaac {
88634d6f44ffSToby Isaac   PetscFunctionBegin;
88644d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8865064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
88667a8be351SBarry Smith   PetscCheck(dm->ops->projectfunctionlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
88679566063dSJacob Faibussowitsch   PetscCall((dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX));
88684d6f44ffSToby Isaac   PetscFunctionReturn(0);
88694d6f44ffSToby Isaac }
88704d6f44ffSToby Isaac 
8871a6e0b375SMatthew G. Knepley /*@C
8872a6e0b375SMatthew 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.
8873a6e0b375SMatthew G. Knepley 
8874a6e0b375SMatthew G. Knepley   Collective on DM
8875a6e0b375SMatthew G. Knepley 
8876a6e0b375SMatthew G. Knepley   Input Parameters:
8877a6e0b375SMatthew G. Knepley + dm      - The DM
8878a6e0b375SMatthew G. Knepley . time    - The time
8879a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8880a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8881a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8882a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8883a6e0b375SMatthew G. Knepley 
8884a6e0b375SMatthew G. Knepley   Output Parameter:
8885a6e0b375SMatthew G. Knepley . X - vector
8886a6e0b375SMatthew G. Knepley 
8887a6e0b375SMatthew G. Knepley    Calling sequence of func:
888877b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
8889a6e0b375SMatthew G. Knepley 
8890a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8891a6e0b375SMatthew G. Knepley .  x   - The coordinates
889277b739a6SMatthew Knepley .  Nc  - The number of components
8893a6e0b375SMatthew G. Knepley .  u   - The output field values
8894a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8895a6e0b375SMatthew G. Knepley 
8896a6e0b375SMatthew G. Knepley   Level: developer
8897a6e0b375SMatthew G. Knepley 
8898a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
8899a6e0b375SMatthew G. Knepley @*/
89002c53366bSMatthew 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)
89012c53366bSMatthew G. Knepley {
89022c53366bSMatthew G. Knepley   Vec            localX;
89032c53366bSMatthew G. Knepley 
89042c53366bSMatthew G. Knepley   PetscFunctionBegin;
89052c53366bSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
89069566063dSJacob Faibussowitsch   PetscCall(DMGetLocalVector(dm, &localX));
89079566063dSJacob Faibussowitsch   PetscCall(DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX));
89089566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalBegin(dm, localX, mode, X));
89099566063dSJacob Faibussowitsch   PetscCall(DMLocalToGlobalEnd(dm, localX, mode, X));
89109566063dSJacob Faibussowitsch   PetscCall(DMRestoreLocalVector(dm, &localX));
89112c53366bSMatthew G. Knepley   PetscFunctionReturn(0);
89122c53366bSMatthew G. Knepley }
89132c53366bSMatthew G. Knepley 
8914a6e0b375SMatthew G. Knepley /*@C
8915a6e0b375SMatthew 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.
8916a6e0b375SMatthew G. Knepley 
8917a6e0b375SMatthew G. Knepley   Not collective
8918a6e0b375SMatthew G. Knepley 
8919a6e0b375SMatthew G. Knepley   Input Parameters:
8920a6e0b375SMatthew G. Knepley + dm      - The DM
8921a6e0b375SMatthew G. Knepley . time    - The time
8922a6e0b375SMatthew G. Knepley . label   - The DMLabel selecting the portion of the mesh for projection
8923a6e0b375SMatthew G. Knepley . funcs   - The coordinate functions to evaluate, one per field
8924a6e0b375SMatthew G. Knepley . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
8925a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8926a6e0b375SMatthew G. Knepley 
8927a6e0b375SMatthew G. Knepley   Output Parameter:
8928a6e0b375SMatthew G. Knepley . localX - vector
8929a6e0b375SMatthew G. Knepley 
8930a6e0b375SMatthew G. Knepley    Calling sequence of func:
893177b739a6SMatthew Knepley $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nc, PetscScalar u[], void *ctx);
8932a6e0b375SMatthew G. Knepley 
8933a6e0b375SMatthew G. Knepley +  dim - The spatial dimension
8934a6e0b375SMatthew G. Knepley .  x   - The coordinates
893577b739a6SMatthew Knepley .  Nc  - The number of components
8936a6e0b375SMatthew G. Knepley .  u   - The output field values
8937a6e0b375SMatthew G. Knepley -  ctx - optional user-defined function context
8938a6e0b375SMatthew G. Knepley 
8939a6e0b375SMatthew G. Knepley   Level: developer
8940a6e0b375SMatthew G. Knepley 
8941a6e0b375SMatthew G. Knepley .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
8942a6e0b375SMatthew G. Knepley @*/
89431c531cf8SMatthew 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)
89444d6f44ffSToby Isaac {
89454d6f44ffSToby Isaac   PetscFunctionBegin;
89464d6f44ffSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8947064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
89487a8be351SBarry Smith   PetscCheck(dm->ops->projectfunctionlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
89499566063dSJacob Faibussowitsch   PetscCall((dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX));
89504d6f44ffSToby Isaac   PetscFunctionReturn(0);
89514d6f44ffSToby Isaac }
89522716604bSToby Isaac 
8953a6e0b375SMatthew G. Knepley /*@C
8954a6e0b375SMatthew G. Knepley   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
8955a6e0b375SMatthew G. Knepley 
8956a6e0b375SMatthew G. Knepley   Not collective
8957a6e0b375SMatthew G. Knepley 
8958a6e0b375SMatthew G. Knepley   Input Parameters:
8959a6e0b375SMatthew G. Knepley + dm      - The DM
8960a6e0b375SMatthew G. Knepley . time    - The time
8961a6e0b375SMatthew G. Knepley . localU  - The input field vector
8962a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
8963a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
8964a6e0b375SMatthew G. Knepley 
8965a6e0b375SMatthew G. Knepley   Output Parameter:
8966a6e0b375SMatthew G. Knepley . localX  - The output vector
8967a6e0b375SMatthew G. Knepley 
8968a6e0b375SMatthew G. Knepley    Calling sequence of func:
8969a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8970a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8971a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8972a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8973a6e0b375SMatthew G. Knepley 
8974a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
8975a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
8976a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
8977a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
8978a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
8979a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
8980a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
8981a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
8982a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
8983a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
8984a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
8985a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8986a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
8987a6e0b375SMatthew G. Knepley .  t            - The current time
8988a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
8989a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
8990a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
8991a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
8992a6e0b375SMatthew G. Knepley 
8993a6e0b375SMatthew 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.
8994a6e0b375SMatthew 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
8995a6e0b375SMatthew 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
8996a6e0b375SMatthew 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.
8997a6e0b375SMatthew G. Knepley 
8998a6e0b375SMatthew G. Knepley   Level: intermediate
8999a6e0b375SMatthew G. Knepley 
9000a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9001a6e0b375SMatthew G. Knepley @*/
90028c6c5593SMatthew G. Knepley PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
90038c6c5593SMatthew G. Knepley                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
90048c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
90058c6c5593SMatthew G. Knepley                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9006191494d9SMatthew G. Knepley                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
90078c6c5593SMatthew G. Knepley                                    InsertMode mode, Vec localX)
90088c6c5593SMatthew G. Knepley {
90098c6c5593SMatthew G. Knepley   PetscFunctionBegin;
90108c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
90118c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
90128c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
90137a8be351SBarry Smith   PetscCheck(dm->ops->projectfieldlocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
90149566063dSJacob Faibussowitsch   PetscCall((dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX));
90158c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
90168c6c5593SMatthew G. Knepley }
90178c6c5593SMatthew G. Knepley 
9018a6e0b375SMatthew G. Knepley /*@C
9019a6e0b375SMatthew 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.
9020a6e0b375SMatthew G. Knepley 
9021a6e0b375SMatthew G. Knepley   Not collective
9022a6e0b375SMatthew G. Knepley 
9023a6e0b375SMatthew G. Knepley   Input Parameters:
9024a6e0b375SMatthew G. Knepley + dm      - The DM
9025a6e0b375SMatthew G. Knepley . time    - The time
9026a6e0b375SMatthew G. Knepley . label   - The DMLabel marking the portion of the domain to output
9027a6e0b375SMatthew G. Knepley . numIds  - The number of label ids to use
9028a6e0b375SMatthew G. Knepley . ids     - The label ids to use for marking
9029a6e0b375SMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9030a6e0b375SMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9031a6e0b375SMatthew G. Knepley . localU  - The input field vector
9032a6e0b375SMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9033a6e0b375SMatthew G. Knepley - mode    - The insertion mode for values
9034a6e0b375SMatthew G. Knepley 
9035a6e0b375SMatthew G. Knepley   Output Parameter:
9036a6e0b375SMatthew G. Knepley . localX  - The output vector
9037a6e0b375SMatthew G. Knepley 
9038a6e0b375SMatthew G. Knepley    Calling sequence of func:
9039a6e0b375SMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9040a6e0b375SMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9041a6e0b375SMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9042a6e0b375SMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9043a6e0b375SMatthew G. Knepley 
9044a6e0b375SMatthew G. Knepley +  dim          - The spatial dimension
9045a6e0b375SMatthew G. Knepley .  Nf           - The number of input fields
9046a6e0b375SMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9047a6e0b375SMatthew G. Knepley .  uOff         - The offset of each field in u[]
9048a6e0b375SMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9049a6e0b375SMatthew G. Knepley .  u            - The field values at this point in space
9050a6e0b375SMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9051a6e0b375SMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9052a6e0b375SMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9053a6e0b375SMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9054a6e0b375SMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9055a6e0b375SMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9056a6e0b375SMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9057a6e0b375SMatthew G. Knepley .  t            - The current time
9058a6e0b375SMatthew G. Knepley .  x            - The coordinates of this point
9059a6e0b375SMatthew G. Knepley .  numConstants - The number of constants
9060a6e0b375SMatthew G. Knepley .  constants    - The value of each constant
9061a6e0b375SMatthew G. Knepley -  f            - The value of the function at this point in space
9062a6e0b375SMatthew G. Knepley 
9063a6e0b375SMatthew 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.
9064a6e0b375SMatthew 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
9065a6e0b375SMatthew 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
9066a6e0b375SMatthew 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.
9067a6e0b375SMatthew G. Knepley 
9068a6e0b375SMatthew G. Knepley   Level: intermediate
9069a6e0b375SMatthew G. Knepley 
9070a6e0b375SMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9071a6e0b375SMatthew G. Knepley @*/
90721c531cf8SMatthew G. Knepley PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
90738c6c5593SMatthew G. Knepley                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
90748c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
90758c6c5593SMatthew G. Knepley                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9076191494d9SMatthew G. Knepley                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
90778c6c5593SMatthew G. Knepley                                         InsertMode mode, Vec localX)
90788c6c5593SMatthew G. Knepley {
90798c6c5593SMatthew G. Knepley   PetscFunctionBegin;
90808c6c5593SMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9081064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9082064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
90837a8be351SBarry Smith   PetscCheck(dm->ops->projectfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
90849566063dSJacob Faibussowitsch   PetscCall((dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX));
90858c6c5593SMatthew G. Knepley   PetscFunctionReturn(0);
90868c6c5593SMatthew G. Knepley }
90878c6c5593SMatthew G. Knepley 
90882716604bSToby Isaac /*@C
9089ece3a9fcSMatthew 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.
9090ece3a9fcSMatthew G. Knepley 
9091ece3a9fcSMatthew G. Knepley   Not collective
9092ece3a9fcSMatthew G. Knepley 
9093ece3a9fcSMatthew G. Knepley   Input Parameters:
9094ece3a9fcSMatthew G. Knepley + dm      - The DM
9095ece3a9fcSMatthew G. Knepley . time    - The time
9096ece3a9fcSMatthew G. Knepley . label   - The DMLabel marking the portion of the domain boundary to output
9097ece3a9fcSMatthew G. Knepley . numIds  - The number of label ids to use
9098ece3a9fcSMatthew G. Knepley . ids     - The label ids to use for marking
9099ece3a9fcSMatthew G. Knepley . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
9100ece3a9fcSMatthew G. Knepley . comps   - The components to set in the output, or NULL for all components
9101ece3a9fcSMatthew G. Knepley . localU  - The input field vector
9102ece3a9fcSMatthew G. Knepley . funcs   - The functions to evaluate, one per field
9103ece3a9fcSMatthew G. Knepley - mode    - The insertion mode for values
9104ece3a9fcSMatthew G. Knepley 
9105ece3a9fcSMatthew G. Knepley   Output Parameter:
9106ece3a9fcSMatthew G. Knepley . localX  - The output vector
9107ece3a9fcSMatthew G. Knepley 
9108ece3a9fcSMatthew G. Knepley    Calling sequence of func:
9109ece3a9fcSMatthew G. Knepley $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
9110ece3a9fcSMatthew G. Knepley $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
9111ece3a9fcSMatthew G. Knepley $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
9112ece3a9fcSMatthew G. Knepley $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
9113ece3a9fcSMatthew G. Knepley 
9114ece3a9fcSMatthew G. Knepley +  dim          - The spatial dimension
9115ece3a9fcSMatthew G. Knepley .  Nf           - The number of input fields
9116ece3a9fcSMatthew G. Knepley .  NfAux        - The number of input auxiliary fields
9117ece3a9fcSMatthew G. Knepley .  uOff         - The offset of each field in u[]
9118ece3a9fcSMatthew G. Knepley .  uOff_x       - The offset of each field in u_x[]
9119ece3a9fcSMatthew G. Knepley .  u            - The field values at this point in space
9120ece3a9fcSMatthew G. Knepley .  u_t          - The field time derivative at this point in space (or NULL)
9121ece3a9fcSMatthew G. Knepley .  u_x          - The field derivatives at this point in space
9122ece3a9fcSMatthew G. Knepley .  aOff         - The offset of each auxiliary field in u[]
9123ece3a9fcSMatthew G. Knepley .  aOff_x       - The offset of each auxiliary field in u_x[]
9124ece3a9fcSMatthew G. Knepley .  a            - The auxiliary field values at this point in space
9125ece3a9fcSMatthew G. Knepley .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
9126ece3a9fcSMatthew G. Knepley .  a_x          - The auxiliary field derivatives at this point in space
9127ece3a9fcSMatthew G. Knepley .  t            - The current time
9128ece3a9fcSMatthew G. Knepley .  x            - The coordinates of this point
9129ece3a9fcSMatthew G. Knepley .  n            - The face normal
9130ece3a9fcSMatthew G. Knepley .  numConstants - The number of constants
9131ece3a9fcSMatthew G. Knepley .  constants    - The value of each constant
9132ece3a9fcSMatthew G. Knepley -  f            - The value of the function at this point in space
9133ece3a9fcSMatthew G. Knepley 
9134ece3a9fcSMatthew G. Knepley   Note:
9135ece3a9fcSMatthew 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.
9136ece3a9fcSMatthew 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
9137ece3a9fcSMatthew 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
9138ece3a9fcSMatthew 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.
9139ece3a9fcSMatthew G. Knepley 
9140ece3a9fcSMatthew G. Knepley   Level: intermediate
9141ece3a9fcSMatthew G. Knepley 
9142ece3a9fcSMatthew G. Knepley .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
9143ece3a9fcSMatthew G. Knepley @*/
9144ece3a9fcSMatthew G. Knepley PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
9145ece3a9fcSMatthew G. Knepley                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
9146ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9147ece3a9fcSMatthew G. Knepley                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
9148ece3a9fcSMatthew G. Knepley                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
9149ece3a9fcSMatthew G. Knepley                                           InsertMode mode, Vec localX)
9150ece3a9fcSMatthew G. Knepley {
9151ece3a9fcSMatthew G. Knepley   PetscFunctionBegin;
9152ece3a9fcSMatthew G. Knepley   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9153064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localU,VEC_CLASSID,8);
9154064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(localX,VEC_CLASSID,11);
91557a8be351SBarry Smith   PetscCheck(dm->ops->projectbdfieldlabellocal,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
91569566063dSJacob Faibussowitsch   PetscCall((dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX));
9157ece3a9fcSMatthew G. Knepley   PetscFunctionReturn(0);
9158ece3a9fcSMatthew G. Knepley }
9159ece3a9fcSMatthew G. Knepley 
9160ece3a9fcSMatthew G. Knepley /*@C
91612716604bSToby Isaac   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
91622716604bSToby Isaac 
91632716604bSToby Isaac   Input Parameters:
91642716604bSToby Isaac + dm    - The DM
91650709b2feSToby Isaac . time  - The time
91662716604bSToby Isaac . funcs - The functions to evaluate for each field component
91672716604bSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9168574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
91692716604bSToby Isaac 
91702716604bSToby Isaac   Output Parameter:
91712716604bSToby Isaac . diff - The diff ||u - u_h||_2
91722716604bSToby Isaac 
91732716604bSToby Isaac   Level: developer
91742716604bSToby Isaac 
91751189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
91762716604bSToby Isaac @*/
91770709b2feSToby Isaac PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
91782716604bSToby Isaac {
91792716604bSToby Isaac   PetscFunctionBegin;
91802716604bSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9181b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
91827a8be351SBarry Smith   PetscCheck(dm->ops->computel2diff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
91839566063dSJacob Faibussowitsch   PetscCall((dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff));
91842716604bSToby Isaac   PetscFunctionReturn(0);
91852716604bSToby Isaac }
9186b698f381SToby Isaac 
9187b698f381SToby Isaac /*@C
9188b698f381SToby Isaac   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
9189b698f381SToby Isaac 
9190d083f849SBarry Smith   Collective on dm
9191d083f849SBarry Smith 
9192b698f381SToby Isaac   Input Parameters:
9193b698f381SToby Isaac + dm    - The DM
9194b698f381SToby Isaac , time  - The time
9195b698f381SToby Isaac . funcs - The gradient functions to evaluate for each field component
9196b698f381SToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9197574a98acSMatthew G. Knepley . X     - The coefficient vector u_h, a global vector
9198b698f381SToby Isaac - n     - The vector to project along
9199b698f381SToby Isaac 
9200b698f381SToby Isaac   Output Parameter:
9201b698f381SToby Isaac . diff - The diff ||(grad u - grad u_h) . n||_2
9202b698f381SToby Isaac 
9203b698f381SToby Isaac   Level: developer
9204b698f381SToby Isaac 
9205b698f381SToby Isaac .seealso: DMProjectFunction(), DMComputeL2Diff()
9206b698f381SToby Isaac @*/
9207b698f381SToby 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)
9208b698f381SToby Isaac {
9209b698f381SToby Isaac   PetscFunctionBegin;
9210b698f381SToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
9211b698f381SToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
92127a8be351SBarry Smith   PetscCheck(dm->ops->computel2gradientdiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
92139566063dSJacob Faibussowitsch   PetscCall((dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff));
9214b698f381SToby Isaac   PetscFunctionReturn(0);
9215b698f381SToby Isaac }
9216b698f381SToby Isaac 
92172a16baeaSToby Isaac /*@C
92182a16baeaSToby Isaac   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
92192a16baeaSToby Isaac 
9220d083f849SBarry Smith   Collective on dm
9221d083f849SBarry Smith 
92222a16baeaSToby Isaac   Input Parameters:
92232a16baeaSToby Isaac + dm    - The DM
92242a16baeaSToby Isaac . time  - The time
92252a16baeaSToby Isaac . funcs - The functions to evaluate for each field component
92262a16baeaSToby Isaac . ctxs  - Optional array of contexts to pass to each function, or NULL.
9227574a98acSMatthew G. Knepley - X     - The coefficient vector u_h, a global vector
92282a16baeaSToby Isaac 
92292a16baeaSToby Isaac   Output Parameter:
92302a16baeaSToby Isaac . diff - The array of differences, ||u^f - u^f_h||_2
92312a16baeaSToby Isaac 
92322a16baeaSToby Isaac   Level: developer
92332a16baeaSToby Isaac 
92341189c1efSToby Isaac .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
92352a16baeaSToby Isaac @*/
92361189c1efSToby Isaac PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
92372a16baeaSToby Isaac {
92382a16baeaSToby Isaac   PetscFunctionBegin;
92392a16baeaSToby Isaac   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
92402a16baeaSToby Isaac   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
92417a8be351SBarry Smith   PetscCheck(dm->ops->computel2fielddiff,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
92429566063dSJacob Faibussowitsch   PetscCall((dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff));
92432a16baeaSToby Isaac   PetscFunctionReturn(0);
92442a16baeaSToby Isaac }
92452a16baeaSToby Isaac 
9246df0b854cSToby Isaac /*@C
9247502a2867SDave May  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
9248502a2867SDave May 
9249502a2867SDave May  Not Collective
9250502a2867SDave May 
9251502a2867SDave May  Input Parameter:
9252502a2867SDave May .  dm    - The DM
9253502a2867SDave May 
92540a19bb7dSprj-  Output Parameters:
92550a19bb7dSprj- +  nranks - the number of neighbours
92560a19bb7dSprj- -  ranks - the neighbors ranks
9257502a2867SDave May 
9258502a2867SDave May  Notes:
9259502a2867SDave May  Do not free the array, it is freed when the DM is destroyed.
9260502a2867SDave May 
9261502a2867SDave May  Level: beginner
9262502a2867SDave May 
9263dec1416fSJunchao Zhang  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
9264502a2867SDave May @*/
9265502a2867SDave May PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
9266502a2867SDave May {
9267502a2867SDave May   PetscFunctionBegin;
9268502a2867SDave May   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
92697a8be351SBarry Smith   PetscCheck(dm->ops->getneighbors,PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
92709566063dSJacob Faibussowitsch   PetscCall((dm->ops->getneighbors)(dm,nranks,ranks));
9271502a2867SDave May   PetscFunctionReturn(0);
9272502a2867SDave May }
9273502a2867SDave May 
9274531c7667SBarry Smith #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
9275531c7667SBarry Smith 
9276531c7667SBarry Smith /*
9277531c7667SBarry Smith     Converts the input vector to a ghosted vector and then calls the standard coloring code.
9278531c7667SBarry Smith     This has be a different function because it requires DM which is not defined in the Mat library
9279531c7667SBarry Smith */
9280531c7667SBarry Smith PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
9281531c7667SBarry Smith {
9282531c7667SBarry Smith   PetscFunctionBegin;
9283531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9284531c7667SBarry Smith     Vec x1local;
9285531c7667SBarry Smith     DM  dm;
92869566063dSJacob Faibussowitsch     PetscCall(MatGetDM(J,&dm));
92877a8be351SBarry Smith     PetscCheck(dm,PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
92889566063dSJacob Faibussowitsch     PetscCall(DMGetLocalVector(dm,&x1local));
92899566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local));
92909566063dSJacob Faibussowitsch     PetscCall(DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local));
9291531c7667SBarry Smith     x1   = x1local;
9292531c7667SBarry Smith   }
92939566063dSJacob Faibussowitsch   PetscCall(MatFDColoringApply_AIJ(J,coloring,x1,sctx));
9294531c7667SBarry Smith   if (coloring->ctype == IS_COLORING_LOCAL) {
9295531c7667SBarry Smith     DM  dm;
92969566063dSJacob Faibussowitsch     PetscCall(MatGetDM(J,&dm));
92979566063dSJacob Faibussowitsch     PetscCall(DMRestoreLocalVector(dm,&x1));
9298531c7667SBarry Smith   }
9299531c7667SBarry Smith   PetscFunctionReturn(0);
9300531c7667SBarry Smith }
9301531c7667SBarry Smith 
9302531c7667SBarry Smith /*@
9303531c7667SBarry Smith     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
9304531c7667SBarry Smith 
9305531c7667SBarry Smith     Input Parameter:
9306531c7667SBarry Smith .    coloring - the MatFDColoring object
9307531c7667SBarry Smith 
930895452b02SPatrick Sanan     Developer Notes:
930995452b02SPatrick Sanan     this routine exists because the PETSc Mat library does not know about the DM objects
9310531c7667SBarry Smith 
93111b266c99SBarry Smith     Level: advanced
93121b266c99SBarry Smith 
9313531c7667SBarry Smith .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
9314531c7667SBarry Smith @*/
9315531c7667SBarry Smith PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
9316531c7667SBarry Smith {
9317531c7667SBarry Smith   PetscFunctionBegin;
9318531c7667SBarry Smith   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
9319531c7667SBarry Smith   PetscFunctionReturn(0);
9320531c7667SBarry Smith }
93218320bc6fSPatrick Sanan 
93228320bc6fSPatrick Sanan /*@
93238320bc6fSPatrick Sanan     DMGetCompatibility - determine if two DMs are compatible
93248320bc6fSPatrick Sanan 
93258320bc6fSPatrick Sanan     Collective
93268320bc6fSPatrick Sanan 
93278320bc6fSPatrick Sanan     Input Parameters:
9328a5bc1bf3SBarry Smith +    dm1 - the first DM
93298320bc6fSPatrick Sanan -    dm2 - the second DM
93308320bc6fSPatrick Sanan 
93318320bc6fSPatrick Sanan     Output Parameters:
93328320bc6fSPatrick Sanan +    compatible - whether or not the two DMs are compatible
93338320bc6fSPatrick Sanan -    set - whether or not the compatible value was set
93348320bc6fSPatrick Sanan 
93358320bc6fSPatrick Sanan     Notes:
93368320bc6fSPatrick Sanan     Two DMs are deemed compatible if they represent the same parallel decomposition
93373d862458SPatrick Sanan     of the same topology. This implies that the section (field data) on one
93388320bc6fSPatrick Sanan     "makes sense" with respect to the topology and parallel decomposition of the other.
93393d862458SPatrick Sanan     Loosely speaking, compatible DMs represent the same domain and parallel
93403d862458SPatrick Sanan     decomposition, but hold different data.
93418320bc6fSPatrick Sanan 
93428320bc6fSPatrick Sanan     Typically, one would confirm compatibility if intending to simultaneously iterate
93438320bc6fSPatrick Sanan     over a pair of vectors obtained from different DMs.
93448320bc6fSPatrick Sanan 
93458320bc6fSPatrick Sanan     For example, two DMDA objects are compatible if they have the same local
93468320bc6fSPatrick Sanan     and global sizes and the same stencil width. They can have different numbers
93478320bc6fSPatrick Sanan     of degrees of freedom per node. Thus, one could use the node numbering from
93488320bc6fSPatrick Sanan     either DM in bounds for a loop over vectors derived from either DM.
93498320bc6fSPatrick Sanan 
93508320bc6fSPatrick Sanan     Consider the operation of summing data living on a 2-dof DMDA to data living
93518320bc6fSPatrick Sanan     on a 1-dof DMDA, which should be compatible, as in the following snippet.
93528320bc6fSPatrick Sanan .vb
93538320bc6fSPatrick Sanan   ...
93549566063dSJacob Faibussowitsch   PetscCall(DMGetCompatibility(da1,da2,&compatible,&set));
93558320bc6fSPatrick Sanan   if (set && compatible)  {
93569566063dSJacob Faibussowitsch     PetscCall(DMDAVecGetArrayDOF(da1,vec1,&arr1));
93579566063dSJacob Faibussowitsch     PetscCall(DMDAVecGetArrayDOF(da2,vec2,&arr2));
93589566063dSJacob Faibussowitsch     PetscCall(DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL));
93598320bc6fSPatrick Sanan     for (j=y; j<y+n; ++j) {
93608320bc6fSPatrick Sanan       for (i=x; i<x+m, ++i) {
93618320bc6fSPatrick Sanan         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
93628320bc6fSPatrick Sanan       }
93638320bc6fSPatrick Sanan     }
93649566063dSJacob Faibussowitsch     PetscCall(DMDAVecRestoreArrayDOF(da1,vec1,&arr1));
93659566063dSJacob Faibussowitsch     PetscCall(DMDAVecRestoreArrayDOF(da2,vec2,&arr2));
93668320bc6fSPatrick Sanan   } else {
93678320bc6fSPatrick Sanan     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
93688320bc6fSPatrick Sanan   }
93698320bc6fSPatrick Sanan   ...
93708320bc6fSPatrick Sanan .ve
93718320bc6fSPatrick Sanan 
93728320bc6fSPatrick Sanan     Checking compatibility might be expensive for a given implementation of DM,
93738320bc6fSPatrick Sanan     or might be impossible to unambiguously confirm or deny. For this reason,
93748320bc6fSPatrick Sanan     this function may decline to determine compatibility, and hence users should
93758320bc6fSPatrick Sanan     always check the "set" output parameter.
93768320bc6fSPatrick Sanan 
93778320bc6fSPatrick Sanan     A DM is always compatible with itself.
93788320bc6fSPatrick Sanan 
93798320bc6fSPatrick Sanan     In the current implementation, DMs which live on "unequal" communicators
93808320bc6fSPatrick Sanan     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
93818320bc6fSPatrick Sanan     incompatible.
93828320bc6fSPatrick Sanan 
93838320bc6fSPatrick Sanan     This function is labeled "Collective," as information about all subdomains
93848320bc6fSPatrick Sanan     is required on each rank. However, in DM implementations which store all this
93858320bc6fSPatrick Sanan     information locally, this function may be merely "Logically Collective".
93868320bc6fSPatrick Sanan 
93878320bc6fSPatrick Sanan     Developer Notes:
93883d862458SPatrick Sanan     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
93893d862458SPatrick Sanan     iff B is compatible with A. Thus, this function checks the implementations
9390a5bc1bf3SBarry Smith     of both dm and dmc (if they are of different types), attempting to determine
93918320bc6fSPatrick Sanan     compatibility. It is left to DM implementers to ensure that symmetry is
93928320bc6fSPatrick Sanan     preserved. The simplest way to do this is, when implementing type-specific
93933d862458SPatrick Sanan     logic for this function, is to check for existing logic in the implementation
93943d862458SPatrick Sanan     of other DM types and let *set = PETSC_FALSE if found.
93958320bc6fSPatrick Sanan 
93968320bc6fSPatrick Sanan     Level: advanced
93978320bc6fSPatrick Sanan 
93983d862458SPatrick Sanan .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
93998320bc6fSPatrick Sanan @*/
94008320bc6fSPatrick Sanan 
9401a5bc1bf3SBarry Smith PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
94028320bc6fSPatrick Sanan {
94038320bc6fSPatrick Sanan   PetscMPIInt    compareResult;
94048320bc6fSPatrick Sanan   DMType         type,type2;
94058320bc6fSPatrick Sanan   PetscBool      sameType;
94068320bc6fSPatrick Sanan 
94078320bc6fSPatrick Sanan   PetscFunctionBegin;
9408a5bc1bf3SBarry Smith   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
94098320bc6fSPatrick Sanan   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
94108320bc6fSPatrick Sanan 
94118320bc6fSPatrick Sanan   /* Declare a DM compatible with itself */
9412a5bc1bf3SBarry Smith   if (dm1 == dm2) {
94138320bc6fSPatrick Sanan     *set = PETSC_TRUE;
94148320bc6fSPatrick Sanan     *compatible = PETSC_TRUE;
94158320bc6fSPatrick Sanan     PetscFunctionReturn(0);
94168320bc6fSPatrick Sanan   }
94178320bc6fSPatrick Sanan 
94188320bc6fSPatrick Sanan   /* Declare a DM incompatible with a DM that lives on an "unequal"
94198320bc6fSPatrick Sanan      communicator. Note that this does not preclude compatibility with
94208320bc6fSPatrick Sanan      DMs living on "congruent" or "similar" communicators, but this must be
94218320bc6fSPatrick Sanan      determined by the implementation-specific logic */
94229566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult));
94238320bc6fSPatrick Sanan   if (compareResult == MPI_UNEQUAL) {
94248320bc6fSPatrick Sanan     *set = PETSC_TRUE;
94258320bc6fSPatrick Sanan     *compatible = PETSC_FALSE;
94268320bc6fSPatrick Sanan     PetscFunctionReturn(0);
94278320bc6fSPatrick Sanan   }
94288320bc6fSPatrick Sanan 
94298320bc6fSPatrick Sanan   /* Pass to the implementation-specific routine, if one exists. */
9430a5bc1bf3SBarry Smith   if (dm1->ops->getcompatibility) {
94319566063dSJacob Faibussowitsch     PetscCall((*dm1->ops->getcompatibility)(dm1,dm2,compatible,set));
9432b9d85ea2SLisandro Dalcin     if (*set) PetscFunctionReturn(0);
94338320bc6fSPatrick Sanan   }
94348320bc6fSPatrick Sanan 
9435a5bc1bf3SBarry Smith   /* If dm1 and dm2 are of different types, then attempt to check compatibility
94368320bc6fSPatrick Sanan      with an implementation of this function from dm2 */
94379566063dSJacob Faibussowitsch   PetscCall(DMGetType(dm1,&type));
94389566063dSJacob Faibussowitsch   PetscCall(DMGetType(dm2,&type2));
94399566063dSJacob Faibussowitsch   PetscCall(PetscStrcmp(type,type2,&sameType));
94408320bc6fSPatrick Sanan   if (!sameType && dm2->ops->getcompatibility) {
94419566063dSJacob Faibussowitsch     PetscCall((*dm2->ops->getcompatibility)(dm2,dm1,compatible,set)); /* Note argument order */
94428320bc6fSPatrick Sanan   } else {
94438320bc6fSPatrick Sanan     *set = PETSC_FALSE;
94448320bc6fSPatrick Sanan   }
94458320bc6fSPatrick Sanan   PetscFunctionReturn(0);
94468320bc6fSPatrick Sanan }
9447c0f0dcc3SMatthew G. Knepley 
9448c0f0dcc3SMatthew G. Knepley /*@C
9449c0f0dcc3SMatthew G. Knepley   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
9450c0f0dcc3SMatthew G. Knepley 
9451c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9452c0f0dcc3SMatthew G. Knepley 
9453c0f0dcc3SMatthew G. Knepley   Input Parameters:
9454c0f0dcc3SMatthew G. Knepley + DM - the DM
9455c0f0dcc3SMatthew G. Knepley . f - the monitor function
9456c0f0dcc3SMatthew G. Knepley . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
9457c0f0dcc3SMatthew G. Knepley - monitordestroy - [optional] routine that frees monitor context (may be NULL)
9458c0f0dcc3SMatthew G. Knepley 
9459c0f0dcc3SMatthew G. Knepley   Options Database Keys:
9460c0f0dcc3SMatthew G. Knepley - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
9461c0f0dcc3SMatthew G. Knepley                             does not cancel those set via the options database.
9462c0f0dcc3SMatthew G. Knepley 
9463c0f0dcc3SMatthew G. Knepley   Notes:
9464c0f0dcc3SMatthew G. Knepley   Several different monitoring routines may be set by calling
9465c0f0dcc3SMatthew G. Knepley   DMMonitorSet() multiple times; all will be called in the
9466c0f0dcc3SMatthew G. Knepley   order in which they were set.
9467c0f0dcc3SMatthew G. Knepley 
9468c0f0dcc3SMatthew G. Knepley   Fortran Notes:
9469c0f0dcc3SMatthew G. Knepley   Only a single monitor function can be set for each DM object
9470c0f0dcc3SMatthew G. Knepley 
9471c0f0dcc3SMatthew G. Knepley   Level: intermediate
9472c0f0dcc3SMatthew G. Knepley 
9473c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorCancel()
9474c0f0dcc3SMatthew G. Knepley @*/
9475c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
9476c0f0dcc3SMatthew G. Knepley {
9477c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9478c0f0dcc3SMatthew G. Knepley 
9479c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9480c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9481c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
9482c0f0dcc3SMatthew G. Knepley     PetscBool identical;
9483c0f0dcc3SMatthew G. Knepley 
94849566063dSJacob Faibussowitsch     PetscCall(PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical));
9485c0f0dcc3SMatthew G. Knepley     if (identical) PetscFunctionReturn(0);
9486c0f0dcc3SMatthew G. Knepley   }
94877a8be351SBarry Smith   PetscCheck(dm->numbermonitors < MAXDMMONITORS,PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
9488c0f0dcc3SMatthew G. Knepley   dm->monitor[dm->numbermonitors]          = f;
9489c0f0dcc3SMatthew G. Knepley   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
9490c0f0dcc3SMatthew G. Knepley   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
9491c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9492c0f0dcc3SMatthew G. Knepley }
9493c0f0dcc3SMatthew G. Knepley 
9494c0f0dcc3SMatthew G. Knepley /*@
9495c0f0dcc3SMatthew G. Knepley   DMMonitorCancel - Clears all the monitor functions for a DM object.
9496c0f0dcc3SMatthew G. Knepley 
9497c0f0dcc3SMatthew G. Knepley   Logically Collective on DM
9498c0f0dcc3SMatthew G. Knepley 
9499c0f0dcc3SMatthew G. Knepley   Input Parameter:
9500c0f0dcc3SMatthew G. Knepley . dm - the DM
9501c0f0dcc3SMatthew G. Knepley 
9502c0f0dcc3SMatthew G. Knepley   Options Database Key:
9503c0f0dcc3SMatthew G. Knepley . -dm_monitor_cancel - cancels all monitors that have been hardwired
9504c0f0dcc3SMatthew G. Knepley   into a code by calls to DMonitorSet(), but does not cancel those
9505c0f0dcc3SMatthew G. Knepley   set via the options database
9506c0f0dcc3SMatthew G. Knepley 
9507c0f0dcc3SMatthew G. Knepley   Notes:
9508c0f0dcc3SMatthew G. Knepley   There is no way to clear one specific monitor from a DM object.
9509c0f0dcc3SMatthew G. Knepley 
9510c0f0dcc3SMatthew G. Knepley   Level: intermediate
9511c0f0dcc3SMatthew G. Knepley 
9512c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9513c0f0dcc3SMatthew G. Knepley @*/
9514c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitorCancel(DM dm)
9515c0f0dcc3SMatthew G. Knepley {
9516c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9517c0f0dcc3SMatthew G. Knepley 
9518c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9519c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9520c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
95219566063dSJacob Faibussowitsch     if (dm->monitordestroy[m]) PetscCall((*dm->monitordestroy[m])(&dm->monitorcontext[m]));
9522c0f0dcc3SMatthew G. Knepley   }
9523c0f0dcc3SMatthew G. Knepley   dm->numbermonitors = 0;
9524c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9525c0f0dcc3SMatthew G. Knepley }
9526c0f0dcc3SMatthew G. Knepley 
9527c0f0dcc3SMatthew G. Knepley /*@C
9528c0f0dcc3SMatthew G. Knepley   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
9529c0f0dcc3SMatthew G. Knepley 
9530c0f0dcc3SMatthew G. Knepley   Collective on DM
9531c0f0dcc3SMatthew G. Knepley 
9532c0f0dcc3SMatthew G. Knepley   Input Parameters:
9533c0f0dcc3SMatthew G. Knepley + dm   - DM object you wish to monitor
9534c0f0dcc3SMatthew G. Knepley . name - the monitor type one is seeking
9535c0f0dcc3SMatthew G. Knepley . help - message indicating what monitoring is done
9536c0f0dcc3SMatthew G. Knepley . manual - manual page for the monitor
9537c0f0dcc3SMatthew G. Knepley . monitor - the monitor function
9538c0f0dcc3SMatthew 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
9539c0f0dcc3SMatthew G. Knepley 
9540c0f0dcc3SMatthew G. Knepley   Output Parameter:
9541c0f0dcc3SMatthew G. Knepley . flg - Flag set if the monitor was created
9542c0f0dcc3SMatthew G. Knepley 
9543c0f0dcc3SMatthew G. Knepley   Level: developer
9544c0f0dcc3SMatthew G. Knepley 
9545c0f0dcc3SMatthew G. Knepley .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
9546c0f0dcc3SMatthew G. Knepley           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
9547c0f0dcc3SMatthew G. Knepley           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
9548c0f0dcc3SMatthew G. Knepley           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
9549c0f0dcc3SMatthew G. Knepley           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
9550c0f0dcc3SMatthew G. Knepley           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
9551c0f0dcc3SMatthew G. Knepley           PetscOptionsFList(), PetscOptionsEList()
9552c0f0dcc3SMatthew G. Knepley @*/
9553c0f0dcc3SMatthew 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)
9554c0f0dcc3SMatthew G. Knepley {
9555c0f0dcc3SMatthew G. Knepley   PetscViewer       viewer;
9556c0f0dcc3SMatthew G. Knepley   PetscViewerFormat format;
9557c0f0dcc3SMatthew G. Knepley 
9558c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9559c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
95609566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg));
9561c0f0dcc3SMatthew G. Knepley   if (*flg) {
9562c0f0dcc3SMatthew G. Knepley     PetscViewerAndFormat *vf;
9563c0f0dcc3SMatthew G. Knepley 
95649566063dSJacob Faibussowitsch     PetscCall(PetscViewerAndFormatCreate(viewer, format, &vf));
95659566063dSJacob Faibussowitsch     PetscCall(PetscObjectDereference((PetscObject) viewer));
95669566063dSJacob Faibussowitsch     if (monitorsetup) PetscCall((*monitorsetup)(dm, vf));
95679566063dSJacob Faibussowitsch     PetscCall(DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy));
9568c0f0dcc3SMatthew G. Knepley   }
9569c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9570c0f0dcc3SMatthew G. Knepley }
9571c0f0dcc3SMatthew G. Knepley 
9572c0f0dcc3SMatthew G. Knepley /*@
9573c0f0dcc3SMatthew G. Knepley    DMMonitor - runs the user provided monitor routines, if they exist
9574c0f0dcc3SMatthew G. Knepley 
9575c0f0dcc3SMatthew G. Knepley    Collective on DM
9576c0f0dcc3SMatthew G. Knepley 
9577c0f0dcc3SMatthew G. Knepley    Input Parameters:
9578c0f0dcc3SMatthew G. Knepley .  dm - The DM
9579c0f0dcc3SMatthew G. Knepley 
9580c0f0dcc3SMatthew G. Knepley    Level: developer
9581c0f0dcc3SMatthew G. Knepley 
9582c0f0dcc3SMatthew G. Knepley .seealso: DMMonitorSet()
9583c0f0dcc3SMatthew G. Knepley @*/
9584c0f0dcc3SMatthew G. Knepley PetscErrorCode DMMonitor(DM dm)
9585c0f0dcc3SMatthew G. Knepley {
9586c0f0dcc3SMatthew G. Knepley   PetscInt       m;
9587c0f0dcc3SMatthew G. Knepley 
9588c0f0dcc3SMatthew G. Knepley   PetscFunctionBegin;
9589c0f0dcc3SMatthew G. Knepley   if (!dm) PetscFunctionReturn(0);
9590c0f0dcc3SMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
9591c0f0dcc3SMatthew G. Knepley   for (m = 0; m < dm->numbermonitors; ++m) {
95929566063dSJacob Faibussowitsch     PetscCall((*dm->monitor[m])(dm, dm->monitorcontext[m]));
9593c0f0dcc3SMatthew G. Knepley   }
9594c0f0dcc3SMatthew G. Knepley   PetscFunctionReturn(0);
9595c0f0dcc3SMatthew G. Knepley }
95962e4af2aeSMatthew G. Knepley 
95972e4af2aeSMatthew G. Knepley /*@
95982e4af2aeSMatthew G. Knepley   DMComputeError - Computes the error assuming the user has given exact solution functions
95992e4af2aeSMatthew G. Knepley 
96002e4af2aeSMatthew G. Knepley   Collective on DM
96012e4af2aeSMatthew G. Knepley 
96022e4af2aeSMatthew G. Knepley   Input Parameters:
96032e4af2aeSMatthew G. Knepley + dm     - The DM
96046b867d5aSJose E. Roman - sol    - The solution vector
96052e4af2aeSMatthew G. Knepley 
96066b867d5aSJose E. Roman   Input/Output Parameter:
96076b867d5aSJose E. Roman . errors - An array of length Nf, the number of fields, or NULL for no output; on output
96086b867d5aSJose E. Roman            contains the error in each field
96096b867d5aSJose E. Roman 
96106b867d5aSJose E. Roman   Output Parameter:
96116b867d5aSJose E. Roman . errorVec - A vector to hold the cellwise error (may be NULL)
96122e4af2aeSMatthew G. Knepley 
96132e4af2aeSMatthew G. Knepley   Note: The exact solutions come from the PetscDS object, and the time comes from DMGetOutputSequenceNumber().
96142e4af2aeSMatthew G. Knepley 
96152e4af2aeSMatthew G. Knepley   Level: developer
96162e4af2aeSMatthew G. Knepley 
96172e4af2aeSMatthew G. Knepley .seealso: DMMonitorSet(), DMGetRegionNumDS(), PetscDSGetExactSolution(), DMGetOutputSequenceNumber()
96182e4af2aeSMatthew G. Knepley @*/
96192e4af2aeSMatthew G. Knepley PetscErrorCode DMComputeError(DM dm, Vec sol, PetscReal errors[], Vec *errorVec)
96202e4af2aeSMatthew G. Knepley {
96212e4af2aeSMatthew G. Knepley   PetscErrorCode (**exactSol)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *);
96222e4af2aeSMatthew G. Knepley   void            **ctxs;
96232e4af2aeSMatthew G. Knepley   PetscReal         time;
96242e4af2aeSMatthew G. Knepley   PetscInt          Nf, f, Nds, s;
96252e4af2aeSMatthew G. Knepley 
96262e4af2aeSMatthew G. Knepley   PetscFunctionBegin;
96279566063dSJacob Faibussowitsch   PetscCall(DMGetNumFields(dm, &Nf));
96289566063dSJacob Faibussowitsch   PetscCall(PetscCalloc2(Nf, &exactSol, Nf, &ctxs));
96299566063dSJacob Faibussowitsch   PetscCall(DMGetNumDS(dm, &Nds));
96302e4af2aeSMatthew G. Knepley   for (s = 0; s < Nds; ++s) {
96312e4af2aeSMatthew G. Knepley     PetscDS         ds;
96322e4af2aeSMatthew G. Knepley     DMLabel         label;
96332e4af2aeSMatthew G. Knepley     IS              fieldIS;
96342e4af2aeSMatthew G. Knepley     const PetscInt *fields;
96352e4af2aeSMatthew G. Knepley     PetscInt        dsNf;
96362e4af2aeSMatthew G. Knepley 
96379566063dSJacob Faibussowitsch     PetscCall(DMGetRegionNumDS(dm, s, &label, &fieldIS, &ds));
96389566063dSJacob Faibussowitsch     PetscCall(PetscDSGetNumFields(ds, &dsNf));
96399566063dSJacob Faibussowitsch     if (fieldIS) PetscCall(ISGetIndices(fieldIS, &fields));
96402e4af2aeSMatthew G. Knepley     for (f = 0; f < dsNf; ++f) {
96412e4af2aeSMatthew G. Knepley       const PetscInt field = fields[f];
96429566063dSJacob Faibussowitsch       PetscCall(PetscDSGetExactSolution(ds, field, &exactSol[field], &ctxs[field]));
96432e4af2aeSMatthew G. Knepley     }
96449566063dSJacob Faibussowitsch     if (fieldIS) PetscCall(ISRestoreIndices(fieldIS, &fields));
96452e4af2aeSMatthew G. Knepley   }
96462e4af2aeSMatthew G. Knepley   for (f = 0; f < Nf; ++f) {
96477a8be351SBarry Smith     PetscCheck(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);
96482e4af2aeSMatthew G. Knepley   }
96499566063dSJacob Faibussowitsch   PetscCall(DMGetOutputSequenceNumber(dm, NULL, &time));
96509566063dSJacob Faibussowitsch   if (errors) PetscCall(DMComputeL2FieldDiff(dm, time, exactSol, ctxs, sol, errors));
96512e4af2aeSMatthew G. Knepley   if (errorVec) {
96522e4af2aeSMatthew G. Knepley     DM             edm;
96532e4af2aeSMatthew G. Knepley     DMPolytopeType ct;
96542e4af2aeSMatthew G. Knepley     PetscBool      simplex;
96552e4af2aeSMatthew G. Knepley     PetscInt       dim, cStart, Nf;
96562e4af2aeSMatthew G. Knepley 
96579566063dSJacob Faibussowitsch     PetscCall(DMClone(dm, &edm));
96589566063dSJacob Faibussowitsch     PetscCall(DMGetDimension(edm, &dim));
96599566063dSJacob Faibussowitsch     PetscCall(DMPlexGetHeightStratum(dm, 0, &cStart, NULL));
96609566063dSJacob Faibussowitsch     PetscCall(DMPlexGetCellType(dm, cStart, &ct));
96612e4af2aeSMatthew G. Knepley     simplex = DMPolytopeTypeGetNumVertices(ct) == DMPolytopeTypeGetDim(ct)+1 ? PETSC_TRUE : PETSC_FALSE;
96629566063dSJacob Faibussowitsch     PetscCall(DMGetNumFields(dm, &Nf));
96632e4af2aeSMatthew G. Knepley     for (f = 0; f < Nf; ++f) {
96642e4af2aeSMatthew G. Knepley       PetscFE         fe, efe;
96652e4af2aeSMatthew G. Knepley       PetscQuadrature q;
96662e4af2aeSMatthew G. Knepley       const char     *name;
96672e4af2aeSMatthew G. Knepley 
96689566063dSJacob Faibussowitsch       PetscCall(DMGetField(dm, f, NULL, (PetscObject *) &fe));
96699566063dSJacob Faibussowitsch       PetscCall(PetscFECreateLagrange(PETSC_COMM_SELF, dim, Nf, simplex, 0, PETSC_DETERMINE, &efe));
96709566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetName((PetscObject) fe, &name));
96719566063dSJacob Faibussowitsch       PetscCall(PetscObjectSetName((PetscObject) efe, name));
96729566063dSJacob Faibussowitsch       PetscCall(PetscFEGetQuadrature(fe, &q));
96739566063dSJacob Faibussowitsch       PetscCall(PetscFESetQuadrature(efe, q));
96749566063dSJacob Faibussowitsch       PetscCall(DMSetField(edm, f, NULL, (PetscObject) efe));
96759566063dSJacob Faibussowitsch       PetscCall(PetscFEDestroy(&efe));
96762e4af2aeSMatthew G. Knepley     }
96779566063dSJacob Faibussowitsch     PetscCall(DMCreateDS(edm));
96782e4af2aeSMatthew G. Knepley 
96799566063dSJacob Faibussowitsch     PetscCall(DMCreateGlobalVector(edm, errorVec));
96809566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetName((PetscObject) *errorVec, "Error"));
96819566063dSJacob Faibussowitsch     PetscCall(DMPlexComputeL2DiffVec(dm, time, exactSol, ctxs, sol, *errorVec));
96829566063dSJacob Faibussowitsch     PetscCall(DMDestroy(&edm));
96832e4af2aeSMatthew G. Knepley   }
96849566063dSJacob Faibussowitsch   PetscCall(PetscFree2(exactSol, ctxs));
96852e4af2aeSMatthew G. Knepley   PetscFunctionReturn(0);
96862e4af2aeSMatthew G. Knepley }
96879a2a23afSMatthew G. Knepley 
96889a2a23afSMatthew G. Knepley /*@
96899a2a23afSMatthew G. Knepley   DMGetNumAuxiliaryVec - Get the number of auxiliary vectors associated with this DM
96909a2a23afSMatthew G. Knepley 
96919a2a23afSMatthew G. Knepley   Not collective
96929a2a23afSMatthew G. Knepley 
96939a2a23afSMatthew G. Knepley   Input Parameter:
96949a2a23afSMatthew G. Knepley . dm     - The DM
96959a2a23afSMatthew G. Knepley 
96969a2a23afSMatthew G. Knepley   Output Parameter:
9697a5b23f4aSJose E. Roman . numAux - The number of auxiliary data vectors
96989a2a23afSMatthew G. Knepley 
96999a2a23afSMatthew G. Knepley   Level: advanced
97009a2a23afSMatthew G. Knepley 
97019a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryLabels(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
97029a2a23afSMatthew G. Knepley @*/
97039a2a23afSMatthew G. Knepley PetscErrorCode DMGetNumAuxiliaryVec(DM dm, PetscInt *numAux)
97049a2a23afSMatthew G. Knepley {
97059a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97069a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97079566063dSJacob Faibussowitsch   PetscCall(PetscHMapAuxGetSize(dm->auxData, numAux));
97089a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97099a2a23afSMatthew G. Knepley }
97109a2a23afSMatthew G. Knepley 
97119a2a23afSMatthew G. Knepley /*@
9712ac17215fSMatthew G. Knepley   DMGetAuxiliaryVec - Get the auxiliary vector for region specified by the given label and value, and equation part
97139a2a23afSMatthew G. Knepley 
97149a2a23afSMatthew G. Knepley   Not collective
97159a2a23afSMatthew G. Knepley 
97169a2a23afSMatthew G. Knepley   Input Parameters:
97179a2a23afSMatthew G. Knepley + dm     - The DM
97189a2a23afSMatthew G. Knepley . label  - The DMLabel
9719ac17215fSMatthew G. Knepley . value  - The label value indicating the region
9720ac17215fSMatthew G. Knepley - part   - The equation part, or 0 if unused
97219a2a23afSMatthew G. Knepley 
97229a2a23afSMatthew G. Knepley   Output Parameter:
97239a2a23afSMatthew G. Knepley . aux    - The Vec holding auxiliary field data
97249a2a23afSMatthew G. Knepley 
9725ac17215fSMatthew G. Knepley   Note: If no auxiliary vector is found for this (label, value), (NULL, 0, 0) is checked as well.
972604c51a94SMatthew G. Knepley 
97279a2a23afSMatthew G. Knepley   Level: advanced
97289a2a23afSMatthew G. Knepley 
97299a2a23afSMatthew G. Knepley .seealso: DMSetAuxiliaryVec(), DMGetNumAuxiliaryVec()
97309a2a23afSMatthew G. Knepley @*/
9731ac17215fSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, PetscInt part, Vec *aux)
97329a2a23afSMatthew G. Knepley {
9733ac17215fSMatthew G. Knepley   PetscHashAuxKey key, wild = {NULL, 0, 0};
973404c51a94SMatthew G. Knepley   PetscBool       has;
97359a2a23afSMatthew G. Knepley 
97369a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97379a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97389a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
97399a2a23afSMatthew G. Knepley   key.label = label;
97409a2a23afSMatthew G. Knepley   key.value = value;
9741ac17215fSMatthew G. Knepley   key.part  = part;
97429566063dSJacob Faibussowitsch   PetscCall(PetscHMapAuxHas(dm->auxData, key, &has));
97439566063dSJacob Faibussowitsch   if (has) PetscCall(PetscHMapAuxGet(dm->auxData, key,  aux));
97449566063dSJacob Faibussowitsch   else     PetscCall(PetscHMapAuxGet(dm->auxData, wild, aux));
97459a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97469a2a23afSMatthew G. Knepley }
97479a2a23afSMatthew G. Knepley 
97489a2a23afSMatthew G. Knepley /*@
9749ac17215fSMatthew G. Knepley   DMSetAuxiliaryVec - Set the auxiliary vector for region specified by the given label and value, and equation part
97509a2a23afSMatthew G. Knepley 
97519a2a23afSMatthew G. Knepley   Not collective
97529a2a23afSMatthew G. Knepley 
97539a2a23afSMatthew G. Knepley   Input Parameters:
97549a2a23afSMatthew G. Knepley + dm     - The DM
97559a2a23afSMatthew G. Knepley . label  - The DMLabel
97569a2a23afSMatthew G. Knepley . value  - The label value indicating the region
9757ac17215fSMatthew G. Knepley . part   - The equation part, or 0 if unused
97589a2a23afSMatthew G. Knepley - aux    - The Vec holding auxiliary field data
97599a2a23afSMatthew G. Knepley 
97609a2a23afSMatthew G. Knepley   Level: advanced
97619a2a23afSMatthew G. Knepley 
97629a2a23afSMatthew G. Knepley .seealso: DMGetAuxiliaryVec()
97639a2a23afSMatthew G. Knepley @*/
9764ac17215fSMatthew G. Knepley PetscErrorCode DMSetAuxiliaryVec(DM dm, DMLabel label, PetscInt value, PetscInt part, Vec aux)
97659a2a23afSMatthew G. Knepley {
97669a2a23afSMatthew G. Knepley   Vec             old;
97679a2a23afSMatthew G. Knepley   PetscHashAuxKey key;
97689a2a23afSMatthew G. Knepley 
97699a2a23afSMatthew G. Knepley   PetscFunctionBegin;
97709a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
97719a2a23afSMatthew G. Knepley   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
97729a2a23afSMatthew G. Knepley   key.label = label;
97739a2a23afSMatthew G. Knepley   key.value = value;
9774ac17215fSMatthew G. Knepley   key.part  = part;
97759566063dSJacob Faibussowitsch   PetscCall(PetscHMapAuxGet(dm->auxData, key, &old));
97769566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject) aux));
97779566063dSJacob Faibussowitsch   PetscCall(PetscObjectDereference((PetscObject) old));
97789566063dSJacob Faibussowitsch   if (!aux) PetscCall(PetscHMapAuxDel(dm->auxData, key));
97799566063dSJacob Faibussowitsch   else      PetscCall(PetscHMapAuxSet(dm->auxData, key, aux));
97809a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
97819a2a23afSMatthew G. Knepley }
97829a2a23afSMatthew G. Knepley 
97839a2a23afSMatthew G. Knepley /*@C
9784ac17215fSMatthew G. Knepley   DMGetAuxiliaryLabels - Get the labels, values, and parts for all auxiliary vectors in this DM
97859a2a23afSMatthew G. Knepley 
97869a2a23afSMatthew G. Knepley   Not collective
97879a2a23afSMatthew G. Knepley 
97889a2a23afSMatthew G. Knepley   Input Parameter:
97899a2a23afSMatthew G. Knepley . dm      - The DM
97909a2a23afSMatthew G. Knepley 
97919a2a23afSMatthew G. Knepley   Output Parameters:
97929a2a23afSMatthew G. Knepley + labels  - The DMLabels for each Vec
9793ac17215fSMatthew G. Knepley . values  - The label values for each Vec
9794ac17215fSMatthew G. Knepley - parts   - The equation parts for each Vec
97959a2a23afSMatthew G. Knepley 
97969a2a23afSMatthew G. Knepley   Note: The arrays passed in must be at least as large as DMGetNumAuxiliaryVec().
97979a2a23afSMatthew G. Knepley 
97989a2a23afSMatthew G. Knepley   Level: advanced
97999a2a23afSMatthew G. Knepley 
98009a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
98019a2a23afSMatthew G. Knepley @*/
9802ac17215fSMatthew G. Knepley PetscErrorCode DMGetAuxiliaryLabels(DM dm, DMLabel labels[], PetscInt values[], PetscInt parts[])
98039a2a23afSMatthew G. Knepley {
98049a2a23afSMatthew G. Knepley   PetscHashAuxKey *keys;
98059a2a23afSMatthew G. Knepley   PetscInt         n, i, off = 0;
98069a2a23afSMatthew G. Knepley 
98079a2a23afSMatthew G. Knepley   PetscFunctionBegin;
98089a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
98099a2a23afSMatthew G. Knepley   PetscValidPointer(labels, 2);
9810dadcf809SJacob Faibussowitsch   PetscValidIntPointer(values, 3);
9811dadcf809SJacob Faibussowitsch   PetscValidIntPointer(parts,  4);
98129566063dSJacob Faibussowitsch   PetscCall(DMGetNumAuxiliaryVec(dm, &n));
98139566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(n, &keys));
98149566063dSJacob Faibussowitsch   PetscCall(PetscHMapAuxGetKeys(dm->auxData, &off, keys));
9815ac17215fSMatthew G. Knepley   for (i = 0; i < n; ++i) {labels[i] = keys[i].label; values[i] = keys[i].value; parts[i] = keys[i].part;}
98169566063dSJacob Faibussowitsch   PetscCall(PetscFree(keys));
98179a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
98189a2a23afSMatthew G. Knepley }
98199a2a23afSMatthew G. Knepley 
98209a2a23afSMatthew G. Knepley /*@
98219a2a23afSMatthew G. Knepley   DMCopyAuxiliaryVec - Copy the auxiliary data to a new DM
98229a2a23afSMatthew G. Knepley 
98239a2a23afSMatthew G. Knepley   Not collective
98249a2a23afSMatthew G. Knepley 
98259a2a23afSMatthew G. Knepley   Input Parameter:
98269a2a23afSMatthew G. Knepley . dm    - The DM
98279a2a23afSMatthew G. Knepley 
98289a2a23afSMatthew G. Knepley   Output Parameter:
98299a2a23afSMatthew G. Knepley . dmNew - The new DM, now with the same auxiliary data
98309a2a23afSMatthew G. Knepley 
98319a2a23afSMatthew G. Knepley   Level: advanced
98329a2a23afSMatthew G. Knepley 
98339a2a23afSMatthew G. Knepley .seealso: DMGetNumAuxiliaryVec(), DMGetAuxiliaryVec(), DMSetAuxiliaryVec()
98349a2a23afSMatthew G. Knepley @*/
98359a2a23afSMatthew G. Knepley PetscErrorCode DMCopyAuxiliaryVec(DM dm, DM dmNew)
98369a2a23afSMatthew G. Knepley {
98379a2a23afSMatthew G. Knepley   PetscFunctionBegin;
98389a2a23afSMatthew G. Knepley   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
98399566063dSJacob Faibussowitsch   PetscCall(PetscHMapAuxDestroy(&dmNew->auxData));
98409566063dSJacob Faibussowitsch   PetscCall(PetscHMapAuxDuplicate(dm->auxData, &dmNew->auxData));
98419a2a23afSMatthew G. Knepley   PetscFunctionReturn(0);
98429a2a23afSMatthew G. Knepley }
9843b5a892a1SMatthew G. Knepley 
9844b5a892a1SMatthew G. Knepley /*@C
9845b5a892a1SMatthew G. Knepley   DMPolytopeMatchOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
9846b5a892a1SMatthew G. Knepley 
9847b5a892a1SMatthew G. Knepley   Not collective
9848b5a892a1SMatthew G. Knepley 
9849b5a892a1SMatthew G. Knepley   Input Parameters:
9850b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9851b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
9852b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
9853b5a892a1SMatthew G. Knepley 
9854b5a892a1SMatthew G. Knepley   Output Parameters:
9855b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
9856b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
9857b5a892a1SMatthew G. Knepley 
9858b5a892a1SMatthew G. Knepley   Level: advanced
9859b5a892a1SMatthew G. Knepley 
9860b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchVertexOrientation()
9861b5a892a1SMatthew G. Knepley @*/
9862b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt, PetscBool *found)
9863b5a892a1SMatthew G. Knepley {
9864b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetConeSize(ct);
9865b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
9866b5a892a1SMatthew G. Knepley   PetscInt       o, c;
9867b5a892a1SMatthew G. Knepley 
9868b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9869b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
9870b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
9871b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetArrangment(ct, o);
9872b5a892a1SMatthew G. Knepley 
9873b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceCone[arr[c*2]] != targetCone[c]) break;
9874b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
9875b5a892a1SMatthew G. Knepley   }
9876b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
9877b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9878b5a892a1SMatthew G. Knepley }
9879b5a892a1SMatthew G. Knepley 
9880b5a892a1SMatthew G. Knepley /*@C
9881b5a892a1SMatthew G. Knepley   DMPolytopeGetOrientation - Determine an orientation that takes the source face arrangement to the target face arrangement
9882b5a892a1SMatthew G. Knepley 
9883b5a892a1SMatthew G. Knepley   Not collective
9884b5a892a1SMatthew G. Knepley 
9885b5a892a1SMatthew G. Knepley   Input Parameters:
9886b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9887b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of faces
9888b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of faces
9889b5a892a1SMatthew G. Knepley 
9890b5a892a1SMatthew G. Knepley   Output Parameters:
9891b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
9892b5a892a1SMatthew G. Knepley 
9893b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
9894b5a892a1SMatthew G. Knepley 
9895b5a892a1SMatthew G. Knepley   Level: advanced
9896b5a892a1SMatthew G. Knepley 
9897b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchOrientation(), DMPolytopeGetVertexOrientation()
9898b5a892a1SMatthew G. Knepley @*/
9899b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
9900b5a892a1SMatthew G. Knepley {
9901b5a892a1SMatthew G. Knepley   PetscBool      found;
9902b5a892a1SMatthew G. Knepley 
9903b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
99049566063dSJacob Faibussowitsch   PetscCall(DMPolytopeMatchOrientation(ct, sourceCone, targetCone, ornt, &found));
99057a8be351SBarry Smith   PetscCheck(found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
9906b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9907b5a892a1SMatthew G. Knepley }
9908b5a892a1SMatthew G. Knepley 
9909b5a892a1SMatthew G. Knepley /*@C
9910b5a892a1SMatthew G. Knepley   DMPolytopeMatchVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
9911b5a892a1SMatthew G. Knepley 
9912b5a892a1SMatthew G. Knepley   Not collective
9913b5a892a1SMatthew G. Knepley 
9914b5a892a1SMatthew G. Knepley   Input Parameters:
9915b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9916b5a892a1SMatthew G. Knepley . sourceVert - The source arrangement of vertices
9917b5a892a1SMatthew G. Knepley - targetVert - The target arrangement of vertices
9918b5a892a1SMatthew G. Knepley 
9919b5a892a1SMatthew G. Knepley   Output Parameters:
9920b5a892a1SMatthew G. Knepley + ornt  - The orientation which will take the source arrangement to the target arrangement
9921b5a892a1SMatthew G. Knepley - found - Flag indicating that a suitable orientation was found
9922b5a892a1SMatthew G. Knepley 
9923b5a892a1SMatthew G. Knepley   Level: advanced
9924b5a892a1SMatthew G. Knepley 
9925b5a892a1SMatthew G. Knepley .seealso: DMPolytopeGetOrientation(), DMPolytopeMatchOrientation()
9926b5a892a1SMatthew G. Knepley @*/
9927b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeMatchVertexOrientation(DMPolytopeType ct, const PetscInt sourceVert[], const PetscInt targetVert[], PetscInt *ornt, PetscBool *found)
9928b5a892a1SMatthew G. Knepley {
9929b5a892a1SMatthew G. Knepley   const PetscInt cS = DMPolytopeTypeGetNumVertices(ct);
9930b5a892a1SMatthew G. Knepley   const PetscInt nO = DMPolytopeTypeGetNumArrangments(ct)/2;
9931b5a892a1SMatthew G. Knepley   PetscInt       o, c;
9932b5a892a1SMatthew G. Knepley 
9933b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
9934b5a892a1SMatthew G. Knepley   if (!nO) {*ornt = 0; *found = PETSC_TRUE; PetscFunctionReturn(0);}
9935b5a892a1SMatthew G. Knepley   for (o = -nO; o < nO; ++o) {
9936b5a892a1SMatthew G. Knepley     const PetscInt *arr = DMPolytopeTypeGetVertexArrangment(ct, o);
9937b5a892a1SMatthew G. Knepley 
9938b5a892a1SMatthew G. Knepley     for (c = 0; c < cS; ++c) if (sourceVert[arr[c]] != targetVert[c]) break;
9939b5a892a1SMatthew G. Knepley     if (c == cS) {*ornt = o; break;}
9940b5a892a1SMatthew G. Knepley   }
9941b5a892a1SMatthew G. Knepley   *found = o == nO ? PETSC_FALSE : PETSC_TRUE;
9942b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9943b5a892a1SMatthew G. Knepley }
9944b5a892a1SMatthew G. Knepley 
9945b5a892a1SMatthew G. Knepley /*@C
9946b5a892a1SMatthew G. Knepley   DMPolytopeGetVertexOrientation - Determine an orientation that takes the source vertex arrangement to the target vertex arrangement
9947b5a892a1SMatthew G. Knepley 
9948b5a892a1SMatthew G. Knepley   Not collective
9949b5a892a1SMatthew G. Knepley 
9950b5a892a1SMatthew G. Knepley   Input Parameters:
9951b5a892a1SMatthew G. Knepley + ct         - The DMPolytopeType
9952b5a892a1SMatthew G. Knepley . sourceCone - The source arrangement of vertices
9953b5a892a1SMatthew G. Knepley - targetCone - The target arrangement of vertices
9954b5a892a1SMatthew G. Knepley 
9955b5a892a1SMatthew G. Knepley   Output Parameters:
9956b5a892a1SMatthew G. Knepley . ornt  - The orientation which will take the source arrangement to the target arrangement
9957b5a892a1SMatthew G. Knepley 
9958b5a892a1SMatthew G. Knepley   Note: This function will fail if no suitable orientation can be found.
9959b5a892a1SMatthew G. Knepley 
9960b5a892a1SMatthew G. Knepley   Level: advanced
9961b5a892a1SMatthew G. Knepley 
9962b5a892a1SMatthew G. Knepley .seealso: DMPolytopeMatchVertexOrientation(), DMPolytopeGetOrientation()
9963b5a892a1SMatthew G. Knepley @*/
9964b5a892a1SMatthew G. Knepley PetscErrorCode DMPolytopeGetVertexOrientation(DMPolytopeType ct, const PetscInt sourceCone[], const PetscInt targetCone[], PetscInt *ornt)
9965b5a892a1SMatthew G. Knepley {
9966b5a892a1SMatthew G. Knepley   PetscBool      found;
9967b5a892a1SMatthew G. Knepley 
9968b5a892a1SMatthew G. Knepley   PetscFunctionBegin;
99699566063dSJacob Faibussowitsch   PetscCall(DMPolytopeMatchVertexOrientation(ct, sourceCone, targetCone, ornt, &found));
99707a8be351SBarry Smith   PetscCheck(found,PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Could not find orientation for %s", DMPolytopeTypes[ct]);
9971b5a892a1SMatthew G. Knepley   PetscFunctionReturn(0);
9972b5a892a1SMatthew G. Knepley }
9973012bc364SMatthew G. Knepley 
9974012bc364SMatthew G. Knepley /*@C
9975012bc364SMatthew G. Knepley   DMPolytopeInCellTest - Check whether a point lies inside the reference cell of given type
9976012bc364SMatthew G. Knepley 
9977012bc364SMatthew G. Knepley   Not collective
9978012bc364SMatthew G. Knepley 
9979012bc364SMatthew G. Knepley   Input Parameters:
9980012bc364SMatthew G. Knepley + ct    - The DMPolytopeType
9981012bc364SMatthew G. Knepley - point - Coordinates of the point
9982012bc364SMatthew G. Knepley 
9983012bc364SMatthew G. Knepley   Output Parameters:
9984012bc364SMatthew G. Knepley . inside  - Flag indicating whether the point is inside the reference cell of given type
9985012bc364SMatthew G. Knepley 
9986012bc364SMatthew G. Knepley   Level: advanced
9987012bc364SMatthew G. Knepley 
9988012bc364SMatthew G. Knepley .seealso: DMLocatePoints()
9989012bc364SMatthew G. Knepley @*/
9990012bc364SMatthew G. Knepley PetscErrorCode DMPolytopeInCellTest(DMPolytopeType ct, const PetscReal point[], PetscBool *inside)
9991012bc364SMatthew G. Knepley {
9992012bc364SMatthew G. Knepley   PetscReal sum = 0.0;
9993012bc364SMatthew G. Knepley   PetscInt  d;
9994012bc364SMatthew G. Knepley 
9995012bc364SMatthew G. Knepley   PetscFunctionBegin;
9996012bc364SMatthew G. Knepley   *inside = PETSC_TRUE;
9997012bc364SMatthew G. Knepley   switch (ct) {
9998012bc364SMatthew G. Knepley   case DM_POLYTOPE_TRIANGLE:
9999012bc364SMatthew G. Knepley   case DM_POLYTOPE_TETRAHEDRON:
10000012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d) {
10001012bc364SMatthew G. Knepley       if (point[d] < -1.0) {*inside = PETSC_FALSE; break;}
10002012bc364SMatthew G. Knepley       sum += point[d];
10003012bc364SMatthew G. Knepley     }
10004012bc364SMatthew G. Knepley     if (sum > PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10005012bc364SMatthew G. Knepley     break;
10006012bc364SMatthew G. Knepley   case DM_POLYTOPE_QUADRILATERAL:
10007012bc364SMatthew G. Knepley   case DM_POLYTOPE_HEXAHEDRON:
10008012bc364SMatthew G. Knepley     for (d = 0; d < DMPolytopeTypeGetDim(ct); ++d)
10009012bc364SMatthew G. Knepley       if (PetscAbsReal(point[d]) > 1.+PETSC_SMALL) {*inside = PETSC_FALSE; break;}
10010012bc364SMatthew G. Knepley     break;
10011012bc364SMatthew G. Knepley   default:
1001298921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Unsupported polytope type %s", DMPolytopeTypes[ct]);
10013012bc364SMatthew G. Knepley   }
10014012bc364SMatthew G. Knepley   PetscFunctionReturn(0);
10015012bc364SMatthew G. Knepley }
10016