improve model setup

Author: kmdeck

src/simulations/model_setup.jl

@@ -1,13 +1,20 @@
 """
     EnergyHydrology(FT, domain, earth_param_set, forcing, prognostic_land_components;
-                         runoff_model =  ClimaLand.Soil.Runoff.TOPMODELRunoff{FT}(f_over = FT(3.28), # extract from EPS
-                                                                                  R_sb = FT(1.484e-4 / 1000),# extract from EPS
+                         runoff_model =  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),
                                                                                   ),
-                         retention_parameters = soil_vangenuchten_parameters(domain.space.subsurface, FT), # Should this be vanGenuchten type?
+                         retention_parameters = soil_vangenuchten_parameters(domain.space.subsurface, FT),
                          composition_parameters = soil_composition_parameters(domain.space.subsurface, FT),
-                         albedo_parameters = clm_soil_albedo_parameters(domain.space.surface, FT), # eventually, can be CLMSoilAlbedo type
-                         S_s = ClimaCore.Fields.zeros(domain.space.subsurface) .+ 1e-3,# extract from EPS or get from file
+                         albedo_parameters = clm_soil_albedo_parameters(domain.space.surface, FT),
+                         S_s = ClimaCore.Fields.zeros(domain.space.subsurface) .+ 1e-3,
+                         top_bc = ClimaLand.Soil.AtmosDrivenFluxBC(forcing.atmos,
+                                                                   forcing.radiation,
+                                                                   runoff_model,
+                                                                   prognostic_land_components,
+                                                                   ),
+                         bottom_bc = ClimaLand.Soil.EnergyWaterFreeDrainage()
+                         sources = (ClimaLand.Soil.PhaseChange{FT}(),)
                          )
 
 Creates a ClimaLand.Soil.EnergyHydrology model with the given float type FT, domain, earth_param_set, forcing, and prognostic land components.
@@ -16,6 +23,8 @@ Default spatially varying parameters (for retention curve parameters, compositio
 changed with keyword arguments. 
 
 The runoff model is also provided and can be changed with a keyword argument.
+
+Boundary conditions and sources suitable for global runs are also provided as defaults, but can be modified using a keyword argument if you know what you are doing.
 """
 function EnergyHydrology(
     FT,
@@ -39,23 +48,19 @@ function EnergyHydrology(
         FT,
     ),
     albedo_parameters = clm_soil_albedo_parameters(domain.space.surface, FT), # eventually, can be CLMSoilAlbedo type
-    S_s = ClimaCore.Fields.zeros(domain.space.subsurface) .+ 1e-3,# extract from EPS or get from file
-)
+    S_s = ClimaCore.Fields.zeros(domain.space.subsurface) .+ 1e-3,# extract from EPS or get from file,
     top_bc = ClimaLand.Soil.AtmosDrivenFluxBC(
         forcing.atmos,
         forcing.radiation,
         runoff_model,
         prognostic_land_components,
-    )
-    bottom_bc = ClimaLand.Soil.EnergyWaterFreeDrainage()
+    ),
+    bottom_bc = ClimaLand.Soil.EnergyWaterFreeDrainage()sources =
+        (ClimaLand.Soil.PhaseChange{FT}(),),
+)
     boundary_conditions = (; top = top_bc, bottom = bottom_bc)
-    # sublimation and subsurface runoff are added automatically
-    if :canopy ∈ prognostic_land_components
-        sources =
-            (ClimaLand.RootExtraction{FT}(), ClimaLand.Soil.PhaseChange{FT}())
-    else
-        sources = (ClimaLand.Soil.PhaseChange{FT}(),)
-    end
+    :canopy ∈ prognostic_land_components &&
+        @assert ClimaLand.RootExtraction{FT}() ∈ sources
     parameters = ClimaLand.Soil.EnergyHydrologyParameters(
         FT;
         retention_parameters...,