xref: /petsc/include/petscdmplextypes.h (revision 8fb5bd83c3955fefcf33a54e3bb66920a9fa884b)
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 {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_DOUBLET, DM_SHAPE_UNKNOWN} DMPlexShape;
24 PETSC_EXTERN const char * const DMPlexShapes[];
25 
26 /*E
27   DMPlexCSRAlgorithm - The algorithm for building the adjacency graph in CSR format, usually for a mesh partitioner
28 
29   Existing shapes include
30 $ DM_PLEX_CSR_MAT     - Use MatPartition by first making a matrix
31 $ DM_PLEX_CSR_GRAPH   - Use the original Plex and communicate along the boundary
32 $ DM_PLEX_CSR_OVERLAP - Build an overlapped Plex and then locally compute
33 
34   Level: beginner
35 
36 .seealso: `DMPlexCreatePartitionerGraph()`, `PetscPartitionerDMPlexPartition()`, `DMPlexDistribute()`
37 E*/
38 typedef enum {DM_PLEX_CSR_MAT, DM_PLEX_CSR_GRAPH, DM_PLEX_CSR_OVERLAP} DMPlexCSRAlgorithm;
39 PETSC_EXTERN const char * const DMPlexCSRAlgorithms[];
40 
41 typedef struct _p_DMPlexPointQueue *DMPlexPointQueue;
42 struct _p_DMPlexPointQueue {
43   PetscInt  size;   /* Size of the storage array */
44   PetscInt *points; /* Array of mesh points */
45   PetscInt  front;  /* Index of the front of the queue */
46   PetscInt  back;   /* Index of the back of the queue */
47   PetscInt  num;    /* Number of enqueued points */
48 };
49 
50 #endif
51