Refactor PrescribedGroundConditions; use time varying input (#1240)

Author: kmdeck

NEWS.md

@@ -3,6 +3,7 @@ ClimaLand.jl Release Notes
 
 main
 -------
+- Remove root_depths from the PrescribeGroundConditions struct, and treat these ground ``drivers" consistently with how we handle atmospheric forcing PR[#1199](https://github.com/CliMA/ClimaLand.jl/pull/1240)
 - Add constructors with default values for Canopy components PR[#1233](https://github.com/CliMA/ClimaLand.jl/pull/1233)
 
 v0.17.2

docs/src/tutorials/standalone/Canopy/canopy_tutorial.jl

@@ -139,15 +139,14 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
 # For this canopy, we are running in standalone mode, which means we need to
 # use a prescribed soil driver, defined as follows:
 
-ψ_soil0 = FT(0.0)
-
+ψ_soil = FT(0.0)
+T_soil = FT(298.0)
 soil_driver = PrescribedGroundConditions(
     FT;
-    root_depths = SVector{10, FT}(-(10:-1:1.0) ./ 10.0 * 2.0 .+ 0.2 / 2.0),
-    ψ = t -> ψ_soil0,
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
-    T = t -> 298.0,
+    T = TimeVaryingInput(t -> T_soil),
+    ψ = TimeVaryingInput(t -> ψ_soil),
     ϵ = FT(0.99),
 );
 

experiments/standalone/Vegetation/no_vegetation.jl

@@ -53,15 +53,11 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     z0_b,
     earth_param_set,
 );
-ψ_soil0 = FT(0.0)
 
 soil_driver = PrescribedGroundConditions(
     FT;
-    root_depths = SVector{10, FT}(-(10:-1:1.0) ./ 10.0 * 2.0 .+ 0.2 / 2.0),
-    ψ = t -> ψ_soil0,
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
-    T = t -> 298.0,
     ϵ = FT(0.99),
 );
 

experiments/standalone/Vegetation/timestep_test.jl

@@ -92,15 +92,11 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     z0_b,
     earth_param_set,
 );
-ψ_soil0 = FT(0.0)
 
 soil_driver = PrescribedGroundConditions(
     FT;
-    root_depths = SVector{10, FT}(-(10:-1:1.0) ./ 10.0 * 2.0 .+ 0.2 / 2.0),
-    ψ = t -> ψ_soil0,
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
-    T = t -> 298.0,
     ϵ = FT(0.99),
 );
 

experiments/standalone/Vegetation/varying_lai.jl

@@ -53,15 +53,11 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     z0_b,
     earth_param_set,
 );
-ψ_soil0 = FT(0.0)
 
 soil_driver = PrescribedGroundConditions(
     FT;
-    root_depths = SVector{10, FT}(-(10:-1:1.0) ./ 10.0 * 2.0 .+ 0.2 / 2.0),
-    ψ = t -> ψ_soil0,
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
-    T = t -> 298.0,
     ϵ = FT(0.99),
 );
 

experiments/standalone/Vegetation/varying_lai_with_stem.jl

@@ -53,15 +53,11 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     z0_b,
     earth_param_set,
 );
-ψ_soil0 = FT(0.0)
 
 soil_driver = PrescribedGroundConditions(
     FT;
-    root_depths = SVector{10, FT}(-(10:-1:1.0) ./ 10.0 * 2.0 .+ 0.2 / 2.0),
-    ψ = t -> ψ_soil0,
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
-    T = t -> 298.0,
     ϵ = FT(0.99),
 );
 

src/ClimaLand.jl

@@ -407,8 +407,7 @@ import .Canopy:
     ground_albedo_PAR,
     ground_albedo_NIR,
     canopy_radiant_energy_fluxes!,
-    root_energy_flux_per_ground_area!,
-    AbstractGroundConditions
+    root_energy_flux_per_ground_area!
 ### Concrete types of AbstractLandModels
 ### and associated methods
 include("integrated/soil_energy_hydrology_biogeochemistry.jl")

src/integrated/land.jl

@@ -123,7 +123,7 @@ function LandModel{FT}(;
     )
 
     transpiration = Canopy.PlantHydraulics.DiagnosticTranspiration{FT}()
-    ground_conditions = PrognosticGroundConditions()
+    ground_conditions = PrognosticGroundConditions{FT}()
     if :energy in propertynames(canopy_component_args)
         energy_model = canopy_component_types.energy(
             canopy_component_args.energy.parameters,
@@ -635,68 +635,6 @@ function ClimaLand.Soil.sublimation_source(
     return SoilSublimationwithSnow{FT}()
 end
 
-"""
-     PrognosticGroundConditions <: Canopy.AbstractGroundConditions
-
-A type of Canopy.AbstractGroundConditions to use when the soil model is prognostic and
-of type `EnergyHydrology`, and the snow model is prognostic and included.
-
-Note that this struct is linked with the EnergyHydrology/SnowModel model. If we ever had a different
-soil model, we might need to construct a different `PrognosticGroundConditions` because
-the fields may be stored in different places.
-"""
-struct PrognosticGroundConditions <: Canopy.AbstractGroundConditions end
-
-"""
-    Canopy.ground_albedo_PAR(
-        prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
-        ground::PrognosticGroundConditions,
-        Y,
-        p,
-        t,
-    )
-
-A method of Canopy.ground_albedo_PAR for a prognostic soil/snow. This function is called in
-the Canopy update_aux! function.
-"""
-function Canopy.ground_albedo_PAR(
-    prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
-    ground::PrognosticGroundConditions,
-    Y,
-    p,
-    t,
-)
-    @. p.α_ground.PAR =
-        (1 - p.snow.snow_cover_fraction) * p.soil.PAR_albedo +
-        p.snow.snow_cover_fraction * p.snow.α_snow
-    return p.α_ground.PAR
-end
-
-"""
-    Canopy.ground_albedo_NIR(
-        prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
-        ground::PrognosticGroundConditions,
-        Y,
-        p,
-        t,
-    )
-
-A method of Canopy.ground_albedo_NIR for a prognostic soil/snow. This function is called in
-the Canopy update_aux! function.
-"""
-function Canopy.ground_albedo_NIR(
-    prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
-    ground::PrognosticGroundConditions,
-    Y,
-    p,
-    t,
-)
-    @. p.α_ground.NIR =
-        (1 - p.snow.snow_cover_fraction) * p.soil.NIR_albedo +
-        p.snow.snow_cover_fraction * p.snow.α_snow
-    return p.α_ground.NIR
-end
-
 """
     ClimaLand.get_drivers(model::LandModel)
 

src/integrated/land_radiation.jl

@@ -46,3 +46,96 @@ function Canopy.canopy_radiant_energy_fluxes!(
 ) where {PSE}
     nothing
 end
+
+"""
+    Canopy.ground_albedo_PAR(
+        prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
+        ground::PrognosticSoilConditions,
+        Y,
+        p,
+        t,
+    )
+
+A method of Canopy.Canopy.ground_albedo_PAR for a prognostic soil.
+"""
+function Canopy.ground_albedo_PAR(
+    prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
+    ground::PrognosticSoilConditions,
+    Y,
+    p,
+    t,
+)
+    return p.soil.PAR_albedo
+end
+
+"""
+    Canopy.ground_albedo_NIR(
+        prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
+        ground::PrognosticSoilConditions,
+        Y,
+        p,
+        t,
+    )
+
+A method of Canopy.ground_albedo_NIR for a prognostic soil.
+"""
+function Canopy.ground_albedo_NIR(
+    prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
+    ground::PrognosticSoilConditions,
+    Y,
+    p,
+    t,
+)
+    return p.soil.NIR_albedo
+end
+
+
+"""
+    Canopy.ground_albedo_PAR(
+        prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
+        ground::PrognosticGroundConditions,
+        Y,
+        p,
+        t,
+    )
+
+A method of Canopy.ground_albedo_PAR for a prognostic soil/snow. This function is called in
+the Canopy update_aux! function.
+"""
+function Canopy.ground_albedo_PAR(
+    prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
+    ground::PrognosticGroundConditions,
+    Y,
+    p,
+    t,
+)
+    @. p.α_ground.PAR =
+        (1 - p.snow.snow_cover_fraction) * p.soil.PAR_albedo +
+        p.snow.snow_cover_fraction * p.snow.α_snow
+    return p.α_ground.PAR
+end
+
+"""
+    Canopy.ground_albedo_NIR(
+        prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
+        ground::PrognosticGroundConditions,
+        Y,
+        p,
+        t,
+    )
+
+A method of Canopy.ground_albedo_NIR for a prognostic soil/snow. This function is called in
+the Canopy update_aux! function.
+"""
+function Canopy.ground_albedo_NIR(
+    prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
+    ground::PrognosticGroundConditions,
+    Y,
+    p,
+    t,
+)
+    @. p.α_ground.NIR =
+        (1 - p.snow.snow_cover_fraction) * p.soil.NIR_albedo +
+        p.snow.snow_cover_fraction * p.snow.α_snow
+    return p.α_ground.NIR
+end

src/integrated/soil_canopy_model.jl

@@ -98,7 +98,7 @@ function SoilCanopyModel{FT}(;
     )
 
     transpiration = Canopy.PlantHydraulics.DiagnosticTranspiration{FT}()
-    ground_conditions = PrognosticSoilConditions()
+    ground_conditions = PrognosticSoilConditions{FT}()
     if :energy in propertynames(canopy_component_args)
         energy_model = canopy_component_types.energy(
             canopy_component_args.energy.parameters,
@@ -464,56 +464,6 @@ function Soil.compute_liquid_influx(
     return p.drivers.P_liq
 end
 
-"""
-     PrognosticSoilConditions <: Canopy.AbstractGroundConditions
-
- A type of Canopy.AbstractGroundConditions to use when the soil model is prognostic and
-of type `EnergyHydrology`. `PrognosticSoilConditions` functions as a flag and is used for dispatch
-"""
-struct PrognosticSoilConditions <: Canopy.AbstractGroundConditions end
-
-"""
-    Canopy.ground_albedo_PAR(
-        prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
-        ground::PrognosticSoilConditions,
-        Y,
-        p,
-        t,
-    )
-
-A method of Canopy.ground_albedo_PAR for a prognostic soil.
-"""
-function Canopy.ground_albedo_PAR(
-    prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
-    ground::PrognosticSoilConditions,
-    Y,
-    p,
-    t,
-)
-    return p.soil.PAR_albedo
-end
-
-"""
-    Canopy.ground_albedo_NIR(
-        prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
-        ground::PrognosticSoilConditions,
-        Y,
-        p,
-        t,
-    )
-
-A method of Canopy.ground_albedo_NIR for a prognostic soil.
-"""
-function Canopy.ground_albedo_NIR(
-    prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
-    ground::PrognosticSoilConditions,
-    Y,
-    p,
-    t,
-)
-    return p.soil.NIR_albedo
-end
-
 function ClimaLand.Soil.sublimation_source(
     prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
     FT,