Skip to content

Commit

Permalink
Merge pull request #1848 from CliMA/ck/convenience_constructors
Browse files Browse the repository at this point in the history
Add convenience constructors for grids
  • Loading branch information
charleskawczynski authored Nov 8, 2024
2 parents 99132e0 + b217d88 commit aa95d03
Show file tree
Hide file tree
Showing 7 changed files with 926 additions and 0 deletions.
8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
34 changes: 34 additions & 0 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,12 @@ DataLayouts.VIJHF

## Geometry

### Global Geometry
```@docs
Geometry.AbstractGlobalGeometry
Geometry.CartesianGlobalGeometry
```

### Coordinates
```@docs
Geometry.AbstractPoint
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions src/ClimaCore.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
Loading

0 comments on commit aa95d03

Please sign in to comment.