Skip to content

Commit

Permalink
Splitting the definitions, need more elaborations on the different ty…
Browse files Browse the repository at this point in the history
…pes of grids are
  • Loading branch information
natgeo-wong committed Oct 8, 2024
1 parent 3499eaf commit 1d2a06d
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 38 deletions.
5 changes: 5 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ makedocs(;
pages=[
"Home" => "index.md",
"Getting Started" => "regiongrids.md",
"Types of RegionGrids" => [
"Rectilinear Grids" => "types/rectilinear.md",
"Generalized Grids" => "types/generalized.md",
"Unstructured Grids" => "types/unstructured.md"
],
],
)

Expand Down
37 changes: 1 addition & 36 deletions docs/src/regiongrids.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ A `RegionGrid` contains information that:
RegionGrid
```

## Types of RegionGrids

The `RegionGrid` abstract type has three subtypes:
1. `RectilinearGrid` type, which is for the extraction of data on rectilinear lon-lat grids
2. `GeneralizedGrid` type, which is for the extraction of data on non-rectilinear lon-lat grids, such as a curvilinear grid.
Expand All @@ -22,37 +20,4 @@ GeneralizedGrid
UnstructuredGrid
```

Each of these types is in turn subdivided into **two** subtypes, (1) a `-Mask` type and (2) a `-Tilt` type. The `-Tilt` types are the same as the `-Mask` types, but with additional fields that specify the _rotation_ of fields.

### The `Rectilinear` Grid

The `RectilinearGrid` type can be further subdivided into three different types based on the `GeoRegion` type:
* Mapping rectilinearly-gridded lon-lat data to a `RectRegion` or `PolyRegion` returns a `RLinearMask` type.
* Mapping rectilinearly-gridded lon-lat data to a `TiltRegion` returns a `RLinearTilt` type.

```@docs
RLinearMask
RLinearTilt
```

### The `GeneralizedGrid` Type

The `GeneralizedGrid` type can be further subdivided into two different types based on the `GeoRegion` type:
* Mapping generalized gridded lon-lat data to a `RectRegion` or `PolyRegion` returns a `GeneralMask` type.
* Mapping generalized gridded lon-lat data to a `TiltRegion` returns a `GeneralTilt` type.

```@docs
GeneralMask
GeneralTilt
```

### The `UnstructuredGrid` Type

The `UnstructuredGrid` type can be further subdivided into two different types based on the `GeoRegion` type:
* Mapping unstructured lon-lat data to a `RectRegion` or `PolyRegion` returns a `VectorMask` type.
* Mapping unstructured lon-lat data to a `TiltRegion` returns a `VectorTilt` type.

```@docs
VectorMask
VectorTilt
```
Each of these types is in turn subdivided into **two** subtypes, (1) a `-Mask` type and (2) a `-Tilt` type. The `-Tilt` types are the same as the `-Mask` types, but with additional fields that specify the _rotation_ of fields.
10 changes: 10 additions & 0 deletions docs/src/types/generalized.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Generalized

The `GeneralizedGrid` type can be further subdivided into two different types based on the `GeoRegion` type:
* Mapping generalized gridded lon-lat data to a `RectRegion` or `PolyRegion` returns a `GeneralMask` type.
* Mapping generalized gridded lon-lat data to a `TiltRegion` returns a `GeneralTilt` type.

```@docs
GeneralMask
GeneralTilt
```
10 changes: 10 additions & 0 deletions docs/src/types/rectilinear.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Rectilinear

The `RectilinearGrid` type can be further subdivided into three different types based on the `GeoRegion` type:
* Mapping rectilinearly-gridded lon-lat data to a `RectRegion` or `PolyRegion` returns a `RLinearMask` type.
* Mapping rectilinearly-gridded lon-lat data to a `TiltRegion` returns a `RLinearTilt` type.

```@docs
RLinearMask
RLinearTilt
```
10 changes: 10 additions & 0 deletions docs/src/types/unstructured.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Unstructured

The `UnstructuredGrid` type can be further subdivided into two different types based on the `GeoRegion` type:
* Mapping unstructured lon-lat data to a `RectRegion` or `PolyRegion` returns a `VectorMask` type.
* Mapping unstructured lon-lat data to a `TiltRegion` returns a `VectorTilt` type.

```@docs
VectorMask
VectorTilt
```
4 changes: 2 additions & 2 deletions src/RegionGrids.jl
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ abstract type UnstructuredGrid <: RegionGrid end
"""
VectorMask <: UnstructuredGrid
Information on a `GeneralizedGrid` type that is extracted based on vectors of longitude and latitude points.
Information on a `UnstructuredGrid` type that is extracted based on vectors of longitude and latitude points.
"""
struct VectorMask{FT<:Real} <: UnstructuredGrid
lon :: Vector{FT}
Expand All @@ -149,7 +149,7 @@ end
"""
VectorTilt <: UnstructuredGrid
Information on a `GeneralizedGrid` type that is extracted based on vectors of longitude and latitude points.
Information on a `UnstructuredGrid` type that is extracted based on vectors of longitude and latitude points.
A `VectorTilt` type will also contain the following fields:
* `rotX` - A vector of `Float`s, defining indices of the parent longitude vector describing the region
Expand Down

0 comments on commit 1d2a06d

Please sign in to comment.