xref: /petsc/include/petscdmplextypes.h (revision d71ae5a4db6382e7f06317b8d368875286fe9008)
1 #ifndef 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 $ DM_SHAPE_ANNULUS     - The area between two concentric spheres in dimension d
19 
20   Level: beginner
21 
22 .seealso: `DMPlexGetCellRefiner()`, `DMPlexSetCellRefiner()`, `DMRefine()`, `DMPolytopeType`
23 E*/
24 typedef enum {
25   DM_SHAPE_BOX,
26   DM_SHAPE_BOX_SURFACE,
27   DM_SHAPE_BALL,
28   DM_SHAPE_SPHERE,
29   DM_SHAPE_CYLINDER,
30   DM_SHAPE_SCHWARZ_P,
31   DM_SHAPE_GYROID,
32   DM_SHAPE_DOUBLET,
33   DM_SHAPE_ANNULUS,
34   DM_SHAPE_UNKNOWN
35 } DMPlexShape;
36 PETSC_EXTERN const char *const DMPlexShapes[];
37 
38 /*E
39   DMPlexCSRAlgorithm - The algorithm for building the adjacency graph in CSR format, usually for a mesh partitioner
40 
41   Existing shapes include
42 $ DM_PLEX_CSR_MAT     - Use `MatPartitioning` by first making a matrix
43 $ DM_PLEX_CSR_GRAPH   - Use the original `DMPLEX` and communicate along the boundary
44 $ DM_PLEX_CSR_OVERLAP - Build an overlapped `DMPLEX` and then locally compute
45 
46   Level: beginner
47 
48 .seealso: `DMPlexCreatePartitionerGraph()`, `PetscPartitionerDMPlexPartition()`, `DMPlexDistribute()`
49 E*/
50 typedef enum {
51   DM_PLEX_CSR_MAT,
52   DM_PLEX_CSR_GRAPH,
53   DM_PLEX_CSR_OVERLAP
54 } DMPlexCSRAlgorithm;
55 PETSC_EXTERN const char *const DMPlexCSRAlgorithms[];
56 
57 typedef struct _p_DMPlexPointQueue *DMPlexPointQueue;
58 struct _p_DMPlexPointQueue {
59   PetscInt  size;   /* Size of the storage array */
60   PetscInt *points; /* Array of mesh points */
61   PetscInt  front;  /* Index of the front of the queue */
62   PetscInt  back;   /* Index of the back of the queue */
63   PetscInt  num;    /* Number of enqueued points */
64 };
65 
66 #endif
67