xref: /petsc/src/dm/interface/dm.c (revision 117ef88edefbfc12e7c19efe87a19a2e1b0acd4f)
1 #include <petsc/private/dmimpl.h>           /*I      "petscdm.h"          I*/
2 #include <petsc/private/dmlabelimpl.h>      /*I      "petscdmlabel.h"     I*/
3 #include <petsc/private/petscdsimpl.h>      /*I      "petscds.h"     I*/
4 #include <petscdmplex.h>
5 #include <petscdmfield.h>
6 #include <petscsf.h>
7 #include <petscds.h>
8 
9 PetscClassId  DM_CLASSID;
10 PetscClassId  DMLABEL_CLASSID;
11 PetscLogEvent DM_Convert, DM_GlobalToLocal, DM_LocalToGlobal, DM_LocalToLocal, DM_LocatePoints, DM_Coarsen, DM_Refine, DM_CreateInterpolation, DM_CreateRestriction, DM_CreateInjection, DM_CreateMatrix, DM_Load;
12 
13 const char *const DMBoundaryTypes[] = {"NONE","GHOSTED","MIRROR","PERIODIC","TWIST","DMBoundaryType","DM_BOUNDARY_",0};
14 const char *const DMBoundaryConditionTypes[] = {"INVALID","ESSENTIAL","NATURAL","INVALID","INVALID","ESSENTIAL_FIELD","NATURAL_FIELD","INVALID","INVALID","INVALID","NATURAL_RIEMANN","DMBoundaryConditionType","DM_BC_",0};
15 const char *const DMPolytopeTypes[] = {"vertex", "segment", "tensor_segment", "triangle", "quadrilateral", "tensor_quad", "tetrahedron", "hexahedron", "triangular_prism", "tensor_triangular_prism", "tensor_quadrilateral_prism", "FV_ghost_cell", "unknown", "DMPolytopeType", "DM_POLYTOPE_", 0};
16 /*@
17   DMCreate - Creates an empty DM object. The type can then be set with DMSetType().
18 
19    If you never  call DMSetType()  it will generate an
20    error when you try to use the vector.
21 
22   Collective
23 
24   Input Parameter:
25 . comm - The communicator for the DM object
26 
27   Output Parameter:
28 . dm - The DM object
29 
30   Level: beginner
31 
32 .seealso: DMSetType(), DMDA, DMSLICED, DMCOMPOSITE, DMPLEX, DMMOAB, DMNETWORK
33 @*/
34 PetscErrorCode  DMCreate(MPI_Comm comm,DM *dm)
35 {
36   DM             v;
37   PetscDS        ds;
38   PetscErrorCode ierr;
39 
40   PetscFunctionBegin;
41   PetscValidPointer(dm,2);
42   *dm = NULL;
43   ierr = DMInitializePackage();CHKERRQ(ierr);
44 
45   ierr = PetscHeaderCreate(v, DM_CLASSID, "DM", "Distribution Manager", "DM", comm, DMDestroy, DMView);CHKERRQ(ierr);
46 
47   v->setupcalled              = PETSC_FALSE;
48   v->setfromoptionscalled     = PETSC_FALSE;
49   v->ltogmap                  = NULL;
50   v->bs                       = 1;
51   v->coloringtype             = IS_COLORING_GLOBAL;
52   ierr                        = PetscSFCreate(comm, &v->sf);CHKERRQ(ierr);
53   ierr                        = PetscSFCreate(comm, &v->sectionSF);CHKERRQ(ierr);
54   v->labels                   = NULL;
55   v->adjacency[0]             = PETSC_FALSE;
56   v->adjacency[1]             = PETSC_TRUE;
57   v->depthLabel               = NULL;
58   v->celltypeLabel            = NULL;
59   v->localSection             = NULL;
60   v->globalSection            = NULL;
61   v->defaultConstraintSection = NULL;
62   v->defaultConstraintMat     = NULL;
63   v->L                        = NULL;
64   v->maxCell                  = NULL;
65   v->bdtype                   = NULL;
66   v->dimEmbed                 = PETSC_DEFAULT;
67   v->dim                      = PETSC_DETERMINE;
68   {
69     PetscInt i;
70     for (i = 0; i < 10; ++i) {
71       v->nullspaceConstructors[i] = NULL;
72       v->nearnullspaceConstructors[i] = NULL;
73     }
74   }
75   ierr = PetscDSCreate(PetscObjectComm((PetscObject) v), &ds);CHKERRQ(ierr);
76   ierr = DMSetRegionDS(v, NULL, NULL, ds);CHKERRQ(ierr);
77   ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
78   v->dmBC = NULL;
79   v->coarseMesh = NULL;
80   v->outputSequenceNum = -1;
81   v->outputSequenceVal = 0.0;
82   ierr = DMSetVecType(v,VECSTANDARD);CHKERRQ(ierr);
83   ierr = DMSetMatType(v,MATAIJ);CHKERRQ(ierr);
84 
85   *dm = v;
86   PetscFunctionReturn(0);
87 }
88 
89 /*@
90   DMClone - Creates a DM object with the same topology as the original.
91 
92   Collective
93 
94   Input Parameter:
95 . dm - The original DM object
96 
97   Output Parameter:
98 . newdm  - The new DM object
99 
100   Level: beginner
101 
102   Notes:
103   For some DM implementations this is a shallow clone, the result of which may share (referent counted) information with its parent. For example,
104   DMClone() applied to a DMPLEX object will result in a new DMPLEX that shares the topology with the original DMPLEX. It does not
105   share the PetscSection of the original DM.
106 
107   The clone is considered set up iff the original is.
108 
109 .seealso: DMDestroy(), DMCreate(), DMSetType(), DMSetLocalSection(), DMSetGlobalSection()
110 
111 @*/
112 PetscErrorCode DMClone(DM dm, DM *newdm)
113 {
114   PetscSF        sf;
115   Vec            coords;
116   void          *ctx;
117   PetscInt       dim, cdim;
118   PetscErrorCode ierr;
119 
120   PetscFunctionBegin;
121   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
122   PetscValidPointer(newdm,2);
123   ierr = DMCreate(PetscObjectComm((PetscObject) dm), newdm);CHKERRQ(ierr);
124   ierr = DMCopyLabels(dm, *newdm, PETSC_COPY_VALUES, PETSC_TRUE);CHKERRQ(ierr);
125   (*newdm)->leveldown  = dm->leveldown;
126   (*newdm)->levelup    = dm->levelup;
127   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
128   ierr = DMSetDimension(*newdm, dim);CHKERRQ(ierr);
129   if (dm->ops->clone) {
130     ierr = (*dm->ops->clone)(dm, newdm);CHKERRQ(ierr);
131   }
132   (*newdm)->setupcalled = dm->setupcalled;
133   ierr = DMGetPointSF(dm, &sf);CHKERRQ(ierr);
134   ierr = DMSetPointSF(*newdm, sf);CHKERRQ(ierr);
135   ierr = DMGetApplicationContext(dm, &ctx);CHKERRQ(ierr);
136   ierr = DMSetApplicationContext(*newdm, ctx);CHKERRQ(ierr);
137   if (dm->coordinateDM) {
138     DM           ncdm;
139     PetscSection cs;
140     PetscInt     pEnd = -1, pEndMax = -1;
141 
142     ierr = DMGetLocalSection(dm->coordinateDM, &cs);CHKERRQ(ierr);
143     if (cs) {ierr = PetscSectionGetChart(cs, NULL, &pEnd);CHKERRQ(ierr);}
144     ierr = MPI_Allreduce(&pEnd,&pEndMax,1,MPIU_INT,MPI_MAX,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
145     if (pEndMax >= 0) {
146       ierr = DMClone(dm->coordinateDM, &ncdm);CHKERRQ(ierr);
147       ierr = DMCopyDisc(dm->coordinateDM, ncdm);CHKERRQ(ierr);
148       ierr = DMSetLocalSection(ncdm, cs);CHKERRQ(ierr);
149       ierr = DMSetCoordinateDM(*newdm, ncdm);CHKERRQ(ierr);
150       ierr = DMDestroy(&ncdm);CHKERRQ(ierr);
151     }
152   }
153   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
154   ierr = DMSetCoordinateDim(*newdm, cdim);CHKERRQ(ierr);
155   ierr = DMGetCoordinatesLocal(dm, &coords);CHKERRQ(ierr);
156   if (coords) {
157     ierr = DMSetCoordinatesLocal(*newdm, coords);CHKERRQ(ierr);
158   } else {
159     ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
160     if (coords) {ierr = DMSetCoordinates(*newdm, coords);CHKERRQ(ierr);}
161   }
162   {
163     PetscBool             isper;
164     const PetscReal      *maxCell, *L;
165     const DMBoundaryType *bd;
166     ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
167     ierr = DMSetPeriodicity(*newdm, isper, maxCell,  L,  bd);CHKERRQ(ierr);
168   }
169   {
170     PetscBool useCone, useClosure;
171 
172     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, &useCone, &useClosure);CHKERRQ(ierr);
173     ierr = DMSetAdjacency(*newdm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
174   }
175   PetscFunctionReturn(0);
176 }
177 
178 /*@C
179        DMSetVecType - Sets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
180 
181    Logically Collective on da
182 
183    Input Parameter:
184 +  da - initial distributed array
185 .  ctype - the vector type, currently either VECSTANDARD, VECCUDA, or VECVIENNACL
186 
187    Options Database:
188 .   -dm_vec_type ctype
189 
190    Level: intermediate
191 
192 .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMGetVecType(), DMSetMatType(), DMGetMatType()
193 @*/
194 PetscErrorCode  DMSetVecType(DM da,VecType ctype)
195 {
196   PetscErrorCode ierr;
197 
198   PetscFunctionBegin;
199   PetscValidHeaderSpecific(da,DM_CLASSID,1);
200   ierr = PetscFree(da->vectype);CHKERRQ(ierr);
201   ierr = PetscStrallocpy(ctype,(char**)&da->vectype);CHKERRQ(ierr);
202   PetscFunctionReturn(0);
203 }
204 
205 /*@C
206        DMGetVecType - Gets the type of vector created with DMCreateLocalVector() and DMCreateGlobalVector()
207 
208    Logically Collective on da
209 
210    Input Parameter:
211 .  da - initial distributed array
212 
213    Output Parameter:
214 .  ctype - the vector type
215 
216    Level: intermediate
217 
218 .seealso: DMCreate(), DMDestroy(), DM, DMDAInterpolationType, VecType, DMSetMatType(), DMGetMatType(), DMSetVecType()
219 @*/
220 PetscErrorCode  DMGetVecType(DM da,VecType *ctype)
221 {
222   PetscFunctionBegin;
223   PetscValidHeaderSpecific(da,DM_CLASSID,1);
224   *ctype = da->vectype;
225   PetscFunctionReturn(0);
226 }
227 
228 /*@
229   VecGetDM - Gets the DM defining the data layout of the vector
230 
231   Not collective
232 
233   Input Parameter:
234 . v - The Vec
235 
236   Output Parameter:
237 . dm - The DM
238 
239   Level: intermediate
240 
241 .seealso: VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
242 @*/
243 PetscErrorCode VecGetDM(Vec v, DM *dm)
244 {
245   PetscErrorCode ierr;
246 
247   PetscFunctionBegin;
248   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
249   PetscValidPointer(dm,2);
250   ierr = PetscObjectQuery((PetscObject) v, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
251   PetscFunctionReturn(0);
252 }
253 
254 /*@
255   VecSetDM - Sets the DM defining the data layout of the vector.
256 
257   Not collective
258 
259   Input Parameters:
260 + v - The Vec
261 - dm - The DM
262 
263   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.
264 
265   Level: intermediate
266 
267 .seealso: VecGetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()
268 @*/
269 PetscErrorCode VecSetDM(Vec v, DM dm)
270 {
271   PetscErrorCode ierr;
272 
273   PetscFunctionBegin;
274   PetscValidHeaderSpecific(v,VEC_CLASSID,1);
275   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
276   ierr = PetscObjectCompose((PetscObject) v, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
277   PetscFunctionReturn(0);
278 }
279 
280 /*@C
281        DMSetISColoringType - Sets the type of coloring, global or local, that is created by the DM
282 
283    Logically Collective on dm
284 
285    Input Parameters:
286 +  dm - the DM context
287 -  ctype - the matrix type
288 
289    Options Database:
290 .   -dm_is_coloring_type - global or local
291 
292    Level: intermediate
293 
294 .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
295           DMGetISColoringType()
296 @*/
297 PetscErrorCode  DMSetISColoringType(DM dm,ISColoringType ctype)
298 {
299   PetscFunctionBegin;
300   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
301   dm->coloringtype = ctype;
302   PetscFunctionReturn(0);
303 }
304 
305 /*@C
306        DMGetISColoringType - Gets the type of coloring, global or local, that is created by the DM
307 
308    Logically Collective on dm
309 
310    Input Parameter:
311 .  dm - the DM context
312 
313    Output Parameter:
314 .  ctype - the matrix type
315 
316    Options Database:
317 .   -dm_is_coloring_type - global or local
318 
319    Level: intermediate
320 
321 .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(),
322           DMGetISColoringType()
323 @*/
324 PetscErrorCode  DMGetISColoringType(DM dm,ISColoringType *ctype)
325 {
326   PetscFunctionBegin;
327   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
328   *ctype = dm->coloringtype;
329   PetscFunctionReturn(0);
330 }
331 
332 /*@C
333        DMSetMatType - Sets the type of matrix created with DMCreateMatrix()
334 
335    Logically Collective on dm
336 
337    Input Parameters:
338 +  dm - the DM context
339 -  ctype - the matrix type
340 
341    Options Database:
342 .   -dm_mat_type ctype
343 
344    Level: intermediate
345 
346 .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMGetMatType(), DMSetMatType(), DMGetMatType()
347 @*/
348 PetscErrorCode  DMSetMatType(DM dm,MatType ctype)
349 {
350   PetscErrorCode ierr;
351 
352   PetscFunctionBegin;
353   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
354   ierr = PetscFree(dm->mattype);CHKERRQ(ierr);
355   ierr = PetscStrallocpy(ctype,(char**)&dm->mattype);CHKERRQ(ierr);
356   PetscFunctionReturn(0);
357 }
358 
359 /*@C
360        DMGetMatType - Gets the type of matrix created with DMCreateMatrix()
361 
362    Logically Collective on dm
363 
364    Input Parameter:
365 .  dm - the DM context
366 
367    Output Parameter:
368 .  ctype - the matrix type
369 
370    Options Database:
371 .   -dm_mat_type ctype
372 
373    Level: intermediate
374 
375 .seealso: DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMCreateMatrix(), DMSetMatrixPreallocateOnly(), MatType, DMSetMatType(), DMSetMatType(), DMGetMatType()
376 @*/
377 PetscErrorCode  DMGetMatType(DM dm,MatType *ctype)
378 {
379   PetscFunctionBegin;
380   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
381   *ctype = dm->mattype;
382   PetscFunctionReturn(0);
383 }
384 
385 /*@
386   MatGetDM - Gets the DM defining the data layout of the matrix
387 
388   Not collective
389 
390   Input Parameter:
391 . A - The Mat
392 
393   Output Parameter:
394 . dm - The DM
395 
396   Level: intermediate
397 
398   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
399                   the Mat through a PetscObjectCompose() operation
400 
401 .seealso: MatSetDM(), DMCreateMatrix(), DMSetMatType()
402 @*/
403 PetscErrorCode MatGetDM(Mat A, DM *dm)
404 {
405   PetscErrorCode ierr;
406 
407   PetscFunctionBegin;
408   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
409   PetscValidPointer(dm,2);
410   ierr = PetscObjectQuery((PetscObject) A, "__PETSc_dm", (PetscObject*) dm);CHKERRQ(ierr);
411   PetscFunctionReturn(0);
412 }
413 
414 /*@
415   MatSetDM - Sets the DM defining the data layout of the matrix
416 
417   Not collective
418 
419   Input Parameters:
420 + A - The Mat
421 - dm - The DM
422 
423   Level: intermediate
424 
425   Developer Note: Since the Mat class doesn't know about the DM class the DM object is associated with
426                   the Mat through a PetscObjectCompose() operation
427 
428 
429 .seealso: MatGetDM(), DMCreateMatrix(), DMSetMatType()
430 @*/
431 PetscErrorCode MatSetDM(Mat A, DM dm)
432 {
433   PetscErrorCode ierr;
434 
435   PetscFunctionBegin;
436   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
437   if (dm) PetscValidHeaderSpecific(dm,DM_CLASSID,2);
438   ierr = PetscObjectCompose((PetscObject) A, "__PETSc_dm", (PetscObject) dm);CHKERRQ(ierr);
439   PetscFunctionReturn(0);
440 }
441 
442 /*@C
443    DMSetOptionsPrefix - Sets the prefix used for searching for all
444    DM options in the database.
445 
446    Logically Collective on dm
447 
448    Input Parameter:
449 +  da - the DM context
450 -  prefix - the prefix to prepend to all option names
451 
452    Notes:
453    A hyphen (-) must NOT be given at the beginning of the prefix name.
454    The first character of all runtime options is AUTOMATICALLY the hyphen.
455 
456    Level: advanced
457 
458 .seealso: DMSetFromOptions()
459 @*/
460 PetscErrorCode  DMSetOptionsPrefix(DM dm,const char prefix[])
461 {
462   PetscErrorCode ierr;
463 
464   PetscFunctionBegin;
465   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
466   ierr = PetscObjectSetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
467   if (dm->sf) {
468     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sf,prefix);CHKERRQ(ierr);
469   }
470   if (dm->sectionSF) {
471     ierr = PetscObjectSetOptionsPrefix((PetscObject)dm->sectionSF,prefix);CHKERRQ(ierr);
472   }
473   PetscFunctionReturn(0);
474 }
475 
476 /*@C
477    DMAppendOptionsPrefix - Appends to the prefix used for searching for all
478    DM options in the database.
479 
480    Logically Collective on dm
481 
482    Input Parameters:
483 +  dm - the DM context
484 -  prefix - the prefix string to prepend to all DM option requests
485 
486    Notes:
487    A hyphen (-) must NOT be given at the beginning of the prefix name.
488    The first character of all runtime options is AUTOMATICALLY the hyphen.
489 
490    Level: advanced
491 
492 .seealso: DMSetOptionsPrefix(), DMGetOptionsPrefix()
493 @*/
494 PetscErrorCode  DMAppendOptionsPrefix(DM dm,const char prefix[])
495 {
496   PetscErrorCode ierr;
497 
498   PetscFunctionBegin;
499   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
500   ierr = PetscObjectAppendOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
501   PetscFunctionReturn(0);
502 }
503 
504 /*@C
505    DMGetOptionsPrefix - Gets the prefix used for searching for all
506    DM options in the database.
507 
508    Not Collective
509 
510    Input Parameters:
511 .  dm - the DM context
512 
513    Output Parameters:
514 .  prefix - pointer to the prefix string used is returned
515 
516    Notes:
517     On the fortran side, the user should pass in a string 'prefix' of
518    sufficient length to hold the prefix.
519 
520    Level: advanced
521 
522 .seealso: DMSetOptionsPrefix(), DMAppendOptionsPrefix()
523 @*/
524 PetscErrorCode  DMGetOptionsPrefix(DM dm,const char *prefix[])
525 {
526   PetscErrorCode ierr;
527 
528   PetscFunctionBegin;
529   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
530   ierr = PetscObjectGetOptionsPrefix((PetscObject)dm,prefix);CHKERRQ(ierr);
531   PetscFunctionReturn(0);
532 }
533 
534 static PetscErrorCode DMCountNonCyclicReferences(DM dm, PetscBool recurseCoarse, PetscBool recurseFine, PetscInt *ncrefct)
535 {
536   PetscInt       refct = ((PetscObject) dm)->refct;
537   PetscErrorCode ierr;
538 
539   PetscFunctionBegin;
540   *ncrefct = 0;
541   if (dm->coarseMesh && dm->coarseMesh->fineMesh == dm) {
542     refct--;
543     if (recurseCoarse) {
544       PetscInt coarseCount;
545 
546       ierr = DMCountNonCyclicReferences(dm->coarseMesh, PETSC_TRUE, PETSC_FALSE,&coarseCount);CHKERRQ(ierr);
547       refct += coarseCount;
548     }
549   }
550   if (dm->fineMesh && dm->fineMesh->coarseMesh == dm) {
551     refct--;
552     if (recurseFine) {
553       PetscInt fineCount;
554 
555       ierr = DMCountNonCyclicReferences(dm->fineMesh, PETSC_FALSE, PETSC_TRUE,&fineCount);CHKERRQ(ierr);
556       refct += fineCount;
557     }
558   }
559   *ncrefct = refct;
560   PetscFunctionReturn(0);
561 }
562 
563 PetscErrorCode DMDestroyLabelLinkList_Internal(DM dm)
564 {
565   DMLabelLink    next = dm->labels;
566   PetscErrorCode ierr;
567 
568   PetscFunctionBegin;
569   /* destroy the labels */
570   while (next) {
571     DMLabelLink tmp = next->next;
572 
573     if (next->label == dm->depthLabel)    dm->depthLabel    = NULL;
574     if (next->label == dm->celltypeLabel) dm->celltypeLabel = NULL;
575     ierr = DMLabelDestroy(&next->label);CHKERRQ(ierr);
576     ierr = PetscFree(next);CHKERRQ(ierr);
577     next = tmp;
578   }
579   dm->labels = NULL;
580   PetscFunctionReturn(0);
581 }
582 
583 /*@
584     DMDestroy - Destroys a vector packer or DM.
585 
586     Collective on dm
587 
588     Input Parameter:
589 .   dm - the DM object to destroy
590 
591     Level: developer
592 
593 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
594 
595 @*/
596 PetscErrorCode  DMDestroy(DM *dm)
597 {
598   PetscInt       cnt;
599   DMNamedVecLink nlink,nnext;
600   PetscErrorCode ierr;
601 
602   PetscFunctionBegin;
603   if (!*dm) PetscFunctionReturn(0);
604   PetscValidHeaderSpecific((*dm),DM_CLASSID,1);
605 
606   /* count all non-cyclic references in the doubly-linked list of coarse<->fine meshes */
607   ierr = DMCountNonCyclicReferences(*dm,PETSC_TRUE,PETSC_TRUE,&cnt);CHKERRQ(ierr);
608   --((PetscObject)(*dm))->refct;
609   if (--cnt > 0) {*dm = 0; PetscFunctionReturn(0);}
610   if (((PetscObject)(*dm))->refct < 0) PetscFunctionReturn(0);
611   ((PetscObject)(*dm))->refct = 0;
612 
613   ierr = DMClearGlobalVectors(*dm);CHKERRQ(ierr);
614   ierr = DMClearLocalVectors(*dm);CHKERRQ(ierr);
615 
616   nnext=(*dm)->namedglobal;
617   (*dm)->namedglobal = NULL;
618   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named vectors */
619     nnext = nlink->next;
620     if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
621     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
622     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
623     ierr = PetscFree(nlink);CHKERRQ(ierr);
624   }
625   nnext=(*dm)->namedlocal;
626   (*dm)->namedlocal = NULL;
627   for (nlink=nnext; nlink; nlink=nnext) { /* Destroy the named local vectors */
628     nnext = nlink->next;
629     if (nlink->status != DMVEC_STATUS_IN) SETERRQ1(((PetscObject)*dm)->comm,PETSC_ERR_ARG_WRONGSTATE,"DM still has Vec named '%s' checked out",nlink->name);
630     ierr = PetscFree(nlink->name);CHKERRQ(ierr);
631     ierr = VecDestroy(&nlink->X);CHKERRQ(ierr);
632     ierr = PetscFree(nlink);CHKERRQ(ierr);
633   }
634 
635   /* Destroy the list of hooks */
636   {
637     DMCoarsenHookLink link,next;
638     for (link=(*dm)->coarsenhook; link; link=next) {
639       next = link->next;
640       ierr = PetscFree(link);CHKERRQ(ierr);
641     }
642     (*dm)->coarsenhook = NULL;
643   }
644   {
645     DMRefineHookLink link,next;
646     for (link=(*dm)->refinehook; link; link=next) {
647       next = link->next;
648       ierr = PetscFree(link);CHKERRQ(ierr);
649     }
650     (*dm)->refinehook = NULL;
651   }
652   {
653     DMSubDomainHookLink link,next;
654     for (link=(*dm)->subdomainhook; link; link=next) {
655       next = link->next;
656       ierr = PetscFree(link);CHKERRQ(ierr);
657     }
658     (*dm)->subdomainhook = NULL;
659   }
660   {
661     DMGlobalToLocalHookLink link,next;
662     for (link=(*dm)->gtolhook; link; link=next) {
663       next = link->next;
664       ierr = PetscFree(link);CHKERRQ(ierr);
665     }
666     (*dm)->gtolhook = NULL;
667   }
668   {
669     DMLocalToGlobalHookLink link,next;
670     for (link=(*dm)->ltoghook; link; link=next) {
671       next = link->next;
672       ierr = PetscFree(link);CHKERRQ(ierr);
673     }
674     (*dm)->ltoghook = NULL;
675   }
676   /* Destroy the work arrays */
677   {
678     DMWorkLink link,next;
679     if ((*dm)->workout) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Work array still checked out");
680     for (link=(*dm)->workin; link; link=next) {
681       next = link->next;
682       ierr = PetscFree(link->mem);CHKERRQ(ierr);
683       ierr = PetscFree(link);CHKERRQ(ierr);
684     }
685     (*dm)->workin = NULL;
686   }
687   /* destroy the labels */
688   ierr = DMDestroyLabelLinkList_Internal(*dm);CHKERRQ(ierr);
689   /* destroy the fields */
690   ierr = DMClearFields(*dm);CHKERRQ(ierr);
691   /* destroy the boundaries */
692   {
693     DMBoundary next = (*dm)->boundary;
694     while (next) {
695       DMBoundary b = next;
696 
697       next = b->next;
698       ierr = PetscFree(b);CHKERRQ(ierr);
699     }
700   }
701 
702   ierr = PetscObjectDestroy(&(*dm)->dmksp);CHKERRQ(ierr);
703   ierr = PetscObjectDestroy(&(*dm)->dmsnes);CHKERRQ(ierr);
704   ierr = PetscObjectDestroy(&(*dm)->dmts);CHKERRQ(ierr);
705 
706   if ((*dm)->ctx && (*dm)->ctxdestroy) {
707     ierr = (*(*dm)->ctxdestroy)(&(*dm)->ctx);CHKERRQ(ierr);
708   }
709   ierr = MatFDColoringDestroy(&(*dm)->fd);CHKERRQ(ierr);
710   ierr = ISLocalToGlobalMappingDestroy(&(*dm)->ltogmap);CHKERRQ(ierr);
711   ierr = PetscFree((*dm)->vectype);CHKERRQ(ierr);
712   ierr = PetscFree((*dm)->mattype);CHKERRQ(ierr);
713 
714   ierr = PetscSectionDestroy(&(*dm)->localSection);CHKERRQ(ierr);
715   ierr = PetscSectionDestroy(&(*dm)->globalSection);CHKERRQ(ierr);
716   ierr = PetscLayoutDestroy(&(*dm)->map);CHKERRQ(ierr);
717   ierr = PetscSectionDestroy(&(*dm)->defaultConstraintSection);CHKERRQ(ierr);
718   ierr = MatDestroy(&(*dm)->defaultConstraintMat);CHKERRQ(ierr);
719   ierr = PetscSFDestroy(&(*dm)->sf);CHKERRQ(ierr);
720   ierr = PetscSFDestroy(&(*dm)->sectionSF);CHKERRQ(ierr);
721   if ((*dm)->useNatural) {
722     if ((*dm)->sfNatural) {
723       ierr = PetscSFDestroy(&(*dm)->sfNatural);CHKERRQ(ierr);
724     }
725     ierr = PetscObjectDereference((PetscObject) (*dm)->sfMigration);CHKERRQ(ierr);
726   }
727   if ((*dm)->coarseMesh && (*dm)->coarseMesh->fineMesh == *dm) {
728     ierr = DMSetFineDM((*dm)->coarseMesh,NULL);CHKERRQ(ierr);
729   }
730 
731   ierr = DMDestroy(&(*dm)->coarseMesh);CHKERRQ(ierr);
732   if ((*dm)->fineMesh && (*dm)->fineMesh->coarseMesh == *dm) {
733     ierr = DMSetCoarseDM((*dm)->fineMesh,NULL);CHKERRQ(ierr);
734   }
735   ierr = DMDestroy(&(*dm)->fineMesh);CHKERRQ(ierr);
736   ierr = DMFieldDestroy(&(*dm)->coordinateField);CHKERRQ(ierr);
737   ierr = DMDestroy(&(*dm)->coordinateDM);CHKERRQ(ierr);
738   ierr = VecDestroy(&(*dm)->coordinates);CHKERRQ(ierr);
739   ierr = VecDestroy(&(*dm)->coordinatesLocal);CHKERRQ(ierr);
740   ierr = PetscFree((*dm)->L);CHKERRQ(ierr);
741   ierr = PetscFree((*dm)->maxCell);CHKERRQ(ierr);
742   ierr = PetscFree((*dm)->bdtype);CHKERRQ(ierr);
743   if ((*dm)->transformDestroy) {ierr = (*(*dm)->transformDestroy)(*dm, (*dm)->transformCtx);CHKERRQ(ierr);}
744   ierr = DMDestroy(&(*dm)->transformDM);CHKERRQ(ierr);
745   ierr = VecDestroy(&(*dm)->transform);CHKERRQ(ierr);
746 
747   ierr = DMClearDS(*dm);CHKERRQ(ierr);
748   ierr = DMDestroy(&(*dm)->dmBC);CHKERRQ(ierr);
749   /* if memory was published with SAWs then destroy it */
750   ierr = PetscObjectSAWsViewOff((PetscObject)*dm);CHKERRQ(ierr);
751 
752   if ((*dm)->ops->destroy) {
753     ierr = (*(*dm)->ops->destroy)(*dm);CHKERRQ(ierr);
754   }
755   ierr = DMMonitorCancel(*dm);CHKERRQ(ierr);
756   /* We do not destroy (*dm)->data here so that we can reference count backend objects */
757   ierr = PetscHeaderDestroy(dm);CHKERRQ(ierr);
758   PetscFunctionReturn(0);
759 }
760 
761 /*@
762     DMSetUp - sets up the data structures inside a DM object
763 
764     Collective on dm
765 
766     Input Parameter:
767 .   dm - the DM object to setup
768 
769     Level: developer
770 
771 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
772 
773 @*/
774 PetscErrorCode  DMSetUp(DM dm)
775 {
776   PetscErrorCode ierr;
777 
778   PetscFunctionBegin;
779   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
780   if (dm->setupcalled) PetscFunctionReturn(0);
781   if (dm->ops->setup) {
782     ierr = (*dm->ops->setup)(dm);CHKERRQ(ierr);
783   }
784   dm->setupcalled = PETSC_TRUE;
785   PetscFunctionReturn(0);
786 }
787 
788 /*@
789     DMSetFromOptions - sets parameters in a DM from the options database
790 
791     Collective on dm
792 
793     Input Parameter:
794 .   dm - the DM object to set options for
795 
796     Options Database:
797 +   -dm_preallocate_only - Only preallocate the matrix for DMCreateMatrix(), but do not fill it with zeros
798 .   -dm_vec_type <type>  - type of vector to create inside DM
799 .   -dm_mat_type <type>  - type of matrix to create inside DM
800 -   -dm_is_coloring_type - <global or local>
801 
802     DMPLEX Specific Checks
803 +   -dm_plex_check_symmetry        - Check that the adjacency information in the mesh is symmetric - DMPlexCheckSymmetry()
804 .   -dm_plex_check_skeleton        - Check that each cell has the correct number of vertices (only for homogeneous simplex or tensor meshes) - DMPlexCheckSkeleton()
805 .   -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()
806 .   -dm_plex_check_geometry        - Check that cells have positive volume - DMPlexCheckGeometry()
807 .   -dm_plex_check_pointsf         - Check some necessary conditions for PointSF - DMPlexCheckPointSF()
808 .   -dm_plex_check_interface_cones - Check points on inter-partition interfaces have conforming order of cone points - DMPlexCheckInterfaceCones()
809 -   -dm_plex_check_all             - Perform all the checks above
810 
811     Level: intermediate
812 
813 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(),
814     DMPlexCheckSymmetry(), DMPlexCheckSkeleton(), DMPlexCheckFaces(), DMPlexCheckGeometry(), DMPlexCheckPointSF(), DMPlexCheckInterfaceCones()
815 
816 @*/
817 PetscErrorCode DMSetFromOptions(DM dm)
818 {
819   char           typeName[256];
820   PetscBool      flg;
821   PetscErrorCode ierr;
822 
823   PetscFunctionBegin;
824   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
825   dm->setfromoptionscalled = PETSC_TRUE;
826   if (dm->sf) {ierr = PetscSFSetFromOptions(dm->sf);CHKERRQ(ierr);}
827   if (dm->sectionSF) {ierr = PetscSFSetFromOptions(dm->sectionSF);CHKERRQ(ierr);}
828   ierr = PetscObjectOptionsBegin((PetscObject)dm);CHKERRQ(ierr);
829   ierr = PetscOptionsBool("-dm_preallocate_only","only preallocate matrix, but do not set column indices","DMSetMatrixPreallocateOnly",dm->prealloc_only,&dm->prealloc_only,NULL);CHKERRQ(ierr);
830   ierr = PetscOptionsFList("-dm_vec_type","Vector type used for created vectors","DMSetVecType",VecList,dm->vectype,typeName,256,&flg);CHKERRQ(ierr);
831   if (flg) {
832     ierr = DMSetVecType(dm,typeName);CHKERRQ(ierr);
833   }
834   ierr = PetscOptionsFList("-dm_mat_type","Matrix type used for created matrices","DMSetMatType",MatList,dm->mattype ? dm->mattype : typeName,typeName,sizeof(typeName),&flg);CHKERRQ(ierr);
835   if (flg) {
836     ierr = DMSetMatType(dm,typeName);CHKERRQ(ierr);
837   }
838   ierr = PetscOptionsEnum("-dm_is_coloring_type","Global or local coloring of Jacobian","DMSetISColoringType",ISColoringTypes,(PetscEnum)dm->coloringtype,(PetscEnum*)&dm->coloringtype,NULL);CHKERRQ(ierr);
839   if (dm->ops->setfromoptions) {
840     ierr = (*dm->ops->setfromoptions)(PetscOptionsObject,dm);CHKERRQ(ierr);
841   }
842   /* process any options handlers added with PetscObjectAddOptionsHandler() */
843   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject) dm);CHKERRQ(ierr);
844   ierr = PetscOptionsEnd();CHKERRQ(ierr);
845   PetscFunctionReturn(0);
846 }
847 
848 /*@C
849    DMViewFromOptions - View from Options
850 
851    Collective on DM
852 
853    Input Parameters:
854 +  dm - the DM object
855 .  obj - Optional object
856 -  name - command line option
857 
858    Level: intermediate
859 .seealso:  DM, DMView, PetscObjectViewFromOptions(), DMCreate()
860 @*/
861 PetscErrorCode  DMViewFromOptions(DM dm,PetscObject obj,const char name[])
862 {
863   PetscErrorCode ierr;
864 
865   PetscFunctionBegin;
866   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
867   ierr = PetscObjectViewFromOptions((PetscObject)dm,obj,name);CHKERRQ(ierr);
868   PetscFunctionReturn(0);
869 }
870 
871 /*@C
872     DMView - Views a DM
873 
874     Collective on dm
875 
876     Input Parameter:
877 +   dm - the DM object to view
878 -   v - the viewer
879 
880     Level: beginner
881 
882 .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
883 
884 @*/
885 PetscErrorCode  DMView(DM dm,PetscViewer v)
886 {
887   PetscErrorCode    ierr;
888   PetscBool         isbinary;
889   PetscMPIInt       size;
890   PetscViewerFormat format;
891 
892   PetscFunctionBegin;
893   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
894   if (!v) {
895     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)dm),&v);CHKERRQ(ierr);
896   }
897   PetscValidHeaderSpecific(v,PETSC_VIEWER_CLASSID,2);
898   /* Ideally, we would like to have this test on.
899      However, it currently breaks socket viz via GLVis.
900      During DMView(parallel_mesh,glvis_viewer), each
901      process opens a sequential ASCII socket to visualize
902      the local mesh, and PetscObjectView(dm,local_socket)
903      is internally called inside VecView_GLVis, incurring
904      in an error here */
905   /* PetscCheckSameComm(dm,1,v,2); */
906   ierr = PetscViewerCheckWritable(v);CHKERRQ(ierr);
907 
908   ierr = PetscViewerGetFormat(v,&format);CHKERRQ(ierr);
909   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&size);CHKERRQ(ierr);
910   if (size == 1 && format == PETSC_VIEWER_LOAD_BALANCE) PetscFunctionReturn(0);
911   ierr = PetscObjectPrintClassNamePrefixType((PetscObject)dm,v);CHKERRQ(ierr);
912   ierr = PetscObjectTypeCompare((PetscObject)v,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
913   if (isbinary) {
914     PetscInt classid = DM_FILE_CLASSID;
915     char     type[256];
916 
917     ierr = PetscViewerBinaryWrite(v,&classid,1,PETSC_INT);CHKERRQ(ierr);
918     ierr = PetscStrncpy(type,((PetscObject)dm)->type_name,256);CHKERRQ(ierr);
919     ierr = PetscViewerBinaryWrite(v,type,256,PETSC_CHAR);CHKERRQ(ierr);
920   }
921   if (dm->ops->view) {
922     ierr = (*dm->ops->view)(dm,v);CHKERRQ(ierr);
923   }
924   PetscFunctionReturn(0);
925 }
926 
927 /*@
928     DMCreateGlobalVector - Creates a global vector from a DM object
929 
930     Collective on dm
931 
932     Input Parameter:
933 .   dm - the DM object
934 
935     Output Parameter:
936 .   vec - the global vector
937 
938     Level: beginner
939 
940 .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
941 
942 @*/
943 PetscErrorCode  DMCreateGlobalVector(DM dm,Vec *vec)
944 {
945   PetscErrorCode ierr;
946 
947   PetscFunctionBegin;
948   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
949   PetscValidPointer(vec,2);
950   if (!dm->ops->createglobalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateGlobalVector",((PetscObject)dm)->type_name);
951   ierr = (*dm->ops->createglobalvector)(dm,vec);CHKERRQ(ierr);
952   if (PetscDefined(USE_DEBUG)) {
953     DM vdm;
954 
955     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
956     if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name);
957   }
958   PetscFunctionReturn(0);
959 }
960 
961 /*@
962     DMCreateLocalVector - Creates a local vector from a DM object
963 
964     Not Collective
965 
966     Input Parameter:
967 .   dm - the DM object
968 
969     Output Parameter:
970 .   vec - the local vector
971 
972     Level: beginner
973 
974 .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
975 
976 @*/
977 PetscErrorCode  DMCreateLocalVector(DM dm,Vec *vec)
978 {
979   PetscErrorCode ierr;
980 
981   PetscFunctionBegin;
982   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
983   PetscValidPointer(vec,2);
984   if (!dm->ops->createlocalvector) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateLocalVector",((PetscObject)dm)->type_name);
985   ierr = (*dm->ops->createlocalvector)(dm,vec);CHKERRQ(ierr);
986   if (PetscDefined(USE_DEBUG)) {
987     DM vdm;
988 
989     ierr = VecGetDM(*vec,&vdm);CHKERRQ(ierr);
990     if (!vdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_LIB,"DM type '%s' did not attach the DM to the vector\n",((PetscObject)dm)->type_name);
991   }
992   PetscFunctionReturn(0);
993 }
994 
995 /*@
996    DMGetLocalToGlobalMapping - Accesses the local-to-global mapping in a DM.
997 
998    Collective on dm
999 
1000    Input Parameter:
1001 .  dm - the DM that provides the mapping
1002 
1003    Output Parameter:
1004 .  ltog - the mapping
1005 
1006    Level: intermediate
1007 
1008    Notes:
1009    This mapping can then be used by VecSetLocalToGlobalMapping() or
1010    MatSetLocalToGlobalMapping().
1011 
1012 .seealso: DMCreateLocalVector()
1013 @*/
1014 PetscErrorCode DMGetLocalToGlobalMapping(DM dm,ISLocalToGlobalMapping *ltog)
1015 {
1016   PetscInt       bs = -1, bsLocal[2], bsMinMax[2];
1017   PetscErrorCode ierr;
1018 
1019   PetscFunctionBegin;
1020   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1021   PetscValidPointer(ltog,2);
1022   if (!dm->ltogmap) {
1023     PetscSection section, sectionGlobal;
1024 
1025     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1026     if (section) {
1027       const PetscInt *cdofs;
1028       PetscInt       *ltog;
1029       PetscInt        pStart, pEnd, n, p, k, l;
1030 
1031       ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
1032       ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
1033       ierr = PetscSectionGetStorageSize(section, &n);CHKERRQ(ierr);
1034       ierr = PetscMalloc1(n, &ltog);CHKERRQ(ierr); /* We want the local+overlap size */
1035       for (p = pStart, l = 0; p < pEnd; ++p) {
1036         PetscInt bdof, cdof, dof, off, c, cind = 0;
1037 
1038         /* Should probably use constrained dofs */
1039         ierr = PetscSectionGetDof(section, p, &dof);CHKERRQ(ierr);
1040         ierr = PetscSectionGetConstraintDof(section, p, &cdof);CHKERRQ(ierr);
1041         ierr = PetscSectionGetConstraintIndices(section, p, &cdofs);CHKERRQ(ierr);
1042         ierr = PetscSectionGetOffset(sectionGlobal, p, &off);CHKERRQ(ierr);
1043         /* If you have dofs, and constraints, and they are unequal, we set the blocksize to 1 */
1044         bdof = cdof && (dof-cdof) ? 1 : dof;
1045         if (dof) {
1046           if (bs < 0)          {bs = bdof;}
1047           else if (bs != bdof) {bs = 1;}
1048         }
1049         for (c = 0; c < dof; ++c, ++l) {
1050           if ((cind < cdof) && (c == cdofs[cind])) ltog[l] = off < 0 ? off-c : off+c;
1051           else                                     ltog[l] = (off < 0 ? -(off+1) : off) + c;
1052         }
1053       }
1054       /* Must have same blocksize on all procs (some might have no points) */
1055       bsLocal[0] = bs < 0 ? PETSC_MAX_INT : bs; bsLocal[1] = bs;
1056       ierr = PetscGlobalMinMaxInt(PetscObjectComm((PetscObject) dm), bsLocal, bsMinMax);CHKERRQ(ierr);
1057       if (bsMinMax[0] != bsMinMax[1]) {bs = 1;}
1058       else                            {bs = bsMinMax[0];}
1059       bs = bs < 0 ? 1 : bs;
1060       /* Must reduce indices by blocksize */
1061       if (bs > 1) {
1062         for (l = 0, k = 0; l < n; l += bs, ++k) ltog[k] = ltog[l]/bs;
1063         n /= bs;
1064       }
1065       ierr = ISLocalToGlobalMappingCreate(PetscObjectComm((PetscObject)dm), bs, n, ltog, PETSC_OWN_POINTER, &dm->ltogmap);CHKERRQ(ierr);
1066       ierr = PetscLogObjectParent((PetscObject)dm, (PetscObject)dm->ltogmap);CHKERRQ(ierr);
1067     } else {
1068       if (!dm->ops->getlocaltoglobalmapping) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetLocalToGlobalMapping",((PetscObject)dm)->type_name);
1069       ierr = (*dm->ops->getlocaltoglobalmapping)(dm);CHKERRQ(ierr);
1070     }
1071   }
1072   *ltog = dm->ltogmap;
1073   PetscFunctionReturn(0);
1074 }
1075 
1076 /*@
1077    DMGetBlockSize - Gets the inherent block size associated with a DM
1078 
1079    Not Collective
1080 
1081    Input Parameter:
1082 .  dm - the DM with block structure
1083 
1084    Output Parameter:
1085 .  bs - the block size, 1 implies no exploitable block structure
1086 
1087    Level: intermediate
1088 
1089 .seealso: ISCreateBlock(), VecSetBlockSize(), MatSetBlockSize(), DMGetLocalToGlobalMapping()
1090 @*/
1091 PetscErrorCode  DMGetBlockSize(DM dm,PetscInt *bs)
1092 {
1093   PetscFunctionBegin;
1094   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1095   PetscValidIntPointer(bs,2);
1096   if (dm->bs < 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"DM does not have enough information to provide a block size yet");
1097   *bs = dm->bs;
1098   PetscFunctionReturn(0);
1099 }
1100 
1101 /*@
1102     DMCreateInterpolation - Gets interpolation matrix between two DM objects
1103 
1104     Collective on dmc
1105 
1106     Input Parameter:
1107 +   dmc - the DM object
1108 -   dmf - the second, finer DM object
1109 
1110     Output Parameter:
1111 +  mat - the interpolation
1112 -  vec - the scaling (optional)
1113 
1114     Level: developer
1115 
1116     Notes:
1117     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
1118         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1119 
1120         For DMDA objects you can use this interpolation (more precisely the interpolation from the DMGetCoordinateDM()) to interpolate the mesh coordinate vectors
1121         EXCEPT in the periodic case where it does not make sense since the coordinate vectors are not periodic.
1122 
1123 
1124 .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolationScale()
1125 
1126 @*/
1127 PetscErrorCode  DMCreateInterpolation(DM dmc,DM dmf,Mat *mat,Vec *vec)
1128 {
1129   PetscErrorCode ierr;
1130 
1131   PetscFunctionBegin;
1132   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1133   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1134   PetscValidPointer(mat,3);
1135   if (!dmc->ops->createinterpolation) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInterpolation",((PetscObject)dmc)->type_name);
1136   ierr = PetscLogEventBegin(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
1137   ierr = (*dmc->ops->createinterpolation)(dmc,dmf,mat,vec);CHKERRQ(ierr);
1138   ierr = PetscLogEventEnd(DM_CreateInterpolation,dmc,dmf,0,0);CHKERRQ(ierr);
1139   PetscFunctionReturn(0);
1140 }
1141 
1142 /*@
1143     DMCreateInterpolationScale - Forms L = 1/(R*1) such that diag(L)*R preserves scale and is thus suitable for state (versus residual) restriction.
1144 
1145   Input Parameters:
1146 +      dac - DM that defines a coarse mesh
1147 .      daf - DM that defines a fine mesh
1148 -      mat - the restriction (or interpolation operator) from fine to coarse
1149 
1150   Output Parameter:
1151 .    scale - the scaled vector
1152 
1153   Level: developer
1154 
1155 .seealso: DMCreateInterpolation()
1156 
1157 @*/
1158 PetscErrorCode  DMCreateInterpolationScale(DM dac,DM daf,Mat mat,Vec *scale)
1159 {
1160   PetscErrorCode ierr;
1161   Vec            fine;
1162   PetscScalar    one = 1.0;
1163 
1164   PetscFunctionBegin;
1165   ierr = DMCreateGlobalVector(daf,&fine);CHKERRQ(ierr);
1166   ierr = DMCreateGlobalVector(dac,scale);CHKERRQ(ierr);
1167   ierr = VecSet(fine,one);CHKERRQ(ierr);
1168   ierr = MatRestrict(mat,fine,*scale);CHKERRQ(ierr);
1169   ierr = VecDestroy(&fine);CHKERRQ(ierr);
1170   ierr = VecReciprocal(*scale);CHKERRQ(ierr);
1171   PetscFunctionReturn(0);
1172 }
1173 
1174 /*@
1175     DMCreateRestriction - Gets restriction matrix between two DM objects
1176 
1177     Collective on dmc
1178 
1179     Input Parameter:
1180 +   dmc - the DM object
1181 -   dmf - the second, finer DM object
1182 
1183     Output Parameter:
1184 .  mat - the restriction
1185 
1186 
1187     Level: developer
1188 
1189     Notes:
1190     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
1191         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the interpolation.
1192 
1193 
1194 .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateInterpolation()
1195 
1196 @*/
1197 PetscErrorCode  DMCreateRestriction(DM dmc,DM dmf,Mat *mat)
1198 {
1199   PetscErrorCode ierr;
1200 
1201   PetscFunctionBegin;
1202   PetscValidHeaderSpecific(dmc,DM_CLASSID,1);
1203   PetscValidHeaderSpecific(dmf,DM_CLASSID,2);
1204   PetscValidPointer(mat,3);
1205   if (!dmc->ops->createrestriction) SETERRQ1(PetscObjectComm((PetscObject)dmc),PETSC_ERR_SUP,"DM type %s does not implement DMCreateRestriction",((PetscObject)dmc)->type_name);
1206   ierr = PetscLogEventBegin(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
1207   ierr = (*dmc->ops->createrestriction)(dmc,dmf,mat);CHKERRQ(ierr);
1208   ierr = PetscLogEventEnd(DM_CreateRestriction,dmc,dmf,0,0);CHKERRQ(ierr);
1209   PetscFunctionReturn(0);
1210 }
1211 
1212 /*@
1213     DMCreateInjection - Gets injection matrix between two DM objects
1214 
1215     Collective on dac
1216 
1217     Input Parameter:
1218 +   dac - the DM object
1219 -   daf - the second, finer DM object
1220 
1221     Output Parameter:
1222 .   mat - the injection
1223 
1224     Level: developer
1225 
1226    Notes:
1227     For DMDA objects this only works for "uniform refinement", that is the refined mesh was obtained DMRefine() or the coarse mesh was obtained by
1228         DMCoarsen(). The coordinates set into the DMDA are completely ignored in computing the injection.
1229 
1230 .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateColoring(), DMCreateMatrix(), DMCreateInterpolation()
1231 
1232 @*/
1233 PetscErrorCode  DMCreateInjection(DM dac,DM daf,Mat *mat)
1234 {
1235   PetscErrorCode ierr;
1236 
1237   PetscFunctionBegin;
1238   PetscValidHeaderSpecific(dac,DM_CLASSID,1);
1239   PetscValidHeaderSpecific(daf,DM_CLASSID,2);
1240   PetscValidPointer(mat,3);
1241   if (!dac->ops->createinjection) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateInjection",((PetscObject)dac)->type_name);
1242   ierr = PetscLogEventBegin(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
1243   ierr = (*dac->ops->createinjection)(dac,daf,mat);CHKERRQ(ierr);
1244   ierr = PetscLogEventEnd(DM_CreateInjection,dac,daf,0,0);CHKERRQ(ierr);
1245   PetscFunctionReturn(0);
1246 }
1247 
1248 /*@
1249   DMCreateMassMatrix - Gets mass matrix between two DM objects, M_ij = \int \phi_i \psi_j
1250 
1251   Collective on dac
1252 
1253   Input Parameter:
1254 + dac - the DM object
1255 - daf - the second, finer DM object
1256 
1257   Output Parameter:
1258 . mat - the interpolation
1259 
1260   Level: developer
1261 
1262 .seealso DMCreateMatrix(), DMRefine(), DMCoarsen(), DMCreateRestriction(), DMCreateInterpolation(), DMCreateInjection()
1263 @*/
1264 PetscErrorCode DMCreateMassMatrix(DM dac, DM daf, Mat *mat)
1265 {
1266   PetscErrorCode ierr;
1267 
1268   PetscFunctionBegin;
1269   PetscValidHeaderSpecific(dac, DM_CLASSID, 1);
1270   PetscValidHeaderSpecific(daf, DM_CLASSID, 2);
1271   PetscValidPointer(mat,3);
1272   if (!dac->ops->createmassmatrix) SETERRQ1(PetscObjectComm((PetscObject)dac),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMassMatrix",((PetscObject)dac)->type_name);
1273   ierr = (*dac->ops->createmassmatrix)(dac, daf, mat);CHKERRQ(ierr);
1274   PetscFunctionReturn(0);
1275 }
1276 
1277 /*@
1278     DMCreateColoring - Gets coloring for a DM
1279 
1280     Collective on dm
1281 
1282     Input Parameter:
1283 +   dm - the DM object
1284 -   ctype - IS_COLORING_LOCAL or IS_COLORING_GLOBAL
1285 
1286     Output Parameter:
1287 .   coloring - the coloring
1288 
1289     Notes:
1290        Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the
1291        matrix comes from. In general using the mesh produces a more optimal coloring (fewer colors).
1292 
1293        This produces a coloring with the distance of 2, see MatSetColoringDistance() which can be used for efficiently computing Jacobians with MatFDColoringCreate()
1294 
1295     Level: developer
1296 
1297 .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateMatrix(), DMSetMatType(), MatColoring, MatFDColoringCreate()
1298 
1299 @*/
1300 PetscErrorCode  DMCreateColoring(DM dm,ISColoringType ctype,ISColoring *coloring)
1301 {
1302   PetscErrorCode ierr;
1303 
1304   PetscFunctionBegin;
1305   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1306   PetscValidPointer(coloring,3);
1307   if (!dm->ops->getcoloring) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateColoring",((PetscObject)dm)->type_name);
1308   ierr = (*dm->ops->getcoloring)(dm,ctype,coloring);CHKERRQ(ierr);
1309   PetscFunctionReturn(0);
1310 }
1311 
1312 /*@
1313     DMCreateMatrix - Gets empty Jacobian for a DM
1314 
1315     Collective on dm
1316 
1317     Input Parameter:
1318 .   dm - the DM object
1319 
1320     Output Parameter:
1321 .   mat - the empty Jacobian
1322 
1323     Level: beginner
1324 
1325     Notes:
1326     This properly preallocates the number of nonzeros in the sparse matrix so you
1327        do not need to do it yourself.
1328 
1329        By default it also sets the nonzero structure and puts in the zero entries. To prevent setting
1330        the nonzero pattern call DMSetMatrixPreallocateOnly()
1331 
1332        For structured grid problems, when you call MatView() on this matrix it is displayed using the global natural ordering, NOT in the ordering used
1333        internally by PETSc.
1334 
1335        For structured grid problems, in general it is easiest to use MatSetValuesStencil() or MatSetValuesLocal() to put values into the matrix because MatSetValues() requires
1336        the indices for the global numbering for DMDAs which is complicated.
1337 
1338 .seealso DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMSetMatType()
1339 
1340 @*/
1341 PetscErrorCode  DMCreateMatrix(DM dm,Mat *mat)
1342 {
1343   PetscErrorCode ierr;
1344 
1345   PetscFunctionBegin;
1346   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1347   PetscValidPointer(mat,3);
1348   if (!dm->ops->creatematrix) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateMatrix",((PetscObject)dm)->type_name);
1349   ierr = MatInitializePackage();CHKERRQ(ierr);
1350   ierr = PetscLogEventBegin(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1351   ierr = (*dm->ops->creatematrix)(dm,mat);CHKERRQ(ierr);
1352   if (PetscDefined(USE_DEBUG)) {
1353     DM mdm;
1354 
1355     ierr = MatGetDM(*mat,&mdm);CHKERRQ(ierr);
1356     if (!mdm) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"DM type '%s' did not attach the DM to the matrix\n",((PetscObject)dm)->type_name);
1357   }
1358   /* Handle nullspace and near nullspace */
1359   if (dm->Nf) {
1360     MatNullSpace nullSpace;
1361     PetscInt     Nf;
1362 
1363     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
1364     if (Nf == 1) {
1365       if (dm->nullspaceConstructors[0]) {
1366         ierr = (*dm->nullspaceConstructors[0])(dm, 0, &nullSpace);CHKERRQ(ierr);
1367         ierr = MatSetNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1368         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1369       }
1370       if (dm->nearnullspaceConstructors[0]) {
1371         ierr = (*dm->nearnullspaceConstructors[0])(dm, 0, &nullSpace);CHKERRQ(ierr);
1372         ierr = MatSetNearNullSpace(*mat, nullSpace);CHKERRQ(ierr);
1373         ierr = MatNullSpaceDestroy(&nullSpace);CHKERRQ(ierr);
1374       }
1375     }
1376   }
1377   ierr = PetscLogEventEnd(DM_CreateMatrix,0,0,0,0);CHKERRQ(ierr);
1378   PetscFunctionReturn(0);
1379 }
1380 
1381 /*@
1382   DMSetMatrixPreallocateOnly - When DMCreateMatrix() is called the matrix will be properly
1383     preallocated but the nonzero structure and zero values will not be set.
1384 
1385   Logically Collective on dm
1386 
1387   Input Parameter:
1388 + dm - the DM
1389 - only - PETSC_TRUE if only want preallocation
1390 
1391   Level: developer
1392 .seealso DMCreateMatrix(), DMSetMatrixStructureOnly()
1393 @*/
1394 PetscErrorCode DMSetMatrixPreallocateOnly(DM dm, PetscBool only)
1395 {
1396   PetscFunctionBegin;
1397   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1398   dm->prealloc_only = only;
1399   PetscFunctionReturn(0);
1400 }
1401 
1402 /*@
1403   DMSetMatrixStructureOnly - When DMCreateMatrix() is called, the matrix structure will be created
1404     but the array for values will not be allocated.
1405 
1406   Logically Collective on dm
1407 
1408   Input Parameter:
1409 + dm - the DM
1410 - only - PETSC_TRUE if only want matrix stucture
1411 
1412   Level: developer
1413 .seealso DMCreateMatrix(), DMSetMatrixPreallocateOnly()
1414 @*/
1415 PetscErrorCode DMSetMatrixStructureOnly(DM dm, PetscBool only)
1416 {
1417   PetscFunctionBegin;
1418   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1419   dm->structure_only = only;
1420   PetscFunctionReturn(0);
1421 }
1422 
1423 /*@C
1424   DMGetWorkArray - Gets a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1425 
1426   Not Collective
1427 
1428   Input Parameters:
1429 + dm - the DM object
1430 . count - The minium size
1431 - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT)
1432 
1433   Output Parameter:
1434 . array - the work array
1435 
1436   Level: developer
1437 
1438 .seealso DMDestroy(), DMCreate()
1439 @*/
1440 PetscErrorCode DMGetWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1441 {
1442   PetscErrorCode ierr;
1443   DMWorkLink     link;
1444   PetscMPIInt    dsize;
1445 
1446   PetscFunctionBegin;
1447   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1448   PetscValidPointer(mem,4);
1449   if (dm->workin) {
1450     link       = dm->workin;
1451     dm->workin = dm->workin->next;
1452   } else {
1453     ierr = PetscNewLog(dm,&link);CHKERRQ(ierr);
1454   }
1455   ierr = MPI_Type_size(dtype,&dsize);CHKERRQ(ierr);
1456   if (((size_t)dsize*count) > link->bytes) {
1457     ierr        = PetscFree(link->mem);CHKERRQ(ierr);
1458     ierr        = PetscMalloc(dsize*count,&link->mem);CHKERRQ(ierr);
1459     link->bytes = dsize*count;
1460   }
1461   link->next   = dm->workout;
1462   dm->workout  = link;
1463   *(void**)mem = link->mem;
1464   PetscFunctionReturn(0);
1465 }
1466 
1467 /*@C
1468   DMRestoreWorkArray - Restores a work array guaranteed to be at least the input size, restore with DMRestoreWorkArray()
1469 
1470   Not Collective
1471 
1472   Input Parameters:
1473 + dm - the DM object
1474 . count - The minium size
1475 - dtype - MPI data type, often MPIU_REAL, MPIU_SCALAR, MPIU_INT
1476 
1477   Output Parameter:
1478 . array - the work array
1479 
1480   Level: developer
1481 
1482   Developer Notes:
1483     count and dtype are ignored, they are only needed for DMGetWorkArray()
1484 .seealso DMDestroy(), DMCreate()
1485 @*/
1486 PetscErrorCode DMRestoreWorkArray(DM dm,PetscInt count,MPI_Datatype dtype,void *mem)
1487 {
1488   DMWorkLink *p,link;
1489 
1490   PetscFunctionBegin;
1491   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1492   PetscValidPointer(mem,4);
1493   for (p=&dm->workout; (link=*p); p=&link->next) {
1494     if (link->mem == *(void**)mem) {
1495       *p           = link->next;
1496       link->next   = dm->workin;
1497       dm->workin   = link;
1498       *(void**)mem = NULL;
1499       PetscFunctionReturn(0);
1500     }
1501   }
1502   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Array was not checked out");
1503 }
1504 
1505 PetscErrorCode DMSetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1506 {
1507   PetscFunctionBegin;
1508   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1509   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1510   dm->nullspaceConstructors[field] = nullsp;
1511   PetscFunctionReturn(0);
1512 }
1513 
1514 PetscErrorCode DMGetNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1515 {
1516   PetscFunctionBegin;
1517   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1518   PetscValidPointer(nullsp, 3);
1519   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1520   *nullsp = dm->nullspaceConstructors[field];
1521   PetscFunctionReturn(0);
1522 }
1523 
1524 PetscErrorCode DMSetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (*nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1525 {
1526   PetscFunctionBegin;
1527   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1528   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1529   dm->nearnullspaceConstructors[field] = nullsp;
1530   PetscFunctionReturn(0);
1531 }
1532 
1533 PetscErrorCode DMGetNearNullSpaceConstructor(DM dm, PetscInt field, PetscErrorCode (**nullsp)(DM dm, PetscInt field, MatNullSpace *nullSpace))
1534 {
1535   PetscFunctionBegin;
1536   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
1537   PetscValidPointer(nullsp, 3);
1538   if (field >= 10) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Cannot handle %d >= 10 fields", field);
1539   *nullsp = dm->nearnullspaceConstructors[field];
1540   PetscFunctionReturn(0);
1541 }
1542 
1543 /*@C
1544   DMCreateFieldIS - Creates a set of IS objects with the global indices of dofs for each field
1545 
1546   Not collective
1547 
1548   Input Parameter:
1549 . dm - the DM object
1550 
1551   Output Parameters:
1552 + numFields  - The number of fields (or NULL if not requested)
1553 . fieldNames - The name for each field (or NULL if not requested)
1554 - fields     - The global indices for each field (or NULL if not requested)
1555 
1556   Level: intermediate
1557 
1558   Notes:
1559   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1560   PetscFree(), every entry of fields should be destroyed with ISDestroy(), and both arrays should be freed with
1561   PetscFree().
1562 
1563 .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix()
1564 @*/
1565 PetscErrorCode DMCreateFieldIS(DM dm, PetscInt *numFields, char ***fieldNames, IS **fields)
1566 {
1567   PetscSection   section, sectionGlobal;
1568   PetscErrorCode ierr;
1569 
1570   PetscFunctionBegin;
1571   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1572   if (numFields) {
1573     PetscValidIntPointer(numFields,2);
1574     *numFields = 0;
1575   }
1576   if (fieldNames) {
1577     PetscValidPointer(fieldNames,3);
1578     *fieldNames = NULL;
1579   }
1580   if (fields) {
1581     PetscValidPointer(fields,4);
1582     *fields = NULL;
1583   }
1584   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1585   if (section) {
1586     PetscInt *fieldSizes, *fieldNc, **fieldIndices;
1587     PetscInt nF, f, pStart, pEnd, p;
1588 
1589     ierr = DMGetGlobalSection(dm, &sectionGlobal);CHKERRQ(ierr);
1590     ierr = PetscSectionGetNumFields(section, &nF);CHKERRQ(ierr);
1591     ierr = PetscMalloc3(nF,&fieldSizes,nF,&fieldNc,nF,&fieldIndices);CHKERRQ(ierr);
1592     ierr = PetscSectionGetChart(sectionGlobal, &pStart, &pEnd);CHKERRQ(ierr);
1593     for (f = 0; f < nF; ++f) {
1594       fieldSizes[f] = 0;
1595       ierr          = PetscSectionGetFieldComponents(section, f, &fieldNc[f]);CHKERRQ(ierr);
1596     }
1597     for (p = pStart; p < pEnd; ++p) {
1598       PetscInt gdof;
1599 
1600       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
1601       if (gdof > 0) {
1602         for (f = 0; f < nF; ++f) {
1603           PetscInt fdof, fcdof, fpdof;
1604 
1605           ierr  = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
1606           ierr  = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
1607           fpdof = fdof-fcdof;
1608           if (fpdof && fpdof != fieldNc[f]) {
1609             /* Layout does not admit a pointwise block size */
1610             fieldNc[f] = 1;
1611           }
1612           fieldSizes[f] += fpdof;
1613         }
1614       }
1615     }
1616     for (f = 0; f < nF; ++f) {
1617       ierr          = PetscMalloc1(fieldSizes[f], &fieldIndices[f]);CHKERRQ(ierr);
1618       fieldSizes[f] = 0;
1619     }
1620     for (p = pStart; p < pEnd; ++p) {
1621       PetscInt gdof, goff;
1622 
1623       ierr = PetscSectionGetDof(sectionGlobal, p, &gdof);CHKERRQ(ierr);
1624       if (gdof > 0) {
1625         ierr = PetscSectionGetOffset(sectionGlobal, p, &goff);CHKERRQ(ierr);
1626         for (f = 0; f < nF; ++f) {
1627           PetscInt fdof, fcdof, fc;
1628 
1629           ierr = PetscSectionGetFieldDof(section, p, f, &fdof);CHKERRQ(ierr);
1630           ierr = PetscSectionGetFieldConstraintDof(section, p, f, &fcdof);CHKERRQ(ierr);
1631           for (fc = 0; fc < fdof-fcdof; ++fc, ++fieldSizes[f]) {
1632             fieldIndices[f][fieldSizes[f]] = goff++;
1633           }
1634         }
1635       }
1636     }
1637     if (numFields) *numFields = nF;
1638     if (fieldNames) {
1639       ierr = PetscMalloc1(nF, fieldNames);CHKERRQ(ierr);
1640       for (f = 0; f < nF; ++f) {
1641         const char *fieldName;
1642 
1643         ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1644         ierr = PetscStrallocpy(fieldName, (char**) &(*fieldNames)[f]);CHKERRQ(ierr);
1645       }
1646     }
1647     if (fields) {
1648       ierr = PetscMalloc1(nF, fields);CHKERRQ(ierr);
1649       for (f = 0; f < nF; ++f) {
1650         PetscInt bs, in[2], out[2];
1651 
1652         ierr  = ISCreateGeneral(PetscObjectComm((PetscObject)dm), fieldSizes[f], fieldIndices[f], PETSC_OWN_POINTER, &(*fields)[f]);CHKERRQ(ierr);
1653         in[0] = -fieldNc[f];
1654         in[1] = fieldNc[f];
1655         ierr  = MPIU_Allreduce(in, out, 2, MPIU_INT, MPI_MAX, PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
1656         bs    = (-out[0] == out[1]) ? out[1] : 1;
1657         ierr  = ISSetBlockSize((*fields)[f], bs);CHKERRQ(ierr);
1658       }
1659     }
1660     ierr = PetscFree3(fieldSizes,fieldNc,fieldIndices);CHKERRQ(ierr);
1661   } else if (dm->ops->createfieldis) {
1662     ierr = (*dm->ops->createfieldis)(dm, numFields, fieldNames, fields);CHKERRQ(ierr);
1663   }
1664   PetscFunctionReturn(0);
1665 }
1666 
1667 
1668 /*@C
1669   DMCreateFieldDecomposition - Returns a list of IS objects defining a decomposition of a problem into subproblems
1670                           corresponding to different fields: each IS contains the global indices of the dofs of the
1671                           corresponding field. The optional list of DMs define the DM for each subproblem.
1672                           Generalizes DMCreateFieldIS().
1673 
1674   Not collective
1675 
1676   Input Parameter:
1677 . dm - the DM object
1678 
1679   Output Parameters:
1680 + len       - The number of subproblems in the field decomposition (or NULL if not requested)
1681 . namelist  - The name for each field (or NULL if not requested)
1682 . islist    - The global indices for each field (or NULL if not requested)
1683 - dmlist    - The DMs for each field subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1684 
1685   Level: intermediate
1686 
1687   Notes:
1688   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1689   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1690   and all of the arrays should be freed with PetscFree().
1691 
1692 .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1693 @*/
1694 PetscErrorCode DMCreateFieldDecomposition(DM dm, PetscInt *len, char ***namelist, IS **islist, DM **dmlist)
1695 {
1696   PetscErrorCode ierr;
1697 
1698   PetscFunctionBegin;
1699   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1700   if (len) {
1701     PetscValidIntPointer(len,2);
1702     *len = 0;
1703   }
1704   if (namelist) {
1705     PetscValidPointer(namelist,3);
1706     *namelist = 0;
1707   }
1708   if (islist) {
1709     PetscValidPointer(islist,4);
1710     *islist = 0;
1711   }
1712   if (dmlist) {
1713     PetscValidPointer(dmlist,5);
1714     *dmlist = 0;
1715   }
1716   /*
1717    Is it a good idea to apply the following check across all impls?
1718    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1719    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1720    */
1721   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
1722   if (!dm->ops->createfielddecomposition) {
1723     PetscSection section;
1724     PetscInt     numFields, f;
1725 
1726     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
1727     if (section) {ierr = PetscSectionGetNumFields(section, &numFields);CHKERRQ(ierr);}
1728     if (section && numFields && dm->ops->createsubdm) {
1729       if (len) *len = numFields;
1730       if (namelist) {ierr = PetscMalloc1(numFields,namelist);CHKERRQ(ierr);}
1731       if (islist)   {ierr = PetscMalloc1(numFields,islist);CHKERRQ(ierr);}
1732       if (dmlist)   {ierr = PetscMalloc1(numFields,dmlist);CHKERRQ(ierr);}
1733       for (f = 0; f < numFields; ++f) {
1734         const char *fieldName;
1735 
1736         ierr = DMCreateSubDM(dm, 1, &f, islist ? &(*islist)[f] : NULL, dmlist ? &(*dmlist)[f] : NULL);CHKERRQ(ierr);
1737         if (namelist) {
1738           ierr = PetscSectionGetFieldName(section, f, &fieldName);CHKERRQ(ierr);
1739           ierr = PetscStrallocpy(fieldName, (char**) &(*namelist)[f]);CHKERRQ(ierr);
1740         }
1741       }
1742     } else {
1743       ierr = DMCreateFieldIS(dm, len, namelist, islist);CHKERRQ(ierr);
1744       /* By default there are no DMs associated with subproblems. */
1745       if (dmlist) *dmlist = NULL;
1746     }
1747   } else {
1748     ierr = (*dm->ops->createfielddecomposition)(dm,len,namelist,islist,dmlist);CHKERRQ(ierr);
1749   }
1750   PetscFunctionReturn(0);
1751 }
1752 
1753 /*@
1754   DMCreateSubDM - Returns an IS and DM encapsulating a subproblem defined by the fields passed in.
1755                   The fields are defined by DMCreateFieldIS().
1756 
1757   Not collective
1758 
1759   Input Parameters:
1760 + dm        - The DM object
1761 . numFields - The number of fields in this subproblem
1762 - fields    - The field numbers of the selected fields
1763 
1764   Output Parameters:
1765 + is - The global indices for the subproblem
1766 - subdm - The DM for the subproblem
1767 
1768   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
1769 
1770   Level: intermediate
1771 
1772 .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1773 @*/
1774 PetscErrorCode DMCreateSubDM(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
1775 {
1776   PetscErrorCode ierr;
1777 
1778   PetscFunctionBegin;
1779   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1780   PetscValidPointer(fields,3);
1781   if (is) PetscValidPointer(is,4);
1782   if (subdm) PetscValidPointer(subdm,5);
1783   if (!dm->ops->createsubdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSubDM",((PetscObject)dm)->type_name);
1784   ierr = (*dm->ops->createsubdm)(dm, numFields, fields, is, subdm);CHKERRQ(ierr);
1785   PetscFunctionReturn(0);
1786 }
1787 
1788 /*@C
1789   DMCreateSuperDM - Returns an arrays of ISes and DM encapsulating a superproblem defined by the DMs passed in.
1790 
1791   Not collective
1792 
1793   Input Parameter:
1794 + dms - The DM objects
1795 - len - The number of DMs
1796 
1797   Output Parameters:
1798 + is - The global indices for the subproblem, or NULL
1799 - superdm - The DM for the superproblem
1800 
1801   Note: You need to call DMPlexSetMigrationSF() on the original DM if you want the Global-To-Natural map to be automatically constructed
1802 
1803   Level: intermediate
1804 
1805 .seealso DMPlexSetMigrationSF(), DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1806 @*/
1807 PetscErrorCode DMCreateSuperDM(DM dms[], PetscInt len, IS **is, DM *superdm)
1808 {
1809   PetscInt       i;
1810   PetscErrorCode ierr;
1811 
1812   PetscFunctionBegin;
1813   PetscValidPointer(dms,1);
1814   for (i = 0; i < len; ++i) {PetscValidHeaderSpecific(dms[i],DM_CLASSID,1);}
1815   if (is) PetscValidPointer(is,3);
1816   PetscValidPointer(superdm,4);
1817   if (len < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Number of DMs must be nonnegative: %D", len);
1818   if (len) {
1819     DM dm = dms[0];
1820     if (!dm->ops->createsuperdm) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateSuperDM",((PetscObject)dm)->type_name);
1821     ierr = (*dm->ops->createsuperdm)(dms, len, is, superdm);CHKERRQ(ierr);
1822   }
1823   PetscFunctionReturn(0);
1824 }
1825 
1826 
1827 /*@C
1828   DMCreateDomainDecomposition - Returns lists of IS objects defining a decomposition of a problem into subproblems
1829                           corresponding to restrictions to pairs nested subdomains: each IS contains the global
1830                           indices of the dofs of the corresponding subdomains.  The inner subdomains conceptually
1831                           define a nonoverlapping covering, while outer subdomains can overlap.
1832                           The optional list of DMs define the DM for each subproblem.
1833 
1834   Not collective
1835 
1836   Input Parameter:
1837 . dm - the DM object
1838 
1839   Output Parameters:
1840 + len         - The number of subproblems in the domain decomposition (or NULL if not requested)
1841 . namelist    - The name for each subdomain (or NULL if not requested)
1842 . innerislist - The global indices for each inner subdomain (or NULL, if not requested)
1843 . outerislist - The global indices for each outer subdomain (or NULL, if not requested)
1844 - dmlist      - The DMs for each subdomain subproblem (or NULL, if not requested; if NULL is returned, no DMs are defined)
1845 
1846   Level: intermediate
1847 
1848   Notes:
1849   The user is responsible for freeing all requested arrays. In particular, every entry of names should be freed with
1850   PetscFree(), every entry of is should be destroyed with ISDestroy(), every entry of dm should be destroyed with DMDestroy(),
1851   and all of the arrays should be freed with PetscFree().
1852 
1853 .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldDecomposition()
1854 @*/
1855 PetscErrorCode DMCreateDomainDecomposition(DM dm, PetscInt *len, char ***namelist, IS **innerislist, IS **outerislist, DM **dmlist)
1856 {
1857   PetscErrorCode      ierr;
1858   DMSubDomainHookLink link;
1859   PetscInt            i,l;
1860 
1861   PetscFunctionBegin;
1862   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1863   if (len)           {PetscValidPointer(len,2);            *len         = 0;}
1864   if (namelist)      {PetscValidPointer(namelist,3);       *namelist    = NULL;}
1865   if (innerislist)   {PetscValidPointer(innerislist,4);    *innerislist = NULL;}
1866   if (outerislist)   {PetscValidPointer(outerislist,5);    *outerislist = NULL;}
1867   if (dmlist)        {PetscValidPointer(dmlist,6);         *dmlist      = NULL;}
1868   /*
1869    Is it a good idea to apply the following check across all impls?
1870    Perhaps some impls can have a well-defined decomposition before DMSetUp?
1871    This, however, follows the general principle that accessors are not well-behaved until the object is set up.
1872    */
1873   if (!dm->setupcalled) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_WRONGSTATE, "Decomposition defined only after DMSetUp");
1874   if (dm->ops->createdomaindecomposition) {
1875     ierr = (*dm->ops->createdomaindecomposition)(dm,&l,namelist,innerislist,outerislist,dmlist);CHKERRQ(ierr);
1876     /* copy subdomain hooks and context over to the subdomain DMs */
1877     if (dmlist && *dmlist) {
1878       for (i = 0; i < l; i++) {
1879         for (link=dm->subdomainhook; link; link=link->next) {
1880           if (link->ddhook) {ierr = (*link->ddhook)(dm,(*dmlist)[i],link->ctx);CHKERRQ(ierr);}
1881         }
1882         if (dm->ctx) (*dmlist)[i]->ctx = dm->ctx;
1883       }
1884     }
1885     if (len) *len = l;
1886   }
1887   PetscFunctionReturn(0);
1888 }
1889 
1890 
1891 /*@C
1892   DMCreateDomainDecompositionScatters - Returns scatters to the subdomain vectors from the global vector
1893 
1894   Not collective
1895 
1896   Input Parameters:
1897 + dm - the DM object
1898 . n  - the number of subdomain scatters
1899 - subdms - the local subdomains
1900 
1901   Output Parameters:
1902 + n     - the number of scatters returned
1903 . iscat - scatter from global vector to nonoverlapping global vector entries on subdomain
1904 . oscat - scatter from global vector to overlapping global vector entries on subdomain
1905 - gscat - scatter from global vector to local vector on subdomain (fills in ghosts)
1906 
1907   Notes:
1908     This is an alternative to the iis and ois arguments in DMCreateDomainDecomposition that allow for the solution
1909   of general nonlinear problems with overlapping subdomain methods.  While merely having index sets that enable subsets
1910   of the residual equations to be created is fine for linear problems, nonlinear problems require local assembly of
1911   solution and residual data.
1912 
1913   Level: developer
1914 
1915 .seealso DMDestroy(), DMView(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMCreateFieldIS()
1916 @*/
1917 PetscErrorCode DMCreateDomainDecompositionScatters(DM dm,PetscInt n,DM *subdms,VecScatter **iscat,VecScatter **oscat,VecScatter **gscat)
1918 {
1919   PetscErrorCode ierr;
1920 
1921   PetscFunctionBegin;
1922   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1923   PetscValidPointer(subdms,3);
1924   if (!dm->ops->createddscatters) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCreateDomainDecompositionScatters",((PetscObject)dm)->type_name);
1925   ierr = (*dm->ops->createddscatters)(dm,n,subdms,iscat,oscat,gscat);CHKERRQ(ierr);
1926   PetscFunctionReturn(0);
1927 }
1928 
1929 /*@
1930   DMRefine - Refines a DM object
1931 
1932   Collective on dm
1933 
1934   Input Parameter:
1935 + dm   - the DM object
1936 - comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
1937 
1938   Output Parameter:
1939 . dmf - the refined DM, or NULL
1940 
1941   Options Dtabase Keys:
1942 . -dm_plex_cell_refiner <strategy> - chooses the refinement strategy, e.g. regular, tohex
1943 
1944   Note: If no refinement was done, the return value is NULL
1945 
1946   Level: developer
1947 
1948 .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
1949 @*/
1950 PetscErrorCode  DMRefine(DM dm,MPI_Comm comm,DM *dmf)
1951 {
1952   PetscErrorCode   ierr;
1953   DMRefineHookLink link;
1954 
1955   PetscFunctionBegin;
1956   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
1957   if (!dm->ops->refine) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMRefine",((PetscObject)dm)->type_name);
1958   ierr = PetscLogEventBegin(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
1959   ierr = (*dm->ops->refine)(dm,comm,dmf);CHKERRQ(ierr);
1960   if (*dmf) {
1961     (*dmf)->ops->creatematrix = dm->ops->creatematrix;
1962 
1963     ierr = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmf);CHKERRQ(ierr);
1964 
1965     (*dmf)->ctx       = dm->ctx;
1966     (*dmf)->leveldown = dm->leveldown;
1967     (*dmf)->levelup   = dm->levelup + 1;
1968 
1969     ierr = DMSetMatType(*dmf,dm->mattype);CHKERRQ(ierr);
1970     for (link=dm->refinehook; link; link=link->next) {
1971       if (link->refinehook) {
1972         ierr = (*link->refinehook)(dm,*dmf,link->ctx);CHKERRQ(ierr);
1973       }
1974     }
1975   }
1976   ierr = PetscLogEventEnd(DM_Refine,dm,0,0,0);CHKERRQ(ierr);
1977   PetscFunctionReturn(0);
1978 }
1979 
1980 /*@C
1981    DMRefineHookAdd - adds a callback to be run when interpolating a nonlinear problem to a finer grid
1982 
1983    Logically Collective
1984 
1985    Input Arguments:
1986 +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
1987 .  refinehook - function to run when setting up a coarser level
1988 .  interphook - function to run to update data on finer levels (once per SNESSolve())
1989 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
1990 
1991    Calling sequence of refinehook:
1992 $    refinehook(DM coarse,DM fine,void *ctx);
1993 
1994 +  coarse - coarse level DM
1995 .  fine - fine level DM to interpolate problem to
1996 -  ctx - optional user-defined function context
1997 
1998    Calling sequence for interphook:
1999 $    interphook(DM coarse,Mat interp,DM fine,void *ctx)
2000 
2001 +  coarse - coarse level DM
2002 .  interp - matrix interpolating a coarse-level solution to the finer grid
2003 .  fine - fine level DM to update
2004 -  ctx - optional user-defined function context
2005 
2006    Level: advanced
2007 
2008    Notes:
2009    This function is only needed if auxiliary data needs to be passed to fine grids while grid sequencing
2010 
2011    If this function is called multiple times, the hooks will be run in the order they are added.
2012 
2013    This function is currently not available from Fortran.
2014 
2015 .seealso: DMCoarsenHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2016 @*/
2017 PetscErrorCode DMRefineHookAdd(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2018 {
2019   PetscErrorCode   ierr;
2020   DMRefineHookLink link,*p;
2021 
2022   PetscFunctionBegin;
2023   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
2024   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
2025     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) PetscFunctionReturn(0);
2026   }
2027   ierr             = PetscNew(&link);CHKERRQ(ierr);
2028   link->refinehook = refinehook;
2029   link->interphook = interphook;
2030   link->ctx        = ctx;
2031   link->next       = NULL;
2032   *p               = link;
2033   PetscFunctionReturn(0);
2034 }
2035 
2036 /*@C
2037    DMRefineHookRemove - remove a callback from the list of hooks to be run when interpolating a nonlinear problem to a finer grid
2038 
2039    Logically Collective
2040 
2041    Input Arguments:
2042 +  coarse - nonlinear solver context on which to run a hook when restricting to a coarser level
2043 .  refinehook - function to run when setting up a coarser level
2044 .  interphook - function to run to update data on finer levels (once per SNESSolve())
2045 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2046 
2047    Level: advanced
2048 
2049    Notes:
2050    This function does nothing if the hook is not in the list.
2051 
2052    This function is currently not available from Fortran.
2053 
2054 .seealso: DMCoarsenHookRemove(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2055 @*/
2056 PetscErrorCode DMRefineHookRemove(DM coarse,PetscErrorCode (*refinehook)(DM,DM,void*),PetscErrorCode (*interphook)(DM,Mat,DM,void*),void *ctx)
2057 {
2058   PetscErrorCode   ierr;
2059   DMRefineHookLink link,*p;
2060 
2061   PetscFunctionBegin;
2062   PetscValidHeaderSpecific(coarse,DM_CLASSID,1);
2063   for (p=&coarse->refinehook; *p; p=&(*p)->next) { /* Search the list of current hooks */
2064     if ((*p)->refinehook == refinehook && (*p)->interphook == interphook && (*p)->ctx == ctx) {
2065       link = *p;
2066       *p = link->next;
2067       ierr = PetscFree(link);CHKERRQ(ierr);
2068       break;
2069     }
2070   }
2071   PetscFunctionReturn(0);
2072 }
2073 
2074 /*@
2075    DMInterpolate - interpolates user-defined problem data to a finer DM by running hooks registered by DMRefineHookAdd()
2076 
2077    Collective if any hooks are
2078 
2079    Input Arguments:
2080 +  coarse - coarser DM to use as a base
2081 .  interp - interpolation matrix, apply using MatInterpolate()
2082 -  fine - finer DM to update
2083 
2084    Level: developer
2085 
2086 .seealso: DMRefineHookAdd(), MatInterpolate()
2087 @*/
2088 PetscErrorCode DMInterpolate(DM coarse,Mat interp,DM fine)
2089 {
2090   PetscErrorCode   ierr;
2091   DMRefineHookLink link;
2092 
2093   PetscFunctionBegin;
2094   for (link=fine->refinehook; link; link=link->next) {
2095     if (link->interphook) {
2096       ierr = (*link->interphook)(coarse,interp,fine,link->ctx);CHKERRQ(ierr);
2097     }
2098   }
2099   PetscFunctionReturn(0);
2100 }
2101 
2102 /*@
2103     DMGetRefineLevel - Get's the number of refinements that have generated this DM.
2104 
2105     Not Collective
2106 
2107     Input Parameter:
2108 .   dm - the DM object
2109 
2110     Output Parameter:
2111 .   level - number of refinements
2112 
2113     Level: developer
2114 
2115 .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2116 
2117 @*/
2118 PetscErrorCode  DMGetRefineLevel(DM dm,PetscInt *level)
2119 {
2120   PetscFunctionBegin;
2121   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2122   *level = dm->levelup;
2123   PetscFunctionReturn(0);
2124 }
2125 
2126 /*@
2127     DMSetRefineLevel - Set's the number of refinements that have generated this DM.
2128 
2129     Not Collective
2130 
2131     Input Parameter:
2132 +   dm - the DM object
2133 -   level - number of refinements
2134 
2135     Level: advanced
2136 
2137     Notes:
2138     This value is used by PCMG to determine how many multigrid levels to use
2139 
2140 .seealso DMCoarsen(), DMGetCoarsenLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2141 
2142 @*/
2143 PetscErrorCode  DMSetRefineLevel(DM dm,PetscInt level)
2144 {
2145   PetscFunctionBegin;
2146   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2147   dm->levelup = level;
2148   PetscFunctionReturn(0);
2149 }
2150 
2151 PetscErrorCode DMGetBasisTransformDM_Internal(DM dm, DM *tdm)
2152 {
2153   PetscFunctionBegin;
2154   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2155   PetscValidPointer(tdm, 2);
2156   *tdm = dm->transformDM;
2157   PetscFunctionReturn(0);
2158 }
2159 
2160 PetscErrorCode DMGetBasisTransformVec_Internal(DM dm, Vec *tv)
2161 {
2162   PetscFunctionBegin;
2163   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2164   PetscValidPointer(tv, 2);
2165   *tv = dm->transform;
2166   PetscFunctionReturn(0);
2167 }
2168 
2169 /*@
2170   DMHasBasisTransform - Whether we employ a basis transformation from functions in global vectors to functions in local vectors
2171 
2172   Input Parameter:
2173 . dm - The DM
2174 
2175   Output Parameter:
2176 . flg - PETSC_TRUE if a basis transformation should be done
2177 
2178   Level: developer
2179 
2180 .seealso: DMPlexGlobalToLocalBasis(), DMPlexLocalToGlobalBasis(), DMPlexCreateBasisRotation()
2181 @*/
2182 PetscErrorCode DMHasBasisTransform(DM dm, PetscBool *flg)
2183 {
2184   Vec            tv;
2185   PetscErrorCode ierr;
2186 
2187   PetscFunctionBegin;
2188   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2189   PetscValidBoolPointer(flg, 2);
2190   ierr = DMGetBasisTransformVec_Internal(dm, &tv);CHKERRQ(ierr);
2191   *flg = tv ? PETSC_TRUE : PETSC_FALSE;
2192   PetscFunctionReturn(0);
2193 }
2194 
2195 PetscErrorCode DMConstructBasisTransform_Internal(DM dm)
2196 {
2197   PetscSection   s, ts;
2198   PetscScalar   *ta;
2199   PetscInt       cdim, pStart, pEnd, p, Nf, f, Nc, dof;
2200   PetscErrorCode ierr;
2201 
2202   PetscFunctionBegin;
2203   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
2204   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2205   ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2206   ierr = PetscSectionGetNumFields(s, &Nf);CHKERRQ(ierr);
2207   ierr = DMClone(dm, &dm->transformDM);CHKERRQ(ierr);
2208   ierr = DMGetLocalSection(dm->transformDM, &ts);CHKERRQ(ierr);
2209   ierr = PetscSectionSetNumFields(ts, Nf);CHKERRQ(ierr);
2210   ierr = PetscSectionSetChart(ts, pStart, pEnd);CHKERRQ(ierr);
2211   for (f = 0; f < Nf; ++f) {
2212     ierr = PetscSectionGetFieldComponents(s, f, &Nc);CHKERRQ(ierr);
2213     /* We could start to label fields by their transformation properties */
2214     if (Nc != cdim) continue;
2215     for (p = pStart; p < pEnd; ++p) {
2216       ierr = PetscSectionGetFieldDof(s, p, f, &dof);CHKERRQ(ierr);
2217       if (!dof) continue;
2218       ierr = PetscSectionSetFieldDof(ts, p, f, PetscSqr(cdim));CHKERRQ(ierr);
2219       ierr = PetscSectionAddDof(ts, p, PetscSqr(cdim));CHKERRQ(ierr);
2220     }
2221   }
2222   ierr = PetscSectionSetUp(ts);CHKERRQ(ierr);
2223   ierr = DMCreateLocalVector(dm->transformDM, &dm->transform);CHKERRQ(ierr);
2224   ierr = VecGetArray(dm->transform, &ta);CHKERRQ(ierr);
2225   for (p = pStart; p < pEnd; ++p) {
2226     for (f = 0; f < Nf; ++f) {
2227       ierr = PetscSectionGetFieldDof(ts, p, f, &dof);CHKERRQ(ierr);
2228       if (dof) {
2229         PetscReal          x[3] = {0.0, 0.0, 0.0};
2230         PetscScalar       *tva;
2231         const PetscScalar *A;
2232 
2233         /* TODO Get quadrature point for this dual basis vector for coordinate */
2234         ierr = (*dm->transformGetMatrix)(dm, x, PETSC_TRUE, &A, dm->transformCtx);CHKERRQ(ierr);
2235         ierr = DMPlexPointLocalFieldRef(dm->transformDM, p, f, ta, (void *) &tva);CHKERRQ(ierr);
2236         ierr = PetscArraycpy(tva, A, PetscSqr(cdim));CHKERRQ(ierr);
2237       }
2238     }
2239   }
2240   ierr = VecRestoreArray(dm->transform, &ta);CHKERRQ(ierr);
2241   PetscFunctionReturn(0);
2242 }
2243 
2244 PetscErrorCode DMCopyTransform(DM dm, DM newdm)
2245 {
2246   PetscErrorCode ierr;
2247 
2248   PetscFunctionBegin;
2249   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2250   PetscValidHeaderSpecific(newdm, DM_CLASSID, 2);
2251   newdm->transformCtx       = dm->transformCtx;
2252   newdm->transformSetUp     = dm->transformSetUp;
2253   newdm->transformDestroy   = NULL;
2254   newdm->transformGetMatrix = dm->transformGetMatrix;
2255   if (newdm->transformSetUp) {ierr = DMConstructBasisTransform_Internal(newdm);CHKERRQ(ierr);}
2256   PetscFunctionReturn(0);
2257 }
2258 
2259 /*@C
2260    DMGlobalToLocalHookAdd - adds a callback to be run when global to local is called
2261 
2262    Logically Collective
2263 
2264    Input Arguments:
2265 +  dm - the DM
2266 .  beginhook - function to run at the beginning of DMGlobalToLocalBegin()
2267 .  endhook - function to run after DMGlobalToLocalEnd() has completed
2268 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2269 
2270    Calling sequence for beginhook:
2271 $    beginhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2272 
2273 +  dm - global DM
2274 .  g - global vector
2275 .  mode - mode
2276 .  l - local vector
2277 -  ctx - optional user-defined function context
2278 
2279 
2280    Calling sequence for endhook:
2281 $    endhook(DM fine,VecScatter out,VecScatter in,DM coarse,void *ctx)
2282 
2283 +  global - global DM
2284 -  ctx - optional user-defined function context
2285 
2286    Level: advanced
2287 
2288 .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2289 @*/
2290 PetscErrorCode DMGlobalToLocalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2291 {
2292   PetscErrorCode          ierr;
2293   DMGlobalToLocalHookLink link,*p;
2294 
2295   PetscFunctionBegin;
2296   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2297   for (p=&dm->gtolhook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
2298   ierr            = PetscNew(&link);CHKERRQ(ierr);
2299   link->beginhook = beginhook;
2300   link->endhook   = endhook;
2301   link->ctx       = ctx;
2302   link->next      = NULL;
2303   *p              = link;
2304   PetscFunctionReturn(0);
2305 }
2306 
2307 static PetscErrorCode DMGlobalToLocalHook_Constraints(DM dm, Vec g, InsertMode mode, Vec l, void *ctx)
2308 {
2309   Mat cMat;
2310   Vec cVec;
2311   PetscSection section, cSec;
2312   PetscInt pStart, pEnd, p, dof;
2313   PetscErrorCode ierr;
2314 
2315   PetscFunctionBegin;
2316   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2317   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
2318   if (cMat && (mode == INSERT_VALUES || mode == INSERT_ALL_VALUES || mode == INSERT_BC_VALUES)) {
2319     PetscInt nRows;
2320 
2321     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
2322     if (nRows <= 0) PetscFunctionReturn(0);
2323     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
2324     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
2325     ierr = MatMult(cMat,l,cVec);CHKERRQ(ierr);
2326     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
2327     for (p = pStart; p < pEnd; p++) {
2328       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
2329       if (dof) {
2330         PetscScalar *vals;
2331         ierr = VecGetValuesSection(cVec,cSec,p,&vals);CHKERRQ(ierr);
2332         ierr = VecSetValuesSection(l,section,p,vals,INSERT_ALL_VALUES);CHKERRQ(ierr);
2333       }
2334     }
2335     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
2336   }
2337   PetscFunctionReturn(0);
2338 }
2339 
2340 /*@
2341     DMGlobalToLocal - update local vectors from global vector
2342 
2343     Neighbor-wise Collective on dm
2344 
2345     Input Parameters:
2346 +   dm - the DM object
2347 .   g - the global vector
2348 .   mode - INSERT_VALUES or ADD_VALUES
2349 -   l - the local vector
2350 
2351     Notes:
2352     The communication involved in this update can be overlapped with computation by using
2353     DMGlobalToLocalBegin() and DMGlobalToLocalEnd().
2354 
2355     Level: beginner
2356 
2357 .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
2358 
2359 @*/
2360 PetscErrorCode DMGlobalToLocal(DM dm,Vec g,InsertMode mode,Vec l)
2361 {
2362   PetscErrorCode ierr;
2363 
2364   PetscFunctionBegin;
2365   ierr = DMGlobalToLocalBegin(dm,g,mode,l);CHKERRQ(ierr);
2366   ierr = DMGlobalToLocalEnd(dm,g,mode,l);CHKERRQ(ierr);
2367   PetscFunctionReturn(0);
2368 }
2369 
2370 /*@
2371     DMGlobalToLocalBegin - Begins updating local vectors from global vector
2372 
2373     Neighbor-wise Collective on dm
2374 
2375     Input Parameters:
2376 +   dm - the DM object
2377 .   g - the global vector
2378 .   mode - INSERT_VALUES or ADD_VALUES
2379 -   l - the local vector
2380 
2381     Level: intermediate
2382 
2383 .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
2384 
2385 @*/
2386 PetscErrorCode  DMGlobalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
2387 {
2388   PetscSF                 sf;
2389   PetscErrorCode          ierr;
2390   DMGlobalToLocalHookLink link;
2391 
2392   PetscFunctionBegin;
2393   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2394   for (link=dm->gtolhook; link; link=link->next) {
2395     if (link->beginhook) {
2396       ierr = (*link->beginhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);
2397     }
2398   }
2399   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2400   if (sf) {
2401     const PetscScalar *gArray;
2402     PetscScalar       *lArray;
2403 
2404     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2405     ierr = VecGetArrayInPlace(l, &lArray);CHKERRQ(ierr);
2406     ierr = VecGetArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
2407     ierr = PetscSFBcastBegin(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
2408     ierr = VecRestoreArrayInPlace(l, &lArray);CHKERRQ(ierr);
2409     ierr = VecRestoreArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
2410   } else {
2411     if (!dm->ops->globaltolocalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalBegin() for type %s",((PetscObject)dm)->type_name);
2412     ierr = (*dm->ops->globaltolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2413   }
2414   PetscFunctionReturn(0);
2415 }
2416 
2417 /*@
2418     DMGlobalToLocalEnd - Ends updating local vectors from global vector
2419 
2420     Neighbor-wise Collective on dm
2421 
2422     Input Parameters:
2423 +   dm - the DM object
2424 .   g - the global vector
2425 .   mode - INSERT_VALUES or ADD_VALUES
2426 -   l - the local vector
2427 
2428     Level: intermediate
2429 
2430 .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMLocalToGlobalBegin(), DMLocalToGlobal(), DMLocalToGlobalBegin(), DMLocalToGlobalEnd()
2431 
2432 @*/
2433 PetscErrorCode  DMGlobalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
2434 {
2435   PetscSF                 sf;
2436   PetscErrorCode          ierr;
2437   const PetscScalar      *gArray;
2438   PetscScalar            *lArray;
2439   PetscBool               transform;
2440   DMGlobalToLocalHookLink link;
2441 
2442   PetscFunctionBegin;
2443   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2444   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2445   ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2446   if (sf) {
2447     if (mode == ADD_VALUES) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2448 
2449     ierr = VecGetArrayInPlace(l, &lArray);CHKERRQ(ierr);
2450     ierr = VecGetArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
2451     ierr = PetscSFBcastEnd(sf, MPIU_SCALAR, gArray, lArray);CHKERRQ(ierr);
2452     ierr = VecRestoreArrayInPlace(l, &lArray);CHKERRQ(ierr);
2453     ierr = VecRestoreArrayReadInPlace(g, &gArray);CHKERRQ(ierr);
2454     if (transform) {ierr = DMPlexGlobalToLocalBasis(dm, l);CHKERRQ(ierr);}
2455   } else {
2456     if (!dm->ops->globaltolocalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMGlobalToLocalEnd() for type %s",((PetscObject)dm)->type_name);
2457     ierr = (*dm->ops->globaltolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2458   }
2459   ierr = DMGlobalToLocalHook_Constraints(dm,g,mode,l,NULL);CHKERRQ(ierr);
2460   for (link=dm->gtolhook; link; link=link->next) {
2461     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2462   }
2463   PetscFunctionReturn(0);
2464 }
2465 
2466 /*@C
2467    DMLocalToGlobalHookAdd - adds a callback to be run when a local to global is called
2468 
2469    Logically Collective
2470 
2471    Input Arguments:
2472 +  dm - the DM
2473 .  beginhook - function to run at the beginning of DMLocalToGlobalBegin()
2474 .  endhook - function to run after DMLocalToGlobalEnd() has completed
2475 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2476 
2477    Calling sequence for beginhook:
2478 $    beginhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2479 
2480 +  dm - global DM
2481 .  l - local vector
2482 .  mode - mode
2483 .  g - global vector
2484 -  ctx - optional user-defined function context
2485 
2486 
2487    Calling sequence for endhook:
2488 $    endhook(DM fine,Vec l,InsertMode mode,Vec g,void *ctx)
2489 
2490 +  global - global DM
2491 .  l - local vector
2492 .  mode - mode
2493 .  g - global vector
2494 -  ctx - optional user-defined function context
2495 
2496    Level: advanced
2497 
2498 .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2499 @*/
2500 PetscErrorCode DMLocalToGlobalHookAdd(DM dm,PetscErrorCode (*beginhook)(DM,Vec,InsertMode,Vec,void*),PetscErrorCode (*endhook)(DM,Vec,InsertMode,Vec,void*),void *ctx)
2501 {
2502   PetscErrorCode          ierr;
2503   DMLocalToGlobalHookLink link,*p;
2504 
2505   PetscFunctionBegin;
2506   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2507   for (p=&dm->ltoghook; *p; p=&(*p)->next) {} /* Scan to the end of the current list of hooks */
2508   ierr            = PetscNew(&link);CHKERRQ(ierr);
2509   link->beginhook = beginhook;
2510   link->endhook   = endhook;
2511   link->ctx       = ctx;
2512   link->next      = NULL;
2513   *p              = link;
2514   PetscFunctionReturn(0);
2515 }
2516 
2517 static PetscErrorCode DMLocalToGlobalHook_Constraints(DM dm, Vec l, InsertMode mode, Vec g, void *ctx)
2518 {
2519   Mat cMat;
2520   Vec cVec;
2521   PetscSection section, cSec;
2522   PetscInt pStart, pEnd, p, dof;
2523   PetscErrorCode ierr;
2524 
2525   PetscFunctionBegin;
2526   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
2527   ierr = DMGetDefaultConstraints(dm,&cSec,&cMat);CHKERRQ(ierr);
2528   if (cMat && (mode == ADD_VALUES || mode == ADD_ALL_VALUES || mode == ADD_BC_VALUES)) {
2529     PetscInt nRows;
2530 
2531     ierr = MatGetSize(cMat,&nRows,NULL);CHKERRQ(ierr);
2532     if (nRows <= 0) PetscFunctionReturn(0);
2533     ierr = DMGetLocalSection(dm,&section);CHKERRQ(ierr);
2534     ierr = MatCreateVecs(cMat,NULL,&cVec);CHKERRQ(ierr);
2535     ierr = PetscSectionGetChart(cSec,&pStart,&pEnd);CHKERRQ(ierr);
2536     for (p = pStart; p < pEnd; p++) {
2537       ierr = PetscSectionGetDof(cSec,p,&dof);CHKERRQ(ierr);
2538       if (dof) {
2539         PetscInt d;
2540         PetscScalar *vals;
2541         ierr = VecGetValuesSection(l,section,p,&vals);CHKERRQ(ierr);
2542         ierr = VecSetValuesSection(cVec,cSec,p,vals,mode);CHKERRQ(ierr);
2543         /* for this to be the true transpose, we have to zero the values that
2544          * we just extracted */
2545         for (d = 0; d < dof; d++) {
2546           vals[d] = 0.;
2547         }
2548       }
2549     }
2550     ierr = MatMultTransposeAdd(cMat,cVec,l,l);CHKERRQ(ierr);
2551     ierr = VecDestroy(&cVec);CHKERRQ(ierr);
2552   }
2553   PetscFunctionReturn(0);
2554 }
2555 /*@
2556     DMLocalToGlobal - updates global vectors from local vectors
2557 
2558     Neighbor-wise Collective on dm
2559 
2560     Input Parameters:
2561 +   dm - the DM object
2562 .   l - the local vector
2563 .   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.
2564 -   g - the global vector
2565 
2566     Notes:
2567     The communication involved in this update can be overlapped with computation by using
2568     DMLocalToGlobalBegin() and DMLocalToGlobalEnd().
2569 
2570     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
2571            INSERT_VALUES is not supported for DMDA; in that case simply compute the values directly into a global vector instead of a local one.
2572 
2573     Level: beginner
2574 
2575 .seealso DMLocalToGlobalBegin(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
2576 
2577 @*/
2578 PetscErrorCode DMLocalToGlobal(DM dm,Vec l,InsertMode mode,Vec g)
2579 {
2580   PetscErrorCode ierr;
2581 
2582   PetscFunctionBegin;
2583   ierr = DMLocalToGlobalBegin(dm,l,mode,g);CHKERRQ(ierr);
2584   ierr = DMLocalToGlobalEnd(dm,l,mode,g);CHKERRQ(ierr);
2585   PetscFunctionReturn(0);
2586 }
2587 
2588 /*@
2589     DMLocalToGlobalBegin - begins updating global vectors from local vectors
2590 
2591     Neighbor-wise Collective on dm
2592 
2593     Input Parameters:
2594 +   dm - the DM object
2595 .   l - the local vector
2596 .   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.
2597 -   g - the global vector
2598 
2599     Notes:
2600     In the ADD_VALUES case you normally would zero the receiving vector before beginning this operation.
2601            INSERT_VALUES is not supported for DMDA, in that case simply compute the values directly into a global vector instead of a local one.
2602 
2603     Level: intermediate
2604 
2605 .seealso DMLocalToGlobal(), DMLocalToGlobalEnd(), DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocal(), DMGlobalToLocalEnd(), DMGlobalToLocalBegin()
2606 
2607 @*/
2608 PetscErrorCode  DMLocalToGlobalBegin(DM dm,Vec l,InsertMode mode,Vec g)
2609 {
2610   PetscSF                 sf;
2611   PetscSection            s, gs;
2612   DMLocalToGlobalHookLink link;
2613   Vec                     tmpl;
2614   const PetscScalar      *lArray;
2615   PetscScalar            *gArray;
2616   PetscBool               isInsert, transform, l_inplace = PETSC_FALSE, g_inplace = PETSC_FALSE;
2617   PetscErrorCode          ierr;
2618 
2619   PetscFunctionBegin;
2620   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2621   for (link=dm->ltoghook; link; link=link->next) {
2622     if (link->beginhook) {
2623       ierr = (*link->beginhook)(dm,l,mode,g,link->ctx);CHKERRQ(ierr);
2624     }
2625   }
2626   ierr = DMLocalToGlobalHook_Constraints(dm,l,mode,g,NULL);CHKERRQ(ierr);
2627   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2628   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2629   switch (mode) {
2630   case INSERT_VALUES:
2631   case INSERT_ALL_VALUES:
2632   case INSERT_BC_VALUES:
2633     isInsert = PETSC_TRUE; break;
2634   case ADD_VALUES:
2635   case ADD_ALL_VALUES:
2636   case ADD_BC_VALUES:
2637     isInsert = PETSC_FALSE; break;
2638   default:
2639     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2640   }
2641   if ((sf && !isInsert) || (s && isInsert)) {
2642     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2643     if (transform) {
2644       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2645       ierr = VecCopy(l, tmpl);CHKERRQ(ierr);
2646       ierr = DMPlexLocalToGlobalBasis(dm, tmpl);CHKERRQ(ierr);
2647       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2648     } else if (isInsert) {
2649       ierr = VecGetArrayRead(l, &lArray);CHKERRQ(ierr);
2650     } else {
2651       ierr = VecGetArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2652       l_inplace = PETSC_TRUE;
2653     }
2654     if (s && isInsert) {
2655       ierr = VecGetArray(g, &gArray);CHKERRQ(ierr);
2656     } else {
2657       ierr = VecGetArrayInPlace(g, &gArray);CHKERRQ(ierr);
2658       g_inplace = PETSC_TRUE;
2659     }
2660     if (sf && !isInsert) {
2661       ierr = PetscSFReduceBegin(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2662     } else if (s && isInsert) {
2663       PetscInt gStart, pStart, pEnd, p;
2664 
2665       ierr = DMGetGlobalSection(dm, &gs);CHKERRQ(ierr);
2666       ierr = PetscSectionGetChart(s, &pStart, &pEnd);CHKERRQ(ierr);
2667       ierr = VecGetOwnershipRange(g, &gStart, NULL);CHKERRQ(ierr);
2668       for (p = pStart; p < pEnd; ++p) {
2669         PetscInt dof, gdof, cdof, gcdof, off, goff, d, e;
2670 
2671         ierr = PetscSectionGetDof(s, p, &dof);CHKERRQ(ierr);
2672         ierr = PetscSectionGetDof(gs, p, &gdof);CHKERRQ(ierr);
2673         ierr = PetscSectionGetConstraintDof(s, p, &cdof);CHKERRQ(ierr);
2674         ierr = PetscSectionGetConstraintDof(gs, p, &gcdof);CHKERRQ(ierr);
2675         ierr = PetscSectionGetOffset(s, p, &off);CHKERRQ(ierr);
2676         ierr = PetscSectionGetOffset(gs, p, &goff);CHKERRQ(ierr);
2677         /* Ignore off-process data and points with no global data */
2678         if (!gdof || goff < 0) continue;
2679         if (dof != gdof) SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
2680         /* If no constraints are enforced in the global vector */
2681         if (!gcdof) {
2682           for (d = 0; d < dof; ++d) gArray[goff-gStart+d] = lArray[off+d];
2683           /* If constraints are enforced in the global vector */
2684         } else if (cdof == gcdof) {
2685           const PetscInt *cdofs;
2686           PetscInt        cind = 0;
2687 
2688           ierr = PetscSectionGetConstraintIndices(s, p, &cdofs);CHKERRQ(ierr);
2689           for (d = 0, e = 0; d < dof; ++d) {
2690             if ((cind < cdof) && (d == cdofs[cind])) {++cind; continue;}
2691             gArray[goff-gStart+e++] = lArray[off+d];
2692           }
2693         } else SETERRQ5(PETSC_COMM_SELF, PETSC_ERR_ARG_SIZ, "Inconsistent sizes, p: %d dof: %d gdof: %d cdof: %d gcdof: %d", p, dof, gdof, cdof, gcdof);
2694       }
2695     }
2696     if (g_inplace) {
2697       ierr = VecRestoreArrayInPlace(g, &gArray);CHKERRQ(ierr);
2698     } else {
2699       ierr = VecRestoreArray(g, &gArray);CHKERRQ(ierr);
2700     }
2701     if (transform) {
2702       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2703       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2704     } else if (l_inplace) {
2705       ierr = VecRestoreArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2706     } else {
2707       ierr = VecRestoreArrayRead(l, &lArray);CHKERRQ(ierr);
2708     }
2709   } else {
2710     if (!dm->ops->localtoglobalbegin) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalBegin() for type %s",((PetscObject)dm)->type_name);
2711     ierr = (*dm->ops->localtoglobalbegin)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
2712   }
2713   PetscFunctionReturn(0);
2714 }
2715 
2716 /*@
2717     DMLocalToGlobalEnd - updates global vectors from local vectors
2718 
2719     Neighbor-wise Collective on dm
2720 
2721     Input Parameters:
2722 +   dm - the DM object
2723 .   l - the local vector
2724 .   mode - INSERT_VALUES or ADD_VALUES
2725 -   g - the global vector
2726 
2727     Level: intermediate
2728 
2729 .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMGlobalToLocalEnd(), DMGlobalToLocalEnd()
2730 
2731 @*/
2732 PetscErrorCode  DMLocalToGlobalEnd(DM dm,Vec l,InsertMode mode,Vec g)
2733 {
2734   PetscSF                 sf;
2735   PetscSection            s;
2736   DMLocalToGlobalHookLink link;
2737   PetscBool               isInsert, transform;
2738   PetscErrorCode          ierr;
2739 
2740   PetscFunctionBegin;
2741   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2742   ierr = DMGetSectionSF(dm, &sf);CHKERRQ(ierr);
2743   ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
2744   switch (mode) {
2745   case INSERT_VALUES:
2746   case INSERT_ALL_VALUES:
2747     isInsert = PETSC_TRUE; break;
2748   case ADD_VALUES:
2749   case ADD_ALL_VALUES:
2750     isInsert = PETSC_FALSE; break;
2751   default:
2752     SETERRQ1(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid insertion mode %D", mode);
2753   }
2754   if (sf && !isInsert) {
2755     const PetscScalar *lArray;
2756     PetscScalar       *gArray;
2757     Vec                tmpl;
2758 
2759     ierr = DMHasBasisTransform(dm, &transform);CHKERRQ(ierr);
2760     if (transform) {
2761       ierr = DMGetNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2762       ierr = VecGetArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2763     } else {
2764       ierr = VecGetArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2765     }
2766     ierr = VecGetArrayInPlace(g, &gArray);CHKERRQ(ierr);
2767     ierr = PetscSFReduceEnd(sf, MPIU_SCALAR, lArray, gArray, MPIU_SUM);CHKERRQ(ierr);
2768     if (transform) {
2769       ierr = VecRestoreArrayRead(tmpl, &lArray);CHKERRQ(ierr);
2770       ierr = DMRestoreNamedLocalVector(dm, "__petsc_dm_transform_local_copy", &tmpl);CHKERRQ(ierr);
2771     } else {
2772       ierr = VecRestoreArrayReadInPlace(l, &lArray);CHKERRQ(ierr);
2773     }
2774     ierr = VecRestoreArrayInPlace(g, &gArray);CHKERRQ(ierr);
2775   } else if (s && isInsert) {
2776   } else {
2777     if (!dm->ops->localtoglobalend) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Missing DMLocalToGlobalEnd() for type %s",((PetscObject)dm)->type_name);
2778     ierr = (*dm->ops->localtoglobalend)(dm,l,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),g);CHKERRQ(ierr);
2779   }
2780   for (link=dm->ltoghook; link; link=link->next) {
2781     if (link->endhook) {ierr = (*link->endhook)(dm,g,mode,l,link->ctx);CHKERRQ(ierr);}
2782   }
2783   PetscFunctionReturn(0);
2784 }
2785 
2786 /*@
2787    DMLocalToLocalBegin - Maps from a local vector (including ghost points
2788    that contain irrelevant values) to another local vector where the ghost
2789    points in the second are set correctly. Must be followed by DMLocalToLocalEnd().
2790 
2791    Neighbor-wise Collective on dm
2792 
2793    Input Parameters:
2794 +  dm - the DM object
2795 .  g - the original local vector
2796 -  mode - one of INSERT_VALUES or ADD_VALUES
2797 
2798    Output Parameter:
2799 .  l  - the local vector with correct ghost values
2800 
2801    Level: intermediate
2802 
2803    Notes:
2804    The local vectors used here need not be the same as those
2805    obtained from DMCreateLocalVector(), BUT they
2806    must have the same parallel data layout; they could, for example, be
2807    obtained with VecDuplicate() from the DM originating vectors.
2808 
2809 .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalEnd(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2810 
2811 @*/
2812 PetscErrorCode  DMLocalToLocalBegin(DM dm,Vec g,InsertMode mode,Vec l)
2813 {
2814   PetscErrorCode          ierr;
2815 
2816   PetscFunctionBegin;
2817   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2818   if (!dm->ops->localtolocalbegin) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
2819   ierr = (*dm->ops->localtolocalbegin)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2820   PetscFunctionReturn(0);
2821 }
2822 
2823 /*@
2824    DMLocalToLocalEnd - Maps from a local vector (including ghost points
2825    that contain irrelevant values) to another local vector where the ghost
2826    points in the second are set correctly. Must be preceded by DMLocalToLocalBegin().
2827 
2828    Neighbor-wise Collective on dm
2829 
2830    Input Parameters:
2831 +  da - the DM object
2832 .  g - the original local vector
2833 -  mode - one of INSERT_VALUES or ADD_VALUES
2834 
2835    Output Parameter:
2836 .  l  - the local vector with correct ghost values
2837 
2838    Level: intermediate
2839 
2840    Notes:
2841    The local vectors used here need not be the same as those
2842    obtained from DMCreateLocalVector(), BUT they
2843    must have the same parallel data layout; they could, for example, be
2844    obtained with VecDuplicate() from the DM originating vectors.
2845 
2846 .seealso DMCoarsen(), DMDestroy(), DMView(), DMCreateLocalVector(), DMCreateGlobalVector(), DMCreateInterpolation(), DMLocalToLocalBegin(), DMGlobalToLocalEnd(), DMLocalToGlobalBegin()
2847 
2848 @*/
2849 PetscErrorCode  DMLocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l)
2850 {
2851   PetscErrorCode          ierr;
2852 
2853   PetscFunctionBegin;
2854   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2855   if (!dm->ops->localtolocalend) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"This DM does not support local to local maps");
2856   ierr = (*dm->ops->localtolocalend)(dm,g,mode == INSERT_ALL_VALUES ? INSERT_VALUES : (mode == ADD_ALL_VALUES ? ADD_VALUES : mode),l);CHKERRQ(ierr);
2857   PetscFunctionReturn(0);
2858 }
2859 
2860 
2861 /*@
2862     DMCoarsen - Coarsens a DM object
2863 
2864     Collective on dm
2865 
2866     Input Parameter:
2867 +   dm - the DM object
2868 -   comm - the communicator to contain the new DM object (or MPI_COMM_NULL)
2869 
2870     Output Parameter:
2871 .   dmc - the coarsened DM
2872 
2873     Level: developer
2874 
2875 .seealso DMRefine(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
2876 
2877 @*/
2878 PetscErrorCode DMCoarsen(DM dm, MPI_Comm comm, DM *dmc)
2879 {
2880   PetscErrorCode    ierr;
2881   DMCoarsenHookLink link;
2882 
2883   PetscFunctionBegin;
2884   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
2885   if (!dm->ops->coarsen) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMCoarsen",((PetscObject)dm)->type_name);
2886   ierr = PetscLogEventBegin(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
2887   ierr = (*dm->ops->coarsen)(dm, comm, dmc);CHKERRQ(ierr);
2888   if (*dmc) {
2889     ierr = DMSetCoarseDM(dm,*dmc);CHKERRQ(ierr);
2890     (*dmc)->ops->creatematrix = dm->ops->creatematrix;
2891     ierr                      = PetscObjectCopyFortranFunctionPointers((PetscObject)dm,(PetscObject)*dmc);CHKERRQ(ierr);
2892     (*dmc)->ctx               = dm->ctx;
2893     (*dmc)->levelup           = dm->levelup;
2894     (*dmc)->leveldown         = dm->leveldown + 1;
2895     ierr                      = DMSetMatType(*dmc,dm->mattype);CHKERRQ(ierr);
2896     for (link=dm->coarsenhook; link; link=link->next) {
2897       if (link->coarsenhook) {ierr = (*link->coarsenhook)(dm,*dmc,link->ctx);CHKERRQ(ierr);}
2898     }
2899   }
2900   ierr = PetscLogEventEnd(DM_Coarsen,dm,0,0,0);CHKERRQ(ierr);
2901   if (!(*dmc)) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "NULL coarse mesh produced");
2902   PetscFunctionReturn(0);
2903 }
2904 
2905 /*@C
2906    DMCoarsenHookAdd - adds a callback to be run when restricting a nonlinear problem to the coarse grid
2907 
2908    Logically Collective
2909 
2910    Input Arguments:
2911 +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
2912 .  coarsenhook - function to run when setting up a coarser level
2913 .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
2914 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2915 
2916    Calling sequence of coarsenhook:
2917 $    coarsenhook(DM fine,DM coarse,void *ctx);
2918 
2919 +  fine - fine level DM
2920 .  coarse - coarse level DM to restrict problem to
2921 -  ctx - optional user-defined function context
2922 
2923    Calling sequence for restricthook:
2924 $    restricthook(DM fine,Mat mrestrict,Vec rscale,Mat inject,DM coarse,void *ctx)
2925 
2926 +  fine - fine level DM
2927 .  mrestrict - matrix restricting a fine-level solution to the coarse grid
2928 .  rscale - scaling vector for restriction
2929 .  inject - matrix restricting by injection
2930 .  coarse - coarse level DM to update
2931 -  ctx - optional user-defined function context
2932 
2933    Level: advanced
2934 
2935    Notes:
2936    This function is only needed if auxiliary data needs to be set up on coarse grids.
2937 
2938    If this function is called multiple times, the hooks will be run in the order they are added.
2939 
2940    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
2941    extract the finest level information from its context (instead of from the SNES).
2942 
2943    This function is currently not available from Fortran.
2944 
2945 .seealso: DMCoarsenHookRemove(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2946 @*/
2947 PetscErrorCode DMCoarsenHookAdd(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
2948 {
2949   PetscErrorCode    ierr;
2950   DMCoarsenHookLink link,*p;
2951 
2952   PetscFunctionBegin;
2953   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
2954   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
2955     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
2956   }
2957   ierr               = PetscNew(&link);CHKERRQ(ierr);
2958   link->coarsenhook  = coarsenhook;
2959   link->restricthook = restricthook;
2960   link->ctx          = ctx;
2961   link->next         = NULL;
2962   *p                 = link;
2963   PetscFunctionReturn(0);
2964 }
2965 
2966 /*@C
2967    DMCoarsenHookRemove - remove a callback from the list of hooks to be run when restricting a nonlinear problem to the coarse grid
2968 
2969    Logically Collective
2970 
2971    Input Arguments:
2972 +  fine - nonlinear solver context on which to run a hook when restricting to a coarser level
2973 .  coarsenhook - function to run when setting up a coarser level
2974 .  restricthook - function to run to update data on coarser levels (once per SNESSolve())
2975 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
2976 
2977    Level: advanced
2978 
2979    Notes:
2980    This function does nothing if the hook is not in the list.
2981 
2982    This function is currently not available from Fortran.
2983 
2984 .seealso: DMCoarsenHookAdd(), DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
2985 @*/
2986 PetscErrorCode DMCoarsenHookRemove(DM fine,PetscErrorCode (*coarsenhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,Mat,Vec,Mat,DM,void*),void *ctx)
2987 {
2988   PetscErrorCode    ierr;
2989   DMCoarsenHookLink link,*p;
2990 
2991   PetscFunctionBegin;
2992   PetscValidHeaderSpecific(fine,DM_CLASSID,1);
2993   for (p=&fine->coarsenhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
2994     if ((*p)->coarsenhook == coarsenhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
2995       link = *p;
2996       *p = link->next;
2997       ierr = PetscFree(link);CHKERRQ(ierr);
2998       break;
2999     }
3000   }
3001   PetscFunctionReturn(0);
3002 }
3003 
3004 
3005 /*@
3006    DMRestrict - restricts user-defined problem data to a coarser DM by running hooks registered by DMCoarsenHookAdd()
3007 
3008    Collective if any hooks are
3009 
3010    Input Arguments:
3011 +  fine - finer DM to use as a base
3012 .  restrct - restriction matrix, apply using MatRestrict()
3013 .  rscale - scaling vector for restriction
3014 .  inject - injection matrix, also use MatRestrict()
3015 -  coarse - coarser DM to update
3016 
3017    Level: developer
3018 
3019 .seealso: DMCoarsenHookAdd(), MatRestrict()
3020 @*/
3021 PetscErrorCode DMRestrict(DM fine,Mat restrct,Vec rscale,Mat inject,DM coarse)
3022 {
3023   PetscErrorCode    ierr;
3024   DMCoarsenHookLink link;
3025 
3026   PetscFunctionBegin;
3027   for (link=fine->coarsenhook; link; link=link->next) {
3028     if (link->restricthook) {
3029       ierr = (*link->restricthook)(fine,restrct,rscale,inject,coarse,link->ctx);CHKERRQ(ierr);
3030     }
3031   }
3032   PetscFunctionReturn(0);
3033 }
3034 
3035 /*@C
3036    DMSubDomainHookAdd - adds a callback to be run when restricting a problem to the coarse grid
3037 
3038    Logically Collective on global
3039 
3040    Input Arguments:
3041 +  global - global DM
3042 .  ddhook - function to run to pass data to the decomposition DM upon its creation
3043 .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3044 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3045 
3046 
3047    Calling sequence for ddhook:
3048 $    ddhook(DM global,DM block,void *ctx)
3049 
3050 +  global - global DM
3051 .  block  - block DM
3052 -  ctx - optional user-defined function context
3053 
3054    Calling sequence for restricthook:
3055 $    restricthook(DM global,VecScatter out,VecScatter in,DM block,void *ctx)
3056 
3057 +  global - global DM
3058 .  out    - scatter to the outer (with ghost and overlap points) block vector
3059 .  in     - scatter to block vector values only owned locally
3060 .  block  - block DM
3061 -  ctx - optional user-defined function context
3062 
3063    Level: advanced
3064 
3065    Notes:
3066    This function is only needed if auxiliary data needs to be set up on subdomain DMs.
3067 
3068    If this function is called multiple times, the hooks will be run in the order they are added.
3069 
3070    In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
3071    extract the global information from its context (instead of from the SNES).
3072 
3073    This function is currently not available from Fortran.
3074 
3075 .seealso: DMRefineHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3076 @*/
3077 PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3078 {
3079   PetscErrorCode      ierr;
3080   DMSubDomainHookLink link,*p;
3081 
3082   PetscFunctionBegin;
3083   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3084   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Scan to the end of the current list of hooks */
3085     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) PetscFunctionReturn(0);
3086   }
3087   ierr               = PetscNew(&link);CHKERRQ(ierr);
3088   link->restricthook = restricthook;
3089   link->ddhook       = ddhook;
3090   link->ctx          = ctx;
3091   link->next         = NULL;
3092   *p                 = link;
3093   PetscFunctionReturn(0);
3094 }
3095 
3096 /*@C
3097    DMSubDomainHookRemove - remove a callback from the list to be run when restricting a problem to the coarse grid
3098 
3099    Logically Collective
3100 
3101    Input Arguments:
3102 +  global - global DM
3103 .  ddhook - function to run to pass data to the decomposition DM upon its creation
3104 .  restricthook - function to run to update data on block solve (at the beginning of the block solve)
3105 -  ctx - [optional] user-defined context for provide data for the hooks (may be NULL)
3106 
3107    Level: advanced
3108 
3109    Notes:
3110 
3111    This function is currently not available from Fortran.
3112 
3113 .seealso: DMSubDomainHookAdd(), SNESFASGetInterpolation(), SNESFASGetInjection(), PetscObjectCompose(), PetscContainerCreate()
3114 @*/
3115 PetscErrorCode DMSubDomainHookRemove(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,void*),void *ctx)
3116 {
3117   PetscErrorCode      ierr;
3118   DMSubDomainHookLink link,*p;
3119 
3120   PetscFunctionBegin;
3121   PetscValidHeaderSpecific(global,DM_CLASSID,1);
3122   for (p=&global->subdomainhook; *p; p=&(*p)->next) { /* Search the list of current hooks */
3123     if ((*p)->ddhook == ddhook && (*p)->restricthook == restricthook && (*p)->ctx == ctx) {
3124       link = *p;
3125       *p = link->next;
3126       ierr = PetscFree(link);CHKERRQ(ierr);
3127       break;
3128     }
3129   }
3130   PetscFunctionReturn(0);
3131 }
3132 
3133 /*@
3134    DMSubDomainRestrict - restricts user-defined problem data to a block DM by running hooks registered by DMSubDomainHookAdd()
3135 
3136    Collective if any hooks are
3137 
3138    Input Arguments:
3139 +  fine - finer DM to use as a base
3140 .  oscatter - scatter from domain global vector filling subdomain global vector with overlap
3141 .  gscatter - scatter from domain global vector filling subdomain local vector with ghosts
3142 -  coarse - coarer DM to update
3143 
3144    Level: developer
3145 
3146 .seealso: DMCoarsenHookAdd(), MatRestrict()
3147 @*/
3148 PetscErrorCode DMSubDomainRestrict(DM global,VecScatter oscatter,VecScatter gscatter,DM subdm)
3149 {
3150   PetscErrorCode      ierr;
3151   DMSubDomainHookLink link;
3152 
3153   PetscFunctionBegin;
3154   for (link=global->subdomainhook; link; link=link->next) {
3155     if (link->restricthook) {
3156       ierr = (*link->restricthook)(global,oscatter,gscatter,subdm,link->ctx);CHKERRQ(ierr);
3157     }
3158   }
3159   PetscFunctionReturn(0);
3160 }
3161 
3162 /*@
3163     DMGetCoarsenLevel - Get's the number of coarsenings that have generated this DM.
3164 
3165     Not Collective
3166 
3167     Input Parameter:
3168 .   dm - the DM object
3169 
3170     Output Parameter:
3171 .   level - number of coarsenings
3172 
3173     Level: developer
3174 
3175 .seealso DMCoarsen(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
3176 
3177 @*/
3178 PetscErrorCode  DMGetCoarsenLevel(DM dm,PetscInt *level)
3179 {
3180   PetscFunctionBegin;
3181   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3182   PetscValidIntPointer(level,2);
3183   *level = dm->leveldown;
3184   PetscFunctionReturn(0);
3185 }
3186 
3187 /*@
3188     DMSetCoarsenLevel - Sets the number of coarsenings that have generated this DM.
3189 
3190     Not Collective
3191 
3192     Input Parameters:
3193 +   dm - the DM object
3194 -   level - number of coarsenings
3195 
3196     Level: developer
3197 
3198 .seealso DMCoarsen(), DMGetCoarsenLevel(), DMGetRefineLevel(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
3199 @*/
3200 PetscErrorCode DMSetCoarsenLevel(DM dm,PetscInt level)
3201 {
3202   PetscFunctionBegin;
3203   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3204   dm->leveldown = level;
3205   PetscFunctionReturn(0);
3206 }
3207 
3208 
3209 
3210 /*@C
3211     DMRefineHierarchy - Refines a DM object, all levels at once
3212 
3213     Collective on dm
3214 
3215     Input Parameter:
3216 +   dm - the DM object
3217 -   nlevels - the number of levels of refinement
3218 
3219     Output Parameter:
3220 .   dmf - the refined DM hierarchy
3221 
3222     Level: developer
3223 
3224 .seealso DMCoarsenHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
3225 
3226 @*/
3227 PetscErrorCode  DMRefineHierarchy(DM dm,PetscInt nlevels,DM dmf[])
3228 {
3229   PetscErrorCode ierr;
3230 
3231   PetscFunctionBegin;
3232   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3233   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
3234   if (nlevels == 0) PetscFunctionReturn(0);
3235   PetscValidPointer(dmf,3);
3236   if (dm->ops->refinehierarchy) {
3237     ierr = (*dm->ops->refinehierarchy)(dm,nlevels,dmf);CHKERRQ(ierr);
3238   } else if (dm->ops->refine) {
3239     PetscInt i;
3240 
3241     ierr = DMRefine(dm,PetscObjectComm((PetscObject)dm),&dmf[0]);CHKERRQ(ierr);
3242     for (i=1; i<nlevels; i++) {
3243       ierr = DMRefine(dmf[i-1],PetscObjectComm((PetscObject)dm),&dmf[i]);CHKERRQ(ierr);
3244     }
3245   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No RefineHierarchy for this DM yet");
3246   PetscFunctionReturn(0);
3247 }
3248 
3249 /*@C
3250     DMCoarsenHierarchy - Coarsens a DM object, all levels at once
3251 
3252     Collective on dm
3253 
3254     Input Parameter:
3255 +   dm - the DM object
3256 -   nlevels - the number of levels of coarsening
3257 
3258     Output Parameter:
3259 .   dmc - the coarsened DM hierarchy
3260 
3261     Level: developer
3262 
3263 .seealso DMRefineHierarchy(), DMDestroy(), DMView(), DMCreateGlobalVector(), DMCreateInterpolation()
3264 
3265 @*/
3266 PetscErrorCode  DMCoarsenHierarchy(DM dm, PetscInt nlevels, DM dmc[])
3267 {
3268   PetscErrorCode ierr;
3269 
3270   PetscFunctionBegin;
3271   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3272   if (nlevels < 0) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_OUTOFRANGE,"nlevels cannot be negative");
3273   if (nlevels == 0) PetscFunctionReturn(0);
3274   PetscValidPointer(dmc,3);
3275   if (dm->ops->coarsenhierarchy) {
3276     ierr = (*dm->ops->coarsenhierarchy)(dm, nlevels, dmc);CHKERRQ(ierr);
3277   } else if (dm->ops->coarsen) {
3278     PetscInt i;
3279 
3280     ierr = DMCoarsen(dm,PetscObjectComm((PetscObject)dm),&dmc[0]);CHKERRQ(ierr);
3281     for (i=1; i<nlevels; i++) {
3282       ierr = DMCoarsen(dmc[i-1],PetscObjectComm((PetscObject)dm),&dmc[i]);CHKERRQ(ierr);
3283     }
3284   } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"No CoarsenHierarchy for this DM yet");
3285   PetscFunctionReturn(0);
3286 }
3287 
3288 /*@C
3289     DMSetApplicationContextDestroy - Sets a user function that will be called to destroy the application context when the DM is destroyed
3290 
3291     Not Collective
3292 
3293     Input Parameters:
3294 +   dm - the DM object
3295 -   destroy - the destroy function
3296 
3297     Level: intermediate
3298 
3299 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
3300 
3301 @*/
3302 PetscErrorCode  DMSetApplicationContextDestroy(DM dm,PetscErrorCode (*destroy)(void**))
3303 {
3304   PetscFunctionBegin;
3305   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3306   dm->ctxdestroy = destroy;
3307   PetscFunctionReturn(0);
3308 }
3309 
3310 /*@
3311     DMSetApplicationContext - Set a user context into a DM object
3312 
3313     Not Collective
3314 
3315     Input Parameters:
3316 +   dm - the DM object
3317 -   ctx - the user context
3318 
3319     Level: intermediate
3320 
3321 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
3322 
3323 @*/
3324 PetscErrorCode  DMSetApplicationContext(DM dm,void *ctx)
3325 {
3326   PetscFunctionBegin;
3327   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3328   dm->ctx = ctx;
3329   PetscFunctionReturn(0);
3330 }
3331 
3332 /*@
3333     DMGetApplicationContext - Gets a user context from a DM object
3334 
3335     Not Collective
3336 
3337     Input Parameter:
3338 .   dm - the DM object
3339 
3340     Output Parameter:
3341 .   ctx - the user context
3342 
3343     Level: intermediate
3344 
3345 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
3346 
3347 @*/
3348 PetscErrorCode  DMGetApplicationContext(DM dm,void *ctx)
3349 {
3350   PetscFunctionBegin;
3351   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3352   *(void**)ctx = dm->ctx;
3353   PetscFunctionReturn(0);
3354 }
3355 
3356 /*@C
3357     DMSetVariableBounds - sets a function to compute the lower and upper bound vectors for SNESVI.
3358 
3359     Logically Collective on dm
3360 
3361     Input Parameter:
3362 +   dm - the DM object
3363 -   f - the function that computes variable bounds used by SNESVI (use NULL to cancel a previous function that was set)
3364 
3365     Level: intermediate
3366 
3367 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext(),
3368          DMSetJacobian()
3369 
3370 @*/
3371 PetscErrorCode DMSetVariableBounds(DM dm,PetscErrorCode (*f)(DM,Vec,Vec))
3372 {
3373   PetscFunctionBegin;
3374   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3375   dm->ops->computevariablebounds = f;
3376   PetscFunctionReturn(0);
3377 }
3378 
3379 /*@
3380     DMHasVariableBounds - does the DM object have a variable bounds function?
3381 
3382     Not Collective
3383 
3384     Input Parameter:
3385 .   dm - the DM object to destroy
3386 
3387     Output Parameter:
3388 .   flg - PETSC_TRUE if the variable bounds function exists
3389 
3390     Level: developer
3391 
3392 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
3393 
3394 @*/
3395 PetscErrorCode DMHasVariableBounds(DM dm,PetscBool *flg)
3396 {
3397   PetscFunctionBegin;
3398   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3399   PetscValidBoolPointer(flg,2);
3400   *flg =  (dm->ops->computevariablebounds) ? PETSC_TRUE : PETSC_FALSE;
3401   PetscFunctionReturn(0);
3402 }
3403 
3404 /*@C
3405     DMComputeVariableBounds - compute variable bounds used by SNESVI.
3406 
3407     Logically Collective on dm
3408 
3409     Input Parameters:
3410 .   dm - the DM object
3411 
3412     Output parameters:
3413 +   xl - lower bound
3414 -   xu - upper bound
3415 
3416     Level: advanced
3417 
3418     Notes:
3419     This is generally not called by users. It calls the function provided by the user with DMSetVariableBounds()
3420 
3421 .seealso DMView(), DMCreateGlobalVector(), DMCreateInterpolation(), DMCreateColoring(), DMCreateMatrix(), DMGetApplicationContext()
3422 
3423 @*/
3424 PetscErrorCode DMComputeVariableBounds(DM dm, Vec xl, Vec xu)
3425 {
3426   PetscErrorCode ierr;
3427 
3428   PetscFunctionBegin;
3429   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3430   PetscValidHeaderSpecific(xl,VEC_CLASSID,2);
3431   PetscValidHeaderSpecific(xu,VEC_CLASSID,3);
3432   if (!dm->ops->computevariablebounds) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeVariableBounds",((PetscObject)dm)->type_name);
3433   ierr = (*dm->ops->computevariablebounds)(dm, xl,xu);CHKERRQ(ierr);
3434   PetscFunctionReturn(0);
3435 }
3436 
3437 /*@
3438     DMHasColoring - does the DM object have a method of providing a coloring?
3439 
3440     Not Collective
3441 
3442     Input Parameter:
3443 .   dm - the DM object
3444 
3445     Output Parameter:
3446 .   flg - PETSC_TRUE if the DM has facilities for DMCreateColoring().
3447 
3448     Level: developer
3449 
3450 .seealso DMCreateColoring()
3451 
3452 @*/
3453 PetscErrorCode DMHasColoring(DM dm,PetscBool *flg)
3454 {
3455   PetscFunctionBegin;
3456   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3457   PetscValidBoolPointer(flg,2);
3458   *flg =  (dm->ops->getcoloring) ? PETSC_TRUE : PETSC_FALSE;
3459   PetscFunctionReturn(0);
3460 }
3461 
3462 /*@
3463     DMHasCreateRestriction - does the DM object have a method of providing a restriction?
3464 
3465     Not Collective
3466 
3467     Input Parameter:
3468 .   dm - the DM object
3469 
3470     Output Parameter:
3471 .   flg - PETSC_TRUE if the DM has facilities for DMCreateRestriction().
3472 
3473     Level: developer
3474 
3475 .seealso DMCreateRestriction()
3476 
3477 @*/
3478 PetscErrorCode DMHasCreateRestriction(DM dm,PetscBool *flg)
3479 {
3480   PetscFunctionBegin;
3481   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3482   PetscValidBoolPointer(flg,2);
3483   *flg =  (dm->ops->createrestriction) ? PETSC_TRUE : PETSC_FALSE;
3484   PetscFunctionReturn(0);
3485 }
3486 
3487 
3488 /*@
3489     DMHasCreateInjection - does the DM object have a method of providing an injection?
3490 
3491     Not Collective
3492 
3493     Input Parameter:
3494 .   dm - the DM object
3495 
3496     Output Parameter:
3497 .   flg - PETSC_TRUE if the DM has facilities for DMCreateInjection().
3498 
3499     Level: developer
3500 
3501 .seealso DMCreateInjection()
3502 
3503 @*/
3504 PetscErrorCode DMHasCreateInjection(DM dm,PetscBool *flg)
3505 {
3506   PetscErrorCode ierr;
3507 
3508   PetscFunctionBegin;
3509   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3510   PetscValidBoolPointer(flg,2);
3511   if (dm->ops->hascreateinjection) {
3512     ierr = (*dm->ops->hascreateinjection)(dm,flg);CHKERRQ(ierr);
3513   } else {
3514     *flg = (dm->ops->createinjection) ? PETSC_TRUE : PETSC_FALSE;
3515   }
3516   PetscFunctionReturn(0);
3517 }
3518 
3519 PetscFunctionList DMList              = NULL;
3520 PetscBool         DMRegisterAllCalled = PETSC_FALSE;
3521 
3522 /*@C
3523   DMSetType - Builds a DM, for a particular DM implementation.
3524 
3525   Collective on dm
3526 
3527   Input Parameters:
3528 + dm     - The DM object
3529 - method - The name of the DM type
3530 
3531   Options Database Key:
3532 . -dm_type <type> - Sets the DM type; use -help for a list of available types
3533 
3534   Notes:
3535   See "petsc/include/petscdm.h" for available DM types (for instance, DM1D, DM2D, or DM3D).
3536 
3537   Level: intermediate
3538 
3539 .seealso: DMGetType(), DMCreate()
3540 @*/
3541 PetscErrorCode  DMSetType(DM dm, DMType method)
3542 {
3543   PetscErrorCode (*r)(DM);
3544   PetscBool      match;
3545   PetscErrorCode ierr;
3546 
3547   PetscFunctionBegin;
3548   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3549   ierr = PetscObjectTypeCompare((PetscObject) dm, method, &match);CHKERRQ(ierr);
3550   if (match) PetscFunctionReturn(0);
3551 
3552   ierr = DMRegisterAll();CHKERRQ(ierr);
3553   ierr = PetscFunctionListFind(DMList,method,&r);CHKERRQ(ierr);
3554   if (!r) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_UNKNOWN_TYPE, "Unknown DM type: %s", method);
3555 
3556   if (dm->ops->destroy) {
3557     ierr = (*dm->ops->destroy)(dm);CHKERRQ(ierr);
3558   }
3559   ierr = PetscMemzero(dm->ops,sizeof(*dm->ops));CHKERRQ(ierr);
3560   ierr = PetscObjectChangeTypeName((PetscObject)dm,method);CHKERRQ(ierr);
3561   ierr = (*r)(dm);CHKERRQ(ierr);
3562   PetscFunctionReturn(0);
3563 }
3564 
3565 /*@C
3566   DMGetType - Gets the DM type name (as a string) from the DM.
3567 
3568   Not Collective
3569 
3570   Input Parameter:
3571 . dm  - The DM
3572 
3573   Output Parameter:
3574 . type - The DM type name
3575 
3576   Level: intermediate
3577 
3578 .seealso: DMSetType(), DMCreate()
3579 @*/
3580 PetscErrorCode  DMGetType(DM dm, DMType *type)
3581 {
3582   PetscErrorCode ierr;
3583 
3584   PetscFunctionBegin;
3585   PetscValidHeaderSpecific(dm, DM_CLASSID,1);
3586   PetscValidPointer(type,2);
3587   ierr = DMRegisterAll();CHKERRQ(ierr);
3588   *type = ((PetscObject)dm)->type_name;
3589   PetscFunctionReturn(0);
3590 }
3591 
3592 /*@C
3593   DMConvert - Converts a DM to another DM, either of the same or different type.
3594 
3595   Collective on dm
3596 
3597   Input Parameters:
3598 + dm - the DM
3599 - newtype - new DM type (use "same" for the same type)
3600 
3601   Output Parameter:
3602 . M - pointer to new DM
3603 
3604   Notes:
3605   Cannot be used to convert a sequential DM to parallel or parallel to sequential,
3606   the MPI communicator of the generated DM is always the same as the communicator
3607   of the input DM.
3608 
3609   Level: intermediate
3610 
3611 .seealso: DMCreate()
3612 @*/
3613 PetscErrorCode DMConvert(DM dm, DMType newtype, DM *M)
3614 {
3615   DM             B;
3616   char           convname[256];
3617   PetscBool      sametype/*, issame */;
3618   PetscErrorCode ierr;
3619 
3620   PetscFunctionBegin;
3621   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
3622   PetscValidType(dm,1);
3623   PetscValidPointer(M,3);
3624   ierr = PetscObjectTypeCompare((PetscObject) dm, newtype, &sametype);CHKERRQ(ierr);
3625   /* ierr = PetscStrcmp(newtype, "same", &issame);CHKERRQ(ierr); */
3626   if (sametype) {
3627     *M   = dm;
3628     ierr = PetscObjectReference((PetscObject) dm);CHKERRQ(ierr);
3629     PetscFunctionReturn(0);
3630   } else {
3631     PetscErrorCode (*conv)(DM, DMType, DM*) = NULL;
3632 
3633     /*
3634        Order of precedence:
3635        1) See if a specialized converter is known to the current DM.
3636        2) See if a specialized converter is known to the desired DM class.
3637        3) See if a good general converter is registered for the desired class
3638        4) See if a good general converter is known for the current matrix.
3639        5) Use a really basic converter.
3640     */
3641 
3642     /* 1) See if a specialized converter is known to the current DM and the desired class */
3643     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3644     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3645     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3646     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3647     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
3648     ierr = PetscObjectQueryFunction((PetscObject)dm,convname,&conv);CHKERRQ(ierr);
3649     if (conv) goto foundconv;
3650 
3651     /* 2)  See if a specialized converter is known to the desired DM class. */
3652     ierr = DMCreate(PetscObjectComm((PetscObject)dm), &B);CHKERRQ(ierr);
3653     ierr = DMSetType(B, newtype);CHKERRQ(ierr);
3654     ierr = PetscStrncpy(convname,"DMConvert_",sizeof(convname));CHKERRQ(ierr);
3655     ierr = PetscStrlcat(convname,((PetscObject) dm)->type_name,sizeof(convname));CHKERRQ(ierr);
3656     ierr = PetscStrlcat(convname,"_",sizeof(convname));CHKERRQ(ierr);
3657     ierr = PetscStrlcat(convname,newtype,sizeof(convname));CHKERRQ(ierr);
3658     ierr = PetscStrlcat(convname,"_C",sizeof(convname));CHKERRQ(ierr);
3659     ierr = PetscObjectQueryFunction((PetscObject)B,convname,&conv);CHKERRQ(ierr);
3660     if (conv) {
3661       ierr = DMDestroy(&B);CHKERRQ(ierr);
3662       goto foundconv;
3663     }
3664 
3665 #if 0
3666     /* 3) See if a good general converter is registered for the desired class */
3667     conv = B->ops->convertfrom;
3668     ierr = DMDestroy(&B);CHKERRQ(ierr);
3669     if (conv) goto foundconv;
3670 
3671     /* 4) See if a good general converter is known for the current matrix */
3672     if (dm->ops->convert) {
3673       conv = dm->ops->convert;
3674     }
3675     if (conv) goto foundconv;
3676 #endif
3677 
3678     /* 5) Use a really basic converter. */
3679     SETERRQ2(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "No conversion possible between DM types %s and %s", ((PetscObject) dm)->type_name, newtype);
3680 
3681 foundconv:
3682     ierr = PetscLogEventBegin(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
3683     ierr = (*conv)(dm,newtype,M);CHKERRQ(ierr);
3684     /* Things that are independent of DM type: We should consult DMClone() here */
3685     {
3686       PetscBool             isper;
3687       const PetscReal      *maxCell, *L;
3688       const DMBoundaryType *bd;
3689       ierr = DMGetPeriodicity(dm, &isper, &maxCell, &L, &bd);CHKERRQ(ierr);
3690       ierr = DMSetPeriodicity(*M, isper, maxCell,  L,  bd);CHKERRQ(ierr);
3691     }
3692     ierr = PetscLogEventEnd(DM_Convert,dm,0,0,0);CHKERRQ(ierr);
3693   }
3694   ierr = PetscObjectStateIncrease((PetscObject) *M);CHKERRQ(ierr);
3695   PetscFunctionReturn(0);
3696 }
3697 
3698 /*--------------------------------------------------------------------------------------------------------------------*/
3699 
3700 /*@C
3701   DMRegister -  Adds a new DM component implementation
3702 
3703   Not Collective
3704 
3705   Input Parameters:
3706 + name        - The name of a new user-defined creation routine
3707 - create_func - The creation routine itself
3708 
3709   Notes:
3710   DMRegister() may be called multiple times to add several user-defined DMs
3711 
3712 
3713   Sample usage:
3714 .vb
3715     DMRegister("my_da", MyDMCreate);
3716 .ve
3717 
3718   Then, your DM type can be chosen with the procedural interface via
3719 .vb
3720     DMCreate(MPI_Comm, DM *);
3721     DMSetType(DM,"my_da");
3722 .ve
3723    or at runtime via the option
3724 .vb
3725     -da_type my_da
3726 .ve
3727 
3728   Level: advanced
3729 
3730 .seealso: DMRegisterAll(), DMRegisterDestroy()
3731 
3732 @*/
3733 PetscErrorCode  DMRegister(const char sname[],PetscErrorCode (*function)(DM))
3734 {
3735   PetscErrorCode ierr;
3736 
3737   PetscFunctionBegin;
3738   ierr = DMInitializePackage();CHKERRQ(ierr);
3739   ierr = PetscFunctionListAdd(&DMList,sname,function);CHKERRQ(ierr);
3740   PetscFunctionReturn(0);
3741 }
3742 
3743 /*@C
3744   DMLoad - Loads a DM that has been stored in binary  with DMView().
3745 
3746   Collective on viewer
3747 
3748   Input Parameters:
3749 + newdm - the newly loaded DM, this needs to have been created with DMCreate() or
3750            some related function before a call to DMLoad().
3751 - viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or
3752            HDF5 file viewer, obtained from PetscViewerHDF5Open()
3753 
3754    Level: intermediate
3755 
3756   Notes:
3757    The type is determined by the data in the file, any type set into the DM before this call is ignored.
3758 
3759   Notes for advanced users:
3760   Most users should not need to know the details of the binary storage
3761   format, since DMLoad() and DMView() completely hide these details.
3762   But for anyone who's interested, the standard binary matrix storage
3763   format is
3764 .vb
3765      has not yet been determined
3766 .ve
3767 
3768 .seealso: PetscViewerBinaryOpen(), DMView(), MatLoad(), VecLoad()
3769 @*/
3770 PetscErrorCode  DMLoad(DM newdm, PetscViewer viewer)
3771 {
3772   PetscBool      isbinary, ishdf5;
3773   PetscErrorCode ierr;
3774 
3775   PetscFunctionBegin;
3776   PetscValidHeaderSpecific(newdm,DM_CLASSID,1);
3777   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
3778   ierr = PetscViewerCheckReadable(viewer);CHKERRQ(ierr);
3779   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
3780   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERHDF5,&ishdf5);CHKERRQ(ierr);
3781   ierr = PetscLogEventBegin(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
3782   if (isbinary) {
3783     PetscInt classid;
3784     char     type[256];
3785 
3786     ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
3787     if (classid != DM_FILE_CLASSID) SETERRQ1(PetscObjectComm((PetscObject)newdm),PETSC_ERR_ARG_WRONG,"Not DM next in file, classid found %d",(int)classid);
3788     ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
3789     ierr = DMSetType(newdm, type);CHKERRQ(ierr);
3790     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
3791   } else if (ishdf5) {
3792     if (newdm->ops->load) {ierr = (*newdm->ops->load)(newdm,viewer);CHKERRQ(ierr);}
3793   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen() or PetscViewerHDF5Open()");
3794   ierr = PetscLogEventEnd(DM_Load,viewer,0,0,0);CHKERRQ(ierr);
3795   PetscFunctionReturn(0);
3796 }
3797 
3798 /*@
3799   DMGetLocalBoundingBox - Returns the bounding box for the piece of the DM on this process.
3800 
3801   Not collective
3802 
3803   Input Parameter:
3804 . dm - the DM
3805 
3806   Output Parameters:
3807 + lmin - local minimum coordinates (length coord dim, optional)
3808 - lmax - local maximim coordinates (length coord dim, optional)
3809 
3810   Level: beginner
3811 
3812   Note: If the DM is a DMDA and has no coordinates, the index bounds are returned instead.
3813 
3814 
3815 .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetBoundingBox()
3816 @*/
3817 PetscErrorCode DMGetLocalBoundingBox(DM dm, PetscReal lmin[], PetscReal lmax[])
3818 {
3819   Vec                coords = NULL;
3820   PetscReal          min[3] = {PETSC_MAX_REAL, PETSC_MAX_REAL, PETSC_MAX_REAL};
3821   PetscReal          max[3] = {PETSC_MIN_REAL, PETSC_MIN_REAL, PETSC_MIN_REAL};
3822   const PetscScalar *local_coords;
3823   PetscInt           N, Ni;
3824   PetscInt           cdim, i, j;
3825   PetscErrorCode     ierr;
3826 
3827   PetscFunctionBegin;
3828   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3829   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
3830   ierr = DMGetCoordinates(dm, &coords);CHKERRQ(ierr);
3831   if (coords) {
3832     ierr = VecGetArrayRead(coords, &local_coords);CHKERRQ(ierr);
3833     ierr = VecGetLocalSize(coords, &N);CHKERRQ(ierr);
3834     Ni   = N/cdim;
3835     for (i = 0; i < Ni; ++i) {
3836       for (j = 0; j < 3; ++j) {
3837         min[j] = j < cdim ? PetscMin(min[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
3838         max[j] = j < cdim ? PetscMax(max[j], PetscRealPart(local_coords[i*cdim+j])) : 0;
3839       }
3840     }
3841     ierr = VecRestoreArrayRead(coords, &local_coords);CHKERRQ(ierr);
3842   } else {
3843     PetscBool isda;
3844 
3845     ierr = PetscObjectTypeCompare((PetscObject) dm, DMDA, &isda);CHKERRQ(ierr);
3846     if (isda) {ierr = DMGetLocalBoundingIndices_DMDA(dm, min, max);CHKERRQ(ierr);}
3847   }
3848   if (lmin) {ierr = PetscArraycpy(lmin, min, cdim);CHKERRQ(ierr);}
3849   if (lmax) {ierr = PetscArraycpy(lmax, max, cdim);CHKERRQ(ierr);}
3850   PetscFunctionReturn(0);
3851 }
3852 
3853 /*@
3854   DMGetBoundingBox - Returns the global bounding box for the DM.
3855 
3856   Collective
3857 
3858   Input Parameter:
3859 . dm - the DM
3860 
3861   Output Parameters:
3862 + gmin - global minimum coordinates (length coord dim, optional)
3863 - gmax - global maximim coordinates (length coord dim, optional)
3864 
3865   Level: beginner
3866 
3867 .seealso: DMGetLocalBoundingBox(), DMGetCoordinates(), DMGetCoordinatesLocal()
3868 @*/
3869 PetscErrorCode DMGetBoundingBox(DM dm, PetscReal gmin[], PetscReal gmax[])
3870 {
3871   PetscReal      lmin[3], lmax[3];
3872   PetscInt       cdim;
3873   PetscMPIInt    count;
3874   PetscErrorCode ierr;
3875 
3876   PetscFunctionBegin;
3877   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
3878   ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
3879   ierr = PetscMPIIntCast(cdim, &count);CHKERRQ(ierr);
3880   ierr = DMGetLocalBoundingBox(dm, lmin, lmax);CHKERRQ(ierr);
3881   if (gmin) {ierr = MPIU_Allreduce(lmin, gmin, count, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);}
3882   if (gmax) {ierr = MPIU_Allreduce(lmax, gmax, count, MPIU_REAL, MPIU_MAX, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);}
3883   PetscFunctionReturn(0);
3884 }
3885 
3886 /******************************** FEM Support **********************************/
3887 
3888 PetscErrorCode DMPrintCellVector(PetscInt c, const char name[], PetscInt len, const PetscScalar x[])
3889 {
3890   PetscInt       f;
3891   PetscErrorCode ierr;
3892 
3893   PetscFunctionBegin;
3894   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
3895   for (f = 0; f < len; ++f) {
3896     ierr = PetscPrintf(PETSC_COMM_SELF, "  | %g |\n", (double)PetscRealPart(x[f]));CHKERRQ(ierr);
3897   }
3898   PetscFunctionReturn(0);
3899 }
3900 
3901 PetscErrorCode DMPrintCellMatrix(PetscInt c, const char name[], PetscInt rows, PetscInt cols, const PetscScalar A[])
3902 {
3903   PetscInt       f, g;
3904   PetscErrorCode ierr;
3905 
3906   PetscFunctionBegin;
3907   ierr = PetscPrintf(PETSC_COMM_SELF, "Cell %D Element %s\n", c, name);CHKERRQ(ierr);
3908   for (f = 0; f < rows; ++f) {
3909     ierr = PetscPrintf(PETSC_COMM_SELF, "  |");CHKERRQ(ierr);
3910     for (g = 0; g < cols; ++g) {
3911       ierr = PetscPrintf(PETSC_COMM_SELF, " % 9.5g", PetscRealPart(A[f*cols+g]));CHKERRQ(ierr);
3912     }
3913     ierr = PetscPrintf(PETSC_COMM_SELF, " |\n");CHKERRQ(ierr);
3914   }
3915   PetscFunctionReturn(0);
3916 }
3917 
3918 PetscErrorCode DMPrintLocalVec(DM dm, const char name[], PetscReal tol, Vec X)
3919 {
3920   PetscInt          localSize, bs;
3921   PetscMPIInt       size;
3922   Vec               x, xglob;
3923   const PetscScalar *xarray;
3924   PetscErrorCode    ierr;
3925 
3926   PetscFunctionBegin;
3927   ierr = MPI_Comm_size(PetscObjectComm((PetscObject) dm),&size);CHKERRQ(ierr);
3928   ierr = VecDuplicate(X, &x);CHKERRQ(ierr);
3929   ierr = VecCopy(X, x);CHKERRQ(ierr);
3930   ierr = VecChop(x, tol);CHKERRQ(ierr);
3931   ierr = PetscPrintf(PetscObjectComm((PetscObject) dm),"%s:\n",name);CHKERRQ(ierr);
3932   if (size > 1) {
3933     ierr = VecGetLocalSize(x,&localSize);CHKERRQ(ierr);
3934     ierr = VecGetArrayRead(x,&xarray);CHKERRQ(ierr);
3935     ierr = VecGetBlockSize(x,&bs);CHKERRQ(ierr);
3936     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject) dm),bs,localSize,PETSC_DETERMINE,xarray,&xglob);CHKERRQ(ierr);
3937   } else {
3938     xglob = x;
3939   }
3940   ierr = VecView(xglob,PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject) dm)));CHKERRQ(ierr);
3941   if (size > 1) {
3942     ierr = VecDestroy(&xglob);CHKERRQ(ierr);
3943     ierr = VecRestoreArrayRead(x,&xarray);CHKERRQ(ierr);
3944   }
3945   ierr = VecDestroy(&x);CHKERRQ(ierr);
3946   PetscFunctionReturn(0);
3947 }
3948 
3949 /*@
3950   DMGetSection - Get the PetscSection encoding the local data layout for the DM.   This is equivalent to DMGetLocalSection(). Deprecated in v3.12
3951 
3952   Input Parameter:
3953 . dm - The DM
3954 
3955   Output Parameter:
3956 . section - The PetscSection
3957 
3958   Options Database Keys:
3959 . -dm_petscsection_view - View the Section created by the DM
3960 
3961   Level: advanced
3962 
3963   Notes:
3964   Use DMGetLocalSection() in new code.
3965 
3966   This gets a borrowed reference, so the user should not destroy this PetscSection.
3967 
3968 .seealso: DMGetLocalSection(), DMSetLocalSection(), DMGetGlobalSection()
3969 @*/
3970 PetscErrorCode DMGetSection(DM dm, PetscSection *section)
3971 {
3972   PetscErrorCode ierr;
3973 
3974   PetscFunctionBegin;
3975   ierr = DMGetLocalSection(dm,section);CHKERRQ(ierr);
3976   PetscFunctionReturn(0);
3977 }
3978 
3979 /*@
3980   DMGetLocalSection - Get the PetscSection encoding the local data layout for the DM.
3981 
3982   Input Parameter:
3983 . dm - The DM
3984 
3985   Output Parameter:
3986 . section - The PetscSection
3987 
3988   Options Database Keys:
3989 . -dm_petscsection_view - View the Section created by the DM
3990 
3991   Level: intermediate
3992 
3993   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
3994 
3995 .seealso: DMSetLocalSection(), DMGetGlobalSection()
3996 @*/
3997 PetscErrorCode DMGetLocalSection(DM dm, PetscSection *section)
3998 {
3999   PetscErrorCode ierr;
4000 
4001   PetscFunctionBegin;
4002   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4003   PetscValidPointer(section, 2);
4004   if (!dm->localSection && dm->ops->createlocalsection) {
4005     PetscInt d;
4006 
4007     if (dm->setfromoptionscalled) for (d = 0; d < dm->Nds; ++d) {ierr = PetscDSSetFromOptions(dm->probs[d].ds);CHKERRQ(ierr);}
4008     ierr = (*dm->ops->createlocalsection)(dm);CHKERRQ(ierr);
4009     if (dm->localSection) {ierr = PetscObjectViewFromOptions((PetscObject) dm->localSection, NULL, "-dm_petscsection_view");CHKERRQ(ierr);}
4010   }
4011   *section = dm->localSection;
4012   PetscFunctionReturn(0);
4013 }
4014 
4015 /*@
4016   DMSetSection - Set the PetscSection encoding the local data layout for the DM.  This is equivalent to DMSetLocalSection(). Deprecated in v3.12
4017 
4018   Input Parameters:
4019 + dm - The DM
4020 - section - The PetscSection
4021 
4022   Level: advanced
4023 
4024   Notes:
4025   Use DMSetLocalSection() in new code.
4026 
4027   Any existing Section will be destroyed
4028 
4029 .seealso: DMSetLocalSection(), DMGetLocalSection(), DMSetGlobalSection()
4030 @*/
4031 PetscErrorCode DMSetSection(DM dm, PetscSection section)
4032 {
4033   PetscErrorCode ierr;
4034 
4035   PetscFunctionBegin;
4036   ierr = DMSetLocalSection(dm,section);CHKERRQ(ierr);
4037   PetscFunctionReturn(0);
4038 }
4039 
4040 /*@
4041   DMSetLocalSection - Set the PetscSection encoding the local data layout for the DM.
4042 
4043   Input Parameters:
4044 + dm - The DM
4045 - section - The PetscSection
4046 
4047   Level: intermediate
4048 
4049   Note: Any existing Section will be destroyed
4050 
4051 .seealso: DMGetLocalSection(), DMSetGlobalSection()
4052 @*/
4053 PetscErrorCode DMSetLocalSection(DM dm, PetscSection section)
4054 {
4055   PetscInt       numFields = 0;
4056   PetscInt       f;
4057   PetscErrorCode ierr;
4058 
4059   PetscFunctionBegin;
4060   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4061   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4062   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
4063   ierr = PetscSectionDestroy(&dm->localSection);CHKERRQ(ierr);
4064   dm->localSection = section;
4065   if (section) {ierr = PetscSectionGetNumFields(dm->localSection, &numFields);CHKERRQ(ierr);}
4066   if (numFields) {
4067     ierr = DMSetNumFields(dm, numFields);CHKERRQ(ierr);
4068     for (f = 0; f < numFields; ++f) {
4069       PetscObject disc;
4070       const char *name;
4071 
4072       ierr = PetscSectionGetFieldName(dm->localSection, f, &name);CHKERRQ(ierr);
4073       ierr = DMGetField(dm, f, NULL, &disc);CHKERRQ(ierr);
4074       ierr = PetscObjectSetName(disc, name);CHKERRQ(ierr);
4075     }
4076   }
4077   /* The global section will be rebuilt in the next call to DMGetGlobalSection(). */
4078   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
4079   PetscFunctionReturn(0);
4080 }
4081 
4082 /*@
4083   DMGetDefaultConstraints - Get the PetscSection and Mat that specify the local constraint interpolation. See DMSetDefaultConstraints() for a description of the purpose of constraint interpolation.
4084 
4085   not collective
4086 
4087   Input Parameter:
4088 . dm - The DM
4089 
4090   Output Parameter:
4091 + 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.
4092 - 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.
4093 
4094   Level: advanced
4095 
4096   Note: This gets borrowed references, so the user should not destroy the PetscSection or the Mat.
4097 
4098 .seealso: DMSetDefaultConstraints()
4099 @*/
4100 PetscErrorCode DMGetDefaultConstraints(DM dm, PetscSection *section, Mat *mat)
4101 {
4102   PetscErrorCode ierr;
4103 
4104   PetscFunctionBegin;
4105   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4106   if (!dm->defaultConstraintSection && !dm->defaultConstraintMat && dm->ops->createdefaultconstraints) {ierr = (*dm->ops->createdefaultconstraints)(dm);CHKERRQ(ierr);}
4107   if (section) {*section = dm->defaultConstraintSection;}
4108   if (mat) {*mat = dm->defaultConstraintMat;}
4109   PetscFunctionReturn(0);
4110 }
4111 
4112 /*@
4113   DMSetDefaultConstraints - Set the PetscSection and Mat that specify the local constraint interpolation.
4114 
4115   If a constraint matrix is specified, then it is applied during DMGlobalToLocalEnd() when mode is INSERT_VALUES, INSERT_BC_VALUES, or INSERT_ALL_VALUES.  Without a constraint matrix, the local vector l returned by DMGlobalToLocalEnd() contains values that have been scattered from a global vector without modification; with a constraint matrix A, l is modified by computing c = A * l, l[s[i]] = c[i], where the scatter s is defined by the PetscSection returned by DMGetDefaultConstraintMatrix().
4116 
4117   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.
4118 
4119   collective on dm
4120 
4121   Input Parameters:
4122 + dm - The DM
4123 + 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).
4124 - 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).
4125 
4126   Level: advanced
4127 
4128   Note: This increments the references of the PetscSection and the Mat, so they user can destroy them
4129 
4130 .seealso: DMGetDefaultConstraints()
4131 @*/
4132 PetscErrorCode DMSetDefaultConstraints(DM dm, PetscSection section, Mat mat)
4133 {
4134   PetscMPIInt result;
4135   PetscErrorCode ierr;
4136 
4137   PetscFunctionBegin;
4138   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4139   if (section) {
4140     PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4141     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)section),&result);CHKERRQ(ierr);
4142     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint section must have local communicator");
4143   }
4144   if (mat) {
4145     PetscValidHeaderSpecific(mat,MAT_CLASSID,3);
4146     ierr = MPI_Comm_compare(PETSC_COMM_SELF,PetscObjectComm((PetscObject)mat),&result);CHKERRQ(ierr);
4147     if (result != MPI_CONGRUENT && result != MPI_IDENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NOTSAMECOMM,"constraint matrix must have local communicator");
4148   }
4149   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
4150   ierr = PetscSectionDestroy(&dm->defaultConstraintSection);CHKERRQ(ierr);
4151   dm->defaultConstraintSection = section;
4152   ierr = PetscObjectReference((PetscObject)mat);CHKERRQ(ierr);
4153   ierr = MatDestroy(&dm->defaultConstraintMat);CHKERRQ(ierr);
4154   dm->defaultConstraintMat = mat;
4155   PetscFunctionReturn(0);
4156 }
4157 
4158 #if defined(PETSC_USE_DEBUG)
4159 /*
4160   DMDefaultSectionCheckConsistency - Check the consistentcy of the global and local sections.
4161 
4162   Input Parameters:
4163 + dm - The DM
4164 . localSection - PetscSection describing the local data layout
4165 - globalSection - PetscSection describing the global data layout
4166 
4167   Level: intermediate
4168 
4169 .seealso: DMGetSectionSF(), DMSetSectionSF()
4170 */
4171 static PetscErrorCode DMDefaultSectionCheckConsistency_Internal(DM dm, PetscSection localSection, PetscSection globalSection)
4172 {
4173   MPI_Comm        comm;
4174   PetscLayout     layout;
4175   const PetscInt *ranges;
4176   PetscInt        pStart, pEnd, p, nroots;
4177   PetscMPIInt     size, rank;
4178   PetscBool       valid = PETSC_TRUE, gvalid;
4179   PetscErrorCode  ierr;
4180 
4181   PetscFunctionBegin;
4182   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4183   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4184   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
4185   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
4186   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4187   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4188   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4189   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4190   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4191   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4192   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4193   for (p = pStart; p < pEnd; ++p) {
4194     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d;
4195 
4196     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4197     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4198     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4199     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4200     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4201     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4202     if (!gdof) continue; /* Censored point */
4203     if ((gdof < 0 ? -(gdof+1) : gdof) != dof) {ierr = PetscSynchronizedPrintf(comm, "[%d]Global dof %d for point %d not equal to local dof %d\n", rank, gdof, p, dof);CHKERRQ(ierr); valid = PETSC_FALSE;}
4204     if (gcdof && (gcdof != cdof)) {ierr = PetscSynchronizedPrintf(comm, "[%d]Global constraints %d for point %d not equal to local constraints %d\n", rank, gcdof, p, cdof);CHKERRQ(ierr); valid = PETSC_FALSE;}
4205     if (gdof < 0) {
4206       gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4207       for (d = 0; d < gsize; ++d) {
4208         PetscInt offset = -(goff+1) + d, r;
4209 
4210         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4211         if (r < 0) r = -(r+2);
4212         if ((r < 0) || (r >= size)) {ierr = PetscSynchronizedPrintf(comm, "[%d]Point %d mapped to invalid process %d (%d, %d)\n", rank, p, r, gdof, goff);CHKERRQ(ierr); valid = PETSC_FALSE;break;}
4213       }
4214     }
4215   }
4216   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4217   ierr = PetscSynchronizedFlush(comm, NULL);CHKERRQ(ierr);
4218   ierr = MPIU_Allreduce(&valid, &gvalid, 1, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
4219   if (!gvalid) {
4220     ierr = DMView(dm, NULL);CHKERRQ(ierr);
4221     SETERRQ(comm, PETSC_ERR_ARG_WRONG, "Inconsistent local and global sections");
4222   }
4223   PetscFunctionReturn(0);
4224 }
4225 #endif
4226 
4227 /*@
4228   DMGetGlobalSection - Get the PetscSection encoding the global data layout for the DM.
4229 
4230   Collective on dm
4231 
4232   Input Parameter:
4233 . dm - The DM
4234 
4235   Output Parameter:
4236 . section - The PetscSection
4237 
4238   Level: intermediate
4239 
4240   Note: This gets a borrowed reference, so the user should not destroy this PetscSection.
4241 
4242 .seealso: DMSetLocalSection(), DMGetLocalSection()
4243 @*/
4244 PetscErrorCode DMGetGlobalSection(DM dm, PetscSection *section)
4245 {
4246   PetscErrorCode ierr;
4247 
4248   PetscFunctionBegin;
4249   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4250   PetscValidPointer(section, 2);
4251   if (!dm->globalSection) {
4252     PetscSection s;
4253 
4254     ierr = DMGetLocalSection(dm, &s);CHKERRQ(ierr);
4255     if (!s)  SETERRQ(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a default PetscSection in order to create a global PetscSection");
4256     if (!dm->sf) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM must have a point PetscSF in order to create a global PetscSection");
4257     ierr = PetscSectionCreateGlobalSection(s, dm->sf, PETSC_FALSE, PETSC_FALSE, &dm->globalSection);CHKERRQ(ierr);
4258     ierr = PetscLayoutDestroy(&dm->map);CHKERRQ(ierr);
4259     ierr = PetscSectionGetValueLayout(PetscObjectComm((PetscObject)dm), dm->globalSection, &dm->map);CHKERRQ(ierr);
4260     ierr = PetscSectionViewFromOptions(dm->globalSection, NULL, "-global_section_view");CHKERRQ(ierr);
4261   }
4262   *section = dm->globalSection;
4263   PetscFunctionReturn(0);
4264 }
4265 
4266 /*@
4267   DMSetGlobalSection - Set the PetscSection encoding the global data layout for the DM.
4268 
4269   Input Parameters:
4270 + dm - The DM
4271 - section - The PetscSection, or NULL
4272 
4273   Level: intermediate
4274 
4275   Note: Any existing Section will be destroyed
4276 
4277 .seealso: DMGetGlobalSection(), DMSetLocalSection()
4278 @*/
4279 PetscErrorCode DMSetGlobalSection(DM dm, PetscSection section)
4280 {
4281   PetscErrorCode ierr;
4282 
4283   PetscFunctionBegin;
4284   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4285   if (section) PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,2);
4286   ierr = PetscObjectReference((PetscObject)section);CHKERRQ(ierr);
4287   ierr = PetscSectionDestroy(&dm->globalSection);CHKERRQ(ierr);
4288   dm->globalSection = section;
4289 #if defined(PETSC_USE_DEBUG)
4290   if (section) {ierr = DMDefaultSectionCheckConsistency_Internal(dm, dm->localSection, section);CHKERRQ(ierr);}
4291 #endif
4292   PetscFunctionReturn(0);
4293 }
4294 
4295 /*@
4296   DMGetSectionSF - Get the PetscSF encoding the parallel dof overlap for the DM. If it has not been set,
4297   it is created from the default PetscSection layouts in the DM.
4298 
4299   Input Parameter:
4300 . dm - The DM
4301 
4302   Output Parameter:
4303 . sf - The PetscSF
4304 
4305   Level: intermediate
4306 
4307   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4308 
4309 .seealso: DMSetSectionSF(), DMCreateSectionSF()
4310 @*/
4311 PetscErrorCode DMGetSectionSF(DM dm, PetscSF *sf)
4312 {
4313   PetscInt       nroots;
4314   PetscErrorCode ierr;
4315 
4316   PetscFunctionBegin;
4317   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4318   PetscValidPointer(sf, 2);
4319   if (!dm->sectionSF) {
4320     ierr = PetscSFCreate(PetscObjectComm((PetscObject)dm),&dm->sectionSF);CHKERRQ(ierr);
4321   }
4322   ierr = PetscSFGetGraph(dm->sectionSF, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
4323   if (nroots < 0) {
4324     PetscSection section, gSection;
4325 
4326     ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
4327     if (section) {
4328       ierr = DMGetGlobalSection(dm, &gSection);CHKERRQ(ierr);
4329       ierr = DMCreateSectionSF(dm, section, gSection);CHKERRQ(ierr);
4330     } else {
4331       *sf = NULL;
4332       PetscFunctionReturn(0);
4333     }
4334   }
4335   *sf = dm->sectionSF;
4336   PetscFunctionReturn(0);
4337 }
4338 
4339 /*@
4340   DMSetSectionSF - Set the PetscSF encoding the parallel dof overlap for the DM
4341 
4342   Input Parameters:
4343 + dm - The DM
4344 - sf - The PetscSF
4345 
4346   Level: intermediate
4347 
4348   Note: Any previous SF is destroyed
4349 
4350 .seealso: DMGetSectionSF(), DMCreateSectionSF()
4351 @*/
4352 PetscErrorCode DMSetSectionSF(DM dm, PetscSF sf)
4353 {
4354   PetscErrorCode ierr;
4355 
4356   PetscFunctionBegin;
4357   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4358   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4359   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
4360   ierr = PetscSFDestroy(&dm->sectionSF);CHKERRQ(ierr);
4361   dm->sectionSF = sf;
4362   PetscFunctionReturn(0);
4363 }
4364 
4365 /*@C
4366   DMCreateSectionSF - Create the PetscSF encoding the parallel dof overlap for the DM based upon the PetscSections
4367   describing the data layout.
4368 
4369   Input Parameters:
4370 + dm - The DM
4371 . localSection - PetscSection describing the local data layout
4372 - globalSection - PetscSection describing the global data layout
4373 
4374   Notes: One usually uses DMGetSectionSF() to obtain the PetscSF
4375 
4376   Level: developer
4377 
4378   Developer Note: Since this routine has for arguments the two sections from the DM and puts the resulting PetscSF
4379                   directly into the DM, perhaps this function should not take the local and global sections as
4380                   input and should just obtain them from the DM?
4381 
4382 .seealso: DMGetSectionSF(), DMSetSectionSF(), DMGetLocalSection(), DMGetGlobalSection()
4383 @*/
4384 PetscErrorCode DMCreateSectionSF(DM dm, PetscSection localSection, PetscSection globalSection)
4385 {
4386   MPI_Comm       comm;
4387   PetscLayout    layout;
4388   const PetscInt *ranges;
4389   PetscInt       *local;
4390   PetscSFNode    *remote;
4391   PetscInt       pStart, pEnd, p, nroots, nleaves = 0, l;
4392   PetscMPIInt    size, rank;
4393   PetscErrorCode ierr;
4394 
4395   PetscFunctionBegin;
4396   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4397   ierr = PetscObjectGetComm((PetscObject)dm,&comm);CHKERRQ(ierr);
4398   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
4399   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
4400   ierr = PetscSectionGetChart(globalSection, &pStart, &pEnd);CHKERRQ(ierr);
4401   ierr = PetscSectionGetConstrainedStorageSize(globalSection, &nroots);CHKERRQ(ierr);
4402   ierr = PetscLayoutCreate(comm, &layout);CHKERRQ(ierr);
4403   ierr = PetscLayoutSetBlockSize(layout, 1);CHKERRQ(ierr);
4404   ierr = PetscLayoutSetLocalSize(layout, nroots);CHKERRQ(ierr);
4405   ierr = PetscLayoutSetUp(layout);CHKERRQ(ierr);
4406   ierr = PetscLayoutGetRanges(layout, &ranges);CHKERRQ(ierr);
4407   for (p = pStart; p < pEnd; ++p) {
4408     PetscInt gdof, gcdof;
4409 
4410     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4411     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4412     if (gcdof > (gdof < 0 ? -(gdof+1) : gdof)) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %d has %d constraints > %d dof", p, gcdof, (gdof < 0 ? -(gdof+1) : gdof));
4413     nleaves += gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4414   }
4415   ierr = PetscMalloc1(nleaves, &local);CHKERRQ(ierr);
4416   ierr = PetscMalloc1(nleaves, &remote);CHKERRQ(ierr);
4417   for (p = pStart, l = 0; p < pEnd; ++p) {
4418     const PetscInt *cind;
4419     PetscInt       dof, cdof, off, gdof, gcdof, goff, gsize, d, c;
4420 
4421     ierr = PetscSectionGetDof(localSection, p, &dof);CHKERRQ(ierr);
4422     ierr = PetscSectionGetOffset(localSection, p, &off);CHKERRQ(ierr);
4423     ierr = PetscSectionGetConstraintDof(localSection, p, &cdof);CHKERRQ(ierr);
4424     ierr = PetscSectionGetConstraintIndices(localSection, p, &cind);CHKERRQ(ierr);
4425     ierr = PetscSectionGetDof(globalSection, p, &gdof);CHKERRQ(ierr);
4426     ierr = PetscSectionGetConstraintDof(globalSection, p, &gcdof);CHKERRQ(ierr);
4427     ierr = PetscSectionGetOffset(globalSection, p, &goff);CHKERRQ(ierr);
4428     if (!gdof) continue; /* Censored point */
4429     gsize = gdof < 0 ? -(gdof+1)-gcdof : gdof-gcdof;
4430     if (gsize != dof-cdof) {
4431       if (gsize != dof) SETERRQ4(comm, PETSC_ERR_ARG_WRONG, "Global dof %d for point %d is neither the constrained size %d, nor the unconstrained %d", gsize, p, dof-cdof, dof);
4432       cdof = 0; /* Ignore constraints */
4433     }
4434     for (d = 0, c = 0; d < dof; ++d) {
4435       if ((c < cdof) && (cind[c] == d)) {++c; continue;}
4436       local[l+d-c] = off+d;
4437     }
4438     if (gdof < 0) {
4439       for (d = 0; d < gsize; ++d, ++l) {
4440         PetscInt offset = -(goff+1) + d, r;
4441 
4442         ierr = PetscFindInt(offset,size+1,ranges,&r);CHKERRQ(ierr);
4443         if (r < 0) r = -(r+2);
4444         if ((r < 0) || (r >= size)) SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Point %d mapped to invalid process %d (%d, %d)", p, r, gdof, goff);
4445         remote[l].rank  = r;
4446         remote[l].index = offset - ranges[r];
4447       }
4448     } else {
4449       for (d = 0; d < gsize; ++d, ++l) {
4450         remote[l].rank  = rank;
4451         remote[l].index = goff+d - ranges[rank];
4452       }
4453     }
4454   }
4455   if (l != nleaves) SETERRQ2(comm, PETSC_ERR_PLIB, "Iteration error, l %d != nleaves %d", l, nleaves);
4456   ierr = PetscLayoutDestroy(&layout);CHKERRQ(ierr);
4457   ierr = PetscSFSetGraph(dm->sectionSF, nroots, nleaves, local, PETSC_OWN_POINTER, remote, PETSC_OWN_POINTER);CHKERRQ(ierr);
4458   PetscFunctionReturn(0);
4459 }
4460 
4461 /*@
4462   DMGetPointSF - Get the PetscSF encoding the parallel section point overlap for the DM.
4463 
4464   Input Parameter:
4465 . dm - The DM
4466 
4467   Output Parameter:
4468 . sf - The PetscSF
4469 
4470   Level: intermediate
4471 
4472   Note: This gets a borrowed reference, so the user should not destroy this PetscSF.
4473 
4474 .seealso: DMSetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4475 @*/
4476 PetscErrorCode DMGetPointSF(DM dm, PetscSF *sf)
4477 {
4478   PetscFunctionBegin;
4479   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4480   PetscValidPointer(sf, 2);
4481   *sf = dm->sf;
4482   PetscFunctionReturn(0);
4483 }
4484 
4485 /*@
4486   DMSetPointSF - Set the PetscSF encoding the parallel section point overlap for the DM.
4487 
4488   Input Parameters:
4489 + dm - The DM
4490 - sf - The PetscSF
4491 
4492   Level: intermediate
4493 
4494 .seealso: DMGetPointSF(), DMGetSectionSF(), DMSetSectionSF(), DMCreateSectionSF()
4495 @*/
4496 PetscErrorCode DMSetPointSF(DM dm, PetscSF sf)
4497 {
4498   PetscErrorCode ierr;
4499 
4500   PetscFunctionBegin;
4501   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4502   if (sf) PetscValidHeaderSpecific(sf, PETSCSF_CLASSID, 2);
4503   ierr = PetscObjectReference((PetscObject) sf);CHKERRQ(ierr);
4504   ierr = PetscSFDestroy(&dm->sf);CHKERRQ(ierr);
4505   dm->sf = sf;
4506   PetscFunctionReturn(0);
4507 }
4508 
4509 static PetscErrorCode DMSetDefaultAdjacency_Private(DM dm, PetscInt f, PetscObject disc)
4510 {
4511   PetscClassId   id;
4512   PetscErrorCode ierr;
4513 
4514   PetscFunctionBegin;
4515   ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
4516   if (id == PETSCFE_CLASSID) {
4517     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
4518   } else if (id == PETSCFV_CLASSID) {
4519     ierr = DMSetAdjacency(dm, f, PETSC_TRUE, PETSC_FALSE);CHKERRQ(ierr);
4520   } else {
4521     ierr = DMSetAdjacency(dm, f, PETSC_FALSE, PETSC_TRUE);CHKERRQ(ierr);
4522   }
4523   PetscFunctionReturn(0);
4524 }
4525 
4526 static PetscErrorCode DMFieldEnlarge_Static(DM dm, PetscInt NfNew)
4527 {
4528   RegionField   *tmpr;
4529   PetscInt       Nf = dm->Nf, f;
4530   PetscErrorCode ierr;
4531 
4532   PetscFunctionBegin;
4533   if (Nf >= NfNew) PetscFunctionReturn(0);
4534   ierr = PetscMalloc1(NfNew, &tmpr);CHKERRQ(ierr);
4535   for (f = 0; f < Nf; ++f) tmpr[f] = dm->fields[f];
4536   for (f = Nf; f < NfNew; ++f) {tmpr[f].disc = NULL; tmpr[f].label = NULL;}
4537   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
4538   dm->Nf     = NfNew;
4539   dm->fields = tmpr;
4540   PetscFunctionReturn(0);
4541 }
4542 
4543 /*@
4544   DMClearFields - Remove all fields from the DM
4545 
4546   Logically collective on dm
4547 
4548   Input Parameter:
4549 . dm - The DM
4550 
4551   Level: intermediate
4552 
4553 .seealso: DMGetNumFields(), DMSetNumFields(), DMSetField()
4554 @*/
4555 PetscErrorCode DMClearFields(DM dm)
4556 {
4557   PetscInt       f;
4558   PetscErrorCode ierr;
4559 
4560   PetscFunctionBegin;
4561   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4562   for (f = 0; f < dm->Nf; ++f) {
4563     ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4564     ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4565   }
4566   ierr = PetscFree(dm->fields);CHKERRQ(ierr);
4567   dm->fields = NULL;
4568   dm->Nf     = 0;
4569   PetscFunctionReturn(0);
4570 }
4571 
4572 /*@
4573   DMGetNumFields - Get the number of fields in the DM
4574 
4575   Not collective
4576 
4577   Input Parameter:
4578 . dm - The DM
4579 
4580   Output Parameter:
4581 . Nf - The number of fields
4582 
4583   Level: intermediate
4584 
4585 .seealso: DMSetNumFields(), DMSetField()
4586 @*/
4587 PetscErrorCode DMGetNumFields(DM dm, PetscInt *numFields)
4588 {
4589   PetscFunctionBegin;
4590   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4591   PetscValidIntPointer(numFields, 2);
4592   *numFields = dm->Nf;
4593   PetscFunctionReturn(0);
4594 }
4595 
4596 /*@
4597   DMSetNumFields - Set the number of fields in the DM
4598 
4599   Logically collective on dm
4600 
4601   Input Parameters:
4602 + dm - The DM
4603 - Nf - The number of fields
4604 
4605   Level: intermediate
4606 
4607 .seealso: DMGetNumFields(), DMSetField()
4608 @*/
4609 PetscErrorCode DMSetNumFields(DM dm, PetscInt numFields)
4610 {
4611   PetscInt       Nf, f;
4612   PetscErrorCode ierr;
4613 
4614   PetscFunctionBegin;
4615   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4616   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4617   for (f = Nf; f < numFields; ++f) {
4618     PetscContainer obj;
4619 
4620     ierr = PetscContainerCreate(PetscObjectComm((PetscObject) dm), &obj);CHKERRQ(ierr);
4621     ierr = DMAddField(dm, NULL, (PetscObject) obj);CHKERRQ(ierr);
4622     ierr = PetscContainerDestroy(&obj);CHKERRQ(ierr);
4623   }
4624   PetscFunctionReturn(0);
4625 }
4626 
4627 /*@
4628   DMGetField - Return the discretization object for a given DM field
4629 
4630   Not collective
4631 
4632   Input Parameters:
4633 + dm - The DM
4634 - f  - The field number
4635 
4636   Output Parameters:
4637 + label - The label indicating the support of the field, or NULL for the entire mesh
4638 - field - The discretization object
4639 
4640   Level: intermediate
4641 
4642 .seealso: DMAddField(), DMSetField()
4643 @*/
4644 PetscErrorCode DMGetField(DM dm, PetscInt f, DMLabel *label, PetscObject *field)
4645 {
4646   PetscFunctionBegin;
4647   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4648   PetscValidPointer(field, 3);
4649   if ((f < 0) || (f >= dm->Nf)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, dm->Nf);
4650   if (label) *label = dm->fields[f].label;
4651   if (field) *field = dm->fields[f].disc;
4652   PetscFunctionReturn(0);
4653 }
4654 
4655 /*@
4656   DMSetField - Set the discretization object for a given DM field
4657 
4658   Logically collective on dm
4659 
4660   Input Parameters:
4661 + dm    - The DM
4662 . f     - The field number
4663 . label - The label indicating the support of the field, or NULL for the entire mesh
4664 - field - The discretization object
4665 
4666   Level: intermediate
4667 
4668 .seealso: DMAddField(), DMGetField()
4669 @*/
4670 PetscErrorCode DMSetField(DM dm, PetscInt f, DMLabel label, PetscObject field)
4671 {
4672   PetscErrorCode ierr;
4673 
4674   PetscFunctionBegin;
4675   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4676   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
4677   PetscValidHeader(field, 4);
4678   if (f < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be non-negative", f);
4679   ierr = DMFieldEnlarge_Static(dm, f+1);CHKERRQ(ierr);
4680   ierr = DMLabelDestroy(&dm->fields[f].label);CHKERRQ(ierr);
4681   ierr = PetscObjectDestroy(&dm->fields[f].disc);CHKERRQ(ierr);
4682   dm->fields[f].label = label;
4683   dm->fields[f].disc  = field;
4684   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4685   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4686   ierr = DMSetDefaultAdjacency_Private(dm, f, field);CHKERRQ(ierr);
4687   ierr = DMClearDS(dm);CHKERRQ(ierr);
4688   PetscFunctionReturn(0);
4689 }
4690 
4691 /*@
4692   DMAddField - Add the discretization object for the given DM field
4693 
4694   Logically collective on dm
4695 
4696   Input Parameters:
4697 + dm    - The DM
4698 . label - The label indicating the support of the field, or NULL for the entire mesh
4699 - field - The discretization object
4700 
4701   Level: intermediate
4702 
4703 .seealso: DMSetField(), DMGetField()
4704 @*/
4705 PetscErrorCode DMAddField(DM dm, DMLabel label, PetscObject field)
4706 {
4707   PetscInt       Nf = dm->Nf;
4708   PetscErrorCode ierr;
4709 
4710   PetscFunctionBegin;
4711   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4712   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 3);
4713   PetscValidHeader(field, 3);
4714   ierr = DMFieldEnlarge_Static(dm, Nf+1);CHKERRQ(ierr);
4715   dm->fields[Nf].label = label;
4716   dm->fields[Nf].disc  = field;
4717   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
4718   ierr = PetscObjectReference((PetscObject) field);CHKERRQ(ierr);
4719   ierr = DMSetDefaultAdjacency_Private(dm, Nf, field);CHKERRQ(ierr);
4720   ierr = DMClearDS(dm);CHKERRQ(ierr);
4721   PetscFunctionReturn(0);
4722 }
4723 
4724 /*@
4725   DMCopyFields - Copy the discretizations for the DM into another DM
4726 
4727   Collective on dm
4728 
4729   Input Parameter:
4730 . dm - The DM
4731 
4732   Output Parameter:
4733 . newdm - The DM
4734 
4735   Level: advanced
4736 
4737 .seealso: DMGetField(), DMSetField(), DMAddField(), DMCopyDS(), DMGetDS(), DMGetCellDS()
4738 @*/
4739 PetscErrorCode DMCopyFields(DM dm, DM newdm)
4740 {
4741   PetscInt       Nf, f;
4742   PetscErrorCode ierr;
4743 
4744   PetscFunctionBegin;
4745   if (dm == newdm) PetscFunctionReturn(0);
4746   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4747   ierr = DMClearFields(newdm);CHKERRQ(ierr);
4748   for (f = 0; f < Nf; ++f) {
4749     DMLabel     label;
4750     PetscObject field;
4751     PetscBool   useCone, useClosure;
4752 
4753     ierr = DMGetField(dm, f, &label, &field);CHKERRQ(ierr);
4754     ierr = DMSetField(newdm, f, label, field);CHKERRQ(ierr);
4755     ierr = DMGetAdjacency(dm, f, &useCone, &useClosure);CHKERRQ(ierr);
4756     ierr = DMSetAdjacency(newdm, f, useCone, useClosure);CHKERRQ(ierr);
4757   }
4758   PetscFunctionReturn(0);
4759 }
4760 
4761 /*@
4762   DMGetAdjacency - Returns the flags for determining variable influence
4763 
4764   Not collective
4765 
4766   Input Parameters:
4767 + dm - The DM object
4768 - f  - The field number, or PETSC_DEFAULT for the default adjacency
4769 
4770   Output Parameter:
4771 + useCone    - Flag for variable influence starting with the cone operation
4772 - useClosure - Flag for variable influence using transitive closure
4773 
4774   Notes:
4775 $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
4776 $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
4777 $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4778   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
4779 
4780   Level: developer
4781 
4782 .seealso: DMSetAdjacency(), DMGetField(), DMSetField()
4783 @*/
4784 PetscErrorCode DMGetAdjacency(DM dm, PetscInt f, PetscBool *useCone, PetscBool *useClosure)
4785 {
4786   PetscFunctionBegin;
4787   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4788   if (useCone)    PetscValidBoolPointer(useCone, 3);
4789   if (useClosure) PetscValidBoolPointer(useClosure, 4);
4790   if (f < 0) {
4791     if (useCone)    *useCone    = dm->adjacency[0];
4792     if (useClosure) *useClosure = dm->adjacency[1];
4793   } else {
4794     PetscInt       Nf;
4795     PetscErrorCode ierr;
4796 
4797     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4798     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
4799     if (useCone)    *useCone    = dm->fields[f].adjacency[0];
4800     if (useClosure) *useClosure = dm->fields[f].adjacency[1];
4801   }
4802   PetscFunctionReturn(0);
4803 }
4804 
4805 /*@
4806   DMSetAdjacency - Set the flags for determining variable influence
4807 
4808   Not collective
4809 
4810   Input Parameters:
4811 + dm         - The DM object
4812 . f          - The field number
4813 . useCone    - Flag for variable influence starting with the cone operation
4814 - useClosure - Flag for variable influence using transitive closure
4815 
4816   Notes:
4817 $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
4818 $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
4819 $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4820   Further explanation can be found in the User's Manual Section on the Influence of Variables on One Another.
4821 
4822   Level: developer
4823 
4824 .seealso: DMGetAdjacency(), DMGetField(), DMSetField()
4825 @*/
4826 PetscErrorCode DMSetAdjacency(DM dm, PetscInt f, PetscBool useCone, PetscBool useClosure)
4827 {
4828   PetscFunctionBegin;
4829   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4830   if (f < 0) {
4831     dm->adjacency[0] = useCone;
4832     dm->adjacency[1] = useClosure;
4833   } else {
4834     PetscInt       Nf;
4835     PetscErrorCode ierr;
4836 
4837     ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4838     if (f >= Nf) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Field number %d must be in [0, %d)", f, Nf);
4839     dm->fields[f].adjacency[0] = useCone;
4840     dm->fields[f].adjacency[1] = useClosure;
4841   }
4842   PetscFunctionReturn(0);
4843 }
4844 
4845 /*@
4846   DMGetBasicAdjacency - Returns the flags for determining variable influence, using either the default or field 0 if it is defined
4847 
4848   Not collective
4849 
4850   Input Parameters:
4851 . dm - The DM object
4852 
4853   Output Parameter:
4854 + useCone    - Flag for variable influence starting with the cone operation
4855 - useClosure - Flag for variable influence using transitive closure
4856 
4857   Notes:
4858 $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
4859 $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
4860 $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4861 
4862   Level: developer
4863 
4864 .seealso: DMSetBasicAdjacency(), DMGetField(), DMSetField()
4865 @*/
4866 PetscErrorCode DMGetBasicAdjacency(DM dm, PetscBool *useCone, PetscBool *useClosure)
4867 {
4868   PetscInt       Nf;
4869   PetscErrorCode ierr;
4870 
4871   PetscFunctionBegin;
4872   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4873   if (useCone)    PetscValidBoolPointer(useCone, 3);
4874   if (useClosure) PetscValidBoolPointer(useClosure, 4);
4875   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4876   if (!Nf) {
4877     ierr = DMGetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
4878   } else {
4879     ierr = DMGetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
4880   }
4881   PetscFunctionReturn(0);
4882 }
4883 
4884 /*@
4885   DMSetBasicAdjacency - Set the flags for determining variable influence, using either the default or field 0 if it is defined
4886 
4887   Not collective
4888 
4889   Input Parameters:
4890 + dm         - The DM object
4891 . useCone    - Flag for variable influence starting with the cone operation
4892 - useClosure - Flag for variable influence using transitive closure
4893 
4894   Notes:
4895 $     FEM:   Two points p and q are adjacent if q \in closure(star(p)),   useCone = PETSC_FALSE, useClosure = PETSC_TRUE
4896 $     FVM:   Two points p and q are adjacent if q \in support(p+cone(p)), useCone = PETSC_TRUE,  useClosure = PETSC_FALSE
4897 $     FVM++: Two points p and q are adjacent if q \in star(closure(p)),   useCone = PETSC_TRUE,  useClosure = PETSC_TRUE
4898 
4899   Level: developer
4900 
4901 .seealso: DMGetBasicAdjacency(), DMGetField(), DMSetField()
4902 @*/
4903 PetscErrorCode DMSetBasicAdjacency(DM dm, PetscBool useCone, PetscBool useClosure)
4904 {
4905   PetscInt       Nf;
4906   PetscErrorCode ierr;
4907 
4908   PetscFunctionBegin;
4909   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4910   ierr = DMGetNumFields(dm, &Nf);CHKERRQ(ierr);
4911   if (!Nf) {
4912     ierr = DMSetAdjacency(dm, PETSC_DEFAULT, useCone, useClosure);CHKERRQ(ierr);
4913   } else {
4914     ierr = DMSetAdjacency(dm, 0, useCone, useClosure);CHKERRQ(ierr);
4915   }
4916   PetscFunctionReturn(0);
4917 }
4918 
4919 /* Complete labels that are being used for FEM BC */
4920 static PetscErrorCode DMCompleteBoundaryLabel_Internal(DM dm, PetscDS ds, PetscInt field, PetscInt bdNum, const char labelname[])
4921 {
4922   DMLabel        label;
4923   PetscObject    obj;
4924   PetscClassId   id;
4925   PetscInt       Nbd, bd;
4926   PetscBool      isFE      = PETSC_FALSE;
4927   PetscBool      duplicate = PETSC_FALSE;
4928   PetscErrorCode ierr;
4929 
4930   PetscFunctionBegin;
4931   ierr = DMGetField(dm, field, NULL, &obj);CHKERRQ(ierr);
4932   ierr = PetscObjectGetClassId(obj, &id);CHKERRQ(ierr);
4933   if (id == PETSCFE_CLASSID) isFE = PETSC_TRUE;
4934   ierr = DMGetLabel(dm, labelname, &label);CHKERRQ(ierr);
4935   if (isFE && label) {
4936     /* Only want to modify label once */
4937     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
4938     for (bd = 0; bd < PetscMin(Nbd, bdNum); ++bd) {
4939       const char *lname;
4940 
4941       ierr = PetscDSGetBoundary(ds, bd, NULL, NULL, &lname, NULL, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
4942       ierr = PetscStrcmp(lname, labelname, &duplicate);CHKERRQ(ierr);
4943       if (duplicate) break;
4944     }
4945     if (!duplicate) {
4946       DM plex;
4947 
4948       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
4949       if (plex) {ierr = DMPlexLabelComplete(plex, label);CHKERRQ(ierr);}
4950       ierr = DMDestroy(&plex);CHKERRQ(ierr);
4951     }
4952   }
4953   PetscFunctionReturn(0);
4954 }
4955 
4956 static PetscErrorCode DMDSEnlarge_Static(DM dm, PetscInt NdsNew)
4957 {
4958   DMSpace       *tmpd;
4959   PetscInt       Nds = dm->Nds, s;
4960   PetscErrorCode ierr;
4961 
4962   PetscFunctionBegin;
4963   if (Nds >= NdsNew) PetscFunctionReturn(0);
4964   ierr = PetscMalloc1(NdsNew, &tmpd);CHKERRQ(ierr);
4965   for (s = 0; s < Nds; ++s) tmpd[s] = dm->probs[s];
4966   for (s = Nds; s < NdsNew; ++s) {tmpd[s].ds = NULL; tmpd[s].label = NULL; tmpd[s].fields = NULL;}
4967   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
4968   dm->Nds   = NdsNew;
4969   dm->probs = tmpd;
4970   PetscFunctionReturn(0);
4971 }
4972 
4973 /*@
4974   DMGetNumDS - Get the number of discrete systems in the DM
4975 
4976   Not collective
4977 
4978   Input Parameter:
4979 . dm - The DM
4980 
4981   Output Parameter:
4982 . Nds - The number of PetscDS objects
4983 
4984   Level: intermediate
4985 
4986 .seealso: DMGetDS(), DMGetCellDS()
4987 @*/
4988 PetscErrorCode DMGetNumDS(DM dm, PetscInt *Nds)
4989 {
4990   PetscFunctionBegin;
4991   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
4992   PetscValidIntPointer(Nds, 2);
4993   *Nds = dm->Nds;
4994   PetscFunctionReturn(0);
4995 }
4996 
4997 /*@
4998   DMClearDS - Remove all discrete systems from the DM
4999 
5000   Logically collective on dm
5001 
5002   Input Parameter:
5003 . dm - The DM
5004 
5005   Level: intermediate
5006 
5007 .seealso: DMGetNumDS(), DMGetDS(), DMSetField()
5008 @*/
5009 PetscErrorCode DMClearDS(DM dm)
5010 {
5011   PetscInt       s;
5012   PetscErrorCode ierr;
5013 
5014   PetscFunctionBegin;
5015   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5016   for (s = 0; s < dm->Nds; ++s) {
5017     ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5018     ierr = DMLabelDestroy(&dm->probs[s].label);CHKERRQ(ierr);
5019     ierr = ISDestroy(&dm->probs[s].fields);CHKERRQ(ierr);
5020   }
5021   ierr = PetscFree(dm->probs);CHKERRQ(ierr);
5022   dm->probs = NULL;
5023   dm->Nds   = 0;
5024   PetscFunctionReturn(0);
5025 }
5026 
5027 /*@
5028   DMGetDS - Get the default PetscDS
5029 
5030   Not collective
5031 
5032   Input Parameter:
5033 . dm    - The DM
5034 
5035   Output Parameter:
5036 . prob - The default PetscDS
5037 
5038   Level: intermediate
5039 
5040 .seealso: DMGetCellDS(), DMGetRegionDS()
5041 @*/
5042 PetscErrorCode DMGetDS(DM dm, PetscDS *prob)
5043 {
5044   PetscErrorCode ierr;
5045 
5046   PetscFunctionBeginHot;
5047   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5048   PetscValidPointer(prob, 2);
5049   if (dm->Nds <= 0) {
5050     PetscDS ds;
5051 
5052     ierr = PetscDSCreate(PetscObjectComm((PetscObject) dm), &ds);CHKERRQ(ierr);
5053     ierr = DMSetRegionDS(dm, NULL, NULL, ds);CHKERRQ(ierr);
5054     ierr = PetscDSDestroy(&ds);CHKERRQ(ierr);
5055   }
5056   *prob = dm->probs[0].ds;
5057   PetscFunctionReturn(0);
5058 }
5059 
5060 /*@
5061   DMGetCellDS - Get the PetscDS defined on a given cell
5062 
5063   Not collective
5064 
5065   Input Parameters:
5066 + dm    - The DM
5067 - point - Cell for the DS
5068 
5069   Output Parameter:
5070 . prob - The PetscDS defined on the given cell
5071 
5072   Level: developer
5073 
5074 .seealso: DMGetDS(), DMSetRegionDS()
5075 @*/
5076 PetscErrorCode DMGetCellDS(DM dm, PetscInt point, PetscDS *prob)
5077 {
5078   PetscDS        probDef = NULL;
5079   PetscInt       s;
5080   PetscErrorCode ierr;
5081 
5082   PetscFunctionBeginHot;
5083   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5084   PetscValidPointer(prob, 3);
5085   if (point < 0) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Mesh point cannot be negative: %D", point);
5086   *prob = NULL;
5087   for (s = 0; s < dm->Nds; ++s) {
5088     PetscInt val;
5089 
5090     if (!dm->probs[s].label) {probDef = dm->probs[s].ds;}
5091     else {
5092       ierr = DMLabelGetValue(dm->probs[s].label, point, &val);CHKERRQ(ierr);
5093       if (val >= 0) {*prob = dm->probs[s].ds; break;}
5094     }
5095   }
5096   if (!*prob) *prob = probDef;
5097   PetscFunctionReturn(0);
5098 }
5099 
5100 /*@
5101   DMGetRegionDS - Get the PetscDS for a given mesh region, defined by a DMLabel
5102 
5103   Not collective
5104 
5105   Input Parameters:
5106 + dm    - The DM
5107 - label - The DMLabel defining the mesh region, or NULL for the entire mesh
5108 
5109   Output Parameters:
5110 + fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5111 - prob - The PetscDS defined on the given region, or NULL
5112 
5113   Note: If the label is missing, this function returns an error
5114 
5115   Level: advanced
5116 
5117 .seealso: DMGetRegionNumDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5118 @*/
5119 PetscErrorCode DMGetRegionDS(DM dm, DMLabel label, IS *fields, PetscDS *ds)
5120 {
5121   PetscInt Nds = dm->Nds, s;
5122 
5123   PetscFunctionBegin;
5124   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5125   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5126   if (fields) {PetscValidPointer(fields, 3); *fields = NULL;}
5127   if (ds)     {PetscValidPointer(ds, 4);     *ds     = NULL;}
5128   for (s = 0; s < Nds; ++s) {
5129     if (dm->probs[s].label == label) {
5130       if (fields) *fields = dm->probs[s].fields;
5131       if (ds)     *ds     = dm->probs[s].ds;
5132       PetscFunctionReturn(0);
5133     }
5134   }
5135   PetscFunctionReturn(0);
5136 }
5137 
5138 /*@
5139   DMGetRegionNumDS - Get the PetscDS for a given mesh region, defined by the region number
5140 
5141   Not collective
5142 
5143   Input Parameters:
5144 + dm  - The DM
5145 - num - The region number, in [0, Nds)
5146 
5147   Output Parameters:
5148 + label  - The region label, or NULL
5149 . fields - The IS containing the DM field numbers for the fields in this DS, or NULL
5150 - prob   - The PetscDS defined on the given region, or NULL
5151 
5152   Level: advanced
5153 
5154 .seealso: DMGetRegionDS(), DMSetRegionDS(), DMGetDS(), DMGetCellDS()
5155 @*/
5156 PetscErrorCode DMGetRegionNumDS(DM dm, PetscInt num, DMLabel *label, IS *fields, PetscDS *ds)
5157 {
5158   PetscInt       Nds;
5159   PetscErrorCode ierr;
5160 
5161   PetscFunctionBegin;
5162   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5163   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5164   if ((num < 0) || (num >= Nds)) SETERRQ2(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Region number %D is not in [0, %D)", num, Nds);
5165   if (label) {
5166     PetscValidPointer(label, 3);
5167     *label = dm->probs[num].label;
5168   }
5169   if (fields) {
5170     PetscValidPointer(fields, 4);
5171     *fields = dm->probs[num].fields;
5172   }
5173   if (ds) {
5174     PetscValidPointer(ds, 5);
5175     *ds = dm->probs[num].ds;
5176   }
5177   PetscFunctionReturn(0);
5178 }
5179 
5180 /*@
5181   DMSetRegionDS - Set the PetscDS for a given mesh region, defined by a DMLabel
5182 
5183   Collective on dm
5184 
5185   Input Parameters:
5186 + dm     - The DM
5187 . label  - The DMLabel defining the mesh region, or NULL for the entire mesh
5188 . fields - The IS containing the DM field numbers for the fields in this DS, or NULL for all fields
5189 - prob   - The PetscDS defined on the given cell
5190 
5191   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM. If DS is replaced,
5192   the fields argument is ignored.
5193 
5194   Level: advanced
5195 
5196 .seealso: DMGetRegionDS(), DMGetDS(), DMGetCellDS()
5197 @*/
5198 PetscErrorCode DMSetRegionDS(DM dm, DMLabel label, IS fields, PetscDS ds)
5199 {
5200   PetscInt       Nds = dm->Nds, s;
5201   PetscErrorCode ierr;
5202 
5203   PetscFunctionBegin;
5204   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5205   if (label) PetscValidHeaderSpecific(label, DMLABEL_CLASSID, 2);
5206   PetscValidHeaderSpecific(ds, PETSCDS_CLASSID, 3);
5207   for (s = 0; s < Nds; ++s) {
5208     if (dm->probs[s].label == label) {
5209       ierr = PetscDSDestroy(&dm->probs[s].ds);CHKERRQ(ierr);
5210       ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5211       ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5212       dm->probs[s].fields = fields;
5213       dm->probs[s].ds     = ds;
5214       PetscFunctionReturn(0);
5215     }
5216   }
5217   ierr = DMDSEnlarge_Static(dm, Nds+1);CHKERRQ(ierr);
5218   ierr = PetscObjectReference((PetscObject) label);CHKERRQ(ierr);
5219   ierr = PetscObjectReference((PetscObject) fields);CHKERRQ(ierr);
5220   ierr = PetscObjectReference((PetscObject) ds);CHKERRQ(ierr);
5221   if (!label) {
5222     /* Put the NULL label at the front, so it is returned as the default */
5223     for (s = Nds-1; s >=0; --s) dm->probs[s+1] = dm->probs[s];
5224     Nds = 0;
5225   }
5226   dm->probs[Nds].label  = label;
5227   dm->probs[Nds].fields = fields;
5228   dm->probs[Nds].ds     = ds;
5229   PetscFunctionReturn(0);
5230 }
5231 
5232 /*@
5233   DMCreateDS - Create the discrete systems for the DM based upon the fields added to the DM
5234 
5235   Collective on dm
5236 
5237   Input Parameter:
5238 . dm - The DM
5239 
5240   Note: If the label has a DS defined, it will be replaced. Otherwise, it will be added to the DM.
5241 
5242   Level: intermediate
5243 
5244 .seealso: DMSetField, DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5245 @*/
5246 PetscErrorCode DMCreateDS(DM dm)
5247 {
5248   MPI_Comm       comm;
5249   PetscDS        prob, probh = NULL;
5250   PetscInt       dimEmbed, Nf = dm->Nf, f, s, field = 0, fieldh = 0;
5251   PetscBool      doSetup = PETSC_TRUE;
5252   PetscErrorCode ierr;
5253 
5254   PetscFunctionBegin;
5255   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5256   if (!dm->fields) PetscFunctionReturn(0);
5257   if (dm->Nds > 1) PetscFunctionReturn(0);
5258   /* Can only handle two label cases right now:
5259    1) NULL
5260    2) Hybrid cells
5261   */
5262   ierr = PetscObjectGetComm((PetscObject) dm, &comm);CHKERRQ(ierr);
5263   ierr = DMGetCoordinateDim(dm, &dimEmbed);CHKERRQ(ierr);
5264   /* Create default DS */
5265   ierr = DMGetRegionDS(dm, NULL, NULL, &prob);CHKERRQ(ierr);
5266   if (!prob) {
5267     IS        fields;
5268     PetscInt *fld, nf;
5269 
5270     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) ++nf;
5271     ierr = PetscMalloc1(nf, &fld);CHKERRQ(ierr);
5272     for (f = 0, nf = 0; f < Nf; ++f) if (!dm->fields[f].label) fld[nf++] = f;
5273     ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5274     ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5275     ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5276     ierr = ISGeneralSetIndices(fields, nf, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5277 
5278     ierr = PetscDSCreate(comm, &prob);CHKERRQ(ierr);
5279     ierr = DMSetRegionDS(dm, NULL, fields, prob);CHKERRQ(ierr);
5280     ierr = PetscDSDestroy(&prob);CHKERRQ(ierr);
5281     ierr = ISDestroy(&fields);CHKERRQ(ierr);
5282     ierr = DMGetRegionDS(dm, NULL, NULL, &prob);CHKERRQ(ierr);
5283   }
5284   ierr = PetscDSSetCoordinateDimension(prob, dimEmbed);CHKERRQ(ierr);
5285   /* Optionally create hybrid DS */
5286   for (f = 0; f < Nf; ++f) {
5287     DMLabel  label = dm->fields[f].label;
5288     PetscInt lStart, lEnd;
5289 
5290     if (label) {
5291       DM             plex;
5292       DMPolytopeType ct;
5293       IS             fields;
5294       PetscInt      *fld;
5295       PetscInt       depth;
5296 
5297       ierr = DMConvert(dm, DMPLEX, &plex);CHKERRQ(ierr);
5298       ierr = DMPlexGetDepth(plex, &depth);CHKERRQ(ierr);
5299       ierr = DMDestroy(&plex);CHKERRQ(ierr);
5300 
5301       ierr = DMLabelGetBounds(label, &lStart, &lEnd);CHKERRQ(ierr);
5302       if (lStart >= 0) {
5303         ierr = DMPlexGetCellType(dm, lStart, &ct);CHKERRQ(ierr);
5304         switch (ct) {
5305           case DM_POLYTOPE_POINT_PRISM_TENSOR:
5306           case DM_POLYTOPE_SEG_PRISM_TENSOR:
5307           case DM_POLYTOPE_TRI_PRISM_TENSOR:
5308           case DM_POLYTOPE_QUAD_PRISM_TENSOR:
5309             break;
5310             default: SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Only support labels over tensor prism cells right now");
5311         }
5312       }
5313       ierr = PetscDSCreate(comm, &probh);CHKERRQ(ierr);
5314       ierr = PetscMalloc1(1, &fld);CHKERRQ(ierr);
5315       fld[0] = f;
5316       ierr = ISCreate(PETSC_COMM_SELF, &fields);CHKERRQ(ierr);
5317       ierr = PetscObjectSetOptionsPrefix((PetscObject) fields, "dm_fields_");CHKERRQ(ierr);
5318       ierr = ISSetType(fields, ISGENERAL);CHKERRQ(ierr);
5319       ierr = ISGeneralSetIndices(fields, 1, fld, PETSC_OWN_POINTER);CHKERRQ(ierr);
5320       ierr = DMSetRegionDS(dm, label, fields, probh);CHKERRQ(ierr);
5321       ierr = ISDestroy(&fields);CHKERRQ(ierr);
5322       ierr = PetscDSSetHybrid(probh, PETSC_TRUE);CHKERRQ(ierr);
5323       ierr = PetscDSSetCoordinateDimension(probh, dimEmbed);CHKERRQ(ierr);
5324       break;
5325     }
5326   }
5327   /* Set fields in DSes */
5328   for (f = 0; f < Nf; ++f) {
5329     DMLabel     label = dm->fields[f].label;
5330     PetscObject disc  = dm->fields[f].disc;
5331 
5332     if (!label) {
5333       ierr = PetscDSSetDiscretization(prob,  field++,  disc);CHKERRQ(ierr);
5334       if (probh) {
5335         PetscFE subfe;
5336 
5337         ierr = PetscFEGetHeightSubspace((PetscFE) disc, 1, &subfe);CHKERRQ(ierr);
5338         ierr = PetscDSSetDiscretization(probh, fieldh++, (PetscObject) subfe);CHKERRQ(ierr);
5339       }
5340     } else {
5341       ierr = PetscDSSetDiscretization(probh, fieldh++, disc);CHKERRQ(ierr);
5342     }
5343     /* We allow people to have placeholder fields and construct the Section by hand */
5344     {
5345       PetscClassId id;
5346 
5347       ierr = PetscObjectGetClassId(disc, &id);CHKERRQ(ierr);
5348       if ((id != PETSCFE_CLASSID) && (id != PETSCFV_CLASSID)) doSetup = PETSC_FALSE;
5349     }
5350   }
5351   ierr = PetscDSDestroy(&probh);CHKERRQ(ierr);
5352   /* Setup DSes */
5353   if (doSetup) {
5354     for (s = 0; s < dm->Nds; ++s) {ierr = PetscDSSetUp(dm->probs[s].ds);CHKERRQ(ierr);}
5355   }
5356   PetscFunctionReturn(0);
5357 }
5358 
5359 /*@
5360   DMCopyDS - Copy the discrete systems for the DM into another DM
5361 
5362   Collective on dm
5363 
5364   Input Parameter:
5365 . dm - The DM
5366 
5367   Output Parameter:
5368 . newdm - The DM
5369 
5370   Level: advanced
5371 
5372 .seealso: DMCopyFields(), DMAddField(), DMGetDS(), DMGetCellDS(), DMGetRegionDS(), DMSetRegionDS()
5373 @*/
5374 PetscErrorCode DMCopyDS(DM dm, DM newdm)
5375 {
5376   PetscInt       Nds, s;
5377   PetscErrorCode ierr;
5378 
5379   PetscFunctionBegin;
5380   if (dm == newdm) PetscFunctionReturn(0);
5381   ierr = DMGetNumDS(dm, &Nds);CHKERRQ(ierr);
5382   ierr = DMClearDS(newdm);CHKERRQ(ierr);
5383   for (s = 0; s < Nds; ++s) {
5384     DMLabel  label;
5385     IS       fields;
5386     PetscDS  ds;
5387     PetscInt Nbd, bd;
5388 
5389     ierr = DMGetRegionNumDS(dm, s, &label, &fields, &ds);CHKERRQ(ierr);
5390     ierr = DMSetRegionDS(newdm, label, fields, ds);CHKERRQ(ierr);
5391     ierr = PetscDSGetNumBoundary(ds, &Nbd);CHKERRQ(ierr);
5392     for (bd = 0; bd < Nbd; ++bd) {
5393       const char *labelname, *name;
5394       PetscInt    field;
5395 
5396       /* Do not check if label exists here, since p4est calls this for the reference tree which does not have the labels */
5397       ierr = PetscDSGetBoundary(ds, bd, NULL, &name, &labelname, &field, NULL, NULL, NULL, NULL, NULL, NULL);CHKERRQ(ierr);
5398       ierr = DMCompleteBoundaryLabel_Internal(newdm, ds, field, bd, labelname);CHKERRQ(ierr);
5399     }
5400   }
5401   PetscFunctionReturn(0);
5402 }
5403 
5404 /*@
5405   DMCopyDisc - Copy the fields and discrete systems for the DM into another DM
5406 
5407   Collective on dm
5408 
5409   Input Parameter:
5410 . dm - The DM
5411 
5412   Output Parameter:
5413 . newdm - The DM
5414 
5415   Level: advanced
5416 
5417 .seealso: DMCopyFields(), DMCopyDS()
5418 @*/
5419 PetscErrorCode DMCopyDisc(DM dm, DM newdm)
5420 {
5421   PetscErrorCode ierr;
5422 
5423   PetscFunctionBegin;
5424   ierr = DMCopyFields(dm, newdm);CHKERRQ(ierr);
5425   ierr = DMCopyDS(dm, newdm);CHKERRQ(ierr);
5426   PetscFunctionReturn(0);
5427 }
5428 
5429 PetscErrorCode DMRestrictHook_Coordinates(DM dm,DM dmc,void *ctx)
5430 {
5431   DM dm_coord,dmc_coord;
5432   PetscErrorCode ierr;
5433   Vec coords,ccoords;
5434   Mat inject;
5435   PetscFunctionBegin;
5436   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
5437   ierr = DMGetCoordinateDM(dmc,&dmc_coord);CHKERRQ(ierr);
5438   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
5439   ierr = DMGetCoordinates(dmc,&ccoords);CHKERRQ(ierr);
5440   if (coords && !ccoords) {
5441     ierr = DMCreateGlobalVector(dmc_coord,&ccoords);CHKERRQ(ierr);
5442     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
5443     ierr = DMCreateInjection(dmc_coord,dm_coord,&inject);CHKERRQ(ierr);
5444     ierr = MatRestrict(inject,coords,ccoords);CHKERRQ(ierr);
5445     ierr = MatDestroy(&inject);CHKERRQ(ierr);
5446     ierr = DMSetCoordinates(dmc,ccoords);CHKERRQ(ierr);
5447     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
5448   }
5449   PetscFunctionReturn(0);
5450 }
5451 
5452 static PetscErrorCode DMSubDomainHook_Coordinates(DM dm,DM subdm,void *ctx)
5453 {
5454   DM dm_coord,subdm_coord;
5455   PetscErrorCode ierr;
5456   Vec coords,ccoords,clcoords;
5457   VecScatter *scat_i,*scat_g;
5458   PetscFunctionBegin;
5459   ierr = DMGetCoordinateDM(dm,&dm_coord);CHKERRQ(ierr);
5460   ierr = DMGetCoordinateDM(subdm,&subdm_coord);CHKERRQ(ierr);
5461   ierr = DMGetCoordinates(dm,&coords);CHKERRQ(ierr);
5462   ierr = DMGetCoordinates(subdm,&ccoords);CHKERRQ(ierr);
5463   if (coords && !ccoords) {
5464     ierr = DMCreateGlobalVector(subdm_coord,&ccoords);CHKERRQ(ierr);
5465     ierr = PetscObjectSetName((PetscObject)ccoords,"coordinates");CHKERRQ(ierr);
5466     ierr = DMCreateLocalVector(subdm_coord,&clcoords);CHKERRQ(ierr);
5467     ierr = PetscObjectSetName((PetscObject)clcoords,"coordinates");CHKERRQ(ierr);
5468     ierr = DMCreateDomainDecompositionScatters(dm_coord,1,&subdm_coord,NULL,&scat_i,&scat_g);CHKERRQ(ierr);
5469     ierr = VecScatterBegin(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
5470     ierr = VecScatterEnd(scat_i[0],coords,ccoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
5471     ierr = VecScatterBegin(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
5472     ierr = VecScatterEnd(scat_g[0],coords,clcoords,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
5473     ierr = DMSetCoordinates(subdm,ccoords);CHKERRQ(ierr);
5474     ierr = DMSetCoordinatesLocal(subdm,clcoords);CHKERRQ(ierr);
5475     ierr = VecScatterDestroy(&scat_i[0]);CHKERRQ(ierr);
5476     ierr = VecScatterDestroy(&scat_g[0]);CHKERRQ(ierr);
5477     ierr = VecDestroy(&ccoords);CHKERRQ(ierr);
5478     ierr = VecDestroy(&clcoords);CHKERRQ(ierr);
5479     ierr = PetscFree(scat_i);CHKERRQ(ierr);
5480     ierr = PetscFree(scat_g);CHKERRQ(ierr);
5481   }
5482   PetscFunctionReturn(0);
5483 }
5484 
5485 /*@
5486   DMGetDimension - Return the topological dimension of the DM
5487 
5488   Not collective
5489 
5490   Input Parameter:
5491 . dm - The DM
5492 
5493   Output Parameter:
5494 . dim - The topological dimension
5495 
5496   Level: beginner
5497 
5498 .seealso: DMSetDimension(), DMCreate()
5499 @*/
5500 PetscErrorCode DMGetDimension(DM dm, PetscInt *dim)
5501 {
5502   PetscFunctionBegin;
5503   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5504   PetscValidIntPointer(dim, 2);
5505   *dim = dm->dim;
5506   PetscFunctionReturn(0);
5507 }
5508 
5509 /*@
5510   DMSetDimension - Set the topological dimension of the DM
5511 
5512   Collective on dm
5513 
5514   Input Parameters:
5515 + dm - The DM
5516 - dim - The topological dimension
5517 
5518   Level: beginner
5519 
5520 .seealso: DMGetDimension(), DMCreate()
5521 @*/
5522 PetscErrorCode DMSetDimension(DM dm, PetscInt dim)
5523 {
5524   PetscDS        ds;
5525   PetscErrorCode ierr;
5526 
5527   PetscFunctionBegin;
5528   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5529   PetscValidLogicalCollectiveInt(dm, dim, 2);
5530   dm->dim = dim;
5531   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
5532   if (ds->dimEmbed < 0) {ierr = PetscDSSetCoordinateDimension(ds, dm->dim);CHKERRQ(ierr);}
5533   PetscFunctionReturn(0);
5534 }
5535 
5536 /*@
5537   DMGetDimPoints - Get the half-open interval for all points of a given dimension
5538 
5539   Collective on dm
5540 
5541   Input Parameters:
5542 + dm - the DM
5543 - dim - the dimension
5544 
5545   Output Parameters:
5546 + pStart - The first point of the given dimension
5547 - pEnd - The first point following points of the given dimension
5548 
5549   Note:
5550   The points are vertices in the Hasse diagram encoding the topology. This is explained in
5551   https://arxiv.org/abs/0908.4427. If no points exist of this dimension in the storage scheme,
5552   then the interval is empty.
5553 
5554   Level: intermediate
5555 
5556 .seealso: DMPLEX, DMPlexGetDepthStratum(), DMPlexGetHeightStratum()
5557 @*/
5558 PetscErrorCode DMGetDimPoints(DM dm, PetscInt dim, PetscInt *pStart, PetscInt *pEnd)
5559 {
5560   PetscInt       d;
5561   PetscErrorCode ierr;
5562 
5563   PetscFunctionBegin;
5564   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5565   ierr = DMGetDimension(dm, &d);CHKERRQ(ierr);
5566   if ((dim < 0) || (dim > d)) SETERRQ2(PetscObjectComm((PetscObject) dm), PETSC_ERR_ARG_OUTOFRANGE, "Invalid dimension %d 1", dim, d);
5567   if (!dm->ops->getdimpoints) SETERRQ1(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "DM type %s does not implement DMGetDimPoints",((PetscObject)dm)->type_name);
5568   ierr = (*dm->ops->getdimpoints)(dm, dim, pStart, pEnd);CHKERRQ(ierr);
5569   PetscFunctionReturn(0);
5570 }
5571 
5572 /*@
5573   DMSetCoordinates - Sets into the DM a global vector that holds the coordinates
5574 
5575   Collective on dm
5576 
5577   Input Parameters:
5578 + dm - the DM
5579 - c - coordinate vector
5580 
5581   Notes:
5582   The coordinates do include those for ghost points, which are in the local vector.
5583 
5584   The vector c should be destroyed by the caller.
5585 
5586   Level: intermediate
5587 
5588 .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
5589 @*/
5590 PetscErrorCode DMSetCoordinates(DM dm, Vec c)
5591 {
5592   PetscErrorCode ierr;
5593 
5594   PetscFunctionBegin;
5595   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5596   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
5597   ierr            = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
5598   ierr            = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
5599   dm->coordinates = c;
5600   ierr            = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
5601   ierr            = DMCoarsenHookAdd(dm,DMRestrictHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
5602   ierr            = DMSubDomainHookAdd(dm,DMSubDomainHook_Coordinates,NULL,NULL);CHKERRQ(ierr);
5603   PetscFunctionReturn(0);
5604 }
5605 
5606 /*@
5607   DMSetCoordinatesLocal - Sets into the DM a local vector that holds the coordinates
5608 
5609   Not collective
5610 
5611    Input Parameters:
5612 +  dm - the DM
5613 -  c - coordinate vector
5614 
5615   Notes:
5616   The coordinates of ghost points can be set using DMSetCoordinates()
5617   followed by DMGetCoordinatesLocal(). This is intended to enable the
5618   setting of ghost coordinates outside of the domain.
5619 
5620   The vector c should be destroyed by the caller.
5621 
5622   Level: intermediate
5623 
5624 .seealso: DMGetCoordinatesLocal(), DMSetCoordinates(), DMGetCoordinates(), DMGetCoordinateDM()
5625 @*/
5626 PetscErrorCode DMSetCoordinatesLocal(DM dm, Vec c)
5627 {
5628   PetscErrorCode ierr;
5629 
5630   PetscFunctionBegin;
5631   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5632   PetscValidHeaderSpecific(c,VEC_CLASSID,2);
5633   ierr = PetscObjectReference((PetscObject) c);CHKERRQ(ierr);
5634   ierr = VecDestroy(&dm->coordinatesLocal);CHKERRQ(ierr);
5635 
5636   dm->coordinatesLocal = c;
5637 
5638   ierr = VecDestroy(&dm->coordinates);CHKERRQ(ierr);
5639   PetscFunctionReturn(0);
5640 }
5641 
5642 /*@
5643   DMGetCoordinates - Gets a global vector with the coordinates associated with the DM.
5644 
5645   Collective on dm
5646 
5647   Input Parameter:
5648 . dm - the DM
5649 
5650   Output Parameter:
5651 . c - global coordinate vector
5652 
5653   Note:
5654   This is a borrowed reference, so the user should NOT destroy this vector
5655 
5656   Each process has only the local coordinates (does NOT have the ghost coordinates).
5657 
5658   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
5659   and (x_0,y_0,z_0,x_1,y_1,z_1...)
5660 
5661   Level: intermediate
5662 
5663 .seealso: DMSetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM()
5664 @*/
5665 PetscErrorCode DMGetCoordinates(DM dm, Vec *c)
5666 {
5667   PetscErrorCode ierr;
5668 
5669   PetscFunctionBegin;
5670   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5671   PetscValidPointer(c,2);
5672   if (!dm->coordinates && dm->coordinatesLocal) {
5673     DM        cdm = NULL;
5674     PetscBool localized;
5675 
5676     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
5677     ierr = DMCreateGlobalVector(cdm, &dm->coordinates);CHKERRQ(ierr);
5678     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
5679     /* Block size is not correctly set by CreateGlobalVector() if coordinates are localized */
5680     if (localized) {
5681       PetscInt cdim;
5682 
5683       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
5684       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
5685     }
5686     ierr = PetscObjectSetName((PetscObject) dm->coordinates, "coordinates");CHKERRQ(ierr);
5687     ierr = DMLocalToGlobalBegin(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
5688     ierr = DMLocalToGlobalEnd(cdm, dm->coordinatesLocal, INSERT_VALUES, dm->coordinates);CHKERRQ(ierr);
5689   }
5690   *c = dm->coordinates;
5691   PetscFunctionReturn(0);
5692 }
5693 
5694 /*@
5695   DMGetCoordinatesLocalSetUp - Prepares a local vector of coordinates, so that DMGetCoordinatesLocalNoncollective() can be used as non-collective afterwards.
5696 
5697   Collective on dm
5698 
5699   Input Parameter:
5700 . dm - the DM
5701 
5702   Level: advanced
5703 
5704 .seealso: DMGetCoordinatesLocalNoncollective()
5705 @*/
5706 PetscErrorCode DMGetCoordinatesLocalSetUp(DM dm)
5707 {
5708   PetscErrorCode ierr;
5709 
5710   PetscFunctionBegin;
5711   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5712   if (!dm->coordinatesLocal && dm->coordinates) {
5713     DM        cdm = NULL;
5714     PetscBool localized;
5715 
5716     ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
5717     ierr = DMCreateLocalVector(cdm, &dm->coordinatesLocal);CHKERRQ(ierr);
5718     ierr = DMGetCoordinatesLocalized(dm, &localized);CHKERRQ(ierr);
5719     /* Block size is not correctly set by CreateLocalVector() if coordinates are localized */
5720     if (localized) {
5721       PetscInt cdim;
5722 
5723       ierr = DMGetCoordinateDim(dm, &cdim);CHKERRQ(ierr);
5724       ierr = VecSetBlockSize(dm->coordinates, cdim);CHKERRQ(ierr);
5725     }
5726     ierr = PetscObjectSetName((PetscObject) dm->coordinatesLocal, "coordinates");CHKERRQ(ierr);
5727     ierr = DMGlobalToLocalBegin(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
5728     ierr = DMGlobalToLocalEnd(cdm, dm->coordinates, INSERT_VALUES, dm->coordinatesLocal);CHKERRQ(ierr);
5729   }
5730   PetscFunctionReturn(0);
5731 }
5732 
5733 /*@
5734   DMGetCoordinatesLocal - Gets a local vector with the coordinates associated with the DM.
5735 
5736   Collective on dm
5737 
5738   Input Parameter:
5739 . dm - the DM
5740 
5741   Output Parameter:
5742 . c - coordinate vector
5743 
5744   Note:
5745   This is a borrowed reference, so the user should NOT destroy this vector
5746 
5747   Each process has the local and ghost coordinates
5748 
5749   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
5750   and (x_0,y_0,z_0,x_1,y_1,z_1...)
5751 
5752   Level: intermediate
5753 
5754 .seealso: DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM(), DMGetCoordinatesLocalNoncollective()
5755 @*/
5756 PetscErrorCode DMGetCoordinatesLocal(DM dm, Vec *c)
5757 {
5758   PetscErrorCode ierr;
5759 
5760   PetscFunctionBegin;
5761   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5762   PetscValidPointer(c,2);
5763   ierr = DMGetCoordinatesLocalSetUp(dm);CHKERRQ(ierr);
5764   *c = dm->coordinatesLocal;
5765   PetscFunctionReturn(0);
5766 }
5767 
5768 /*@
5769   DMGetCoordinatesLocalNoncollective - Non-collective version of DMGetCoordinatesLocal(). Fails if global coordinates have been set and DMGetCoordinatesLocalSetUp() not called.
5770 
5771   Not collective
5772 
5773   Input Parameter:
5774 . dm - the DM
5775 
5776   Output Parameter:
5777 . c - coordinate vector
5778 
5779   Level: advanced
5780 
5781 .seealso: DMGetCoordinatesLocalSetUp(), DMGetCoordinatesLocal(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
5782 @*/
5783 PetscErrorCode DMGetCoordinatesLocalNoncollective(DM dm, Vec *c)
5784 {
5785   PetscFunctionBegin;
5786   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5787   PetscValidPointer(c,2);
5788   if (!dm->coordinatesLocal && dm->coordinates) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called");
5789   *c = dm->coordinatesLocal;
5790   PetscFunctionReturn(0);
5791 }
5792 
5793 /*@
5794   DMGetCoordinatesLocalTuple - Gets a local vector with the coordinates of specified points and section describing its layout.
5795 
5796   Not collective
5797 
5798   Input Parameter:
5799 + dm - the DM
5800 - p - the IS of points whose coordinates will be returned
5801 
5802   Output Parameter:
5803 + pCoordSection - the PetscSection describing the layout of pCoord, i.e. each point corresponds to one point in p, and DOFs correspond to coordinates
5804 - pCoord - the Vec with coordinates of points in p
5805 
5806   Note:
5807   DMGetCoordinatesLocalSetUp() must be called first. This function employs DMGetCoordinatesLocalNoncollective() so it is not collective.
5808 
5809   This creates a new vector, so the user SHOULD destroy this vector
5810 
5811   Each process has the local and ghost coordinates
5812 
5813   For DMDA, in two and three dimensions coordinates are interlaced (x_0,y_0,x_1,y_1,...)
5814   and (x_0,y_0,z_0,x_1,y_1,z_1...)
5815 
5816   Level: advanced
5817 
5818 .seealso: DMSetCoordinatesLocal(), DMGetCoordinatesLocal(), DMGetCoordinatesLocalNoncollective(), DMGetCoordinatesLocalSetUp(), DMGetCoordinates(), DMSetCoordinates(), DMGetCoordinateDM()
5819 @*/
5820 PetscErrorCode DMGetCoordinatesLocalTuple(DM dm, IS p, PetscSection *pCoordSection, Vec *pCoord)
5821 {
5822   PetscSection        cs, newcs;
5823   Vec                 coords;
5824   const PetscScalar   *arr;
5825   PetscScalar         *newarr=NULL;
5826   PetscInt            n;
5827   PetscErrorCode      ierr;
5828 
5829   PetscFunctionBegin;
5830   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5831   PetscValidHeaderSpecific(p, IS_CLASSID, 2);
5832   if (pCoordSection) PetscValidPointer(pCoordSection, 3);
5833   if (pCoord) PetscValidPointer(pCoord, 4);
5834   if (!dm->coordinatesLocal) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DMGetCoordinatesLocalSetUp() has not been called or coordinates not set");
5835   if (!dm->coordinateDM || !dm->coordinateDM->localSection) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONGSTATE, "DM not supported");
5836   cs = dm->coordinateDM->localSection;
5837   coords = dm->coordinatesLocal;
5838   ierr = VecGetArrayRead(coords, &arr);CHKERRQ(ierr);
5839   ierr = PetscSectionExtractDofsFromArray(cs, MPIU_SCALAR, arr, p, &newcs, pCoord ? ((void**)&newarr) : NULL);CHKERRQ(ierr);
5840   ierr = VecRestoreArrayRead(coords, &arr);CHKERRQ(ierr);
5841   if (pCoord) {
5842     ierr = PetscSectionGetStorageSize(newcs, &n);CHKERRQ(ierr);
5843     /* set array in two steps to mimic PETSC_OWN_POINTER */
5844     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)p), 1, n, NULL, pCoord);CHKERRQ(ierr);
5845     ierr = VecReplaceArray(*pCoord, newarr);CHKERRQ(ierr);
5846   } else {
5847     ierr = PetscFree(newarr);CHKERRQ(ierr);
5848   }
5849   if (pCoordSection) {*pCoordSection = newcs;}
5850   else               {ierr = PetscSectionDestroy(&newcs);CHKERRQ(ierr);}
5851   PetscFunctionReturn(0);
5852 }
5853 
5854 PetscErrorCode DMGetCoordinateField(DM dm, DMField *field)
5855 {
5856   PetscErrorCode ierr;
5857 
5858   PetscFunctionBegin;
5859   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5860   PetscValidPointer(field,2);
5861   if (!dm->coordinateField) {
5862     if (dm->ops->createcoordinatefield) {
5863       ierr = (*dm->ops->createcoordinatefield)(dm,&dm->coordinateField);CHKERRQ(ierr);
5864     }
5865   }
5866   *field = dm->coordinateField;
5867   PetscFunctionReturn(0);
5868 }
5869 
5870 PetscErrorCode DMSetCoordinateField(DM dm, DMField field)
5871 {
5872   PetscErrorCode ierr;
5873 
5874   PetscFunctionBegin;
5875   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5876   if (field) PetscValidHeaderSpecific(field,DMFIELD_CLASSID,2);
5877   ierr = PetscObjectReference((PetscObject)field);CHKERRQ(ierr);
5878   ierr = DMFieldDestroy(&dm->coordinateField);CHKERRQ(ierr);
5879   dm->coordinateField = field;
5880   PetscFunctionReturn(0);
5881 }
5882 
5883 /*@
5884   DMGetCoordinateDM - Gets the DM that prescribes coordinate layout and scatters between global and local coordinates
5885 
5886   Collective on dm
5887 
5888   Input Parameter:
5889 . dm - the DM
5890 
5891   Output Parameter:
5892 . cdm - coordinate DM
5893 
5894   Level: intermediate
5895 
5896 .seealso: DMSetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
5897 @*/
5898 PetscErrorCode DMGetCoordinateDM(DM dm, DM *cdm)
5899 {
5900   PetscErrorCode ierr;
5901 
5902   PetscFunctionBegin;
5903   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5904   PetscValidPointer(cdm,2);
5905   if (!dm->coordinateDM) {
5906     DM cdm;
5907 
5908     if (!dm->ops->createcoordinatedm) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Unable to create coordinates for this DM");
5909     ierr = (*dm->ops->createcoordinatedm)(dm, &cdm);CHKERRQ(ierr);
5910     /* Just in case the DM sets the coordinate DM when creating it (DMP4est can do this, because it may not setup
5911      * until the call to CreateCoordinateDM) */
5912     ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
5913     dm->coordinateDM = cdm;
5914   }
5915   *cdm = dm->coordinateDM;
5916   PetscFunctionReturn(0);
5917 }
5918 
5919 /*@
5920   DMSetCoordinateDM - Sets the DM that prescribes coordinate layout and scatters between global and local coordinates
5921 
5922   Logically Collective on dm
5923 
5924   Input Parameters:
5925 + dm - the DM
5926 - cdm - coordinate DM
5927 
5928   Level: intermediate
5929 
5930 .seealso: DMGetCoordinateDM(), DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal()
5931 @*/
5932 PetscErrorCode DMSetCoordinateDM(DM dm, DM cdm)
5933 {
5934   PetscErrorCode ierr;
5935 
5936   PetscFunctionBegin;
5937   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5938   PetscValidHeaderSpecific(cdm,DM_CLASSID,2);
5939   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
5940   ierr = DMDestroy(&dm->coordinateDM);CHKERRQ(ierr);
5941   dm->coordinateDM = cdm;
5942   PetscFunctionReturn(0);
5943 }
5944 
5945 /*@
5946   DMGetCoordinateDim - Retrieve the dimension of embedding space for coordinate values.
5947 
5948   Not Collective
5949 
5950   Input Parameter:
5951 . dm - The DM object
5952 
5953   Output Parameter:
5954 . dim - The embedding dimension
5955 
5956   Level: intermediate
5957 
5958 .seealso: DMSetCoordinateDim(), DMGetCoordinateSection(), DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
5959 @*/
5960 PetscErrorCode DMGetCoordinateDim(DM dm, PetscInt *dim)
5961 {
5962   PetscFunctionBegin;
5963   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
5964   PetscValidIntPointer(dim, 2);
5965   if (dm->dimEmbed == PETSC_DEFAULT) {
5966     dm->dimEmbed = dm->dim;
5967   }
5968   *dim = dm->dimEmbed;
5969   PetscFunctionReturn(0);
5970 }
5971 
5972 /*@
5973   DMSetCoordinateDim - Set the dimension of the embedding space for coordinate values.
5974 
5975   Not Collective
5976 
5977   Input Parameters:
5978 + dm  - The DM object
5979 - dim - The embedding dimension
5980 
5981   Level: intermediate
5982 
5983 .seealso: DMGetCoordinateDim(), DMSetCoordinateSection(), DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
5984 @*/
5985 PetscErrorCode DMSetCoordinateDim(DM dm, PetscInt dim)
5986 {
5987   PetscDS        ds;
5988   PetscErrorCode ierr;
5989 
5990   PetscFunctionBegin;
5991   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5992   dm->dimEmbed = dim;
5993   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
5994   ierr = PetscDSSetCoordinateDimension(ds, dim);CHKERRQ(ierr);
5995   PetscFunctionReturn(0);
5996 }
5997 
5998 /*@
5999   DMGetCoordinateSection - Retrieve the layout of coordinate values over the mesh.
6000 
6001   Collective on dm
6002 
6003   Input Parameter:
6004 . dm - The DM object
6005 
6006   Output Parameter:
6007 . section - The PetscSection object
6008 
6009   Level: intermediate
6010 
6011 .seealso: DMGetCoordinateDM(), DMGetLocalSection(), DMSetLocalSection()
6012 @*/
6013 PetscErrorCode DMGetCoordinateSection(DM dm, PetscSection *section)
6014 {
6015   DM             cdm;
6016   PetscErrorCode ierr;
6017 
6018   PetscFunctionBegin;
6019   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6020   PetscValidPointer(section, 2);
6021   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
6022   ierr = DMGetLocalSection(cdm, section);CHKERRQ(ierr);
6023   PetscFunctionReturn(0);
6024 }
6025 
6026 /*@
6027   DMSetCoordinateSection - Set the layout of coordinate values over the mesh.
6028 
6029   Not Collective
6030 
6031   Input Parameters:
6032 + dm      - The DM object
6033 . dim     - The embedding dimension, or PETSC_DETERMINE
6034 - section - The PetscSection object
6035 
6036   Level: intermediate
6037 
6038 .seealso: DMGetCoordinateSection(), DMGetLocalSection(), DMSetLocalSection()
6039 @*/
6040 PetscErrorCode DMSetCoordinateSection(DM dm, PetscInt dim, PetscSection section)
6041 {
6042   DM             cdm;
6043   PetscErrorCode ierr;
6044 
6045   PetscFunctionBegin;
6046   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6047   PetscValidHeaderSpecific(section,PETSC_SECTION_CLASSID,3);
6048   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
6049   ierr = DMSetLocalSection(cdm, section);CHKERRQ(ierr);
6050   if (dim == PETSC_DETERMINE) {
6051     PetscInt d = PETSC_DEFAULT;
6052     PetscInt pStart, pEnd, vStart, vEnd, v, dd;
6053 
6054     ierr = PetscSectionGetChart(section, &pStart, &pEnd);CHKERRQ(ierr);
6055     ierr = DMGetDimPoints(dm, 0, &vStart, &vEnd);CHKERRQ(ierr);
6056     pStart = PetscMax(vStart, pStart);
6057     pEnd   = PetscMin(vEnd, pEnd);
6058     for (v = pStart; v < pEnd; ++v) {
6059       ierr = PetscSectionGetDof(section, v, &dd);CHKERRQ(ierr);
6060       if (dd) {d = dd; break;}
6061     }
6062     if (d >= 0) {ierr = DMSetCoordinateDim(dm, d);CHKERRQ(ierr);}
6063   }
6064   PetscFunctionReturn(0);
6065 }
6066 
6067 /*@C
6068   DMGetPeriodicity - Get the description of mesh periodicity
6069 
6070   Input Parameters:
6071 . dm      - The DM object
6072 
6073   Output Parameters:
6074 + per     - Whether the DM is periodic or not
6075 . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates
6076 . L       - If we assume the mesh is a torus, this is the length of each coordinate
6077 - bd      - This describes the type of periodicity in each topological dimension
6078 
6079   Level: developer
6080 
6081 .seealso: DMGetPeriodicity()
6082 @*/
6083 PetscErrorCode DMGetPeriodicity(DM dm, PetscBool *per, const PetscReal **maxCell, const PetscReal **L, const DMBoundaryType **bd)
6084 {
6085   PetscFunctionBegin;
6086   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6087   if (per)     *per     = dm->periodic;
6088   if (L)       *L       = dm->L;
6089   if (maxCell) *maxCell = dm->maxCell;
6090   if (bd)      *bd      = dm->bdtype;
6091   PetscFunctionReturn(0);
6092 }
6093 
6094 /*@C
6095   DMSetPeriodicity - Set the description of mesh periodicity
6096 
6097   Input Parameters:
6098 + dm      - The DM object
6099 . per     - Whether the DM is periodic or not. If maxCell is not provided, coordinates need to be localized
6100 . maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates
6101 . L       - If we assume the mesh is a torus, this is the length of each coordinate
6102 - bd      - This describes the type of periodicity in each topological dimension
6103 
6104   Level: developer
6105 
6106 .seealso: DMGetPeriodicity()
6107 @*/
6108 PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])
6109 {
6110   PetscInt       dim, d;
6111   PetscErrorCode ierr;
6112 
6113   PetscFunctionBegin;
6114   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6115   PetscValidLogicalCollectiveBool(dm,per,2);
6116   if (maxCell) {PetscValidRealPointer(maxCell,3);}
6117   if (L)       {PetscValidRealPointer(L,4);}
6118   if (bd)      {PetscValidPointer(bd,5);}
6119   ierr = DMGetDimension(dm, &dim);CHKERRQ(ierr);
6120   if (maxCell) {
6121     if (!dm->maxCell) {ierr = PetscMalloc1(dim, &dm->maxCell);CHKERRQ(ierr);}
6122     for (d = 0; d < dim; ++d) dm->maxCell[d] = maxCell[d];
6123   }
6124   if (L) {
6125     if (!dm->L) {ierr = PetscMalloc1(dim, &dm->L);CHKERRQ(ierr);}
6126     for (d = 0; d < dim; ++d) dm->L[d] = L[d];
6127   }
6128   if (bd) {
6129     if (!dm->bdtype) {ierr = PetscMalloc1(dim, &dm->bdtype);CHKERRQ(ierr);}
6130     for (d = 0; d < dim; ++d) dm->bdtype[d] = bd[d];
6131   }
6132   dm->periodic = per;
6133   PetscFunctionReturn(0);
6134 }
6135 
6136 /*@
6137   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.
6138 
6139   Input Parameters:
6140 + dm     - The DM
6141 . in     - The input coordinate point (dim numbers)
6142 - endpoint - Include the endpoint L_i
6143 
6144   Output Parameter:
6145 . out - The localized coordinate point
6146 
6147   Level: developer
6148 
6149 .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
6150 @*/
6151 PetscErrorCode DMLocalizeCoordinate(DM dm, const PetscScalar in[], PetscBool endpoint, PetscScalar out[])
6152 {
6153   PetscInt       dim, d;
6154   PetscErrorCode ierr;
6155 
6156   PetscFunctionBegin;
6157   ierr = DMGetCoordinateDim(dm, &dim);CHKERRQ(ierr);
6158   if (!dm->maxCell) {
6159     for (d = 0; d < dim; ++d) out[d] = in[d];
6160   } else {
6161     if (endpoint) {
6162       for (d = 0; d < dim; ++d) {
6163         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)) {
6164           out[d] = in[d] - dm->L[d]*(PetscFloorReal(PetscRealPart(in[d])/dm->L[d]) - 1);
6165         } else {
6166           out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
6167         }
6168       }
6169     } else {
6170       for (d = 0; d < dim; ++d) {
6171         out[d] = in[d] - dm->L[d]*PetscFloorReal(PetscRealPart(in[d])/dm->L[d]);
6172       }
6173     }
6174   }
6175   PetscFunctionReturn(0);
6176 }
6177 
6178 /*
6179   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.
6180 
6181   Input Parameters:
6182 + dm     - The DM
6183 . dim    - The spatial dimension
6184 . anchor - The anchor point, the input point can be no more than maxCell away from it
6185 - in     - The input coordinate point (dim numbers)
6186 
6187   Output Parameter:
6188 . out - The localized coordinate point
6189 
6190   Level: developer
6191 
6192   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
6193 
6194 .seealso: DMLocalizeCoordinates(), DMLocalizeAddCoordinate()
6195 */
6196 PetscErrorCode DMLocalizeCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
6197 {
6198   PetscInt d;
6199 
6200   PetscFunctionBegin;
6201   if (!dm->maxCell) {
6202     for (d = 0; d < dim; ++d) out[d] = in[d];
6203   } else {
6204     for (d = 0; d < dim; ++d) {
6205       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > dm->maxCell[d])) {
6206         out[d] = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6207       } else {
6208         out[d] = in[d];
6209       }
6210     }
6211   }
6212   PetscFunctionReturn(0);
6213 }
6214 PetscErrorCode DMLocalizeCoordinateReal_Internal(DM dm, PetscInt dim, const PetscReal anchor[], const PetscReal in[], PetscReal out[])
6215 {
6216   PetscInt d;
6217 
6218   PetscFunctionBegin;
6219   if (!dm->maxCell) {
6220     for (d = 0; d < dim; ++d) out[d] = in[d];
6221   } else {
6222     for (d = 0; d < dim; ++d) {
6223       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsReal(anchor[d] - in[d]) > dm->maxCell[d])) {
6224         out[d] = anchor[d] > in[d] ? dm->L[d] + in[d] : in[d] - dm->L[d];
6225       } else {
6226         out[d] = in[d];
6227       }
6228     }
6229   }
6230   PetscFunctionReturn(0);
6231 }
6232 
6233 /*
6234   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.
6235 
6236   Input Parameters:
6237 + dm     - The DM
6238 . dim    - The spatial dimension
6239 . anchor - The anchor point, the input point can be no more than maxCell away from it
6240 . in     - The input coordinate delta (dim numbers)
6241 - out    - The input coordinate point (dim numbers)
6242 
6243   Output Parameter:
6244 . out    - The localized coordinate in + out
6245 
6246   Level: developer
6247 
6248   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
6249 
6250 .seealso: DMLocalizeCoordinates(), DMLocalizeCoordinate()
6251 */
6252 PetscErrorCode DMLocalizeAddCoordinate_Internal(DM dm, PetscInt dim, const PetscScalar anchor[], const PetscScalar in[], PetscScalar out[])
6253 {
6254   PetscInt d;
6255 
6256   PetscFunctionBegin;
6257   if (!dm->maxCell) {
6258     for (d = 0; d < dim; ++d) out[d] += in[d];
6259   } else {
6260     for (d = 0; d < dim; ++d) {
6261       const PetscReal maxC = dm->maxCell[d];
6262 
6263       if ((dm->bdtype[d] != DM_BOUNDARY_NONE) && (PetscAbsScalar(anchor[d] - in[d]) > maxC)) {
6264         const PetscScalar newCoord = PetscRealPart(anchor[d]) > PetscRealPart(in[d]) ? dm->L[d] + in[d] : in[d] - dm->L[d];
6265 
6266         if (PetscAbsScalar(newCoord - anchor[d]) > maxC)
6267           SETERRQ4(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "%D-Coordinate %g more than %g away from anchor %g", d, (double) PetscRealPart(in[d]), (double) maxC, (double) PetscRealPart(anchor[d]));
6268         out[d] += newCoord;
6269       } else {
6270         out[d] += in[d];
6271       }
6272     }
6273   }
6274   PetscFunctionReturn(0);
6275 }
6276 
6277 /*@
6278   DMGetCoordinatesLocalizedLocal - Check if the DM coordinates have been localized for cells on this process
6279 
6280   Not collective
6281 
6282   Input Parameter:
6283 . dm - The DM
6284 
6285   Output Parameter:
6286   areLocalized - True if localized
6287 
6288   Level: developer
6289 
6290 .seealso: DMLocalizeCoordinates(), DMGetCoordinatesLocalized(), DMSetPeriodicity()
6291 @*/
6292 PetscErrorCode DMGetCoordinatesLocalizedLocal(DM dm,PetscBool *areLocalized)
6293 {
6294   DM             cdm;
6295   PetscSection   coordSection;
6296   PetscInt       cStart, cEnd, sStart, sEnd, c, dof;
6297   PetscBool      isPlex, alreadyLocalized;
6298   PetscErrorCode ierr;
6299 
6300   PetscFunctionBegin;
6301   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6302   PetscValidBoolPointer(areLocalized, 2);
6303   *areLocalized = PETSC_FALSE;
6304 
6305   /* We need some generic way of refering to cells/vertices */
6306   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
6307   ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isPlex);CHKERRQ(ierr);
6308   if (!isPlex) PetscFunctionReturn(0);
6309 
6310   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
6311   ierr = DMPlexGetHeightStratum(cdm, 0, &cStart, &cEnd);CHKERRQ(ierr);
6312   ierr = PetscSectionGetChart(coordSection, &sStart, &sEnd);CHKERRQ(ierr);
6313   alreadyLocalized = PETSC_FALSE;
6314   for (c = cStart; c < cEnd; ++c) {
6315     if (c < sStart || c >= sEnd) continue;
6316     ierr = PetscSectionGetDof(coordSection, c, &dof);CHKERRQ(ierr);
6317     if (dof) { alreadyLocalized = PETSC_TRUE; break; }
6318   }
6319   *areLocalized = alreadyLocalized;
6320   PetscFunctionReturn(0);
6321 }
6322 
6323 /*@
6324   DMGetCoordinatesLocalized - Check if the DM coordinates have been localized for cells
6325 
6326   Collective on dm
6327 
6328   Input Parameter:
6329 . dm - The DM
6330 
6331   Output Parameter:
6332   areLocalized - True if localized
6333 
6334   Level: developer
6335 
6336 .seealso: DMLocalizeCoordinates(), DMSetPeriodicity(), DMGetCoordinatesLocalizedLocal()
6337 @*/
6338 PetscErrorCode DMGetCoordinatesLocalized(DM dm,PetscBool *areLocalized)
6339 {
6340   PetscBool      localized;
6341   PetscErrorCode ierr;
6342 
6343   PetscFunctionBegin;
6344   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6345   PetscValidBoolPointer(areLocalized, 2);
6346   ierr = DMGetCoordinatesLocalizedLocal(dm,&localized);CHKERRQ(ierr);
6347   ierr = MPIU_Allreduce(&localized,areLocalized,1,MPIU_BOOL,MPI_LOR,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
6348   PetscFunctionReturn(0);
6349 }
6350 
6351 /*@
6352   DMLocalizeCoordinates - If a mesh is periodic, create local coordinates for cells having periodic faces
6353 
6354   Collective on dm
6355 
6356   Input Parameter:
6357 . dm - The DM
6358 
6359   Level: developer
6360 
6361 .seealso: DMSetPeriodicity(), DMLocalizeCoordinate(), DMLocalizeAddCoordinate()
6362 @*/
6363 PetscErrorCode DMLocalizeCoordinates(DM dm)
6364 {
6365   DM             cdm;
6366   PetscSection   coordSection, cSection;
6367   Vec            coordinates,  cVec;
6368   PetscScalar   *coords, *coords2, *anchor, *localized;
6369   PetscInt       Nc, vStart, vEnd, v, sStart, sEnd, newStart = PETSC_MAX_INT, newEnd = PETSC_MIN_INT, dof, d, off, off2, bs, coordSize;
6370   PetscBool      alreadyLocalized, alreadyLocalizedGlobal;
6371   PetscInt       maxHeight = 0, h;
6372   PetscInt       *pStart = NULL, *pEnd = NULL;
6373   PetscErrorCode ierr;
6374 
6375   PetscFunctionBegin;
6376   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6377   if (!dm->periodic) PetscFunctionReturn(0);
6378   ierr = DMGetCoordinatesLocalized(dm, &alreadyLocalized);CHKERRQ(ierr);
6379   if (alreadyLocalized) PetscFunctionReturn(0);
6380 
6381   /* We need some generic way of refering to cells/vertices */
6382   ierr = DMGetCoordinateDM(dm, &cdm);CHKERRQ(ierr);
6383   {
6384     PetscBool isplex;
6385 
6386     ierr = PetscObjectTypeCompare((PetscObject) cdm, DMPLEX, &isplex);CHKERRQ(ierr);
6387     if (isplex) {
6388       ierr = DMPlexGetDepthStratum(cdm, 0, &vStart, &vEnd);CHKERRQ(ierr);
6389       ierr = DMPlexGetMaxProjectionHeight(cdm,&maxHeight);CHKERRQ(ierr);
6390       ierr = DMGetWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
6391       pEnd = &pStart[maxHeight + 1];
6392       newStart = vStart;
6393       newEnd   = vEnd;
6394       for (h = 0; h <= maxHeight; h++) {
6395         ierr = DMPlexGetHeightStratum(cdm, h, &pStart[h], &pEnd[h]);CHKERRQ(ierr);
6396         newStart = PetscMin(newStart,pStart[h]);
6397         newEnd   = PetscMax(newEnd,pEnd[h]);
6398       }
6399     } else SETERRQ(PetscObjectComm((PetscObject) cdm), PETSC_ERR_ARG_WRONG, "Coordinate localization requires a DMPLEX coordinate DM");
6400   }
6401   ierr = DMGetCoordinatesLocal(dm, &coordinates);CHKERRQ(ierr);
6402   if (!coordinates) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Missing local coordinates vector");
6403   ierr = DMGetCoordinateSection(dm, &coordSection);CHKERRQ(ierr);
6404   ierr = VecGetBlockSize(coordinates, &bs);CHKERRQ(ierr);
6405   ierr = PetscSectionGetChart(coordSection,&sStart,&sEnd);CHKERRQ(ierr);
6406 
6407   ierr = PetscSectionCreate(PetscObjectComm((PetscObject) dm), &cSection);CHKERRQ(ierr);
6408   ierr = PetscSectionSetNumFields(cSection, 1);CHKERRQ(ierr);
6409   ierr = PetscSectionGetFieldComponents(coordSection, 0, &Nc);CHKERRQ(ierr);
6410   ierr = PetscSectionSetFieldComponents(cSection, 0, Nc);CHKERRQ(ierr);
6411   ierr = PetscSectionSetChart(cSection, newStart, newEnd);CHKERRQ(ierr);
6412 
6413   ierr = DMGetWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
6414   localized = &anchor[bs];
6415   alreadyLocalized = alreadyLocalizedGlobal = PETSC_TRUE;
6416   for (h = 0; h <= maxHeight; h++) {
6417     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
6418 
6419     for (c = cStart; c < cEnd; ++c) {
6420       PetscScalar *cellCoords = NULL;
6421       PetscInt     b;
6422 
6423       if (c < sStart || c >= sEnd) alreadyLocalized = PETSC_FALSE;
6424       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
6425       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
6426       for (d = 0; d < dof/bs; ++d) {
6427         ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], localized);CHKERRQ(ierr);
6428         for (b = 0; b < bs; b++) {
6429           if (cellCoords[d*bs + b] != localized[b]) break;
6430         }
6431         if (b < bs) break;
6432       }
6433       if (d < dof/bs) {
6434         if (c >= sStart && c < sEnd) {
6435           PetscInt cdof;
6436 
6437           ierr = PetscSectionGetDof(coordSection, c, &cdof);CHKERRQ(ierr);
6438           if (cdof != dof) alreadyLocalized = PETSC_FALSE;
6439         }
6440         ierr = PetscSectionSetDof(cSection, c, dof);CHKERRQ(ierr);
6441         ierr = PetscSectionSetFieldDof(cSection, c, 0, dof);CHKERRQ(ierr);
6442       }
6443       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
6444     }
6445   }
6446   ierr = MPI_Allreduce(&alreadyLocalized,&alreadyLocalizedGlobal,1,MPIU_BOOL,MPI_LAND,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
6447   if (alreadyLocalizedGlobal) {
6448     ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
6449     ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
6450     ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
6451     PetscFunctionReturn(0);
6452   }
6453   for (v = vStart; v < vEnd; ++v) {
6454     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
6455     ierr = PetscSectionSetDof(cSection, v, dof);CHKERRQ(ierr);
6456     ierr = PetscSectionSetFieldDof(cSection, v, 0, dof);CHKERRQ(ierr);
6457   }
6458   ierr = PetscSectionSetUp(cSection);CHKERRQ(ierr);
6459   ierr = PetscSectionGetStorageSize(cSection, &coordSize);CHKERRQ(ierr);
6460   ierr = VecCreate(PETSC_COMM_SELF, &cVec);CHKERRQ(ierr);
6461   ierr = PetscObjectSetName((PetscObject)cVec,"coordinates");CHKERRQ(ierr);
6462   ierr = VecSetBlockSize(cVec, bs);CHKERRQ(ierr);
6463   ierr = VecSetSizes(cVec, coordSize, PETSC_DETERMINE);CHKERRQ(ierr);
6464   ierr = VecSetType(cVec, VECSTANDARD);CHKERRQ(ierr);
6465   ierr = VecGetArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
6466   ierr = VecGetArray(cVec, &coords2);CHKERRQ(ierr);
6467   for (v = vStart; v < vEnd; ++v) {
6468     ierr = PetscSectionGetDof(coordSection, v, &dof);CHKERRQ(ierr);
6469     ierr = PetscSectionGetOffset(coordSection, v, &off);CHKERRQ(ierr);
6470     ierr = PetscSectionGetOffset(cSection,     v, &off2);CHKERRQ(ierr);
6471     for (d = 0; d < dof; ++d) coords2[off2+d] = coords[off+d];
6472   }
6473   for (h = 0; h <= maxHeight; h++) {
6474     PetscInt cStart = pStart[h], cEnd = pEnd[h], c;
6475 
6476     for (c = cStart; c < cEnd; ++c) {
6477       PetscScalar *cellCoords = NULL;
6478       PetscInt     b, cdof;
6479 
6480       ierr = PetscSectionGetDof(cSection,c,&cdof);CHKERRQ(ierr);
6481       if (!cdof) continue;
6482       ierr = DMPlexVecGetClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
6483       ierr = PetscSectionGetOffset(cSection, c, &off2);CHKERRQ(ierr);
6484       for (b = 0; b < bs; ++b) anchor[b] = cellCoords[b];
6485       for (d = 0; d < dof/bs; ++d) {ierr = DMLocalizeCoordinate_Internal(dm, bs, anchor, &cellCoords[d*bs], &coords2[off2+d*bs]);CHKERRQ(ierr);}
6486       ierr = DMPlexVecRestoreClosure(cdm, coordSection, coordinates, c, &dof, &cellCoords);CHKERRQ(ierr);
6487     }
6488   }
6489   ierr = DMRestoreWorkArray(dm, 2 * bs, MPIU_SCALAR, &anchor);CHKERRQ(ierr);
6490   ierr = DMRestoreWorkArray(dm,2*(maxHeight + 1),MPIU_INT,&pStart);CHKERRQ(ierr);
6491   ierr = VecRestoreArrayRead(coordinates, (const PetscScalar**)&coords);CHKERRQ(ierr);
6492   ierr = VecRestoreArray(cVec, &coords2);CHKERRQ(ierr);
6493   ierr = DMSetCoordinateSection(dm, PETSC_DETERMINE, cSection);CHKERRQ(ierr);
6494   ierr = DMSetCoordinatesLocal(dm, cVec);CHKERRQ(ierr);
6495   ierr = VecDestroy(&cVec);CHKERRQ(ierr);
6496   ierr = PetscSectionDestroy(&cSection);CHKERRQ(ierr);
6497   PetscFunctionReturn(0);
6498 }
6499 
6500 /*@
6501   DMLocatePoints - Locate the points in v in the mesh and return a PetscSF of the containing cells
6502 
6503   Collective on v (see explanation below)
6504 
6505   Input Parameters:
6506 + dm - The DM
6507 . v - The Vec of points
6508 . ltype - The type of point location, e.g. DM_POINTLOCATION_NONE or DM_POINTLOCATION_NEAREST
6509 - cells - Points to either NULL, or a PetscSF with guesses for which cells contain each point.
6510 
6511   Output Parameter:
6512 + v - The Vec of points, which now contains the nearest mesh points to the given points if DM_POINTLOCATION_NEAREST is used
6513 - cells - The PetscSF containing the ranks and local indices of the containing points.
6514 
6515 
6516   Level: developer
6517 
6518   Notes:
6519   To do a search of the local cells of the mesh, v should have PETSC_COMM_SELF as its communicator.
6520   To do a search of all the cells in the distributed mesh, v should have the same communicator as dm.
6521 
6522   If *cellSF is NULL on input, a PetscSF will be created.
6523   If *cellSF is not NULL on input, it should point to an existing PetscSF, whose graph will be used as initial guesses.
6524 
6525   An array that maps each point to its containing cell can be obtained with
6526 
6527 $    const PetscSFNode *cells;
6528 $    PetscInt           nFound;
6529 $    const PetscInt    *found;
6530 $
6531 $    PetscSFGetGraph(cellSF,NULL,&nFound,&found,&cells);
6532 
6533   Where cells[i].rank is the rank of the cell containing point found[i] (or i if found == NULL), and cells[i].index is
6534   the index of the cell in its rank's local numbering.
6535 
6536 .seealso: DMSetCoordinates(), DMSetCoordinatesLocal(), DMGetCoordinates(), DMGetCoordinatesLocal(), DMPointLocationType
6537 @*/
6538 PetscErrorCode DMLocatePoints(DM dm, Vec v, DMPointLocationType ltype, PetscSF *cellSF)
6539 {
6540   PetscErrorCode ierr;
6541 
6542   PetscFunctionBegin;
6543   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6544   PetscValidHeaderSpecific(v,VEC_CLASSID,2);
6545   PetscValidPointer(cellSF,4);
6546   if (*cellSF) {
6547     PetscMPIInt result;
6548 
6549     PetscValidHeaderSpecific(*cellSF,PETSCSF_CLASSID,4);
6550     ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)v),PetscObjectComm((PetscObject)*cellSF),&result);CHKERRQ(ierr);
6551     if (result != MPI_IDENT && result != MPI_CONGRUENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"cellSF must have a communicator congruent to v's");
6552   } else {
6553     ierr = PetscSFCreate(PetscObjectComm((PetscObject)v),cellSF);CHKERRQ(ierr);
6554   }
6555   if (!dm->ops->locatepoints) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_SUP, "Point location not available for this DM");
6556   ierr = PetscLogEventBegin(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
6557   ierr = (*dm->ops->locatepoints)(dm,v,ltype,*cellSF);CHKERRQ(ierr);
6558   ierr = PetscLogEventEnd(DM_LocatePoints,dm,0,0,0);CHKERRQ(ierr);
6559   PetscFunctionReturn(0);
6560 }
6561 
6562 /*@
6563   DMGetOutputDM - Retrieve the DM associated with the layout for output
6564 
6565   Collective on dm
6566 
6567   Input Parameter:
6568 . dm - The original DM
6569 
6570   Output Parameter:
6571 . odm - The DM which provides the layout for output
6572 
6573   Level: intermediate
6574 
6575 .seealso: VecView(), DMGetGlobalSection()
6576 @*/
6577 PetscErrorCode DMGetOutputDM(DM dm, DM *odm)
6578 {
6579   PetscSection   section;
6580   PetscBool      hasConstraints, ghasConstraints;
6581   PetscErrorCode ierr;
6582 
6583   PetscFunctionBegin;
6584   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6585   PetscValidPointer(odm,2);
6586   ierr = DMGetLocalSection(dm, &section);CHKERRQ(ierr);
6587   ierr = PetscSectionHasConstraints(section, &hasConstraints);CHKERRQ(ierr);
6588   ierr = MPI_Allreduce(&hasConstraints, &ghasConstraints, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject) dm));CHKERRQ(ierr);
6589   if (!ghasConstraints) {
6590     *odm = dm;
6591     PetscFunctionReturn(0);
6592   }
6593   if (!dm->dmBC) {
6594     PetscSection newSection, gsection;
6595     PetscSF      sf;
6596 
6597     ierr = DMClone(dm, &dm->dmBC);CHKERRQ(ierr);
6598     ierr = DMCopyDisc(dm, dm->dmBC);CHKERRQ(ierr);
6599     ierr = PetscSectionClone(section, &newSection);CHKERRQ(ierr);
6600     ierr = DMSetLocalSection(dm->dmBC, newSection);CHKERRQ(ierr);
6601     ierr = PetscSectionDestroy(&newSection);CHKERRQ(ierr);
6602     ierr = DMGetPointSF(dm->dmBC, &sf);CHKERRQ(ierr);
6603     ierr = PetscSectionCreateGlobalSection(section, sf, PETSC_TRUE, PETSC_FALSE, &gsection);CHKERRQ(ierr);
6604     ierr = DMSetGlobalSection(dm->dmBC, gsection);CHKERRQ(ierr);
6605     ierr = PetscSectionDestroy(&gsection);CHKERRQ(ierr);
6606   }
6607   *odm = dm->dmBC;
6608   PetscFunctionReturn(0);
6609 }
6610 
6611 /*@
6612   DMGetOutputSequenceNumber - Retrieve the sequence number/value for output
6613 
6614   Input Parameter:
6615 . dm - The original DM
6616 
6617   Output Parameters:
6618 + num - The output sequence number
6619 - val - The output sequence value
6620 
6621   Level: intermediate
6622 
6623   Note: This is intended for output that should appear in sequence, for instance
6624   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
6625 
6626 .seealso: VecView()
6627 @*/
6628 PetscErrorCode DMGetOutputSequenceNumber(DM dm, PetscInt *num, PetscReal *val)
6629 {
6630   PetscFunctionBegin;
6631   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6632   if (num) {PetscValidIntPointer(num,2); *num = dm->outputSequenceNum;}
6633   if (val) {PetscValidRealPointer(val,3);*val = dm->outputSequenceVal;}
6634   PetscFunctionReturn(0);
6635 }
6636 
6637 /*@
6638   DMSetOutputSequenceNumber - Set the sequence number/value for output
6639 
6640   Input Parameters:
6641 + dm - The original DM
6642 . num - The output sequence number
6643 - val - The output sequence value
6644 
6645   Level: intermediate
6646 
6647   Note: This is intended for output that should appear in sequence, for instance
6648   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
6649 
6650 .seealso: VecView()
6651 @*/
6652 PetscErrorCode DMSetOutputSequenceNumber(DM dm, PetscInt num, PetscReal val)
6653 {
6654   PetscFunctionBegin;
6655   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6656   dm->outputSequenceNum = num;
6657   dm->outputSequenceVal = val;
6658   PetscFunctionReturn(0);
6659 }
6660 
6661 /*@C
6662   DMOutputSequenceLoad - Retrieve the sequence value from a Viewer
6663 
6664   Input Parameters:
6665 + dm   - The original DM
6666 . name - The sequence name
6667 - num  - The output sequence number
6668 
6669   Output Parameter:
6670 . val  - The output sequence value
6671 
6672   Level: intermediate
6673 
6674   Note: This is intended for output that should appear in sequence, for instance
6675   a set of timesteps in an HDF5 file, or a set of realizations of a stochastic system.
6676 
6677 .seealso: DMGetOutputSequenceNumber(), DMSetOutputSequenceNumber(), VecView()
6678 @*/
6679 PetscErrorCode DMOutputSequenceLoad(DM dm, PetscViewer viewer, const char *name, PetscInt num, PetscReal *val)
6680 {
6681   PetscBool      ishdf5;
6682   PetscErrorCode ierr;
6683 
6684   PetscFunctionBegin;
6685   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
6686   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
6687   PetscValidRealPointer(val,4);
6688   ierr = PetscObjectTypeCompare((PetscObject) viewer, PETSCVIEWERHDF5, &ishdf5);CHKERRQ(ierr);
6689   if (ishdf5) {
6690 #if defined(PETSC_HAVE_HDF5)
6691     PetscScalar value;
6692 
6693     ierr = DMSequenceLoad_HDF5_Internal(dm, name, num, &value, viewer);CHKERRQ(ierr);
6694     *val = PetscRealPart(value);
6695 #endif
6696   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerHDF5Open()");
6697   PetscFunctionReturn(0);
6698 }
6699 
6700 /*@
6701   DMGetUseNatural - Get the flag for creating a mapping to the natural order on distribution
6702 
6703   Not collective
6704 
6705   Input Parameter:
6706 . dm - The DM
6707 
6708   Output Parameter:
6709 . useNatural - The flag to build the mapping to a natural order during distribution
6710 
6711   Level: beginner
6712 
6713 .seealso: DMSetUseNatural(), DMCreate()
6714 @*/
6715 PetscErrorCode DMGetUseNatural(DM dm, PetscBool *useNatural)
6716 {
6717   PetscFunctionBegin;
6718   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6719   PetscValidBoolPointer(useNatural, 2);
6720   *useNatural = dm->useNatural;
6721   PetscFunctionReturn(0);
6722 }
6723 
6724 /*@
6725   DMSetUseNatural - Set the flag for creating a mapping to the natural order after distribution
6726 
6727   Collective on dm
6728 
6729   Input Parameters:
6730 + dm - The DM
6731 - useNatural - The flag to build the mapping to a natural order during distribution
6732 
6733   Note: This also causes the map to be build after DMCreateSubDM() and DMCreateSuperDM()
6734 
6735   Level: beginner
6736 
6737 .seealso: DMGetUseNatural(), DMCreate(), DMPlexDistribute(), DMCreateSubDM(), DMCreateSuperDM()
6738 @*/
6739 PetscErrorCode DMSetUseNatural(DM dm, PetscBool useNatural)
6740 {
6741   PetscFunctionBegin;
6742   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6743   PetscValidLogicalCollectiveBool(dm, useNatural, 2);
6744   dm->useNatural = useNatural;
6745   PetscFunctionReturn(0);
6746 }
6747 
6748 
6749 /*@C
6750   DMCreateLabel - Create a label of the given name if it does not already exist
6751 
6752   Not Collective
6753 
6754   Input Parameters:
6755 + dm   - The DM object
6756 - name - The label name
6757 
6758   Level: intermediate
6759 
6760 .seealso: DMLabelCreate(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
6761 @*/
6762 PetscErrorCode DMCreateLabel(DM dm, const char name[])
6763 {
6764   PetscBool      flg;
6765   DMLabel        label;
6766   PetscErrorCode ierr;
6767 
6768   PetscFunctionBegin;
6769   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6770   PetscValidCharPointer(name, 2);
6771   ierr = DMHasLabel(dm, name, &flg);CHKERRQ(ierr);
6772   if (!flg) {
6773     ierr = DMLabelCreate(PETSC_COMM_SELF, name, &label);CHKERRQ(ierr);
6774     ierr = DMAddLabel(dm, label);CHKERRQ(ierr);
6775     ierr = DMLabelDestroy(&label);CHKERRQ(ierr);
6776   }
6777   PetscFunctionReturn(0);
6778 }
6779 
6780 /*@C
6781   DMGetLabelValue - Get the value in a Sieve Label for the given point, with 0 as the default
6782 
6783   Not Collective
6784 
6785   Input Parameters:
6786 + dm   - The DM object
6787 . name - The label name
6788 - point - The mesh point
6789 
6790   Output Parameter:
6791 . value - The label value for this point, or -1 if the point is not in the label
6792 
6793   Level: beginner
6794 
6795 .seealso: DMLabelGetValue(), DMSetLabelValue(), DMGetStratumIS()
6796 @*/
6797 PetscErrorCode DMGetLabelValue(DM dm, const char name[], PetscInt point, PetscInt *value)
6798 {
6799   DMLabel        label;
6800   PetscErrorCode ierr;
6801 
6802   PetscFunctionBegin;
6803   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6804   PetscValidCharPointer(name, 2);
6805   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
6806   if (!label) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "No label named %s was found", name);
6807   ierr = DMLabelGetValue(label, point, value);CHKERRQ(ierr);
6808   PetscFunctionReturn(0);
6809 }
6810 
6811 /*@C
6812   DMSetLabelValue - Add a point to a Sieve Label with given value
6813 
6814   Not Collective
6815 
6816   Input Parameters:
6817 + dm   - The DM object
6818 . name - The label name
6819 . point - The mesh point
6820 - value - The label value for this point
6821 
6822   Output Parameter:
6823 
6824   Level: beginner
6825 
6826 .seealso: DMLabelSetValue(), DMGetStratumIS(), DMClearLabelValue()
6827 @*/
6828 PetscErrorCode DMSetLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
6829 {
6830   DMLabel        label;
6831   PetscErrorCode ierr;
6832 
6833   PetscFunctionBegin;
6834   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6835   PetscValidCharPointer(name, 2);
6836   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
6837   if (!label) {
6838     ierr = DMCreateLabel(dm, name);CHKERRQ(ierr);
6839     ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
6840   }
6841   ierr = DMLabelSetValue(label, point, value);CHKERRQ(ierr);
6842   PetscFunctionReturn(0);
6843 }
6844 
6845 /*@C
6846   DMClearLabelValue - Remove a point from a Sieve Label with given value
6847 
6848   Not Collective
6849 
6850   Input Parameters:
6851 + dm   - The DM object
6852 . name - The label name
6853 . point - The mesh point
6854 - value - The label value for this point
6855 
6856   Output Parameter:
6857 
6858   Level: beginner
6859 
6860 .seealso: DMLabelClearValue(), DMSetLabelValue(), DMGetStratumIS()
6861 @*/
6862 PetscErrorCode DMClearLabelValue(DM dm, const char name[], PetscInt point, PetscInt value)
6863 {
6864   DMLabel        label;
6865   PetscErrorCode ierr;
6866 
6867   PetscFunctionBegin;
6868   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6869   PetscValidCharPointer(name, 2);
6870   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
6871   if (!label) PetscFunctionReturn(0);
6872   ierr = DMLabelClearValue(label, point, value);CHKERRQ(ierr);
6873   PetscFunctionReturn(0);
6874 }
6875 
6876 /*@C
6877   DMGetLabelSize - Get the number of different integer ids in a Label
6878 
6879   Not Collective
6880 
6881   Input Parameters:
6882 + dm   - The DM object
6883 - name - The label name
6884 
6885   Output Parameter:
6886 . size - The number of different integer ids, or 0 if the label does not exist
6887 
6888   Level: beginner
6889 
6890 .seealso: DMLabelGetNumValues(), DMSetLabelValue()
6891 @*/
6892 PetscErrorCode DMGetLabelSize(DM dm, const char name[], PetscInt *size)
6893 {
6894   DMLabel        label;
6895   PetscErrorCode ierr;
6896 
6897   PetscFunctionBegin;
6898   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6899   PetscValidCharPointer(name, 2);
6900   PetscValidIntPointer(size, 3);
6901   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
6902   *size = 0;
6903   if (!label) PetscFunctionReturn(0);
6904   ierr = DMLabelGetNumValues(label, size);CHKERRQ(ierr);
6905   PetscFunctionReturn(0);
6906 }
6907 
6908 /*@C
6909   DMGetLabelIdIS - Get the integer ids in a label
6910 
6911   Not Collective
6912 
6913   Input Parameters:
6914 + mesh - The DM object
6915 - name - The label name
6916 
6917   Output Parameter:
6918 . ids - The integer ids, or NULL if the label does not exist
6919 
6920   Level: beginner
6921 
6922 .seealso: DMLabelGetValueIS(), DMGetLabelSize()
6923 @*/
6924 PetscErrorCode DMGetLabelIdIS(DM dm, const char name[], IS *ids)
6925 {
6926   DMLabel        label;
6927   PetscErrorCode ierr;
6928 
6929   PetscFunctionBegin;
6930   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6931   PetscValidCharPointer(name, 2);
6932   PetscValidPointer(ids, 3);
6933   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
6934   *ids = NULL;
6935  if (label) {
6936     ierr = DMLabelGetValueIS(label, ids);CHKERRQ(ierr);
6937   } else {
6938     /* returning an empty IS */
6939     ierr = ISCreateGeneral(PETSC_COMM_SELF,0,NULL,PETSC_USE_POINTER,ids);CHKERRQ(ierr);
6940   }
6941   PetscFunctionReturn(0);
6942 }
6943 
6944 /*@C
6945   DMGetStratumSize - Get the number of points in a label stratum
6946 
6947   Not Collective
6948 
6949   Input Parameters:
6950 + dm - The DM object
6951 . name - The label name
6952 - value - The stratum value
6953 
6954   Output Parameter:
6955 . size - The stratum size
6956 
6957   Level: beginner
6958 
6959 .seealso: DMLabelGetStratumSize(), DMGetLabelSize(), DMGetLabelIds()
6960 @*/
6961 PetscErrorCode DMGetStratumSize(DM dm, const char name[], PetscInt value, PetscInt *size)
6962 {
6963   DMLabel        label;
6964   PetscErrorCode ierr;
6965 
6966   PetscFunctionBegin;
6967   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
6968   PetscValidCharPointer(name, 2);
6969   PetscValidIntPointer(size, 4);
6970   ierr  = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
6971   *size = 0;
6972   if (!label) PetscFunctionReturn(0);
6973   ierr = DMLabelGetStratumSize(label, value, size);CHKERRQ(ierr);
6974   PetscFunctionReturn(0);
6975 }
6976 
6977 /*@C
6978   DMGetStratumIS - Get the points in a label stratum
6979 
6980   Not Collective
6981 
6982   Input Parameters:
6983 + dm - The DM object
6984 . name - The label name
6985 - value - The stratum value
6986 
6987   Output Parameter:
6988 . points - The stratum points, or NULL if the label does not exist or does not have that value
6989 
6990   Level: beginner
6991 
6992 .seealso: DMLabelGetStratumIS(), DMGetStratumSize()
6993 @*/
6994 PetscErrorCode DMGetStratumIS(DM dm, const char name[], PetscInt value, IS *points)
6995 {
6996   DMLabel        label;
6997   PetscErrorCode ierr;
6998 
6999   PetscFunctionBegin;
7000   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7001   PetscValidCharPointer(name, 2);
7002   PetscValidPointer(points, 4);
7003   ierr    = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7004   *points = NULL;
7005   if (!label) PetscFunctionReturn(0);
7006   ierr = DMLabelGetStratumIS(label, value, points);CHKERRQ(ierr);
7007   PetscFunctionReturn(0);
7008 }
7009 
7010 /*@C
7011   DMSetStratumIS - Set the points in a label stratum
7012 
7013   Not Collective
7014 
7015   Input Parameters:
7016 + dm - The DM object
7017 . name - The label name
7018 . value - The stratum value
7019 - points - The stratum points
7020 
7021   Level: beginner
7022 
7023 .seealso: DMLabelSetStratumIS(), DMGetStratumSize()
7024 @*/
7025 PetscErrorCode DMSetStratumIS(DM dm, const char name[], PetscInt value, IS points)
7026 {
7027   DMLabel        label;
7028   PetscErrorCode ierr;
7029 
7030   PetscFunctionBegin;
7031   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7032   PetscValidCharPointer(name, 2);
7033   PetscValidPointer(points, 4);
7034   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7035   if (!label) PetscFunctionReturn(0);
7036   ierr = DMLabelSetStratumIS(label, value, points);CHKERRQ(ierr);
7037   PetscFunctionReturn(0);
7038 }
7039 
7040 /*@C
7041   DMClearLabelStratum - Remove all points from a stratum from a Sieve Label
7042 
7043   Not Collective
7044 
7045   Input Parameters:
7046 + dm   - The DM object
7047 . name - The label name
7048 - value - The label value for this point
7049 
7050   Output Parameter:
7051 
7052   Level: beginner
7053 
7054 .seealso: DMLabelClearStratum(), DMSetLabelValue(), DMGetStratumIS(), DMClearLabelValue()
7055 @*/
7056 PetscErrorCode DMClearLabelStratum(DM dm, const char name[], PetscInt value)
7057 {
7058   DMLabel        label;
7059   PetscErrorCode ierr;
7060 
7061   PetscFunctionBegin;
7062   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7063   PetscValidCharPointer(name, 2);
7064   ierr = DMGetLabel(dm, name, &label);CHKERRQ(ierr);
7065   if (!label) PetscFunctionReturn(0);
7066   ierr = DMLabelClearStratum(label, value);CHKERRQ(ierr);
7067   PetscFunctionReturn(0);
7068 }
7069 
7070 /*@
7071   DMGetNumLabels - Return the number of labels defined by the mesh
7072 
7073   Not Collective
7074 
7075   Input Parameter:
7076 . dm   - The DM object
7077 
7078   Output Parameter:
7079 . numLabels - the number of Labels
7080 
7081   Level: intermediate
7082 
7083 .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7084 @*/
7085 PetscErrorCode DMGetNumLabels(DM dm, PetscInt *numLabels)
7086 {
7087   DMLabelLink next = dm->labels;
7088   PetscInt  n    = 0;
7089 
7090   PetscFunctionBegin;
7091   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7092   PetscValidIntPointer(numLabels, 2);
7093   while (next) {++n; next = next->next;}
7094   *numLabels = n;
7095   PetscFunctionReturn(0);
7096 }
7097 
7098 /*@C
7099   DMGetLabelName - Return the name of nth label
7100 
7101   Not Collective
7102 
7103   Input Parameters:
7104 + dm - The DM object
7105 - n  - the label number
7106 
7107   Output Parameter:
7108 . name - the label name
7109 
7110   Level: intermediate
7111 
7112 .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7113 @*/
7114 PetscErrorCode DMGetLabelName(DM dm, PetscInt n, const char **name)
7115 {
7116   DMLabelLink    next = dm->labels;
7117   PetscInt       l    = 0;
7118   PetscErrorCode ierr;
7119 
7120   PetscFunctionBegin;
7121   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7122   PetscValidPointer(name, 3);
7123   while (next) {
7124     if (l == n) {
7125       ierr = PetscObjectGetName((PetscObject) next->label, name);CHKERRQ(ierr);
7126       PetscFunctionReturn(0);
7127     }
7128     ++l;
7129     next = next->next;
7130   }
7131   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7132 }
7133 
7134 /*@C
7135   DMHasLabel - Determine whether the mesh has a label of a given name
7136 
7137   Not Collective
7138 
7139   Input Parameters:
7140 + dm   - The DM object
7141 - name - The label name
7142 
7143   Output Parameter:
7144 . hasLabel - PETSC_TRUE if the label is present
7145 
7146   Level: intermediate
7147 
7148 .seealso: DMCreateLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7149 @*/
7150 PetscErrorCode DMHasLabel(DM dm, const char name[], PetscBool *hasLabel)
7151 {
7152   DMLabelLink    next = dm->labels;
7153   const char    *lname;
7154   PetscErrorCode ierr;
7155 
7156   PetscFunctionBegin;
7157   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7158   PetscValidCharPointer(name, 2);
7159   PetscValidBoolPointer(hasLabel, 3);
7160   *hasLabel = PETSC_FALSE;
7161   while (next) {
7162     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7163     ierr = PetscStrcmp(name, lname, hasLabel);CHKERRQ(ierr);
7164     if (*hasLabel) break;
7165     next = next->next;
7166   }
7167   PetscFunctionReturn(0);
7168 }
7169 
7170 /*@C
7171   DMGetLabel - Return the label of a given name, or NULL
7172 
7173   Not Collective
7174 
7175   Input Parameters:
7176 + dm   - The DM object
7177 - name - The label name
7178 
7179   Output Parameter:
7180 . label - The DMLabel, or NULL if the label is absent
7181 
7182   Level: intermediate
7183 
7184 .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7185 @*/
7186 PetscErrorCode DMGetLabel(DM dm, const char name[], DMLabel *label)
7187 {
7188   DMLabelLink    next = dm->labels;
7189   PetscBool      hasLabel;
7190   const char    *lname;
7191   PetscErrorCode ierr;
7192 
7193   PetscFunctionBegin;
7194   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7195   PetscValidCharPointer(name, 2);
7196   PetscValidPointer(label, 3);
7197   *label = NULL;
7198   while (next) {
7199     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7200     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7201     if (hasLabel) {
7202       *label = next->label;
7203       break;
7204     }
7205     next = next->next;
7206   }
7207   PetscFunctionReturn(0);
7208 }
7209 
7210 /*@C
7211   DMGetLabelByNum - Return the nth label
7212 
7213   Not Collective
7214 
7215   Input Parameters:
7216 + dm - The DM object
7217 - n  - the label number
7218 
7219   Output Parameter:
7220 . label - the label
7221 
7222   Level: intermediate
7223 
7224 .seealso: DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7225 @*/
7226 PetscErrorCode DMGetLabelByNum(DM dm, PetscInt n, DMLabel *label)
7227 {
7228   DMLabelLink next = dm->labels;
7229   PetscInt    l    = 0;
7230 
7231   PetscFunctionBegin;
7232   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7233   PetscValidPointer(label, 3);
7234   while (next) {
7235     if (l == n) {
7236       *label = next->label;
7237       PetscFunctionReturn(0);
7238     }
7239     ++l;
7240     next = next->next;
7241   }
7242   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %D does not exist in this DM", n);
7243 }
7244 
7245 /*@C
7246   DMAddLabel - Add the label to this mesh
7247 
7248   Not Collective
7249 
7250   Input Parameters:
7251 + dm   - The DM object
7252 - label - The DMLabel
7253 
7254   Level: developer
7255 
7256 .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7257 @*/
7258 PetscErrorCode DMAddLabel(DM dm, DMLabel label)
7259 {
7260   DMLabelLink    l, *p, tmpLabel;
7261   PetscBool      hasLabel;
7262   const char    *lname;
7263   PetscBool      flg;
7264   PetscErrorCode ierr;
7265 
7266   PetscFunctionBegin;
7267   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7268   ierr = PetscObjectGetName((PetscObject) label, &lname);CHKERRQ(ierr);
7269   ierr = DMHasLabel(dm, lname, &hasLabel);CHKERRQ(ierr);
7270   if (hasLabel) SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Label %s already exists in this DM", lname);
7271   ierr = PetscCalloc1(1, &tmpLabel);CHKERRQ(ierr);
7272   tmpLabel->label  = label;
7273   tmpLabel->output = PETSC_TRUE;
7274   for (p=&dm->labels; (l=*p); p=&l->next) {}
7275   *p = tmpLabel;
7276   ierr = PetscObjectReference((PetscObject)label);CHKERRQ(ierr);
7277   ierr = PetscStrcmp(lname, "depth", &flg);CHKERRQ(ierr);
7278   if (flg) dm->depthLabel = label;
7279   ierr = PetscStrcmp(lname, "celltype", &flg);CHKERRQ(ierr);
7280   if (flg) dm->celltypeLabel = label;
7281   PetscFunctionReturn(0);
7282 }
7283 
7284 /*@C
7285   DMRemoveLabel - Remove the label given by name from this mesh
7286 
7287   Not Collective
7288 
7289   Input Parameters:
7290 + dm   - The DM object
7291 - name - The label name
7292 
7293   Output Parameter:
7294 . label - The DMLabel, or NULL if the label is absent
7295 
7296   Level: developer
7297 
7298   Notes:
7299   DMRemoveLabel(dm,name,NULL) removes the label from dm and calls
7300   DMLabelDestroy() on the label.
7301 
7302   DMRemoveLabel(dm,name,&label) removes the label from dm, but it DOES NOT
7303   call DMLabelDestroy(). Instead, the label is returned and the user is
7304   responsible of calling DMLabelDestroy() at some point.
7305 
7306 .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel(), DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabelBySelf()
7307 @*/
7308 PetscErrorCode DMRemoveLabel(DM dm, const char name[], DMLabel *label)
7309 {
7310   DMLabelLink    link, *pnext;
7311   PetscBool      hasLabel;
7312   const char    *lname;
7313   PetscErrorCode ierr;
7314 
7315   PetscFunctionBegin;
7316   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7317   PetscValidCharPointer(name, 2);
7318   if (label) {
7319     PetscValidPointer(label, 3);
7320     *label = NULL;
7321   }
7322   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
7323     ierr = PetscObjectGetName((PetscObject) link->label, &lname);CHKERRQ(ierr);
7324     ierr = PetscStrcmp(name, lname, &hasLabel);CHKERRQ(ierr);
7325     if (hasLabel) {
7326       *pnext = link->next; /* Remove from list */
7327       ierr = PetscStrcmp(name, "depth", &hasLabel);CHKERRQ(ierr);
7328       if (hasLabel) dm->depthLabel = NULL;
7329       ierr = PetscStrcmp(name, "celltype", &hasLabel);CHKERRQ(ierr);
7330       if (hasLabel) dm->celltypeLabel = NULL;
7331       if (label) *label = link->label;
7332       else       {ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);}
7333       ierr = PetscFree(link);CHKERRQ(ierr);
7334       break;
7335     }
7336   }
7337   PetscFunctionReturn(0);
7338 }
7339 
7340 /*@
7341   DMRemoveLabelBySelf - Remove the label from this mesh
7342 
7343   Not Collective
7344 
7345   Input Parameters:
7346 + dm   - The DM object
7347 . label - (Optional) The DMLabel to be removed from the DM
7348 - failNotFound - Should it fail if the label is not found in the DM?
7349 
7350   Level: developer
7351 
7352   Notes:
7353   Only exactly the same instance is removed if found, name match is ignored.
7354   If the DM has an exclusive reference to the label, it gets destroyed and
7355   *label nullified.
7356 
7357 .seealso: DMCreateLabel(), DMHasLabel(), DMGetLabel() DMGetLabelValue(), DMSetLabelValue(), DMLabelDestroy(), DMRemoveLabel()
7358 @*/
7359 PetscErrorCode DMRemoveLabelBySelf(DM dm, DMLabel *label, PetscBool failNotFound)
7360 {
7361   DMLabelLink    link, *pnext;
7362   PetscBool      hasLabel = PETSC_FALSE;
7363   PetscErrorCode ierr;
7364 
7365   PetscFunctionBegin;
7366   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7367   PetscValidPointer(label, 2);
7368   if (!*label && !failNotFound) PetscFunctionReturn(0);
7369   PetscValidHeaderSpecific(*label, DMLABEL_CLASSID, 2);
7370   PetscValidLogicalCollectiveBool(dm,failNotFound,3);
7371   for (pnext=&dm->labels; (link=*pnext); pnext=&link->next) {
7372     if (*label == link->label) {
7373       hasLabel = PETSC_TRUE;
7374       *pnext = link->next; /* Remove from list */
7375       if (*label == dm->depthLabel) dm->depthLabel = NULL;
7376       if (*label == dm->celltypeLabel) dm->celltypeLabel = NULL;
7377       if (((PetscObject) link->label)->refct < 2) *label = NULL; /* nullify if exclusive reference */
7378       ierr = DMLabelDestroy(&link->label);CHKERRQ(ierr);
7379       ierr = PetscFree(link);CHKERRQ(ierr);
7380       break;
7381     }
7382   }
7383   if (!hasLabel && failNotFound) SETERRQ(PetscObjectComm((PetscObject)dm), PETSC_ERR_ARG_WRONG, "Given label not found in DM");
7384   PetscFunctionReturn(0);
7385 }
7386 
7387 /*@C
7388   DMGetLabelOutput - Get the output flag for a given label
7389 
7390   Not Collective
7391 
7392   Input Parameters:
7393 + dm   - The DM object
7394 - name - The label name
7395 
7396   Output Parameter:
7397 . output - The flag for output
7398 
7399   Level: developer
7400 
7401 .seealso: DMSetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7402 @*/
7403 PetscErrorCode DMGetLabelOutput(DM dm, const char name[], PetscBool *output)
7404 {
7405   DMLabelLink    next = dm->labels;
7406   const char    *lname;
7407   PetscErrorCode ierr;
7408 
7409   PetscFunctionBegin;
7410   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7411   PetscValidPointer(name, 2);
7412   PetscValidPointer(output, 3);
7413   while (next) {
7414     PetscBool flg;
7415 
7416     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7417     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
7418     if (flg) {*output = next->output; PetscFunctionReturn(0);}
7419     next = next->next;
7420   }
7421   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
7422 }
7423 
7424 /*@C
7425   DMSetLabelOutput - Set the output flag for a given label
7426 
7427   Not Collective
7428 
7429   Input Parameters:
7430 + dm     - The DM object
7431 . name   - The label name
7432 - output - The flag for output
7433 
7434   Level: developer
7435 
7436 .seealso: DMGetLabelOutput(), DMCreateLabel(), DMHasLabel(), DMGetLabelValue(), DMSetLabelValue(), DMGetStratumIS()
7437 @*/
7438 PetscErrorCode DMSetLabelOutput(DM dm, const char name[], PetscBool output)
7439 {
7440   DMLabelLink    next = dm->labels;
7441   const char    *lname;
7442   PetscErrorCode ierr;
7443 
7444   PetscFunctionBegin;
7445   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7446   PetscValidCharPointer(name, 2);
7447   while (next) {
7448     PetscBool flg;
7449 
7450     ierr = PetscObjectGetName((PetscObject) next->label, &lname);CHKERRQ(ierr);
7451     ierr = PetscStrcmp(name, lname, &flg);CHKERRQ(ierr);
7452     if (flg) {next->output = output; PetscFunctionReturn(0);}
7453     next = next->next;
7454   }
7455   SETERRQ1(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "No label named %s was present in this dm", name);
7456 }
7457 
7458 /*@
7459   DMCopyLabels - Copy labels from one mesh to another with a superset of the points
7460 
7461   Collective on dmA
7462 
7463   Input Parameter:
7464 + dmA - The DM object with initial labels
7465 . dmB - The DM object with copied labels
7466 . mode - Copy labels by pointers (PETSC_OWN_POINTER) or duplicate them (PETSC_COPY_VALUES)
7467 - all  - Copy all labels including "depth", "dim", and "celltype" (PETSC_TRUE) which are otherwise ignored (PETSC_FALSE)
7468 
7469   Level: intermediate
7470 
7471   Note: This is typically used when interpolating or otherwise adding to a mesh
7472 
7473 .seealso: DMGetCoordinates(), DMGetCoordinatesLocal(), DMGetCoordinateDM(), DMGetCoordinateSection(), DMShareLabels()
7474 @*/
7475 PetscErrorCode DMCopyLabels(DM dmA, DM dmB, PetscCopyMode mode, PetscBool all)
7476 {
7477   DMLabel        label, labelNew;
7478   const char    *name;
7479   PetscBool      flg;
7480   DMLabelLink    link;
7481   PetscErrorCode ierr;
7482 
7483   PetscFunctionBegin;
7484   PetscValidHeaderSpecific(dmA, DM_CLASSID, 1);
7485   PetscValidHeaderSpecific(dmB, DM_CLASSID, 2);
7486   PetscValidLogicalCollectiveEnum(dmA, mode,3);
7487   PetscValidLogicalCollectiveBool(dmA, all, 4);
7488   if (mode==PETSC_USE_POINTER) SETERRQ(PetscObjectComm((PetscObject)dmA), PETSC_ERR_SUP, "PETSC_USE_POINTER not supported for objects");
7489   if (dmA == dmB) PetscFunctionReturn(0);
7490   for (link=dmA->labels; link; link=link->next) {
7491     label=link->label;
7492     ierr = PetscObjectGetName((PetscObject)label, &name);CHKERRQ(ierr);
7493     if (!all) {
7494       ierr = PetscStrcmp(name, "depth", &flg);CHKERRQ(ierr);
7495       if (flg) continue;
7496       ierr = PetscStrcmp(name, "dim", &flg);CHKERRQ(ierr);
7497       if (flg) continue;
7498       ierr = PetscStrcmp(name, "celltype", &flg);CHKERRQ(ierr);
7499       if (flg) continue;
7500     }
7501     if (mode==PETSC_COPY_VALUES) {
7502       ierr = DMLabelDuplicate(label, &labelNew);CHKERRQ(ierr);
7503     } else {
7504       labelNew = label;
7505     }
7506     ierr = DMAddLabel(dmB, labelNew);CHKERRQ(ierr);
7507     if (mode==PETSC_COPY_VALUES) {ierr = DMLabelDestroy(&labelNew);CHKERRQ(ierr);}
7508   }
7509   PetscFunctionReturn(0);
7510 }
7511 
7512 /*@
7513   DMGetCoarseDM - Get the coarse mesh from which this was obtained by refinement
7514 
7515   Input Parameter:
7516 . dm - The DM object
7517 
7518   Output Parameter:
7519 . cdm - The coarse DM
7520 
7521   Level: intermediate
7522 
7523 .seealso: DMSetCoarseDM()
7524 @*/
7525 PetscErrorCode DMGetCoarseDM(DM dm, DM *cdm)
7526 {
7527   PetscFunctionBegin;
7528   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7529   PetscValidPointer(cdm, 2);
7530   *cdm = dm->coarseMesh;
7531   PetscFunctionReturn(0);
7532 }
7533 
7534 /*@
7535   DMSetCoarseDM - Set the coarse mesh from which this was obtained by refinement
7536 
7537   Input Parameters:
7538 + dm - The DM object
7539 - cdm - The coarse DM
7540 
7541   Level: intermediate
7542 
7543 .seealso: DMGetCoarseDM()
7544 @*/
7545 PetscErrorCode DMSetCoarseDM(DM dm, DM cdm)
7546 {
7547   PetscErrorCode ierr;
7548 
7549   PetscFunctionBegin;
7550   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7551   if (cdm) PetscValidHeaderSpecific(cdm, DM_CLASSID, 2);
7552   ierr = PetscObjectReference((PetscObject)cdm);CHKERRQ(ierr);
7553   ierr = DMDestroy(&dm->coarseMesh);CHKERRQ(ierr);
7554   dm->coarseMesh = cdm;
7555   PetscFunctionReturn(0);
7556 }
7557 
7558 /*@
7559   DMGetFineDM - Get the fine mesh from which this was obtained by refinement
7560 
7561   Input Parameter:
7562 . dm - The DM object
7563 
7564   Output Parameter:
7565 . fdm - The fine DM
7566 
7567   Level: intermediate
7568 
7569 .seealso: DMSetFineDM()
7570 @*/
7571 PetscErrorCode DMGetFineDM(DM dm, DM *fdm)
7572 {
7573   PetscFunctionBegin;
7574   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7575   PetscValidPointer(fdm, 2);
7576   *fdm = dm->fineMesh;
7577   PetscFunctionReturn(0);
7578 }
7579 
7580 /*@
7581   DMSetFineDM - Set the fine mesh from which this was obtained by refinement
7582 
7583   Input Parameters:
7584 + dm - The DM object
7585 - fdm - The fine DM
7586 
7587   Level: intermediate
7588 
7589 .seealso: DMGetFineDM()
7590 @*/
7591 PetscErrorCode DMSetFineDM(DM dm, DM fdm)
7592 {
7593   PetscErrorCode ierr;
7594 
7595   PetscFunctionBegin;
7596   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7597   if (fdm) PetscValidHeaderSpecific(fdm, DM_CLASSID, 2);
7598   ierr = PetscObjectReference((PetscObject)fdm);CHKERRQ(ierr);
7599   ierr = DMDestroy(&dm->fineMesh);CHKERRQ(ierr);
7600   dm->fineMesh = fdm;
7601   PetscFunctionReturn(0);
7602 }
7603 
7604 /*=== DMBoundary code ===*/
7605 
7606 PetscErrorCode DMCopyBoundary(DM dm, DM dmNew)
7607 {
7608   PetscInt       d;
7609   PetscErrorCode ierr;
7610 
7611   PetscFunctionBegin;
7612   for (d = 0; d < dm->Nds; ++d) {
7613     ierr = PetscDSCopyBoundary(dm->probs[d].ds, dmNew->probs[d].ds);CHKERRQ(ierr);
7614   }
7615   PetscFunctionReturn(0);
7616 }
7617 
7618 /*@C
7619   DMAddBoundary - Add a boundary condition to the model
7620 
7621   Collective on dm
7622 
7623   Input Parameters:
7624 + dm          - The DM, with a PetscDS that matches the problem being constrained
7625 . type        - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
7626 . name        - The BC name
7627 . labelname   - The label defining constrained points
7628 . field       - The field to constrain
7629 . numcomps    - The number of constrained field components (0 will constrain all fields)
7630 . comps       - An array of constrained component numbers
7631 . bcFunc      - A pointwise function giving boundary values
7632 . numids      - The number of DMLabel ids for constrained points
7633 . ids         - An array of ids for constrained points
7634 - ctx         - An optional user context for bcFunc
7635 
7636   Options Database Keys:
7637 + -bc_<boundary name> <num> - Overrides the boundary ids
7638 - -bc_<boundary name>_comp <num> - Overrides the boundary components
7639 
7640   Level: developer
7641 
7642 .seealso: DMGetBoundary()
7643 @*/
7644 PetscErrorCode DMAddBoundary(DM dm, DMBoundaryConditionType type, const char name[], const char labelname[], PetscInt field, PetscInt numcomps, const PetscInt *comps, void (*bcFunc)(void), PetscInt numids, const PetscInt *ids, void *ctx)
7645 {
7646   PetscDS        ds;
7647   PetscErrorCode ierr;
7648 
7649   PetscFunctionBegin;
7650   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7651   PetscValidLogicalCollectiveEnum(dm, type, 2);
7652   PetscValidLogicalCollectiveInt(dm, field, 5);
7653   PetscValidLogicalCollectiveInt(dm, numcomps, 6);
7654   PetscValidLogicalCollectiveInt(dm, numids, 9);
7655   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
7656   ierr = DMCompleteBoundaryLabel_Internal(dm, ds, field, PETSC_MAX_INT, labelname);CHKERRQ(ierr);
7657   ierr = PetscDSAddBoundary(ds, type,name, labelname, field, numcomps, comps, bcFunc, numids, ids, ctx);CHKERRQ(ierr);
7658   PetscFunctionReturn(0);
7659 }
7660 
7661 /*@
7662   DMGetNumBoundary - Get the number of registered BC
7663 
7664   Input Parameters:
7665 . dm - The mesh object
7666 
7667   Output Parameters:
7668 . numBd - The number of BC
7669 
7670   Level: intermediate
7671 
7672 .seealso: DMAddBoundary(), DMGetBoundary()
7673 @*/
7674 PetscErrorCode DMGetNumBoundary(DM dm, PetscInt *numBd)
7675 {
7676   PetscDS        ds;
7677   PetscErrorCode ierr;
7678 
7679   PetscFunctionBegin;
7680   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7681   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
7682   ierr = PetscDSGetNumBoundary(ds, numBd);CHKERRQ(ierr);
7683   PetscFunctionReturn(0);
7684 }
7685 
7686 /*@C
7687   DMGetBoundary - Get a model boundary condition
7688 
7689   Input Parameters:
7690 + dm          - The mesh object
7691 - bd          - The BC number
7692 
7693   Output Parameters:
7694 + type        - The type of condition, e.g. DM_BC_ESSENTIAL_ANALYTIC/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
7695 . name        - The BC name
7696 . labelname   - The label defining constrained points
7697 . field       - The field to constrain
7698 . numcomps    - The number of constrained field components
7699 . comps       - An array of constrained component numbers
7700 . bcFunc      - A pointwise function giving boundary values
7701 . numids      - The number of DMLabel ids for constrained points
7702 . ids         - An array of ids for constrained points
7703 - ctx         - An optional user context for bcFunc
7704 
7705   Options Database Keys:
7706 + -bc_<boundary name> <num> - Overrides the boundary ids
7707 - -bc_<boundary name>_comp <num> - Overrides the boundary components
7708 
7709   Level: developer
7710 
7711 .seealso: DMAddBoundary()
7712 @*/
7713 PetscErrorCode DMGetBoundary(DM dm, PetscInt bd, DMBoundaryConditionType *type, const char **name, const char **labelname, PetscInt *field, PetscInt *numcomps, const PetscInt **comps, void (**func)(void), PetscInt *numids, const PetscInt **ids, void **ctx)
7714 {
7715   PetscDS        ds;
7716   PetscErrorCode ierr;
7717 
7718   PetscFunctionBegin;
7719   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7720   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
7721   ierr = PetscDSGetBoundary(ds, bd, type, name, labelname, field, numcomps, comps, func, numids, ids, ctx);CHKERRQ(ierr);
7722   PetscFunctionReturn(0);
7723 }
7724 
7725 static PetscErrorCode DMPopulateBoundary(DM dm)
7726 {
7727   PetscDS        ds;
7728   DMBoundary    *lastnext;
7729   DSBoundary     dsbound;
7730   PetscErrorCode ierr;
7731 
7732   PetscFunctionBegin;
7733   ierr = DMGetDS(dm, &ds);CHKERRQ(ierr);
7734   dsbound = ds->boundary;
7735   if (dm->boundary) {
7736     DMBoundary next = dm->boundary;
7737 
7738     /* quick check to see if the PetscDS has changed */
7739     if (next->dsboundary == dsbound) PetscFunctionReturn(0);
7740     /* the PetscDS has changed: tear down and rebuild */
7741     while (next) {
7742       DMBoundary b = next;
7743 
7744       next = b->next;
7745       ierr = PetscFree(b);CHKERRQ(ierr);
7746     }
7747     dm->boundary = NULL;
7748   }
7749 
7750   lastnext = &(dm->boundary);
7751   while (dsbound) {
7752     DMBoundary dmbound;
7753 
7754     ierr = PetscNew(&dmbound);CHKERRQ(ierr);
7755     dmbound->dsboundary = dsbound;
7756     ierr = DMGetLabel(dm, dsbound->labelname, &(dmbound->label));CHKERRQ(ierr);
7757     if (!dmbound->label) {ierr = PetscInfo2(dm, "DSBoundary %s wants label %s, which is not in this dm.\n",dsbound->name,dsbound->labelname);CHKERRQ(ierr);}
7758     /* push on the back instead of the front so that it is in the same order as in the PetscDS */
7759     *lastnext = dmbound;
7760     lastnext = &(dmbound->next);
7761     dsbound = dsbound->next;
7762   }
7763   PetscFunctionReturn(0);
7764 }
7765 
7766 PetscErrorCode DMIsBoundaryPoint(DM dm, PetscInt point, PetscBool *isBd)
7767 {
7768   DMBoundary     b;
7769   PetscErrorCode ierr;
7770 
7771   PetscFunctionBegin;
7772   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7773   PetscValidBoolPointer(isBd, 3);
7774   *isBd = PETSC_FALSE;
7775   ierr = DMPopulateBoundary(dm);CHKERRQ(ierr);
7776   b = dm->boundary;
7777   while (b && !(*isBd)) {
7778     DMLabel    label = b->label;
7779     DSBoundary dsb = b->dsboundary;
7780 
7781     if (label) {
7782       PetscInt i;
7783 
7784       for (i = 0; i < dsb->numids && !(*isBd); ++i) {
7785         ierr = DMLabelStratumHasPoint(label, dsb->ids[i], point, isBd);CHKERRQ(ierr);
7786       }
7787     }
7788     b = b->next;
7789   }
7790   PetscFunctionReturn(0);
7791 }
7792 
7793 /*@C
7794   DMProjectFunction - This projects the given function into the function space provided, putting the coefficients in a global vector.
7795 
7796   Collective on DM
7797 
7798   Input Parameters:
7799 + dm      - The DM
7800 . time    - The time
7801 . funcs   - The coordinate functions to evaluate, one per field
7802 . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
7803 - mode    - The insertion mode for values
7804 
7805   Output Parameter:
7806 . X - vector
7807 
7808    Calling sequence of func:
7809 $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
7810 
7811 +  dim - The spatial dimension
7812 .  x   - The coordinates
7813 .  Nf  - The number of fields
7814 .  u   - The output field values
7815 -  ctx - optional user-defined function context
7816 
7817   Level: developer
7818 
7819 .seealso: DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
7820 @*/
7821 PetscErrorCode DMProjectFunction(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec X)
7822 {
7823   Vec            localX;
7824   PetscErrorCode ierr;
7825 
7826   PetscFunctionBegin;
7827   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7828   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
7829   ierr = DMProjectFunctionLocal(dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
7830   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
7831   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
7832   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
7833   PetscFunctionReturn(0);
7834 }
7835 
7836 /*@C
7837   DMProjectFunctionLocal - This projects the given function into the function space provided, putting the coefficients in a local vector.
7838 
7839   Not collective
7840 
7841   Input Parameters:
7842 + dm      - The DM
7843 . time    - The time
7844 . funcs   - The coordinate functions to evaluate, one per field
7845 . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
7846 - mode    - The insertion mode for values
7847 
7848   Output Parameter:
7849 . localX - vector
7850 
7851    Calling sequence of func:
7852 $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
7853 
7854 +  dim - The spatial dimension
7855 .  x   - The coordinates
7856 .  Nf  - The number of fields
7857 .  u   - The output field values
7858 -  ctx - optional user-defined function context
7859 
7860   Level: developer
7861 
7862 .seealso: DMProjectFunction(), DMProjectFunctionLabel(), DMComputeL2Diff()
7863 @*/
7864 PetscErrorCode DMProjectFunctionLocal(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, InsertMode mode, Vec localX)
7865 {
7866   PetscErrorCode ierr;
7867 
7868   PetscFunctionBegin;
7869   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7870   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
7871   if (!dm->ops->projectfunctionlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLocal",((PetscObject)dm)->type_name);
7872   ierr = (dm->ops->projectfunctionlocal) (dm, time, funcs, ctxs, mode, localX);CHKERRQ(ierr);
7873   PetscFunctionReturn(0);
7874 }
7875 
7876 /*@C
7877   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.
7878 
7879   Collective on DM
7880 
7881   Input Parameters:
7882 + dm      - The DM
7883 . time    - The time
7884 . label   - The DMLabel selecting the portion of the mesh for projection
7885 . funcs   - The coordinate functions to evaluate, one per field
7886 . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
7887 - mode    - The insertion mode for values
7888 
7889   Output Parameter:
7890 . X - vector
7891 
7892    Calling sequence of func:
7893 $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
7894 
7895 +  dim - The spatial dimension
7896 .  x   - The coordinates
7897 .  Nf  - The number of fields
7898 .  u   - The output field values
7899 -  ctx - optional user-defined function context
7900 
7901   Level: developer
7902 
7903 .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabelLocal(), DMComputeL2Diff()
7904 @*/
7905 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)
7906 {
7907   Vec            localX;
7908   PetscErrorCode ierr;
7909 
7910   PetscFunctionBegin;
7911   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
7912   ierr = DMGetLocalVector(dm, &localX);CHKERRQ(ierr);
7913   ierr = DMProjectFunctionLabelLocal(dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
7914   ierr = DMLocalToGlobalBegin(dm, localX, mode, X);CHKERRQ(ierr);
7915   ierr = DMLocalToGlobalEnd(dm, localX, mode, X);CHKERRQ(ierr);
7916   ierr = DMRestoreLocalVector(dm, &localX);CHKERRQ(ierr);
7917   PetscFunctionReturn(0);
7918 }
7919 
7920 /*@C
7921   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.
7922 
7923   Not collective
7924 
7925   Input Parameters:
7926 + dm      - The DM
7927 . time    - The time
7928 . label   - The DMLabel selecting the portion of the mesh for projection
7929 . funcs   - The coordinate functions to evaluate, one per field
7930 . ctxs    - Optional array of contexts to pass to each coordinate function.  ctxs itself may be null.
7931 - mode    - The insertion mode for values
7932 
7933   Output Parameter:
7934 . localX - vector
7935 
7936    Calling sequence of func:
7937 $    func(PetscInt dim, PetscReal time, const PetscReal x[], PetscInt Nf, PetscScalar u[], void *ctx);
7938 
7939 +  dim - The spatial dimension
7940 .  x   - The coordinates
7941 .  Nf  - The number of fields
7942 .  u   - The output field values
7943 -  ctx - optional user-defined function context
7944 
7945   Level: developer
7946 
7947 .seealso: DMProjectFunction(), DMProjectFunctionLocal(), DMProjectFunctionLabel(), DMComputeL2Diff()
7948 @*/
7949 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)
7950 {
7951   PetscErrorCode ierr;
7952 
7953   PetscFunctionBegin;
7954   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
7955   PetscValidHeaderSpecific(localX,VEC_CLASSID,5);
7956   if (!dm->ops->projectfunctionlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFunctionLabelLocal",((PetscObject)dm)->type_name);
7957   ierr = (dm->ops->projectfunctionlabellocal) (dm, time, label, numIds, ids, Nc, comps, funcs, ctxs, mode, localX);CHKERRQ(ierr);
7958   PetscFunctionReturn(0);
7959 }
7960 
7961 /*@C
7962   DMProjectFieldLocal - This projects the given function of the input fields into the function space provided, putting the coefficients in a local vector.
7963 
7964   Not collective
7965 
7966   Input Parameters:
7967 + dm      - The DM
7968 . time    - The time
7969 . localU  - The input field vector
7970 . funcs   - The functions to evaluate, one per field
7971 - mode    - The insertion mode for values
7972 
7973   Output Parameter:
7974 . localX  - The output vector
7975 
7976    Calling sequence of func:
7977 $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
7978 $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
7979 $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
7980 $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
7981 
7982 +  dim          - The spatial dimension
7983 .  Nf           - The number of input fields
7984 .  NfAux        - The number of input auxiliary fields
7985 .  uOff         - The offset of each field in u[]
7986 .  uOff_x       - The offset of each field in u_x[]
7987 .  u            - The field values at this point in space
7988 .  u_t          - The field time derivative at this point in space (or NULL)
7989 .  u_x          - The field derivatives at this point in space
7990 .  aOff         - The offset of each auxiliary field in u[]
7991 .  aOff_x       - The offset of each auxiliary field in u_x[]
7992 .  a            - The auxiliary field values at this point in space
7993 .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
7994 .  a_x          - The auxiliary field derivatives at this point in space
7995 .  t            - The current time
7996 .  x            - The coordinates of this point
7997 .  numConstants - The number of constants
7998 .  constants    - The value of each constant
7999 -  f            - The value of the function at this point in space
8000 
8001   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.
8002   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
8003   a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the
8004   auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations.
8005 
8006   Level: intermediate
8007 
8008 .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8009 @*/
8010 PetscErrorCode DMProjectFieldLocal(DM dm, PetscReal time, Vec localU,
8011                                    void (**funcs)(PetscInt, PetscInt, PetscInt,
8012                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8013                                                   const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8014                                                   PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
8015                                    InsertMode mode, Vec localX)
8016 {
8017   PetscErrorCode ierr;
8018 
8019   PetscFunctionBegin;
8020   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8021   PetscValidHeaderSpecific(localU,VEC_CLASSID,3);
8022   PetscValidHeaderSpecific(localX,VEC_CLASSID,6);
8023   if (!dm->ops->projectfieldlocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLocal",((PetscObject)dm)->type_name);
8024   ierr = (dm->ops->projectfieldlocal) (dm, time, localU, funcs, mode, localX);CHKERRQ(ierr);
8025   PetscFunctionReturn(0);
8026 }
8027 
8028 /*@C
8029   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.
8030 
8031   Not collective
8032 
8033   Input Parameters:
8034 + dm      - The DM
8035 . time    - The time
8036 . label   - The DMLabel marking the portion of the domain to output
8037 . numIds  - The number of label ids to use
8038 . ids     - The label ids to use for marking
8039 . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8040 . comps   - The components to set in the output, or NULL for all components
8041 . localU  - The input field vector
8042 . funcs   - The functions to evaluate, one per field
8043 - mode    - The insertion mode for values
8044 
8045   Output Parameter:
8046 . localX  - The output vector
8047 
8048    Calling sequence of func:
8049 $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8050 $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8051 $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8052 $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8053 
8054 +  dim          - The spatial dimension
8055 .  Nf           - The number of input fields
8056 .  NfAux        - The number of input auxiliary fields
8057 .  uOff         - The offset of each field in u[]
8058 .  uOff_x       - The offset of each field in u_x[]
8059 .  u            - The field values at this point in space
8060 .  u_t          - The field time derivative at this point in space (or NULL)
8061 .  u_x          - The field derivatives at this point in space
8062 .  aOff         - The offset of each auxiliary field in u[]
8063 .  aOff_x       - The offset of each auxiliary field in u_x[]
8064 .  a            - The auxiliary field values at this point in space
8065 .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8066 .  a_x          - The auxiliary field derivatives at this point in space
8067 .  t            - The current time
8068 .  x            - The coordinates of this point
8069 .  numConstants - The number of constants
8070 .  constants    - The value of each constant
8071 -  f            - The value of the function at this point in space
8072 
8073   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.
8074   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
8075   a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the
8076   auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations.
8077 
8078   Level: intermediate
8079 
8080 .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8081 @*/
8082 PetscErrorCode DMProjectFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
8083                                         void (**funcs)(PetscInt, PetscInt, PetscInt,
8084                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8085                                                        const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8086                                                        PetscReal, const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
8087                                         InsertMode mode, Vec localX)
8088 {
8089   PetscErrorCode ierr;
8090 
8091   PetscFunctionBegin;
8092   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8093   PetscValidHeaderSpecific(localU,VEC_CLASSID,6);
8094   PetscValidHeaderSpecific(localX,VEC_CLASSID,9);
8095   if (!dm->ops->projectfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectFieldLabelLocal",((PetscObject)dm)->type_name);
8096   ierr = (dm->ops->projectfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
8097   PetscFunctionReturn(0);
8098 }
8099 
8100 /*@C
8101   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.
8102 
8103   Not collective
8104 
8105   Input Parameters:
8106 + dm      - The DM
8107 . time    - The time
8108 . label   - The DMLabel marking the portion of the domain boundary to output
8109 . numIds  - The number of label ids to use
8110 . ids     - The label ids to use for marking
8111 . Nc      - The number of components to set in the output, or PETSC_DETERMINE for all components
8112 . comps   - The components to set in the output, or NULL for all components
8113 . localU  - The input field vector
8114 . funcs   - The functions to evaluate, one per field
8115 - mode    - The insertion mode for values
8116 
8117   Output Parameter:
8118 . localX  - The output vector
8119 
8120    Calling sequence of func:
8121 $    func(PetscInt dim, PetscInt Nf, PetscInt NfAux,
8122 $         const PetscInt uOff[], const PetscInt uOff_x[], const PetscScalar u[], const PetscScalar u_t[], const PetscScalar u_x[],
8123 $         const PetscInt aOff[], const PetscInt aOff_x[], const PetscScalar a[], const PetscScalar a_t[], const PetscScalar a_x[],
8124 $         PetscReal t, const PetscReal x[], PetscInt numConstants, const PetscScalar constants[], PetscScalar f[]);
8125 
8126 +  dim          - The spatial dimension
8127 .  Nf           - The number of input fields
8128 .  NfAux        - The number of input auxiliary fields
8129 .  uOff         - The offset of each field in u[]
8130 .  uOff_x       - The offset of each field in u_x[]
8131 .  u            - The field values at this point in space
8132 .  u_t          - The field time derivative at this point in space (or NULL)
8133 .  u_x          - The field derivatives at this point in space
8134 .  aOff         - The offset of each auxiliary field in u[]
8135 .  aOff_x       - The offset of each auxiliary field in u_x[]
8136 .  a            - The auxiliary field values at this point in space
8137 .  a_t          - The auxiliary field time derivative at this point in space (or NULL)
8138 .  a_x          - The auxiliary field derivatives at this point in space
8139 .  t            - The current time
8140 .  x            - The coordinates of this point
8141 .  n            - The face normal
8142 .  numConstants - The number of constants
8143 .  constants    - The value of each constant
8144 -  f            - The value of the function at this point in space
8145 
8146   Note:
8147   There are three different DMs that potentially interact in this function. The output DM, dm, specifies the layout of the values calculates by funcs.
8148   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
8149   a subdomain. You can also output a different number of fields than the input, with different discretizations. Last the auxiliary DM, attached to the
8150   auxiliary field vector, which is attached to dm, can also be different. It can have a different topology, number of fields, and discretizations.
8151 
8152   Level: intermediate
8153 
8154 .seealso: DMProjectField(), DMProjectFieldLabelLocal(), DMProjectFunction(), DMComputeL2Diff()
8155 @*/
8156 PetscErrorCode DMProjectBdFieldLabelLocal(DM dm, PetscReal time, DMLabel label, PetscInt numIds, const PetscInt ids[], PetscInt Nc, const PetscInt comps[], Vec localU,
8157                                           void (**funcs)(PetscInt, PetscInt, PetscInt,
8158                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8159                                                          const PetscInt[], const PetscInt[], const PetscScalar[], const PetscScalar[], const PetscScalar[],
8160                                                          PetscReal, const PetscReal[], const PetscReal[], PetscInt, const PetscScalar[], PetscScalar[]),
8161                                           InsertMode mode, Vec localX)
8162 {
8163   PetscErrorCode ierr;
8164 
8165   PetscFunctionBegin;
8166   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8167   PetscValidHeaderSpecific(localU,VEC_CLASSID,6);
8168   PetscValidHeaderSpecific(localX,VEC_CLASSID,9);
8169   if (!dm->ops->projectbdfieldlabellocal) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMProjectBdFieldLabelLocal",((PetscObject)dm)->type_name);
8170   ierr = (dm->ops->projectbdfieldlabellocal)(dm, time, label, numIds, ids, Nc, comps, localU, funcs, mode, localX);CHKERRQ(ierr);
8171   PetscFunctionReturn(0);
8172 }
8173 
8174 /*@C
8175   DMComputeL2Diff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h.
8176 
8177   Input Parameters:
8178 + dm    - The DM
8179 . time  - The time
8180 . funcs - The functions to evaluate for each field component
8181 . ctxs  - Optional array of contexts to pass to each function, or NULL.
8182 - X     - The coefficient vector u_h, a global vector
8183 
8184   Output Parameter:
8185 . diff - The diff ||u - u_h||_2
8186 
8187   Level: developer
8188 
8189 .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
8190 @*/
8191 PetscErrorCode DMComputeL2Diff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal *diff)
8192 {
8193   PetscErrorCode ierr;
8194 
8195   PetscFunctionBegin;
8196   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8197   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
8198   if (!dm->ops->computel2diff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2Diff",((PetscObject)dm)->type_name);
8199   ierr = (dm->ops->computel2diff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
8200   PetscFunctionReturn(0);
8201 }
8202 
8203 /*@C
8204   DMComputeL2GradientDiff - This function computes the L_2 difference between the gradient of a function u and an FEM interpolant solution grad u_h.
8205 
8206   Collective on dm
8207 
8208   Input Parameters:
8209 + dm    - The DM
8210 , time  - The time
8211 . funcs - The gradient functions to evaluate for each field component
8212 . ctxs  - Optional array of contexts to pass to each function, or NULL.
8213 . X     - The coefficient vector u_h, a global vector
8214 - n     - The vector to project along
8215 
8216   Output Parameter:
8217 . diff - The diff ||(grad u - grad u_h) . n||_2
8218 
8219   Level: developer
8220 
8221 .seealso: DMProjectFunction(), DMComputeL2Diff()
8222 @*/
8223 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)
8224 {
8225   PetscErrorCode ierr;
8226 
8227   PetscFunctionBegin;
8228   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8229   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
8230   if (!dm->ops->computel2gradientdiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2GradientDiff",((PetscObject)dm)->type_name);
8231   ierr = (dm->ops->computel2gradientdiff)(dm,time,funcs,ctxs,X,n,diff);CHKERRQ(ierr);
8232   PetscFunctionReturn(0);
8233 }
8234 
8235 /*@C
8236   DMComputeL2FieldDiff - This function computes the L_2 difference between a function u and an FEM interpolant solution u_h, separated into field components.
8237 
8238   Collective on dm
8239 
8240   Input Parameters:
8241 + dm    - The DM
8242 . time  - The time
8243 . funcs - The functions to evaluate for each field component
8244 . ctxs  - Optional array of contexts to pass to each function, or NULL.
8245 - X     - The coefficient vector u_h, a global vector
8246 
8247   Output Parameter:
8248 . diff - The array of differences, ||u^f - u^f_h||_2
8249 
8250   Level: developer
8251 
8252 .seealso: DMProjectFunction(), DMComputeL2FieldDiff(), DMComputeL2GradientDiff()
8253 @*/
8254 PetscErrorCode DMComputeL2FieldDiff(DM dm, PetscReal time, PetscErrorCode (**funcs)(PetscInt, PetscReal, const PetscReal [], PetscInt, PetscScalar *, void *), void **ctxs, Vec X, PetscReal diff[])
8255 {
8256   PetscErrorCode ierr;
8257 
8258   PetscFunctionBegin;
8259   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8260   PetscValidHeaderSpecific(X,VEC_CLASSID,5);
8261   if (!dm->ops->computel2fielddiff) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMComputeL2FieldDiff",((PetscObject)dm)->type_name);
8262   ierr = (dm->ops->computel2fielddiff)(dm,time,funcs,ctxs,X,diff);CHKERRQ(ierr);
8263   PetscFunctionReturn(0);
8264 }
8265 
8266 /*@C
8267   DMAdaptLabel - Adapt a dm based on a label with values interpreted as coarsening and refining flags.  Specific implementations of DM maybe have
8268                  specialized flags, but all implementations should accept flag values DM_ADAPT_DETERMINE, DM_ADAPT_KEEP, DM_ADAPT_REFINE, and DM_ADAPT_COARSEN.
8269 
8270   Collective on dm
8271 
8272   Input parameters:
8273 + dm - the pre-adaptation DM object
8274 - label - label with the flags
8275 
8276   Output parameters:
8277 . dmAdapt - the adapted DM object: may be NULL if an adapted DM could not be produced.
8278 
8279   Level: intermediate
8280 
8281 .seealso: DMAdaptMetric(), DMCoarsen(), DMRefine()
8282 @*/
8283 PetscErrorCode DMAdaptLabel(DM dm, DMLabel label, DM *dmAdapt)
8284 {
8285   PetscErrorCode ierr;
8286 
8287   PetscFunctionBegin;
8288   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8289   PetscValidPointer(label,2);
8290   PetscValidPointer(dmAdapt,3);
8291   *dmAdapt = NULL;
8292   if (!dm->ops->adaptlabel) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptLabel",((PetscObject)dm)->type_name);
8293   ierr = (dm->ops->adaptlabel)(dm, label, dmAdapt);CHKERRQ(ierr);
8294   PetscFunctionReturn(0);
8295 }
8296 
8297 /*@C
8298   DMAdaptMetric - Generates a mesh adapted to the specified metric field using the pragmatic library.
8299 
8300   Input Parameters:
8301 + dm - The DM object
8302 . metric - The metric to which the mesh is adapted, defined vertex-wise.
8303 - bdLabel - Label for boundary tags, which will be preserved in the output mesh. bdLabel should be NULL if there is no such label, and should be different from "_boundary_".
8304 
8305   Output Parameter:
8306 . dmAdapt  - Pointer to the DM object containing the adapted mesh
8307 
8308   Note: The label in the adapted mesh will be registered under the name of the input DMLabel object
8309 
8310   Level: advanced
8311 
8312 .seealso: DMAdaptLabel(), DMCoarsen(), DMRefine()
8313 @*/
8314 PetscErrorCode DMAdaptMetric(DM dm, Vec metric, DMLabel bdLabel, DM *dmAdapt)
8315 {
8316   PetscErrorCode ierr;
8317 
8318   PetscFunctionBegin;
8319   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8320   PetscValidHeaderSpecific(metric, VEC_CLASSID, 2);
8321   if (bdLabel) PetscValidPointer(bdLabel, 3);
8322   PetscValidPointer(dmAdapt, 4);
8323   *dmAdapt = NULL;
8324   if (!dm->ops->adaptmetric) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMAdaptMetric",((PetscObject)dm)->type_name);
8325   ierr = (dm->ops->adaptmetric)(dm, metric, bdLabel, dmAdapt);CHKERRQ(ierr);
8326   PetscFunctionReturn(0);
8327 }
8328 
8329 /*@C
8330  DMGetNeighbors - Gets an array containing the MPI rank of all the processes neighbors
8331 
8332  Not Collective
8333 
8334  Input Parameter:
8335 .  dm    - The DM
8336 
8337  Output Parameters:
8338 +  nranks - the number of neighbours
8339 -  ranks - the neighbors ranks
8340 
8341  Notes:
8342  Do not free the array, it is freed when the DM is destroyed.
8343 
8344  Level: beginner
8345 
8346  .seealso: DMDAGetNeighbors(), PetscSFGetRootRanks()
8347 @*/
8348 PetscErrorCode DMGetNeighbors(DM dm,PetscInt *nranks,const PetscMPIInt *ranks[])
8349 {
8350   PetscErrorCode ierr;
8351 
8352   PetscFunctionBegin;
8353   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
8354   if (!dm->ops->getneighbors) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"DM type %s does not implement DMGetNeighbors",((PetscObject)dm)->type_name);
8355   ierr = (dm->ops->getneighbors)(dm,nranks,ranks);CHKERRQ(ierr);
8356   PetscFunctionReturn(0);
8357 }
8358 
8359 #include <petsc/private/matimpl.h> /* Needed because of coloring->ctype below */
8360 
8361 /*
8362     Converts the input vector to a ghosted vector and then calls the standard coloring code.
8363     This has be a different function because it requires DM which is not defined in the Mat library
8364 */
8365 PetscErrorCode  MatFDColoringApply_AIJDM(Mat J,MatFDColoring coloring,Vec x1,void *sctx)
8366 {
8367   PetscErrorCode ierr;
8368 
8369   PetscFunctionBegin;
8370   if (coloring->ctype == IS_COLORING_LOCAL) {
8371     Vec x1local;
8372     DM  dm;
8373     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
8374     if (!dm) SETERRQ(PetscObjectComm((PetscObject)J),PETSC_ERR_ARG_INCOMP,"IS_COLORING_LOCAL requires a DM");
8375     ierr = DMGetLocalVector(dm,&x1local);CHKERRQ(ierr);
8376     ierr = DMGlobalToLocalBegin(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
8377     ierr = DMGlobalToLocalEnd(dm,x1,INSERT_VALUES,x1local);CHKERRQ(ierr);
8378     x1   = x1local;
8379   }
8380   ierr = MatFDColoringApply_AIJ(J,coloring,x1,sctx);CHKERRQ(ierr);
8381   if (coloring->ctype == IS_COLORING_LOCAL) {
8382     DM  dm;
8383     ierr = MatGetDM(J,&dm);CHKERRQ(ierr);
8384     ierr = DMRestoreLocalVector(dm,&x1);CHKERRQ(ierr);
8385   }
8386   PetscFunctionReturn(0);
8387 }
8388 
8389 /*@
8390     MatFDColoringUseDM - allows a MatFDColoring object to use the DM associated with the matrix to use a IS_COLORING_LOCAL coloring
8391 
8392     Input Parameter:
8393 .    coloring - the MatFDColoring object
8394 
8395     Developer Notes:
8396     this routine exists because the PETSc Mat library does not know about the DM objects
8397 
8398     Level: advanced
8399 
8400 .seealso: MatFDColoring, MatFDColoringCreate(), ISColoringType
8401 @*/
8402 PetscErrorCode  MatFDColoringUseDM(Mat coloring,MatFDColoring fdcoloring)
8403 {
8404   PetscFunctionBegin;
8405   coloring->ops->fdcoloringapply = MatFDColoringApply_AIJDM;
8406   PetscFunctionReturn(0);
8407 }
8408 
8409 /*@
8410     DMGetCompatibility - determine if two DMs are compatible
8411 
8412     Collective
8413 
8414     Input Parameters:
8415 +    dm1 - the first DM
8416 -    dm2 - the second DM
8417 
8418     Output Parameters:
8419 +    compatible - whether or not the two DMs are compatible
8420 -    set - whether or not the compatible value was set
8421 
8422     Notes:
8423     Two DMs are deemed compatible if they represent the same parallel decomposition
8424     of the same topology. This implies that the section (field data) on one
8425     "makes sense" with respect to the topology and parallel decomposition of the other.
8426     Loosely speaking, compatible DMs represent the same domain and parallel
8427     decomposition, but hold different data.
8428 
8429     Typically, one would confirm compatibility if intending to simultaneously iterate
8430     over a pair of vectors obtained from different DMs.
8431 
8432     For example, two DMDA objects are compatible if they have the same local
8433     and global sizes and the same stencil width. They can have different numbers
8434     of degrees of freedom per node. Thus, one could use the node numbering from
8435     either DM in bounds for a loop over vectors derived from either DM.
8436 
8437     Consider the operation of summing data living on a 2-dof DMDA to data living
8438     on a 1-dof DMDA, which should be compatible, as in the following snippet.
8439 .vb
8440   ...
8441   ierr = DMGetCompatibility(da1,da2,&compatible,&set);CHKERRQ(ierr);
8442   if (set && compatible)  {
8443     ierr = DMDAVecGetArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
8444     ierr = DMDAVecGetArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
8445     ierr = DMDAGetCorners(da1,&x,&y,NULL,&m,&n,NULL);CHKERRQ(ierr);
8446     for (j=y; j<y+n; ++j) {
8447       for (i=x; i<x+m, ++i) {
8448         arr1[j][i][0] = arr2[j][i][0] + arr2[j][i][1];
8449       }
8450     }
8451     ierr = DMDAVecRestoreArrayDOF(da1,vec1,&arr1);CHKERRQ(ierr);
8452     ierr = DMDAVecRestoreArrayDOF(da2,vec2,&arr2);CHKERRQ(ierr);
8453   } else {
8454     SETERRQ(PetscObjectComm((PetscObject)da1,PETSC_ERR_ARG_INCOMP,"DMDA objects incompatible");
8455   }
8456   ...
8457 .ve
8458 
8459     Checking compatibility might be expensive for a given implementation of DM,
8460     or might be impossible to unambiguously confirm or deny. For this reason,
8461     this function may decline to determine compatibility, and hence users should
8462     always check the "set" output parameter.
8463 
8464     A DM is always compatible with itself.
8465 
8466     In the current implementation, DMs which live on "unequal" communicators
8467     (MPI_UNEQUAL in the terminology of MPI_Comm_compare()) are always deemed
8468     incompatible.
8469 
8470     This function is labeled "Collective," as information about all subdomains
8471     is required on each rank. However, in DM implementations which store all this
8472     information locally, this function may be merely "Logically Collective".
8473 
8474     Developer Notes:
8475     Compatibility is assumed to be a symmetric concept; DM A is compatible with DM B
8476     iff B is compatible with A. Thus, this function checks the implementations
8477     of both dm and dmc (if they are of different types), attempting to determine
8478     compatibility. It is left to DM implementers to ensure that symmetry is
8479     preserved. The simplest way to do this is, when implementing type-specific
8480     logic for this function, is to check for existing logic in the implementation
8481     of other DM types and let *set = PETSC_FALSE if found.
8482 
8483     Level: advanced
8484 
8485 .seealso: DM, DMDACreateCompatibleDMDA(), DMStagCreateCompatibleDMStag()
8486 @*/
8487 
8488 PetscErrorCode DMGetCompatibility(DM dm1,DM dm2,PetscBool *compatible,PetscBool *set)
8489 {
8490   PetscErrorCode ierr;
8491   PetscMPIInt    compareResult;
8492   DMType         type,type2;
8493   PetscBool      sameType;
8494 
8495   PetscFunctionBegin;
8496   PetscValidHeaderSpecific(dm1,DM_CLASSID,1);
8497   PetscValidHeaderSpecific(dm2,DM_CLASSID,2);
8498 
8499   /* Declare a DM compatible with itself */
8500   if (dm1 == dm2) {
8501     *set = PETSC_TRUE;
8502     *compatible = PETSC_TRUE;
8503     PetscFunctionReturn(0);
8504   }
8505 
8506   /* Declare a DM incompatible with a DM that lives on an "unequal"
8507      communicator. Note that this does not preclude compatibility with
8508      DMs living on "congruent" or "similar" communicators, but this must be
8509      determined by the implementation-specific logic */
8510   ierr = MPI_Comm_compare(PetscObjectComm((PetscObject)dm1),PetscObjectComm((PetscObject)dm2),&compareResult);CHKERRQ(ierr);
8511   if (compareResult == MPI_UNEQUAL) {
8512     *set = PETSC_TRUE;
8513     *compatible = PETSC_FALSE;
8514     PetscFunctionReturn(0);
8515   }
8516 
8517   /* Pass to the implementation-specific routine, if one exists. */
8518   if (dm1->ops->getcompatibility) {
8519     ierr = (*dm1->ops->getcompatibility)(dm1,dm2,compatible,set);CHKERRQ(ierr);
8520     if (*set) PetscFunctionReturn(0);
8521   }
8522 
8523   /* If dm1 and dm2 are of different types, then attempt to check compatibility
8524      with an implementation of this function from dm2 */
8525   ierr = DMGetType(dm1,&type);CHKERRQ(ierr);
8526   ierr = DMGetType(dm2,&type2);CHKERRQ(ierr);
8527   ierr = PetscStrcmp(type,type2,&sameType);CHKERRQ(ierr);
8528   if (!sameType && dm2->ops->getcompatibility) {
8529     ierr = (*dm2->ops->getcompatibility)(dm2,dm1,compatible,set);CHKERRQ(ierr); /* Note argument order */
8530   } else {
8531     *set = PETSC_FALSE;
8532   }
8533   PetscFunctionReturn(0);
8534 }
8535 
8536 /*@C
8537   DMMonitorSet - Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
8538 
8539   Logically Collective on DM
8540 
8541   Input Parameters:
8542 + DM - the DM
8543 . f - the monitor function
8544 . mctx - [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
8545 - monitordestroy - [optional] routine that frees monitor context (may be NULL)
8546 
8547   Options Database Keys:
8548 - -dm_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to DMMonitorSet(), but
8549                             does not cancel those set via the options database.
8550 
8551   Notes:
8552   Several different monitoring routines may be set by calling
8553   DMMonitorSet() multiple times; all will be called in the
8554   order in which they were set.
8555 
8556   Fortran Notes:
8557   Only a single monitor function can be set for each DM object
8558 
8559   Level: intermediate
8560 
8561 .seealso: DMMonitorCancel()
8562 @*/
8563 PetscErrorCode DMMonitorSet(DM dm, PetscErrorCode (*f)(DM, void *), void *mctx, PetscErrorCode (*monitordestroy)(void**))
8564 {
8565   PetscInt       m;
8566   PetscErrorCode ierr;
8567 
8568   PetscFunctionBegin;
8569   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8570   for (m = 0; m < dm->numbermonitors; ++m) {
8571     PetscBool identical;
8572 
8573     ierr = PetscMonitorCompare((PetscErrorCode (*)(void)) f, mctx, monitordestroy, (PetscErrorCode (*)(void)) dm->monitor[m], dm->monitorcontext[m], dm->monitordestroy[m], &identical);CHKERRQ(ierr);
8574     if (identical) PetscFunctionReturn(0);
8575   }
8576   if (dm->numbermonitors >= MAXDMMONITORS) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Too many monitors set");
8577   dm->monitor[dm->numbermonitors]          = f;
8578   dm->monitordestroy[dm->numbermonitors]   = monitordestroy;
8579   dm->monitorcontext[dm->numbermonitors++] = (void *) mctx;
8580   PetscFunctionReturn(0);
8581 }
8582 
8583 /*@
8584   DMMonitorCancel - Clears all the monitor functions for a DM object.
8585 
8586   Logically Collective on DM
8587 
8588   Input Parameter:
8589 . dm - the DM
8590 
8591   Options Database Key:
8592 . -dm_monitor_cancel - cancels all monitors that have been hardwired
8593   into a code by calls to DMonitorSet(), but does not cancel those
8594   set via the options database
8595 
8596   Notes:
8597   There is no way to clear one specific monitor from a DM object.
8598 
8599   Level: intermediate
8600 
8601 .seealso: DMMonitorSet()
8602 @*/
8603 PetscErrorCode DMMonitorCancel(DM dm)
8604 {
8605   PetscErrorCode ierr;
8606   PetscInt       m;
8607 
8608   PetscFunctionBegin;
8609   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8610   for (m = 0; m < dm->numbermonitors; ++m) {
8611     if (dm->monitordestroy[m]) {ierr = (*dm->monitordestroy[m])(&dm->monitorcontext[m]);CHKERRQ(ierr);}
8612   }
8613   dm->numbermonitors = 0;
8614   PetscFunctionReturn(0);
8615 }
8616 
8617 /*@C
8618   DMMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
8619 
8620   Collective on DM
8621 
8622   Input Parameters:
8623 + dm   - DM object you wish to monitor
8624 . name - the monitor type one is seeking
8625 . help - message indicating what monitoring is done
8626 . manual - manual page for the monitor
8627 . monitor - the monitor function
8628 - 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
8629 
8630   Output Parameter:
8631 . flg - Flag set if the monitor was created
8632 
8633   Level: developer
8634 
8635 .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
8636           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
8637           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
8638           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
8639           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
8640           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
8641           PetscOptionsFList(), PetscOptionsEList()
8642 @*/
8643 PetscErrorCode DMMonitorSetFromOptions(DM dm, const char name[], const char help[], const char manual[], PetscErrorCode (*monitor)(DM, void *), PetscErrorCode (*monitorsetup)(DM, PetscViewerAndFormat *), PetscBool *flg)
8644 {
8645   PetscViewer       viewer;
8646   PetscViewerFormat format;
8647   PetscErrorCode    ierr;
8648 
8649   PetscFunctionBegin;
8650   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8651   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject) dm), ((PetscObject) dm)->options, ((PetscObject) dm)->prefix, name, &viewer, &format, flg);CHKERRQ(ierr);
8652   if (*flg) {
8653     PetscViewerAndFormat *vf;
8654 
8655     ierr = PetscViewerAndFormatCreate(viewer, format, &vf);CHKERRQ(ierr);
8656     ierr = PetscObjectDereference((PetscObject) viewer);CHKERRQ(ierr);
8657     if (monitorsetup) {ierr = (*monitorsetup)(dm, vf);CHKERRQ(ierr);}
8658     ierr = DMMonitorSet(dm,(PetscErrorCode (*)(DM, void *)) monitor, vf, (PetscErrorCode (*)(void **)) PetscViewerAndFormatDestroy);CHKERRQ(ierr);
8659   }
8660   PetscFunctionReturn(0);
8661 }
8662 
8663 /*@
8664    DMMonitor - runs the user provided monitor routines, if they exist
8665 
8666    Collective on DM
8667 
8668    Input Parameters:
8669 .  dm - The DM
8670 
8671    Level: developer
8672 
8673 .seealso: DMMonitorSet()
8674 @*/
8675 PetscErrorCode DMMonitor(DM dm)
8676 {
8677   PetscInt       m;
8678   PetscErrorCode ierr;
8679 
8680   PetscFunctionBegin;
8681   if (!dm) PetscFunctionReturn(0);
8682   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
8683   for (m = 0; m < dm->numbermonitors; ++m) {
8684     ierr = (*dm->monitor[m])(dm, dm->monitorcontext[m]);CHKERRQ(ierr);
8685   }
8686   PetscFunctionReturn(0);
8687 }
8688