xref: /petsc/include/petscdmplextypes.h (revision ae8b063e4f7e8ac6d2de6909aa6d539b126b38d9)
1 #if !defined(PETSCDMPLEXTYPES_H)
2 #define PETSCDMPLEXTYPES_H
3 
4 /*E
5   DMPlexShape - The domain shape used for automatic mesh creation.
6 
7   Existing shapes include
8 $ DM_SHAPE_BOX         - The tensor product of intervals in dimension d
9 $ DM_SHAPE_BOX_SURFACE - The surface of a box in dimension d+1
10 $ DM_SHAPE_BALL        - The d-dimensional ball
11 $ DM_SHAPE_SPHERE      - The surface of the (d+1)-dimensional ball
12 $ DM_SHAPE_CYLINDER    - The tensor product of the interval and disk
13 $ DM_SHAPE_SCHWARZ_P   - The Schwarz-P triply periodic minimal surface
14 $ DM_SHAPE_GYROID      - The Gyroid triply periodic minimal surface
15 
16   Level: beginner
17 
18 .seealso: DMPlexGetCellRefiner(), DMPlexSetCellRefiner(), DMRefine(), DMPolytopeType
19 E*/
20 typedef enum {DM_SHAPE_BOX, DM_SHAPE_BOX_SURFACE, DM_SHAPE_BALL, DM_SHAPE_SPHERE, DM_SHAPE_CYLINDER, DM_SHAPE_SCHWARZ_P, DM_SHAPE_GYROID, DM_SHAPE_UNKNOWN} DMPlexShape;
21 PETSC_EXTERN const char * const DMPlexShapes[];
22 
23 /*E
24   DMPlexCSRAlgorithm - The algorithm for building the adjacency graph in CSR format, usually for a mesh partitioner
25 
26   Existing shapes include
27 $ DM_PLEX_CSR_MAT     - Use MatPartition by first making a matrix
28 $ DM_PLEX_CSR_GRAPH   - Use the original Plex and communicate along the boundary
29 $ DM_PLEX_CSR_OVERLAP - Build an overlapped Plex and then locally compute
30 
31   Level: beginner
32 
33 .seealso: DMPlexCreatePartitionerGraph(), PetscPartitionerDMPlexPartition(), DMPlexDistribute()
34 E*/
35 typedef enum {DM_PLEX_CSR_MAT, DM_PLEX_CSR_GRAPH, DM_PLEX_CSR_OVERLAP} DMPlexCSRAlgorithm;
36 PETSC_EXTERN const char * const DMPlexCSRAlgorithms[];
37 
38 #endif
39