Skip to content

Commit 0b2bfd9

Browse files
Fix api docs
1 parent 1adf824 commit 0b2bfd9

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

docs/src/api.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -173,13 +173,15 @@ Topologies.ghost_neighboring_elements
173173

174174
## Grids
175175

176+
## Grids.CommonGrids
177+
176178
```@docs
177-
Grids.ExtrudedCubedSphereGrid
178-
Grids.CubedSphereGrid
179-
Grids.ColumnGrid
180-
Grids.Box3DGrid
181-
Grids.SliceXZGrid
182-
Grids.RectangleXYGrid
179+
Grids.CommonGrids.ExtrudedCubedSphereGrid
180+
Grids.CommonGrids.CubedSphereGrid
181+
Grids.CommonGrids.ColumnGrid
182+
Grids.CommonGrids.Box3DGrid
183+
Grids.CommonGrids.SliceXZGrid
184+
Grids.CommonGrids.RectangleXYGrid
183185
```
184186

185187
## Spaces

src/Grids/CommonGrids.jl

+4-4
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ A convenience constructor, which builds an
225225
- `device` the [`ClimaComms.device`](@ref)
226226
- `context` the [`ClimaComms.context`](@ref)
227227
- `stretch` the mesh [`Meshes.StretchingRule`](@ref) (defaults to `Uniform`)
228-
- `hypsography` the hypsography
228+
- `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
229229
- `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
230230
- `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
231231
- `h_mesh` the horizontal mesh (defaults to `Meshes.EquiangularCubedSphere`)
@@ -448,7 +448,7 @@ A convenience constructor, which builds a
448448
- `device` the [`ClimaComms.device`](@ref)
449449
- `context` the [`ClimaComms.context`](@ref)
450450
- `stretch` the mesh [`Meshes.StretchingRule`](@ref) (defaults to `Uniform`)
451-
- `hypsography` the hypsography
451+
- `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
452452
- `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
453453
- `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
454454
- `h_topology` the horizontal topology (defaults to `Topologies.Topology2D`)
@@ -576,7 +576,7 @@ A convenience constructor, which builds a
576576
- `device` the [`ClimaComms.device`](@ref)
577577
- `context` the [`ClimaComms.context`](@ref)
578578
- `stretch` the mesh [`Meshes.StretchingRule`](@ref) (defaults to `Uniform`)
579-
- `hypsography` the hypsography
579+
- `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
580580
- `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
581581
- `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
582582
@@ -679,7 +679,7 @@ A convenience constructor, which builds a
679679
- `y_elem` the number of y-points
680680
- `device` the [`ClimaComms.device`](@ref)
681681
- `context` the [`ClimaComms.context`](@ref)
682-
- `hypsography` the hypsography
682+
- `hypsography` the hypsography model. Can be one of [`Flat` (default), `LinearAdaption`, `SLEVEAdaption`].
683683
- `global_geometry` the global geometry (defaults to `Geometry.CartesianGlobalGeometry`)
684684
- `quad` the quadrature style (defaults to `Quadratures.GLL{n_quad_points}`)
685685

0 commit comments

Comments
 (0)