Define CommonSpaces module

NEWS.md

@@ -4,16 +4,23 @@ ClimaCore.jl Release Notes
 main
 -------
 
+ - We've added new convenience constructors for spaces PR [2082](https://github.com/CliMA/ClimaCore.jl/pull/2082). Here are links to the new constructors:
+   - [ExtrudedCubedSphereSpace]()
+   - [CubedSphereSpace]()
+   - [ColumnSpace]()
+   - [Box3DSpace]()
+   - [SliceXZSpace]()
+   - [RectangleXYSpace]()
+
 v0.14.20
--------
 
  - 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]()
+   - [ExtrudedCubedSphereGrid](https://github.com/CliMA/ClimaCore.jl/blob/cbb193042fac3b4bef33251fbc0f232427bfe506/src/CommonGrids/CommonGrids.jl#L85-L144)
+   - [CubedSphereGrid](https://github.com/CliMA/ClimaCore.jl/blob/cbb193042fac3b4bef33251fbc0f232427bfe506/src/CommonGrids/CommonGrids.jl#L200-L235)
+   - [ColumnGrid](https://github.com/CliMA/ClimaCore.jl/blob/cbb193042fac3b4bef33251fbc0f232427bfe506/src/CommonGrids/CommonGrids.jl#L259-L281)
+   - [Box3DGrid](https://github.com/CliMA/ClimaCore.jl/blob/cbb193042fac3b4bef33251fbc0f232427bfe506/src/CommonGrids/CommonGrids.jl#L303-L378)
+   - [SliceXZGrid](https://github.com/CliMA/ClimaCore.jl/blob/cbb193042fac3b4bef33251fbc0f232427bfe506/src/CommonGrids/CommonGrids.jl#L441-L498)
+   - [RectangleXYGrid](https://github.com/CliMA/ClimaCore.jl/blob/cbb193042fac3b4bef33251fbc0f232427bfe506/src/CommonGrids/CommonGrids.jl#L547-L602)
 
  - 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

docs/src/api.md

@@ -180,6 +180,8 @@ Topologies.ghost_neighboring_elements
 ## Grids
 
 ```@docs
+Grids.CellFace
+Grids.CellCenter
 Grids.ColumnGrid
 Grids.FiniteDifferenceGrid
 Grids.ExtrudedFiniteDifferenceGrid
@@ -247,6 +249,18 @@ Spaces.SpectralElementSpaceSlab
 Spaces.node_horizontal_length_scale
 ```
 
+## CommonSpaces
+
+```@docs
+CommonSpaces
+CommonSpaces.ExtrudedCubedSphereSpace
+CommonSpaces.CubedSphereSpace
+CommonSpaces.ColumnSpace
+CommonSpaces.Box3DSpace
+CommonSpaces.SliceXZSpace
+CommonSpaces.RectangleXYSpace
+```
+
 ### Quadratures
 
 

src/ClimaCore.jl

@@ -24,6 +24,7 @@ include("Limiters/Limiters.jl")
 include("InputOutput/InputOutput.jl")
 include("Remapping/Remapping.jl")
 include("CommonGrids/CommonGrids.jl")
+include("CommonSpaces/CommonSpaces.jl")
 
 include("deprecated.jl")
 

src/CommonGrids/CommonGrids.jl

@@ -269,7 +269,16 @@ end
     )
 
 A convenience constructor, which builds a
-[`Grids.FiniteDifferenceGrid`](@ref).
+[`Grids.FiniteDifferenceGrid`](@ref) given:
+
+ - `FT` the floating-point type (defaults to `Float64`) [`Float32`, `Float64`]
+ - `z_elem` the number of z-points
+ - `z_min` the domain minimum along the z-direction.
+ - `z_max` the domain maximum along the z-direction.
+ - `device` the `ClimaComms.device`
+ - `context` the `ClimaComms.context`
+ - `stretch` the mesh `Meshes.StretchingRule` (defaults to [`Meshes.Uniform`](@ref))
+ - `z_mesh` the vertical mesh, defaults to an `Meshes.IntervalMesh` along `z` with given `stretch`
 
 # Example usage