Merge pull request #1848 from CliMA/ck/convenience_constructors

Add convenience constructors for grids
CliMA · Nov 8, 2024 · aa95d03 · aa95d03
2 parents 99132e0 + b217d88
commit aa95d03
Show file tree

Hide file tree

Showing 7 changed files with 926 additions and 0 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -4,6 +4,14 @@ ClimaCore.jl Release Notes
 main
 -------
 
+ - We've added new convenience constructors for grids PR [1848](https://github.com/CliMA/ClimaCore.jl/pull/1848). Here are links to the new constructors:
+   - [ExtrudedCubedSphereGrid]()
+   - [CubedSphereGrid]()
+   - [ColumnGrid]()
+   - [Box3DGrid]()
+   - [SliceXZGrid]()
+   - [RectangleXYGrid]()
+
  - A `strict = true` keyword was added to `rcompare`, which checks that the types match. If `strict = false`, then `rcompare` will return `true` for `FieldVector`s and `NamedTuple`s with the same properties but permuted order. For example:
      - `rcompare((;a=1,b=2), (;b=2,a=1); strict = true)` will return `false` and
      - `rcompare((;a=1,b=2), (;b=2,a=1); strict = false)` will return `true`

diff --git a/docs/src/api.md b/docs/src/api.md
@@ -40,6 +40,12 @@ DataLayouts.VIJHF
 
 ## Geometry
 
+### Global Geometry
+```@docs
+Geometry.AbstractGlobalGeometry
+Geometry.CartesianGlobalGeometry
+```
+
 ### Coordinates
 ```@docs
 Geometry.AbstractPoint
@@ -171,6 +177,34 @@ Topologies.local_neighboring_elements
 Topologies.ghost_neighboring_elements
 ```
 
+## Grids
+
+```@docs
+Grids.ColumnGrid
+Grids.FiniteDifferenceGrid
+Grids.ExtrudedFiniteDifferenceGrid
+Grids.SpectralElementGrid1D
+Grids.SpectralElementGrid2D
+```
+
+## Hypsography
+
+```@docs
+Grids.Flat
+```
+
+## CommonGrids
+
+```@docs
+CommonGrids
+CommonGrids.ExtrudedCubedSphereGrid
+CommonGrids.CubedSphereGrid
+CommonGrids.ColumnGrid
+CommonGrids.Box3DGrid
+CommonGrids.SliceXZGrid
+CommonGrids.RectangleXYGrid
+```
+
 ## Spaces
 A `Space` represents a discretized function space over some domain.
 Currently two main discretizations are supported: Spectral Element Discretization

diff --git a/src/ClimaCore.jl b/src/ClimaCore.jl
@@ -23,6 +23,7 @@ include("Hypsography/Hypsography.jl")
 include("Limiters/Limiters.jl")
 include("InputOutput/InputOutput.jl")
 include("Remapping/Remapping.jl")
+include("CommonGrids/CommonGrids.jl")
 
 include("deprecated.jl")