xref: /petsc/include/petscdmtypes.h (revision bff4a2f0161c89c6cc121ba5e8b00c1191c71813)
11e25c274SJed Brown #if !defined(_PETSCDMTYPES_H)
21e25c274SJed Brown #define _PETSCDMTYPES_H
31e25c274SJed Brown 
41e25c274SJed Brown /*S
51e25c274SJed Brown      DM - Abstract PETSc object that manages an abstract grid object and its interactions with the algebraic solvers
61e25c274SJed Brown 
71e25c274SJed Brown    Level: intermediate
81e25c274SJed Brown 
91e25c274SJed Brown   Concepts: grids, grid refinement
101e25c274SJed Brown 
111e25c274SJed Brown    Notes: The DMDACreate() based object and the DMCompositeCreate() based object are examples of DMs
121e25c274SJed Brown 
131e25c274SJed Brown .seealso:  DMCompositeCreate(), DMDACreate(), DMSetType(), DMType
141e25c274SJed Brown S*/
151e25c274SJed Brown typedef struct _p_DM* DM;
161e25c274SJed Brown 
17*bff4a2f0SMatthew G. Knepley /*E
18*bff4a2f0SMatthew G. Knepley   DMBoundaryType - Describes the choice for fill of ghost cells on physical domain boundaries.
19*bff4a2f0SMatthew G. Knepley 
20*bff4a2f0SMatthew G. Knepley   Level: beginner
21*bff4a2f0SMatthew G. Knepley 
22*bff4a2f0SMatthew G. Knepley   A boundary may be of type DM_BOUNDARY_NONE (no ghost nodes), DM_BOUNDARY_GHOST (ghost vertices/cells
23*bff4a2f0SMatthew G. Knepley   exist but aren't filled, you can put values into them and then apply a stencil that uses those ghost locations),
24*bff4a2f0SMatthew G. Knepley   DM_BOUNDARY_MIRROR (not yet implemented for 3d), DM_BOUNDARY_PERIODIC (ghost vertices/cells filled by the opposite
25*bff4a2f0SMatthew G. Knepley   edge of the domain), or DM_BOUNDARY_TWIST (like periodic, only glued backwards like a Mobius strip).
26*bff4a2f0SMatthew G. Knepley 
27*bff4a2f0SMatthew G. Knepley   Note: This is information for the boundary of the __PHYSICAL__ domain. It has nothing to do with boundaries between
28*bff4a2f0SMatthew G. Knepley   processes, that width is always determined by the stencil width, see DMDASetStencilWidth().
29*bff4a2f0SMatthew G. Knepley 
30*bff4a2f0SMatthew G. Knepley .seealso: DMDASetBoundaryType(), DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDACreate()
31*bff4a2f0SMatthew G. Knepley E*/
32*bff4a2f0SMatthew G. Knepley typedef enum {DM_BOUNDARY_NONE, DM_BOUNDARY_GHOSTED, DM_BOUNDARY_MIRROR, DM_BOUNDARY_PERIODIC, DM_BOUNDARY_TWIST} DMBoundaryType;
33*bff4a2f0SMatthew G. Knepley 
341e25c274SJed Brown #endif
35