1: #if !defined(_PETSCDMTYPES_H)
  2: #define _PETSCDMTYPES_H

  4: /*S
  5:      DM - Abstract PETSc object that manages an abstract grid object and its interactions with the algebraic solvers

  7:    Level: intermediate

  9:   Concepts: grids, grid refinement

 11:    Notes: The DMDACreate() based object and the DMCompositeCreate() based object are examples of DMs

 13: .seealso:  DMCompositeCreate(), DMDACreate(), DMSetType(), DMType
 14: S*/
 15: typedef struct _p_DM* DM;

 17: /*E
 18:   DMBoundaryType - Describes the choice for fill of ghost cells on physical domain boundaries.

 20:   Level: beginner

 22:   A boundary may be of type DM_BOUNDARY_NONE (no ghost nodes), DM_BOUNDARY_GHOSTED (ghost vertices/cells
 23:   exist but aren't filled, you can put values into them and then apply a stencil that uses those ghost locations),
 24:   DM_BOUNDARY_MIRROR (the ghost value is the same as the value 1 grid point in; that is the 0th grid point in the real mesh acts like a mirror to define the ghost point value; 
 25:   not yet implemented for 3d), DM_BOUNDARY_PERIODIC (ghost vertices/cells filled by the opposite
 26:   edge of the domain), or DM_BOUNDARY_TWIST (like periodic, only glued backwards like a Mobius strip).

 28:   Note: This is information for the boundary of the __PHYSICAL__ domain. It has nothing to do with boundaries between
 29:   processes, that width is always determined by the stencil width, see DMDASetStencilWidth().

 31:   Note: If the physical grid points have values  0 1 2 3 with DM_BOUNDARY_MIRROR then the local vector with ghost points has the values 1 0 1 2 3 2

 33:   Developer notes: Should DM_BOUNDARY_MIRROR have the same meaning with DMDA_Q0, that is a staggered grid? In that case should the ghost point have the same value
 34:   as the 0th grid point where the physical boundary serves as the mirror?

 36:   References: http://scicomp.stackexchange.com/questions/5355/writing-the-poisson-equation-finite-difference-matrix-with-neumann-boundary-cond

 38: .seealso: DMDASetBoundaryType(), DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDACreate()
 39: E*/
 40: typedef enum {DM_BOUNDARY_NONE, DM_BOUNDARY_GHOSTED, DM_BOUNDARY_MIRROR, DM_BOUNDARY_PERIODIC, DM_BOUNDARY_TWIST} DMBoundaryType;

 42: /*E
 43:   DMBoundaryConditionType - indicates what type of boundary condition is to be imposed

 45:   Note: This flag indicates the type of function which will define the condition:
 46: $ DM_BC_ESSENTIAL       - A Dirichlet condition using a function of the coordinates
 47: $ DM_BC_ESSENTIAL_FIELD - A Dirichlet condition using a function of the coordinates and auxiliary field data
 48: $ DM_BC_NATURAL         - A Neumann condition using a function of the coordinates
 49: $ DM_BC_NATURAL_FIELD   - A Dirichlet condition using a function of the coordinates and auxiliary field data
 50: $ DM_BC_NATURAL_RIEMANN - A flux condition which determines the state in ghost cells
 51: The user can check whether a boundary condition is essential using (type & DM_BC_ESSENTIAL), and similarly for
 52: natural conditions (type & DM_BC_NATURAL)

 54:   Level: beginner

 56: .seealso: DMAddBoundary(), DMGetBoundary()
 57: E*/
 58: typedef enum {DM_BC_ESSENTIAL = 1, DM_BC_ESSENTIAL_FIELD = 5, DM_BC_NATURAL = 2, DM_BC_NATURAL_FIELD = 6, DM_BC_NATURAL_RIEMANN = 10} DMBoundaryConditionType;

 60: /*E
 61:   DMPointLocationType - Describes the method to handle point location failure

 63:   Level: beginner

 65:   If a search using DM_POINTLOCATION_NONE fails, the failure is signaled with a negative cell number. On the
 66:   other hand, if DM_POINTLOCATION_NEAREST is used, on failure, the (approximate) nearest point in the mesh is
 67:   used, replacing the given point in the input vector. DM_POINTLOCATION_REMOVE returns values only for points
 68:   which were located.

 70: .seealso: DMLocatePoints()
 71: E*/
 72: typedef enum {DM_POINTLOCATION_NONE, DM_POINTLOCATION_NEAREST, DM_POINTLOCATION_REMOVE} DMPointLocationType;

 74: /*E
 75:   DMAdaptationStrategy - Describes the strategy used for adaptive solves

 77:   Level: beginner

 79:   DM_ADAPTATION_INITIAL will refine a mesh based on an initial guess. DM_ADAPTATION_SEQUENTIAL will refine the
 80:   mesh based on a sequence of solves, much like grid sequencing. DM_ADAPTATION_MULTILEVEL will use the sequence
 81:   of constructed meshes in a multilevel solve, much like the Systematic Upscaling of Brandt.

 83: .seealso: DMAdaptorSolve()
 84: E*/
 85: typedef enum {DM_ADAPTATION_INITIAL, DM_ADAPTATION_SEQUENTIAL, DM_ADAPTATION_MULTILEVEL} DMAdaptationStrategy;

 87: /*E
 88:   DMAdaptationCriterion - Describes the test used to decide whether to coarsen or refine parts of the mesh

 90:   Level: beginner

 92:   DM_ADAPTATION_REFINE will uniformly refine a mesh, much like grid sequencing. DM_ADAPTATION_LABEL will adapt
 93:   the mesh based upon a label of the cells filled with DMAdaptFlag markers. DM_ADAPTATION_METRIC will try to
 94:   mesh the manifold described by the input metric tensor uniformly. PETSc can also construct such a metric based
 95:   upon an input primal or a gradient field.

 97: .seealso: DMAdaptorSolve()
 98: E*/
 99: typedef enum {DM_ADAPTATION_NONE, DM_ADAPTATION_REFINE, DM_ADAPTATION_LABEL, DM_ADAPTATION_METRIC} DMAdaptationCriterion;

101: /*E
102:   DMAdaptFlag - Marker in the label prescribing adaptation

104:   Level: beginner

106: .seealso: DMAdaptLabel()
107: E*/
108: typedef enum {DM_ADAPT_DETERMINE = PETSC_DETERMINE, DM_ADAPT_KEEP = 0, DM_ADAPT_REFINE, DM_ADAPT_COARSEN, DM_ADAPT_RESERVED_COUNT} DMAdaptFlag;

110: /*S
111:   PetscPartitioner - PETSc object that manages a graph partitioner

113:   Level: intermediate

115:   Concepts: partition, mesh

117: .seealso: PetscPartitionerCreate(), PetscPartitionerSetType(), PetscPartitionerType
118: S*/
119: typedef struct _p_PetscPartitioner *PetscPartitioner;

121: /*E
122:   PetscUnit - The seven fundamental SI units

124:   Level: beginner

126: .seealso: DMPlexGetScale(), DMPlexSetScale()
127: E*/
128: typedef enum {PETSC_UNIT_LENGTH, PETSC_UNIT_MASS, PETSC_UNIT_TIME, PETSC_UNIT_CURRENT, PETSC_UNIT_TEMPERATURE, PETSC_UNIT_AMOUNT, PETSC_UNIT_LUMINOSITY, NUM_PETSC_UNITS} PetscUnit;

130: #endif