store reverse_mode in IntervalMesh

Author: juliasloan25

NEWS.md

@@ -4,6 +4,12 @@ ClimaCore.jl Release Notes
 main
 -------
 
+- Store `reverse_mode` in the `IntervalMesh` struct, so that we can access it when writing
+and reading the mesh for restarts
+
+v0.14.39
+-------
+
 v0.14.38
 -------
 

src/InputOutput/readers.jl

@@ -315,19 +315,26 @@ function read_mesh_new(reader::HDF5Reader, name::AbstractString)
         nelements = attrs(group)["nelements"]
         faces_type = get(attrs(group), "faces_type", nothing)
         stretch_type = get(attrs(group), "stretch_type", nothing)
+        reverse_mode = get(attrs(group), "reverse_mode", false)
         if stretch_type == "Uniform" || faces_type == "Range"
             return Meshes.IntervalMesh(
                 domain,
                 Meshes.Uniform();
                 nelems = nelements,
+                reverse_mode,
             )
         end
         stretch_params = get(attrs(group), "stretch_params", nothing)
         if stretch_type ≠ "UnknownStretch" && !isnothing(stretch_params)
             CT = Domains.coordinate_type(domain)
             stretch =
                 getproperty(Meshes, Symbol(stretch_type))(stretch_params...)
-            return Meshes.IntervalMesh(domain, stretch; nelems = nelements)
+            return Meshes.IntervalMesh(
+                domain,
+                stretch;
+                nelems = nelements,
+                reverse_mode,
+            )
         end
         # Fallback: read from array
         @assert faces_type == "Array"

src/InputOutput/writers.jl

@@ -205,6 +205,7 @@ function write_new!(
     write_attribute(group, "type", "IntervalMesh")
     write_attribute(group, "domain", domainname)
     write_attribute(group, "nelements", Meshes.nelements(mesh))
+    write_attribute(group, "reverse_mode", mesh.reverse_mode)
     if occursin("LinRange", string(typeof(mesh.faces)))
         write_attribute(group, "faces_type", "Range")
     else
@@ -324,11 +325,13 @@ end
 defaultname(::DataLayouts.IJHMask) = "IJHMask"
 defaultname(::Grids.SpectralElementGrid1D) = "horizontal_grid"
 defaultname(::Grids.SpectralElementGrid2D) = "horizontal_grid"
-defaultname(::Grids.ExtrudedFiniteDifferenceGrid) =
-    "extruded_finite_difference_grid"
+defaultname(
+    ::Grids.ExtrudedFiniteDifferenceGrid,
+) = "extruded_finite_difference_grid"
 defaultname(grid::Grids.FiniteDifferenceGrid) = defaultname(grid.topology)
-defaultname(grid::Grids.LevelGrid) =
-    "$(defaultname(grid.full_grid)): level $(grid.level)"
+defaultname(
+    grid::Grids.LevelGrid,
+) = "$(defaultname(grid.full_grid)): level $(grid.level)"
 
 """
     write_new!(writer, space, name)

src/Meshes/interval.jl

@@ -17,13 +17,17 @@ Constuct a 1D mesh on `domain` with `nelems` elements, using `stretching`. Possi
 - [`ExponentialStretching(H)`](@ref)
 - [`GeneralizedExponentialStretching(dz_bottom, dz_top)`](@ref)
 - [`HyperbolicTangentStretching(dz_bottom)`](@ref)
+
+If `reverse_mode` is `true`, the smallest element is at the top, and the largest at the bottom
+(this is typical for land model configurations).
 """
 struct IntervalMesh{S, I <: IntervalDomain, V <: AbstractVector, M} <:
        AbstractMesh1D
     stretch::S
     domain::I
     faces::V
     meta::M
+    reverse_mode::Bool
 end
 
 # implies isequal
@@ -141,7 +145,8 @@ function IntervalMesh(domain::IntervalDomain, faces::AbstractArray)
     nelems = length(faces)
     nelems < 1 && throw(ArgumentError("`nelems` must be ≥ 1"))
     monotonic_check(faces)
-    IntervalMesh(UnknownStretch(), domain, faces, nothing)
+    reverse_mode = false
+    IntervalMesh(UnknownStretch(), domain, faces, nothing, reverse_mode)
 end
 
 """
@@ -161,7 +166,8 @@ function IntervalMesh(
     end
     faces = range(domain.coord_min, domain.coord_max; length = nelems + 1)
     monotonic_check(faces)
-    IntervalMesh(stretch, domain, faces, nothing)
+    reverse_mode = false
+    IntervalMesh(stretch, domain, faces, nothing, reverse_mode)
 end
 
 
@@ -217,7 +223,7 @@ function IntervalMesh(
         reverse!(faces)
     end
     monotonic_check(faces)
-    IntervalMesh(stretch, domain, faces, nothing)
+    IntervalMesh(stretch, domain, faces, nothing, reverse_mode)
 end
 
 """
@@ -338,7 +344,7 @@ function IntervalMesh(
         faces[end] = faces[end] == -z_bottom ? z_bottom : faces[1]
     end
     monotonic_check(faces)
-    IntervalMesh(stretch, domain, CT.(faces), (; h_top))
+    IntervalMesh(stretch, domain, CT.(faces), (; h_top), reverse_mode)
 end
 
 """
@@ -356,13 +362,13 @@ For an interval ``[z_0,z_1]``, this makes the elements uniformally spaced in
 \\eta = 1 - \\frac{tanh[\\gamma(1-\\zeta)]}{tanh(\\gamma)},
 ```
 where ``\\eta = \\frac{z - z_0}{z_1-z_0}``. The stretching parameter ``\\gamma``
-is chosen to achieve a given resolution `dz_surface` at the surface. 
+is chosen to achieve a given resolution `dz_surface` at the surface.
 
 Then, the user can define a stretched mesh via
 
     ClimaCore.Meshes.IntervalMesh(interval_domain, HyperbolicTangentStretching(dz_surface); nelems::Int, reverse_mode)
 
-`reverse_mode` is default to false for atmosphere configurations. For land configurations, 
+`reverse_mode` is default to false for atmosphere configurations. For land configurations,
 use `reverse_mode` = `true`.
 
 `faces` contain reference z without any warping.
@@ -427,7 +433,13 @@ function IntervalMesh(
         faces[end] = faces[end] == -z_bottom ? z_bottom : faces[1]
     end
     monotonic_check(faces)
-    IntervalMesh(stretch, domain, CT.(faces), (; γ_sol = γ_sol.root))
+    IntervalMesh(
+        stretch,
+        domain,
+        CT.(faces),
+        (; γ_sol = γ_sol.root),
+        reverse_mode,
+    )
 end
 
 """