@@ -6,6 +6,7 @@ the roots of `Pxest` quadtrees or octrees. The parameter `X` is 4 if the
66roots are quads (2D aka p4est) and 8 if they are hexes (3D aka p8est).
77
88# Fields
9+
910$(DocStringExtensions. FIELDS)
1011
1112# Usage
@@ -15,23 +16,23 @@ $(DocStringExtensions.FIELDS)
1516Construct a connectivity mesh for the roots of a forest-of-quadtrees using
1617p4est's built-in mesh connectivities. Valid values for `name` are
1718
18- - `:unitsquare`: the unit square.
19- - `:periodic`: all-periodic unit square.
20- - `:rotwrap`: periodic unit square (the left and right faces are identified,
21- and bottom and top opposite).
22- - `:corner`: three-tree mesh around a corner.
23- - `:pillow`: two trees on top of each other.
24- - `:moebius`: a five-tree moebius band.
25- - `:star`: six-tree star.
26- - `:cubed`: six sides of a unit cube.
27- - `:disk_nonperiodic`: five-tree flat spherical disk.
28- - `:icosahedron`: for mapping the sphere using an icosahedron (see
29- `@doc P4estTypes.P4est.p4est_connectivity_new_icosahedron` for more info).
30- - `:shell2d`: 2D spherical shell.
31- - `:disk2d`: maps a 2D disk.
32-
33-
34- ---
19+ - `:unitsquare`: the unit square.
20+ - `:periodic`: all-periodic unit square.
21+ - `:rotwrap`: periodic unit square (the left and right faces are identified,
22+ and bottom and top opposite).
23+ - `:corner`: three-tree mesh around a corner.
24+ - `:pillow`: two trees on top of each other.
25+ - `:moebius`: a five-tree moebius band.
26+ - `:star`: six-tree star.
27+ - `:cubed`: six sides of a unit cube.
28+ - `:disk_nonperiodic`: five-tree flat spherical disk.
29+ - `:icosahedron`: for mapping the sphere using an icosahedron (see
30+ `@doc P4estTypes.P4est.p4est_connectivity_new_icosahedron` for more info).
31+ - `:shell2d`: 2D spherical shell.
32+ - `:disk2d`: maps a 2D disk.
33+
34+ * * *
35+
3536 Connectivity{4}(:disk, periodic_x::Bool, periodic_y::Bool)
3637
3738Create a connectivity structure for a five-tree flat spherical disk. The
@@ -40,26 +41,28 @@ the x and y directions, respectively.
4041
4142See `@doc P4estTypes.P4est.p4est_connectivity_new_disk` for detailed information.
4243
43- ---
44+ * * *
45+
4446 Connectivity{8}(name::Symbol)
4547
4648Construct a connectivity mesh for the roots of a forest-of-octrees using
4749p8est's built-in mesh connectivities. Valid values for `name` are
4850
49- - `:unitcube`: the unit cube.
50- - `:periodic`: an all-periodic unit cube.
51- - `:rotcubes`: contains a few cubes (these are rotated against each other to
52- stress the topology routines).
53- - `:rotwrap`: a mostly periodic unit cube (see
54- `@doc P4estTypes.P4est.p8est_connectivity_new_rotwrap`).
55- - `:shell`: a spherical shell (see
56- `@doc P4estTypes.P4est.p8est_connectivity_new_shell`).
57- - `:sphere`: a solid sphere (see
58- `@doc P4estTypes.P4est.p8est_connectivity_new_sphere`).
59- - `:twocubes`: two cubes.
60- - `:twowrap`: two cubes where the two far ends are identified periodically.
61-
62- ---
51+ - `:unitcube`: the unit cube.
52+ - `:periodic`: an all-periodic unit cube.
53+ - `:rotcubes`: contains a few cubes (these are rotated against each other to
54+ stress the topology routines).
55+ - `:rotwrap`: a mostly periodic unit cube (see
56+ `@doc P4estTypes.P4est.p8est_connectivity_new_rotwrap`).
57+ - `:shell`: a spherical shell (see
58+ `@doc P4estTypes.P4est.p8est_connectivity_new_shell`).
59+ - `:sphere`: a solid sphere (see
60+ `@doc P4estTypes.P4est.p8est_connectivity_new_sphere`).
61+ - `:twocubes`: two cubes.
62+ - `:twowrap`: two cubes where the two far ends are identified periodically.
63+
64+ * * *
65+
6366 Connectivity{8}(:torus, nsegments)
6467
6568Create a connectivity structure that builds a revolution torus. Here
@@ -68,7 +71,8 @@ Create a connectivity structure that builds a revolution torus. Here
6871See `@doc P4estTypes.P4est.p8est_connectivity_new_torus` for detailed
6972information.
7073
71- ---
74+ * * *
75+
7276 Connectivity{8}(:torus, nsegments)
7377
7478Create a connectivity structure that builds a revolution torus. Here
@@ -77,7 +81,8 @@ Create a connectivity structure that builds a revolution torus. Here
7781See `@doc P4estTypes.P4est.p8est_connectivity_new_torus` for detailed
7882information.
7983
80- ---
84+ * * *
85+
8186 Connectivity{X}(:twotrees, l_face, r_face, orientation) where {X}
8287
8388Create a connectivity structure (`X=4` for quadtrees and `X=8` for octrees) for
@@ -86,20 +91,22 @@ two trees being rotated with respect to each other in a user-defined way. Here
8691respectively. The argument `orientation` gives the orientation code of the
8792trees with respect to each other.
8893
89- ---
94+ * * *
95+
9096 Connectivity{X}(vertices, elements) where {X}
9197
9298Creates a connectivity from the given list of vertices and element-to-vertex
9399connectivity. The parameter set to `X=4` is for quads and `X=8` for hexes.
94100
95- - `vertices`: should be a number-of-vertices by 3 matrix where the columns
96- correspond to x, y, and z coordinates (typically the `z` coordinate will be
97- zero for a 2D forest).
98- - `elements`: should be a number-of-vertices by 4 or 8 matrix where the columns
99- vertex indices used to define each element. Note that z-ordering should be
100- used, and it should use zero-indexing.
101+ - `vertices`: should be a number-of-vertices by 3 matrix where the columns
102+ correspond to x, y, and z coordinates (typically the `z` coordinate will be
103+ zero for a 2D forest).
104+ - `elements`: should be a number-of-vertices by 4 or 8 matrix where the columns
105+ vertex indices used to define each element. Note that z-ordering should be
106+ used, and it should use zero-indexing.
107+
108+ * * *
101109
102- ---
103110 Connectivity{X}(filename::String) where {X}
104111
105112Create a connectivity from an ABAQUS input at `filename`. The parameter set to
@@ -110,9 +117,10 @@ See `@doc P4estTypes.P4est.p4est_connectivity_read_inp` and
110117files.
111118
112119# See also
113- - [`brick`](@ref): a function to create a rectangular [`Connectivity`](@ref).
114- - [`connectivity`](@ref): a function to get the connectivity of a [`Pxest`](@ref).
115- - [`refine`](@ref): a function to create a refined [`Connectivity`](@ref).
120+
121+ - [`brick`](@ref): a function to create a rectangular [`Connectivity`](@ref).
122+ - [`connectivity`](@ref): a function to get the connectivity of a [`Pxest`](@ref).
123+ - [`refine`](@ref): a function to create a refined [`Connectivity`](@ref).
116124"""
117125mutable struct Connectivity{X,P}
118126 """ The pointer (of type `P`) can be a pointer to either a
0 commit comments