xref: /petsc/include/petscdmplextypes.h (revision 9371c9d470a9602b6d10a8bf50c9b2280a79e45a)
1 #if !defined(PETSCDMPLEXTYPES_H)
2 #define PETSCDMPLEXTYPES_H
3 
4 /* SUBMANSEC = DMPlex */
5 
6 /*E
7   DMPlexShape - The domain shape used for automatic mesh creation.
8 
9   Existing shapes include
10 $ DM_SHAPE_BOX         - The tensor product of intervals in dimension d
11 $ DM_SHAPE_BOX_SURFACE - The surface of a box in dimension d+1
12 $ DM_SHAPE_BALL        - The d-dimensional ball
13 $ DM_SHAPE_SPHERE      - The surface of the (d+1)-dimensional ball
14 $ DM_SHAPE_CYLINDER    - The tensor product of the interval and disk
15 $ DM_SHAPE_SCHWARZ_P   - The Schwarz-P triply periodic minimal surface
16 $ DM_SHAPE_GYROID      - The Gyroid triply periodic minimal surface
17 $ DM_SHAPE_DOUBLET     - The mesh of two cells of a specified type
18 
19   Level: beginner
20 
21 .seealso: `DMPlexGetCellRefiner()`, `DMPlexSetCellRefiner()`, `DMRefine()`, `DMPolytopeType`
22 E*/
23 typedef enum {
24   DM_SHAPE_BOX,
25   DM_SHAPE_BOX_SURFACE,
26   DM_SHAPE_BALL,
27   DM_SHAPE_SPHERE,
28   DM_SHAPE_CYLINDER,
29   DM_SHAPE_SCHWARZ_P,
30   DM_SHAPE_GYROID,
31   DM_SHAPE_DOUBLET,
32   DM_SHAPE_UNKNOWN
33 } DMPlexShape;
34 PETSC_EXTERN const char *const DMPlexShapes[];
35 
36 /*E
37   DMPlexCSRAlgorithm - The algorithm for building the adjacency graph in CSR format, usually for a mesh partitioner
38 
39   Existing shapes include
40 $ DM_PLEX_CSR_MAT     - Use `MatPartitioning` by first making a matrix
41 $ DM_PLEX_CSR_GRAPH   - Use the original `DMPLEX` and communicate along the boundary
42 $ DM_PLEX_CSR_OVERLAP - Build an overlapped `DMPLEX` and then locally compute
43 
44   Level: beginner
45 
46 .seealso: `DMPlexCreatePartitionerGraph()`, `PetscPartitionerDMPlexPartition()`, `DMPlexDistribute()`
47 E*/
48 typedef enum {
49   DM_PLEX_CSR_MAT,
50   DM_PLEX_CSR_GRAPH,
51   DM_PLEX_CSR_OVERLAP
52 } DMPlexCSRAlgorithm;
53 PETSC_EXTERN const char *const DMPlexCSRAlgorithms[];
54 
55 typedef struct _p_DMPlexPointQueue *DMPlexPointQueue;
56 struct _p_DMPlexPointQueue {
57   PetscInt  size;   /* Size of the storage array */
58   PetscInt *points; /* Array of mesh points */
59   PetscInt  front;  /* Index of the front of the queue */
60   PetscInt  back;   /* Index of the back of the queue */
61   PetscInt  num;    /* Number of enqueued points */
62 };
63 
64 #endif
65