Merge pull request #2010 from CliMA/tc/resolution-size

Changes resolution to size and halo size to just halo

Author: tomchor

docs/src/model_setup/grids.md

@@ -21,8 +21,8 @@ julia> grid = RegularRectilinearGrid(size=(32, 64, 256), extent=(128, 256, 512))
 RegularRectilinearGrid{Float64, Periodic, Periodic, Bounded}
                    domain: x ∈ [0.0, 128.0], y ∈ [0.0, 256.0], z ∈ [-512.0, 0.0]
                  topology: (Periodic, Periodic, Bounded)
-  resolution (Nx, Ny, Nz): (32, 64, 256)
-   halo size (Hx, Hy, Hz): (1, 1, 1)
+        size (Nx, Ny, Nz): (32, 64, 256)
+        halo (Hx, Hy, Hz): (1, 1, 1)
 grid spacing (Δx, Δy, Δz): (4.0, 4.0, 2.0)
 ```
 
@@ -46,8 +46,8 @@ julia> grid = RegularRectilinearGrid(topology=(Periodic, Bounded, Bounded), size
 RegularRectilinearGrid{Float64, Periodic, Bounded, Bounded}
                    domain: x ∈ [0.0, 10000.0], y ∈ [0.0, 10000.0], z ∈ [-1000.0, 0.0]
                  topology: (Periodic, Bounded, Bounded)
-  resolution (Nx, Ny, Nz): (64, 64, 32)
-   halo size (Hx, Hy, Hz): (1, 1, 1)
+        size (Nx, Ny, Nz): (64, 64, 32)
+        halo (Hx, Hy, Hz): (1, 1, 1)
 grid spacing (Δx, Δy, Δz): (156.25, 156.25, 31.25)
 ```
 
@@ -66,7 +66,7 @@ julia> grid = RegularRectilinearGrid(size=(32, 16, 256), x=(-100, 100), y=(0, 12
 RegularRectilinearGrid{Float64, Periodic, Periodic, Bounded}
                    domain: x ∈ [-100.0, 100.0], y ∈ [0.0, 12.5], z ∈ [-3.141592653589793, 3.141592653589793]
                  topology: (Periodic, Periodic, Bounded)
-  resolution (Nx, Ny, Nz): (32, 16, 256)
-   halo size (Hx, Hy, Hz): (1, 1, 1)
+        size (Nx, Ny, Nz): (32, 16, 256)
+        halo (Hx, Hy, Hz): (1, 1, 1)
 grid spacing (Δx, Δy, Δz): (6.25, 0.78125, 0.02454369260617026)
 ```

docs/src/simulation_tips.md

@@ -230,8 +230,8 @@ julia> grid = RegularRectilinearGrid(size=(1,1,1), extent=(1,1,1))
 RegularRectilinearGrid{Float64, Periodic, Periodic, Bounded}
                    domain: x ∈ [0.0, 1.0], y ∈ [0.0, 1.0], z ∈ [-1.0, 0.0]
                  topology: (Periodic, Periodic, Bounded)
-  resolution (Nx, Ny, Nz): (1, 1, 1)
-   halo size (Hx, Hy, Hz): (1, 1, 1)
+        size (Nx, Ny, Nz): (1, 1, 1)
+        halo (Hx, Hy, Hz): (1, 1, 1)
 grid spacing (Δx, Δy, Δz): (1.0, 1.0, 1.0)
 
 julia> model = NonhydrostaticModel(grid=grid, architecture=GPU())

src/Grids/conformal_cubed_sphere_face_grid.jl

@@ -293,8 +293,8 @@ Adapt.adapt_structure(to, grid::ConformalCubedSphereFaceGrid) = _adapt_structure
 
 function Base.show(io::IO, g::ConformalCubedSphereFaceGrid{FT}) where FT
     print(io, "ConformalCubedSphereFaceGrid{$FT}\n",
-              "  resolution (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
-              "   halo size (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz))
+              "        size (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
+              "        halo (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz))
 end
 
 @inline xnode(::Face,   ::Face,   LZ, i, j, k, grid::ConformalCubedSphereFaceGrid) = @inbounds grid.λᶠᶠᵃ[i, j]

src/Grids/regular_latitude_longitude_grid.jl

@@ -97,8 +97,8 @@ function show(io::IO, g::RegularLatitudeLongitudeGrid{FT, TX, TY, TZ}) where {FT
     print(io, "RegularLatitudeLongitudeGrid{$FT, $TX, $TY, $TZ}\n",
               "                   domain: $(domain_string(g))\n",
               "                 topology: ", (TX, TY, TZ), '\n',
-              "  resolution (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
-              "   halo size (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz), '\n',
+              "        size (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
+              "        halo (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz), '\n',
               "grid spacing (Δλ, Δφ, Δz): ", (g.Δλ, g.Δφ, g.Δz))
 end
 

src/Grids/regular_rectilinear_grid.jl

@@ -104,8 +104,8 @@ julia> grid = RegularRectilinearGrid(size=(32, 32, 32), extent=(1, 2, 3))
 RegularRectilinearGrid{Float64, Periodic, Periodic, Bounded}
                    domain: x ∈ [0.0, 1.0], y ∈ [0.0, 2.0], z ∈ [-3.0, 0.0]
                  topology: (Periodic, Periodic, Bounded)
-  resolution (Nx, Ny, Nz): (32, 32, 32)
-   halo size (Hx, Hy, Hz): (1, 1, 1)
+        size (Nx, Ny, Nz): (32, 32, 32)
+        halo (Hx, Hy, Hz): (1, 1, 1)
 grid spacing (Δx, Δy, Δz): (0.03125, 0.0625, 0.09375)
 ```
 
@@ -118,8 +118,8 @@ julia> grid = RegularRectilinearGrid(Float32; size=(32, 32, 16), x=(0, 8), y=(-1
 RegularRectilinearGrid{Float32, Periodic, Periodic, Bounded}
                    domain: x ∈ [0.0, 8.0], y ∈ [-10.0, 10.0], z ∈ [-3.1415927, 3.1415927]
                  topology: (Periodic, Periodic, Bounded)
-  resolution (Nx, Ny, Nz): (32, 32, 16)
-   halo size (Hx, Hy, Hz): (1, 1, 1)
+        size (Nx, Ny, Nz): (32, 32, 16)
+        halo (Hx, Hy, Hz): (1, 1, 1)
 grid spacing (Δx, Δy, Δz): (0.25f0, 0.625f0, 0.3926991f0)
 ```
 
@@ -132,8 +132,8 @@ julia> grid = RegularRectilinearGrid(size=(32, 32), extent=(2π, 4π), topology=
 RegularRectilinearGrid{Float64, Periodic, Periodic, Flat}
                    domain: x ∈ [0.0, 6.283185307179586], y ∈ [0.0, 12.566370614359172], z ∈ [0.0, 0.0]
                  topology: (Periodic, Periodic, Flat)
-  resolution (Nx, Ny, Nz): (32, 32, 1)
-   halo size (Hx, Hy, Hz): (1, 1, 0)
+        size (Nx, Ny, Nz): (32, 32, 1)
+        halo (Hx, Hy, Hz): (1, 1, 0)
 grid spacing (Δx, Δy, Δz): (0.19634954084936207, 0.39269908169872414, 0.0)
 ```
 
@@ -146,8 +146,8 @@ julia> grid = RegularRectilinearGrid(size=256, z=(-128, 0), topology=(Flat, Flat
 RegularRectilinearGrid{Float64, Flat, Flat, Bounded}
                    domain: x ∈ [0.0, 0.0], y ∈ [0.0, 0.0], z ∈ [-128.0, 0.0]
                  topology: (Flat, Flat, Bounded)
-  resolution (Nx, Ny, Nz): (1, 1, 256)
-   halo size (Hx, Hy, Hz): (0, 0, 1)
+        size (Nx, Ny, Nz): (1, 1, 256)
+        halo (Hx, Hy, Hz): (0, 0, 1)
 grid spacing (Δx, Δy, Δz): (0.0, 0.0, 0.5)
 ```
 """
@@ -249,8 +249,8 @@ function show(io::IO, g::RegularRectilinearGrid{FT, TX, TY, TZ}) where {FT, TX,
     print(io, "RegularRectilinearGrid{$FT, $TX, $TY, $TZ}\n",
               "                   domain: $(domain_string(g))\n",
               "                 topology: ", (TX, TY, TZ), '\n',
-              "  resolution (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
-              "   halo size (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz), '\n',
+              "        size (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
+              "        halo (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz), '\n',
               "grid spacing (Δx, Δy, Δz): ", (g.Δx, g.Δy, g.Δz))
 end
 

src/Grids/vertically_stretched_rectilinear_grid.jl

@@ -125,8 +125,8 @@ grid = VerticallyStretchedRectilinearGrid(size = (32, 32, Nz),
 VerticallyStretchedRectilinearGrid{Float64, Periodic, Periodic, Bounded}
                    domain: x ∈ [0.0, 64.0], y ∈ [0.0, 64.0], z ∈ [-32.0, -0.0]
                  topology: (Periodic, Periodic, Bounded)
-  resolution (Nx, Ny, Nz): (32, 32, 24)
-   halo size (Hx, Hy, Hz): (1, 1, 1)
+        size (Nx, Ny, Nz): (32, 32, 24)
+        halo (Hx, Hy, Hz): (1, 1, 1)
 grid spacing (Δx, Δy, Δz): (2.0, 2.0, [min=0.6826950100338962, max=1.8309085743885056])
 ```
 """
@@ -302,8 +302,8 @@ function show(io::IO, g::VerticallyStretchedRectilinearGrid{FT, TX, TY, TZ}) whe
     print(io, "VerticallyStretchedRectilinearGrid{$FT, $TX, $TY, $TZ}\n",
               "                   domain: $(domain_string(g))\n",
               "                 topology: ", (TX, TY, TZ), '\n',
-              "  resolution (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
-              "   halo size (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz), '\n',
+              "        size (Nx, Ny, Nz): ", (g.Nx, g.Ny, g.Nz), '\n',
+              "        halo (Hx, Hy, Hz): ", (g.Hx, g.Hy, g.Hz), '\n',
               "grid spacing (Δx, Δy, Δz): (", g.Δx, ", ", g.Δy, ", [min=", Δz_min, ", max=", Δz_max,"])",)
 end