revert harmonic mean fix, release 1.2.1 (#1575)

Author: kmdeck

.buildkite/Manifest-v1.11.toml

@@ -505,7 +505,7 @@ version = "0.3.0"
 deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "Dates", "DocStringExtensions", "Insolation", "Interpolations", "LazyArtifacts", "LazyBroadcast", "LinearAlgebra", "NCDatasets", "SciMLBase", "StaticArrays", "SurfaceFluxes", "Thermodynamics"]
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
-version = "1.2.0"
+version = "1.2.1"
 weakdeps = ["BSON", "CSV", "CairoMakie", "ClimaAnalysis", "DataFrames", "DelimitedFiles", "Flux", "GeoMakie", "HTTP", "Printf", "StatsBase"]
 
     [deps.ClimaLand.extensions]

.buildkite/Manifest.toml

@@ -502,7 +502,7 @@ version = "0.3.0"
 deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "Dates", "DocStringExtensions", "Insolation", "Interpolations", "LazyArtifacts", "LazyBroadcast", "LinearAlgebra", "NCDatasets", "SciMLBase", "StaticArrays", "SurfaceFluxes", "Thermodynamics"]
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
-version = "1.2.0"
+version = "1.2.1"
 weakdeps = ["BSON", "CSV", "CairoMakie", "ClimaAnalysis", "DataFrames", "DelimitedFiles", "Flux", "GeoMakie", "HTTP", "Printf", "StatsBase"]
 
     [deps.ClimaLand.extensions]

NEWS.md

@@ -4,6 +4,10 @@ ClimaLand.jl Release Notes
 main
 ------
 
+v1.2.1
+-------
+- Previous bug fix to harmonic mean formula produces instability; revert until we can solve the issues fixing it causes [#1575](https://github.com/CliMA/ClimaLand.jl/pull/1575)
+
 v1.2.0
 -------
 - Make soil organic carbon and soil O2 prognostic; remove prescribed Soil Organic Carbon driver [#1545](https://github.com/CliMA/ClimaLand.jl/pull/1545)

Project.toml

@@ -1,7 +1,7 @@
 name = "ClimaLand"
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
 authors = ["Clima Land Team"]
-version = "1.2.0"
+version = "1.2.1"
 
 [deps]
 ClimaComms = "3a4d1b5c-c61d-41fd-a00a-5873ba7a1b0d"

docs/Manifest-v1.11.toml

@@ -439,7 +439,7 @@ version = "0.3.0"
 deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "Dates", "DocStringExtensions", "Insolation", "Interpolations", "LazyArtifacts", "LazyBroadcast", "LinearAlgebra", "NCDatasets", "SciMLBase", "StaticArrays", "SurfaceFluxes", "Thermodynamics"]
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
-version = "1.2.0"
+version = "1.2.1"
 weakdeps = ["BSON", "CSV", "CairoMakie", "ClimaAnalysis", "DataFrames", "DelimitedFiles", "Flux", "GeoMakie", "HTTP", "Printf", "StatsBase"]
 
     [deps.ClimaLand.extensions]

docs/Manifest.toml

@@ -436,7 +436,7 @@ version = "0.3.0"
 deps = ["ClimaComms", "ClimaCore", "ClimaDiagnostics", "ClimaParams", "ClimaTimeSteppers", "ClimaUtilities", "Dates", "DocStringExtensions", "Insolation", "Interpolations", "LazyArtifacts", "LazyBroadcast", "LinearAlgebra", "NCDatasets", "SciMLBase", "StaticArrays", "SurfaceFluxes", "Thermodynamics"]
 path = ".."
 uuid = "08f4d4ce-cf43-44bb-ad95-9d2d5f413532"
-version = "1.2.0"
+version = "1.2.1"
 weakdeps = ["BSON", "CSV", "CairoMakie", "ClimaAnalysis", "DataFrames", "DelimitedFiles", "Flux", "GeoMakie", "HTTP", "Printf", "StatsBase"]
 
     [deps.ClimaLand.extensions]

src/standalone/Vegetation/PlantHydraulics.jl

@@ -251,11 +251,10 @@ end
 """
     harmonic_mean(x::FT,y::FT) where {FT}
 
-Computes the harmonic mean of x >=0 and y >=0; returns zero if both
-x and y are zero.
-
+Computes the harmonic mean of x >=0 and y >=0; returns zero if either
+x or y are zero.
 """
-harmonic_mean(x::FT, y::FT) where {FT} = 2 * x * y / max(x + y, eps(FT))
+harmonic_mean(x::FT, y::FT) where {FT} = x * y / max(x + y, eps(FT))
 
 """
     water_flux(

test/standalone/Vegetation/plant_hydraulics_test.jl

@@ -226,7 +226,7 @@ for FT in (Float32, Float64)
             ),
         )
         # Set system to hydrostatic equilibrium
-        AI = (; leaf = LAI(1.0), root = RAI, stem = SAI)
+        AI = (; leaf = FT(LAI(1.0)), root = RAI, stem = SAI)
         T0A = FT(1e-8) * AI[:leaf]
         function initial_compute_exp_tendency!(F, Y)
             for i in 1:(n_leaf + n_stem)
@@ -245,7 +245,10 @@ for FT in (Float32, Float64)
                                 conductivity_model,
                                 Y[i],
                             ),
-                        ) .* AI[:stem]
+                        ) .* ClimaLand.Canopy.PlantHydraulics.harmonic_mean(
+                            AI[:stem],
+                            AI[:root],
+                        )
                 else
                     fa =
                         water_flux(
@@ -261,7 +264,10 @@ for FT in (Float32, Float64)
                                 conductivity_model,
                                 Y[i],
                             ),
-                        ) * AI[plant_hydraulics.compartment_labels[i]]
+                        ) * ClimaLand.Canopy.PlantHydraulics.harmonic_mean(
+                            AI[plant_hydraulics.compartment_labels[i - 1]],
+                            AI[plant_hydraulics.compartment_labels[i]],
+                        )
                 end
                 F[i] = fa - T0A
             end
@@ -272,7 +278,7 @@ for FT in (Float32, Float64)
         tendecy of the model also results in a steady state. This check is repeated using
         the plant hydraulics model directly.
         =======================#
-        ftol = FT(T0A * 1e-4) # 0.01% error in the solution
+        ftol = FT(T0A * 1e-4)
         soln = nlsolve(
             initial_compute_exp_tendency!,
             Vector{FT}(-3.0:-3:-33);