1 #if !defined(_PETSCDMTYPES_H) 2 #define _PETSCDMTYPES_H 3 4 /*S 5 DM - Abstract PETSc object that manages an abstract grid object and its interactions with the algebraic solvers 6 7 Level: intermediate 8 9 Concepts: grids, grid refinement 10 11 Notes: The DMDACreate() based object and the DMCompositeCreate() based object are examples of DMs 12 13 .seealso: DMCompositeCreate(), DMDACreate(), DMSetType(), DMType 14 S*/ 15 typedef struct _p_DM* DM; 16 17 /*E 18 DMBoundaryType - Describes the choice for fill of ghost cells on physical domain boundaries. 19 20 Level: beginner 21 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). 27 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(). 30 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 32 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? 35 36 References: http://scicomp.stackexchange.com/questions/5355/writing-the-poisson-equation-finite-difference-matrix-with-neumann-boundary-cond 37 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; 41 /*E 42 DMBoundaryConditionType - indicates what type of boundary condition is to be imposed 43 44 Note: This flag indicates the type of function which will define the condition: 45 $ DM_BC_ESSENTIAL - A Dirichlet condition using a function of the coordinates 46 $ DM_BC_ESSENTIAL_FIELD - A Dirichlet condition using a function of the coordinates and auxiliary field data 47 $ DM_BC_NATURAL - A Neumann condition using a function of the coordinates 48 $ DM_BC_NATURAL_FIELD - A Dirichlet condition using a function of the coordinates and auxiliary field data 49 $ DM_BC_NATURAL_RIEMANN - A flux condition which determines the state in ghost cells 50 The user can check whether a boundary condition is essential using (type & DM_BC_ESSENTIAL), and similarly for 51 natural conditions (type & DM_BC_NATURAL) 52 53 Level: beginner 54 55 .seealso: DMAddBoundary(), DMGetBoundary() 56 E*/ 57 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; 58 59 /*E 60 DMPointLocationType - Describes the method to handle point location failure 61 62 Level: beginner 63 64 If a search using DM_POINTLOCATION_NONE fails, the failure is signaled with a negative cell number. On the 65 other hand, if DM_POINTLOCATION_NEAREST is used, on failure, the (approximate) nearest point in the mesh is 66 used, replacing the given point in the input vector. DM_POINTLOCATION_REMOVE returns values only for points 67 which were located. 68 69 .seealso: DMLocatePoints() 70 E*/ 71 typedef enum {DM_POINTLOCATION_NONE, DM_POINTLOCATION_NEAREST, DM_POINTLOCATION_REMOVE} DMPointLocationType; 72 73 /*E 74 DMAdaptationStrategy - Describes the strategy used for adaptive solves 75 76 Level: beginner 77 78 DM_ADAPTATION_INITIAL will refine a mesh based on an initial guess. DM_ADAPTATION_SEQUENTIAL will refine the 79 mesh based on a sequence of solves, much like grid sequencing. DM_ADAPTATION_MULTILEVEL will use the sequence 80 of constructed meshes in a multilevel solve, much like the Systematic Upscaling of Brandt. 81 82 .seealso: DMAdaptorSolve() 83 E*/ 84 typedef enum {DM_ADAPTATION_INITIAL, DM_ADAPTATION_SEQUENTIAL, DM_ADAPTATION_MULTILEVEL} DMAdaptationStrategy; 85 86 /*E 87 DMAdaptationCriterion - Describes the test used to decide whether to coarsen or refine parts of the mesh 88 89 Level: beginner 90 91 DM_ADAPTATION_REFINE will uniformly refine a mesh, much like grid sequencing. DM_ADAPTATION_LABEL will adapt 92 the mesh based upon a label of the cells filled with DMAdaptFlag markers. DM_ADAPTATION_METRIC will try to 93 mesh the manifold described by the input metric tensor uniformly. PETSc can also construct such a metric based 94 upon an input primal or a gradient field. 95 96 .seealso: DMAdaptorSolve() 97 E*/ 98 typedef enum {DM_ADAPTATION_NONE, DM_ADAPTATION_REFINE, DM_ADAPTATION_LABEL, DM_ADAPTATION_METRIC} DMAdaptationCriterion; 99 100 /*E 101 DMAdaptFlag - Marker in the label prescribing adaptation 102 103 Level: beginner 104 105 .seealso: DMAdaptLabel() 106 E*/ 107 typedef enum {DM_ADAPT_DETERMINE = PETSC_DETERMINE, DM_ADAPT_KEEP = 0, DM_ADAPT_REFINE, DM_ADAPT_COARSEN, DM_ADAPT_RESERVED_COUNT} DMAdaptFlag; 108 109 /*S 110 PetscPartitioner - PETSc object that manages a graph partitioner 111 112 Level: intermediate 113 114 Concepts: partition, mesh 115 116 .seealso: PetscPartitionerCreate(), PetscPartitionerSetType(), PetscPartitionerType 117 S*/ 118 typedef struct _p_PetscPartitioner *PetscPartitioner; 119 120 /*E 121 PetscUnit - The seven fundamental SI units 122 123 Level: beginner 124 125 .seealso: DMPlexGetScale(), DMPlexSetScale() 126 E*/ 127 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; 128 129 /*S 130 DMField - PETSc object for defining a field on a mesh topology 131 132 Level: intermediate 133 S*/ 134 typedef struct _p_DMField* DMField; 135 136 #endif 137