Merge pull request #1257 from CliMA/js/ft-type-param

juliasloan25 · web-flow · commit 0f7741fce1fc · 2025-07-24T10:43:56.000-07:00
force type specialization in constructors
diff --git a/docs/src/tutorials/standalone/Canopy/canopy_tutorial.jl b/docs/src/tutorials/standalone/Canopy/canopy_tutorial.jl
@@ -141,8 +141,7 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
 
 ψ_soil = FT(0.0)
 T_soil = FT(298.0)
-soil_driver = PrescribedGroundConditions(
-    FT;
+soil_driver = PrescribedGroundConditions{FT}(;
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
     T = TimeVaryingInput(t -> T_soil),
diff --git a/experiments/benchmarks/richards.jl b/experiments/benchmarks/richards.jl
@@ -99,7 +99,7 @@ function setup_prob(t0, tf, Δt; nelements = (101, 15))
         atmos = ClimaLand.PrescribedPrecipitation{FT, typeof(precip)}(precip),
     )
 
-    model = ClimaLand.Soil.RichardsModel(FT, domain, forcing)
+    model = ClimaLand.Soil.RichardsModel{FT}(domain, forcing)
 
     Y, p, cds = initialize(model)
     z = ClimaCore.Fields.coordinate_field(cds.subsurface).z
diff --git a/experiments/integrated/fluxnet/snow_soil/simulation.jl b/experiments/integrated/fluxnet/snow_soil/simulation.jl
@@ -2,7 +2,7 @@
 ## Ma, S., Baldocchi, D. D., Xu, L., Hehn, T. (2007)
 ## Inter-Annual Variability In Carbon Dioxide Exchange Of An
 ## Oak/Grass Savanna And Open Grassland In California, Agricultural
-## And Forest Meteorology, 147(3-4), 157-171. https://doi.org/10.1016/j.agrformet.2007.07.008 
+## And Forest Meteorology, 147(3-4), 157-171. https://doi.org/10.1016/j.agrformet.2007.07.008
 ## CLM 5.0 Tech Note: https://www2.cesm.ucar.edu/models/cesm2/land/CLM50_Tech_Note.pdf
 # Bonan, G. Climate change and terrestrial ecosystem modeling. Cambridge University Press, 2019.
 
@@ -93,8 +93,7 @@ S_s = FT(1e-3)
 z_0m = FT(0.01)
 z_0b = FT(0.001)
 emissivity = FT(0.98)
-soil_model = Soil.EnergyHydrology(
-    FT,
+soil_model = Soil.EnergyHydrology{FT}(
     domain,
     forcing,
     earth_param_set;
@@ -121,7 +120,7 @@ snow_model = Snow.SnowModel(
     density,
 )
 
-land = ClimaLand.SoilSnowModel(; snow = snow_model, soil = soil_model)
+land = ClimaLand.SoilSnowModel{FT}(; snow = snow_model, soil = soil_model)
 Y, p, cds = initialize(land)
 exp_tendency! = make_exp_tendency(land)
 imp_tendency! = make_imp_tendency(land)
diff --git a/experiments/long_runs/soil.jl b/experiments/long_runs/soil.jl
@@ -84,7 +84,7 @@ forcing = ClimaLand.prescribed_forcing_era5(
     max_wind_speed = 25.0,
     time_interpolation_method,
 )
-model = ClimaLand.Soil.EnergyHydrology(FT, domain, forcing, params)
+model = ClimaLand.Soil.EnergyHydrology{FT}(domain, forcing, params)
 diagnostics = ClimaLand.default_diagnostics(
     model,
     start_date;
diff --git a/experiments/standalone/Vegetation/no_vegetation.jl b/experiments/standalone/Vegetation/no_vegetation.jl
@@ -54,8 +54,7 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     earth_param_set,
 );
 
-soil_driver = PrescribedGroundConditions(
-    FT;
+soil_driver = PrescribedGroundConditions{FT}(;
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
     ϵ = FT(0.99),
diff --git a/experiments/standalone/Vegetation/timestep_test.jl b/experiments/standalone/Vegetation/timestep_test.jl
@@ -93,8 +93,7 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     earth_param_set,
 );
 
-soil_driver = PrescribedGroundConditions(
-    FT;
+soil_driver = PrescribedGroundConditions{FT}(;
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
     ϵ = FT(0.99),
diff --git a/experiments/standalone/Vegetation/varying_lai.jl b/experiments/standalone/Vegetation/varying_lai.jl
@@ -54,8 +54,7 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     earth_param_set,
 );
 
-soil_driver = PrescribedGroundConditions(
-    FT;
+soil_driver = PrescribedGroundConditions{FT}(;
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
     ϵ = FT(0.99),
diff --git a/experiments/standalone/Vegetation/varying_lai_with_stem.jl b/experiments/standalone/Vegetation/varying_lai_with_stem.jl
@@ -54,8 +54,7 @@ shared_params = SharedCanopyParameters{FT, typeof(earth_param_set)}(
     earth_param_set,
 );
 
-soil_driver = PrescribedGroundConditions(
-    FT;
+soil_driver = PrescribedGroundConditions{FT}(;
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
     ϵ = FT(0.99),
diff --git a/src/integrated/land.jl b/src/integrated/land.jl
@@ -186,7 +186,7 @@ end
 """
    ClimaLand.land_components(land::LandModel)
 
-Returns the components of the `LandModel`. 
+Returns the components of the `LandModel`.
 
 Currently, this method is required in order to preserve an ordering in how
 we update the component models' auxiliary states. The canopy update_aux! step
@@ -383,7 +383,7 @@ function lsm_radiant_energy_fluxes!(
     canopy_radiation::Canopy.AbstractRadiationModel{FT},
     Y,
     t,
-) where {(FT)}
+) where {FT}
     canopy = land.canopy
     canopy_bc = canopy.boundary_conditions
     radiation = canopy_bc.radiation
@@ -535,7 +535,7 @@ end
    compute_liquid_influx(p,
                          model,
                          prognostic_land_components::Val{(:canopy, :snow, :soil, :soilco2)},
-    ) 
+    )
 
 Returns the liquid water volume flux at the surface of the soil; uses
 the same method as the soil+snow integrated model.
diff --git a/src/integrated/soil_canopy_model.jl b/src/integrated/soil_canopy_model.jl
@@ -292,7 +292,7 @@ function lsm_radiant_energy_fluxes!(
     canopy_radiation::Canopy.AbstractRadiationModel{FT},
     Y,
     t,
-) where {(FT)}
+) where {FT}
     canopy = land.canopy
     earth_param_set = canopy.parameters.earth_param_set
     _σ = LP.Stefan(earth_param_set)
@@ -450,7 +450,7 @@ end
    compute_liquid_influx(p,
                          model,
                          prognostic_land_components::Val{(:canopy, :soil, :soilco2)},
-    ) 
+    )
 
 Returns the liquid water volume flux at the surface of the soil; in
  a model without snow as a prognostic variable, the influx is
diff --git a/src/integrated/soil_snow_model.jl b/src/integrated/soil_snow_model.jl
@@ -31,7 +31,7 @@ struct SoilSnowModel{
     snow::SnM
     "The soil model to be used"
     soil::SoM
-    function SoilSnowModel(; snow, soil)
+    function SoilSnowModel{FT}(; snow, soil) where {FT <: AbstractFloat}
         prognostic_land_components = (:snow, :soil)
         top_soil_bc = soil.boundary_conditions.top
         snow_bc = snow.boundary_conditions
@@ -46,7 +46,6 @@ struct SoilSnowModel{
 
         @assert soil.parameters.earth_param_set ==
                 snow.parameters.earth_param_set
-        FT = eltype(soil.parameters.earth_param_set)
         new{FT, typeof(snow), typeof(soil)}(snow, soil)
     end
 
@@ -154,7 +153,7 @@ see equation 24 and 25, with k=N, of Best et al, Geosci. Model Dev., 4, 677–69
 
 However, this is for a multi-layer snow model, with
 T_snow and Δz_snow related to the bottom layer.
-We only have a single layer snow model, and using Δz_snow = height of snow leads to a very small flux when the snow is deep. 
+We only have a single layer snow model, and using Δz_snow = height of snow leads to a very small flux when the snow is deep.
 Due to this, we cap Δz_snow at 10 cm.
 """
 function update_soil_snow_ground_heat_flux!(
@@ -321,7 +320,7 @@ end
    compute_liquid_influx(p,
                          model,
                          prognostic_land_components::Val{(:snow, :soil,)},
-    ) 
+    )
 
 Returns the liquid water volume flux at the surface of the soil,
 accounting for snowmelt and rainfall.
diff --git a/src/shared_utilities/drivers.jl b/src/shared_utilities/drivers.jl
@@ -1096,7 +1096,7 @@ struct PrescribedGroundConditions{
 end
 
 """
-     function PrescribedGroundConditions(FT;
+     function PrescribedGroundConditions{FT}(;
          ψ::TimeVaryingInput,
          T::TimeVaryingInput,
          α_PAR::FT,
@@ -1107,14 +1107,13 @@ end
 An outer constructor for the PrescribedGroundConditions allowing the user to
 specify the ground parameters by keyword arguments.
 """
-function PrescribedGroundConditions(
-    FT;
+function PrescribedGroundConditions{FT}(;
     ψ = TimeVaryingInput((t) -> 0.0),
     T = TimeVaryingInput((t) -> 298.0),
     α_PAR = FT(0.2),
     α_NIR = FT(0.4),
     ϵ = FT(0.99),
-)
+) where {FT <: AbstractFloat}
     return PrescribedGroundConditions{FT, typeof(ψ), typeof(T)}(
         ψ,
         T,
@@ -1472,8 +1471,8 @@ The argument `era5_ncdata_path` is either a list of nc files, each with all of t
 
 ########## WARNING ##########
 
-High wind speed anomalies (10-100x increase and decrease over a period of a several hours) appear in the ERA5 
-reanalysis data. These generate very large surface fluxes (due to wind speeds up to 300 m/s), which lead to instability. The kwarg max_wind_speed, 
+High wind speed anomalies (10-100x increase and decrease over a period of a several hours) appear in the ERA5
+reanalysis data. These generate very large surface fluxes (due to wind speeds up to 300 m/s), which lead to instability. The kwarg max_wind_speed,
 with a value give in m/s,
 is used to clip these if it is not `nothing`.
 See: https://confluence.ecmwf.int/display/CKB/ERA5%3A+large+10m+winds
diff --git a/src/standalone/Soil/Biogeochemistry/Biogeochemistry.jl b/src/standalone/Soil/Biogeochemistry/Biogeochemistry.jl
@@ -71,7 +71,7 @@ end
 
 
 """
-    SoilCO2ModelParameters(FT; kwargs...)
+    SoilCO2ModelParameters(::Type{FT}; kwargs...)
     SoilCO2ModelParameters(toml_dict; kwargs...)
 
 SoilCO2ModelParameters has two constructors: float-type and toml dict based.
diff --git a/src/standalone/Soil/Soil.jl b/src/standalone/Soil/Soil.jl
@@ -194,7 +194,7 @@ using .Biogeochemistry
 # Soil model constructor useful for working with simulations forced by
 # the atmosphere
 """
-    EnergyHydrology(FT, domain, forcing, earth_param_set;
+    EnergyHydrology{FT}(domain, forcing, earth_param_set;
                          prognostic_land_components = (:soil),
                          albedo = CLMTwoBandSoilAlbedo{FT}(; clm_soil_albedo_parameters(domain.space.surface)...),
                          runoff =  Runoff.TOPMODELRunoff{FT}(f_over = FT(3.28),
@@ -208,7 +208,7 @@ using .Biogeochemistry
                          z_0b = LP.get_default_parameter(FT, :soil_scalar_roughness_length),
                          emissivity = LP.get_default_parameter(FT, :soil_bare_soil),
                          additional_sources = (),
-                         )
+                         ) where {FT <: AbstractFloat}
 
 Creates a EnergyHydrology model with the given float type FT, domain, earth_param_set, forcing, and prognostic land components.
 
@@ -225,8 +225,7 @@ component models.
 Roughness lengths and soil emissivity are currently treated as constants; these can be passed in as Floats
 by kwarg; otherwise the default values are used.
 """
-function EnergyHydrology(
-    FT,
+function EnergyHydrology{FT}(
     domain,
     forcing,
     earth_param_set;
@@ -252,7 +251,7 @@ function EnergyHydrology(
     z_0b = LP.get_default_parameter(FT, :soil_scalar_roughness_length),
     emissivity = LP.get_default_parameter(FT, :emissivity_bare_soil),
     additional_sources = (),
-)
+) where {FT <: AbstractFloat}
     # TODO: Move runoff scalar parameters to ClimaParams, possibly use types in retention, composition,
     #  roughness, and emissivity.
     top_bc = AtmosDrivenFluxBC(
@@ -285,7 +284,7 @@ end
 
 
 """
-    RichardsModel(FT, domain, forcing;
+    RichardsModel{FT}(domain, forcing;
                          runoff =  ClimaLand.Soil.Runoff.TOPMODELRunoff{FT}(f_over = FT(3.28),
                                                                             R_sb = FT(1.484e-4 / 1000),
                                                                             f_max = topmodel_fmax(domain.space.surface,FT),
@@ -301,8 +300,7 @@ changed with keyword arguments.
 
 The runoff parameterization is also provided and can be changed via keyword argument.
 """
-function RichardsModel(
-    FT,
+function RichardsModel{FT}(
     domain,
     forcing;
     runoff::Runoff.AbstractRunoffModel = Runoff.TOPMODELRunoff{FT}(
@@ -315,7 +313,7 @@ function RichardsModel(
         FT,
     ),
     S_s = ClimaCore.Fields.zeros(domain.space.subsurface) .+ 1e-3,
-)
+) where {FT}
     # TODO: Move scalar parameters to ClimaParams and obtain from earth_param_set, possibly use types in retention argument.
     top_bc = RichardsAtmosDrivenFluxBC(forcing.atmos, runoff)
     bottom_bc = WaterFluxBC((p, t) -> 0.0)
diff --git a/src/standalone/Vegetation/optimality_farquhar.jl b/src/standalone/Vegetation/optimality_farquhar.jl
@@ -85,7 +85,7 @@ ClimaLand.auxiliary_domain_names(::OptimalityFarquharModel) =
     update_photosynthesis!(p, Y, model::OptimalityFarquharModel,canopy)
 
 Computes the net photosynthesis rate `An` (mol CO2/m^2/s)for the Optimality Farquhar model, along with the
-dark respiration `Rd` (mol CO2/m^2/s), the value of `Vcmax25`(mol CO2/m^2/s) , and the gross primary 
+dark respiration `Rd` (mol CO2/m^2/s), the value of `Vcmax25`(mol CO2/m^2/s) , and the gross primary
 productivity `GPP` (mol CO2/m^2/s), and updates them in place.
 """
 function update_photosynthesis!(p, Y, model::OptimalityFarquharModel, canopy)
@@ -194,7 +194,7 @@ Base.broadcastable(m::OptimalityFarquharParameters) = tuple(m)
 
 """
     function OptimalityFarquharParameters(
-        FT,
+        ::Type{FT},
         kwargs...  # For individual parameter overrides
     )
 
diff --git a/src/standalone/Vegetation/photosynthesis.jl b/src/standalone/Vegetation/photosynthesis.jl
@@ -276,7 +276,7 @@ include("./optimality_farquhar.jl")
 
 """
     function FarquharParameters(
-        FT,
+        ::Type{FT},
         is_c3::Union{FT, ClimaCore.Fields.Field};
         Vcmax25 = FT(5e-5),
         kwargs...  # For individual parameter overrides
diff --git a/src/standalone/Vegetation/radiation.jl b/src/standalone/Vegetation/radiation.jl
@@ -344,7 +344,7 @@ function TwoStreamParameters(
 end
 
 """
-    function BeerLambertParameters(FT::AbstractFloat;
+    function BeerLambertParameters(::Type{FT};
         ld = (_) -> 0.5,
         α_PAR_leaf = 0.1,
         α_NIR_leaf = 0.4,
diff --git a/src/standalone/Vegetation/stomatalconductance.jl b/src/standalone/Vegetation/stomatalconductance.jl
@@ -76,7 +76,7 @@ end
 # For interfacing with ClimaParams
 
 """
-    function MedlynConductanceParameters(FT::AbstractFloat;
+    function MedlynConductanceParameters(::Type{FT};
         g1 = 790,
         kwargs...
     )
diff --git a/test/integrated/soil_snow.jl b/test/integrated/soil_snow.jl
@@ -68,8 +68,7 @@ z_0m = FT(0.001)
 z_0b = z_0m
 prognostic_land_components = (:snow, :soil)
 
-soil = ClimaLand.Soil.EnergyHydrology(
-    FT,
+soil = ClimaLand.Soil.EnergyHydrology{FT}(
     domain,
     forcing,
     earth_param_set;
@@ -92,7 +91,7 @@ snow = ClimaLand.Snow.SnowModel(
     Δt;
     prognostic_land_components,
 )
-land_model = ClimaLand.SoilSnowModel(; snow, soil)
+land_model = ClimaLand.SoilSnowModel{FT}(; snow, soil)
 
 Y, p, coords = ClimaLand.initialize(land_model)
 p_soil_alone = deepcopy(p)
diff --git a/test/shared_utilities/drivers.jl b/test/shared_utilities/drivers.jl
@@ -238,7 +238,7 @@ end
 
 @testset "Ground Conditions" begin
     for FT in (Float32, Float64)
-        soil_driver = PrescribedGroundConditions(FT)
+        soil_driver = PrescribedGroundConditions{FT}()
         prognostic_soil_driver = ClimaLand.PrognosticGroundConditions{FT}()
         @test ClimaLand.Canopy.ground_albedo_PAR(
             Val((:canopy,)),
diff --git a/test/standalone/Vegetation/canopy_model.jl b/test/standalone/Vegetation/canopy_model.jl
diff --git a/test/standalone/Vegetation/conservation.jl b/test/standalone/Vegetation/conservation.jl
diff --git a/test/standalone/Vegetation/plant_hydraulics_test.jl b/test/standalone/Vegetation/plant_hydraulics_test.jl

Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ function setup_prob(t0, tf, Δt; nelements = (101, 15))`
`99`	`99`	`atmos = ClimaLand.PrescribedPrecipitation{FT, typeof(precip)}(precip),`
`100`	`100`	`)`
`101`	`101`
`102`		`- model = ClimaLand.Soil.RichardsModel(FT, domain, forcing)`
	`102`	`+ model = ClimaLand.Soil.RichardsModel{FT}(domain, forcing)`
`103`	`103`
`104`	`104`	`Y, p, cds = initialize(model)`
`105`	`105`	`z = ClimaCore.Fields.coordinate_field(cds.subsurface).z`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ forcing = ClimaLand.prescribed_forcing_era5(`
`84`	`84`	`max_wind_speed = 25.0,`
`85`	`85`	`time_interpolation_method,`
`86`	`86`	`)`
`87`		`-model = ClimaLand.Soil.EnergyHydrology(FT, domain, forcing, params)`
	`87`	`+model = ClimaLand.Soil.EnergyHydrology{FT}(domain, forcing, params)`
`88`	`88`	`diagnostics = ClimaLand.default_diagnostics(`
`89`	`89`	`model,`
`90`	`90`	`start_date;`