1: #if !defined(PETSCDMTYPES_H) 2:#define PETSCDMTYPES_H4: /*S 5: DM - Abstract PETSc object that manages an abstract grid object and its interactions with the algebraic solvers 7: Level: intermediate 9: Notes: 10: The DMDACreate() based object and the DMCompositeCreate() based object are examples of DMs 12: .seealso: DMCompositeCreate(), DMDACreate(), DMSetType(), DMType 13: S*/ 14: typedef struct _p_DM* DM; 16: /*E 17: DMBoundaryType - Describes the choice for fill of ghost cells on physical domain boundaries. 19: Level: beginner 21: A boundary may be of type DM_BOUNDARY_NONE (no ghost nodes), DM_BOUNDARY_GHOSTED (ghost vertices/cells 22: exist but aren't filled; you can put values into them and then apply a stencil that uses those ghost locations), 23: 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; 24: not yet implemented for 3d), DM_BOUNDARY_PERIODIC (ghost vertices/cells filled by the opposite 25: edge of the domain), or DM_BOUNDARY_TWIST (like periodic, only glued backwards like a Mobius strip). 27: Notes: 28: 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: 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: 34: 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 35: as the 0th grid point where the physical boundary serves as the mirror? 37: References: 38: https://scicomp.stackexchange.com/questions/5355/writing-the-poisson-equation-finite-difference-matrix-with-neumann-boundary-cond 40: .seealso: DMDASetBoundaryType(), DMDACreate1d(), DMDACreate2d(), DMDACreate3d(), DMDACreate() 41: E*/ 42: typedef enum {DM_BOUNDARY_NONE, DM_BOUNDARY_GHOSTED, DM_BOUNDARY_MIRROR, DM_BOUNDARY_PERIODIC, DM_BOUNDARY_TWIST} DMBoundaryType; 43: /*E 44: DMBoundaryConditionType - indicates what type of boundary condition is to be imposed 46: Note: This flag indicates the type of function which will define the condition: 47: $ DM_BC_ESSENTIAL - A Dirichlet condition using a function of the coordinates 48: $ DM_BC_ESSENTIAL_FIELD - A Dirichlet condition using a function of the coordinates and auxiliary field data 49: $ DM_BC_ESSENTIAL_BD_FIELD - A Dirichlet condition using a function of the coordinates, facet normal, and auxiliary field data 50: $ DM_BC_NATURAL - A Neumann condition using a function of the coordinates 51: $ DM_BC_NATURAL_FIELD - A Neumann condition using a function of the coordinates and auxiliary field data 52: $ DM_BC_NATURAL_RIEMANN - A flux condition which determines the state in ghost cells 53: The user can check whether a boundary condition is essential using (type & DM_BC_ESSENTIAL), and similarly for 54: natural conditions (type & DM_BC_NATURAL) 56: Level: beginner 58: .seealso: DMAddBoundary(), DSAddBoundary(), DSGetBoundary() 59: E*/ 60: typedef enum {DM_BC_ESSENTIAL = 1, DM_BC_ESSENTIAL_FIELD = 5, DM_BC_NATURAL = 2, DM_BC_NATURAL_FIELD = 6, DM_BC_ESSENTIAL_BD_FIELD = 9, DM_BC_NATURAL_RIEMANN = 10} DMBoundaryConditionType; 62: /*E 63: DMPointLocationType - Describes the method to handle point location failure 65: Level: beginner 67: If a search using DM_POINTLOCATION_NONE fails, the failure is signaled with a negative cell number. On the 68: other hand, if DM_POINTLOCATION_NEAREST is used, on failure, the (approximate) nearest point in the mesh is 69: used, replacing the given point in the input vector. DM_POINTLOCATION_REMOVE returns values only for points 70: which were located. 72: .seealso: DMLocatePoints() 73: E*/ 74: typedef enum {DM_POINTLOCATION_NONE, DM_POINTLOCATION_NEAREST, DM_POINTLOCATION_REMOVE} DMPointLocationType; 76: /*E 77: DMAdaptationStrategy - Describes the strategy used for adaptive solves 79: Level: beginner 81: DM_ADAPTATION_INITIAL will refine a mesh based on an initial guess. DM_ADAPTATION_SEQUENTIAL will refine the 82: mesh based on a sequence of solves, much like grid sequencing. DM_ADAPTATION_MULTILEVEL will use the sequence 83: of constructed meshes in a multilevel solve, much like the Systematic Upscaling of Brandt. 85: .seealso: DMAdaptorSolve() 86: E*/ 87: typedef enum {DM_ADAPTATION_INITIAL, DM_ADAPTATION_SEQUENTIAL, DM_ADAPTATION_MULTILEVEL} DMAdaptationStrategy; 89: /*E 90: DMAdaptationCriterion - Describes the test used to decide whether to coarsen or refine parts of the mesh 92: Level: beginner 94: DM_ADAPTATION_REFINE will uniformly refine a mesh, much like grid sequencing. DM_ADAPTATION_LABEL will adapt 95: the mesh based upon a label of the cells filled with DMAdaptFlag markers. DM_ADAPTATION_METRIC will try to 96: mesh the manifold described by the input metric tensor uniformly. PETSc can also construct such a metric based 97: upon an input primal or a gradient field. 99: .seealso: DMAdaptorSolve() 100: E*/ 101: typedef enum {DM_ADAPTATION_NONE, DM_ADAPTATION_REFINE, DM_ADAPTATION_LABEL, DM_ADAPTATION_METRIC} DMAdaptationCriterion; 103: /*E 104: DMAdaptFlag - Marker in the label prescribing adaptation 106: Level: beginner 108: .seealso: DMAdaptLabel() 109: E*/ 110: typedef enum {DM_ADAPT_DETERMINE = PETSC_DETERMINE, DM_ADAPT_KEEP = 0, DM_ADAPT_REFINE, DM_ADAPT_COARSEN, DM_ADAPT_COARSEN_LAST, DM_ADAPT_RESERVED_COUNT} DMAdaptFlag; 112: /*E 113: DMDirection - Indicates a coordinate direction 115: Level: beginner 117: .seealso: DMDAGetRay(), DMDAGetProcessorSubset(), DMPlexShearGeometry() 118: E*/ 119: typedef enum {DM_X, DM_Y, DM_Z} DMDirection; 121: /*E 122: DMEnclosureType - The type of enclosure relation between one DM and another 124: Level: beginner 126: For example, one DM dmA may be the boundary of another dmB, in which case it would be labeled DM_ENC_SUBMESH. If 127: the situation is reversed, and dmA has boundary dmB, it would be labeled DM_ENC_SUPERMESH. Likewise, if dmA was 128: a subregion of dmB, it would be labeled DM_ENC_SUBMESH. If no relation can be determined, DM_ENC_NONE is used. 129: If a relation is not yet known, then DM_ENC_UNKNOWN is used. 131: .seealso: DMGetEnclosureRelation() 132: E*/ 133: typedef enum {DM_ENC_EQUALITY, DM_ENC_SUPERMESH, DM_ENC_SUBMESH, DM_ENC_NONE, DM_ENC_UNKNOWN} DMEnclosureType; 135: /*E 136: DMPolytopeType - This describes the polytope represented by each cell. 138: Level: beginner 140: While most operations only need the topology information in the Plex, we must sometimes have the 141: user specify a polytope. For instance, when interpolating from a cell-vertex mesh, the type of 142: polytope can be ambiguous. Also, Plex allows different symmetries of prism cell with the same 143: constituent points. Normally these types are autoamtically inferred and the user does not specify 144: them. 146: .seealso: DMPlexComputeCellTypes() 147: E*/ 148: typedef enum {DM_POLYTOPE_POINT, DM_POLYTOPE_SEGMENT, DM_POLYTOPE_POINT_PRISM_TENSOR, DM_POLYTOPE_TRIANGLE, DM_POLYTOPE_QUADRILATERAL, DM_POLYTOPE_SEG_PRISM_TENSOR, DM_POLYTOPE_TETRAHEDRON, DM_POLYTOPE_HEXAHEDRON, DM_POLYTOPE_TRI_PRISM, DM_POLYTOPE_TRI_PRISM_TENSOR, DM_POLYTOPE_QUAD_PRISM_TENSOR, DM_POLYTOPE_PYRAMID, DM_POLYTOPE_FV_GHOST, DM_POLYTOPE_INTERIOR_GHOST, DM_POLYTOPE_UNKNOWN, DM_NUM_POLYTOPES} DMPolytopeType; 149: PETSC_EXTERN const char *const DMPolytopeTypes[]; 151: /*E 152: PetscUnit - The seven fundamental SI units 154: Level: beginner 156: .seealso: DMPlexGetScale(), DMPlexSetScale() 157: E*/ 158: 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; 160: /*S 161: DMField - PETSc object for defining a field on a mesh topology 163: Level: intermediate 164: S*/ 165: typedef struct _p_DMField* DMField; 167: /*S 168: DMUniversalLabel - A label that encodes a set of DMLabels, bijectively 170: Level: developer 171: S*/ 172: typedef struct _p_UniversalLabel* DMUniversalLabel; 174: #endif