ClimaLand
LSM Model Types and methods
Missing docstring for ClimaLand.SoilPlantHydrologyModel
. Check Documenter's build log for details.
ClimaLand.LandSoilBiogeochemistry
— Typestruct LandSoilBiogeochemistry{
FT,
SEH <: Soil.EnergyHydrology{FT},
SB <: Soil.Biogeochemistry.SoilCO2Model{FT},
} <: AbstractLandModel{FT}
A concrete type of land model used for simulating systems with a soil energy, hydrology, and biogeochemistry component.
soil
: The soil modelsoilco2
: The biochemistry model
ClimaLand.LandHydrology
— Typestruct LandHydrology{
FT,
SM <: Soil.AbstractSoilModel{FT},
SW <: Pond.AbstractSurfaceWaterModel{FT},
} <: AbstractLandModel{FT}
A concrete type of land model used for simulating systems with a soil and surface water component.
soil
: The soil modelsurface_water
: The surface water model
Missing docstring for ClimaLand.make_interactions_update_aux
. Check Documenter's build log for details.
Missing docstring for ClimaLand.initialize_interactions
. Check Documenter's build log for details.
ClimaLand.land_components
— Functionland_components(land::AbstractLandModel)
Returns the component names of the land
model, by calling propertynames(land)
.
ClimaLand.lsm_aux_vars
— Functionlsmauxvars(m::AbstractLandModel)
Returns the additional aux variable symbols for the model in the form of a tuple.
lsm_aux_vars(m::SoilCanopyModel)
The names of the additional auxiliary variables that are included in the integrated Soil-Canopy model.
ClimaLand.lsm_aux_types
— Functionlsmauxtypes(m::AbstractLandModel)
Returns the shared additional aux variable types for the model in the form of a tuple.
lsm_aux_types(m::SoilCanopyModel)
The types of the additional auxiliary variables that are included in the integrated Soil-Canopy model.
ClimaLand.lsm_aux_domain_names
— Functionlsmauxdomain_names(m::AbstractLandModel)
Returns the additional domain symbols in the form of a tuple e.g. :surface or :subsurface.
This is only required for variables shared between land submodels, and only needed for multi-component models, not standalone components. Component-specific variables should be listed as prognostic or auxiliary variables which do not require this to initialize.
lsm_aux_domain_names(m::SoilCanopyModel)
The domain names of the additional auxiliary variables that are included in the integrated Soil-Canopy model.
Missing docstring for ClimaLand.domain_name
. Check Documenter's build log for details.
Land Hydrology
ClimaLand.infiltration_capacity
— Functionfunction infiltration_capacity(
Y::ClimaCore.Fields.FieldVector,
p::NamedTuple,
)
Function which computes the infiltration capacity of the soil based on soil characteristics, moisture levels, and pond height.
Defined such that positive means into soil.
ClimaLand.infiltration_at_point
— Functioninfiltration_at_point(η::FT, i_c::FT, P::FT)
Returns the infiltration given pond height η, infiltration capacity, and precipitation.
This is defined such that positive means into soil.
ClimaLand.PrognosticRunoff
— TypePrognosticRunoff <: Pond.AbstractSurfaceRunoff
Concrete type of Pond.AbstractSurfaceRunoff
for use in LSM models, where precipitation is passed in, but infiltration is computed prognostically.
This is paired with Soil.RunoffBC
: both are used at the same time, ensuring the infiltration used for the boundary condition of soil is also used to compute the runoff for the surface water.
ClimaLand.RunoffBC
— TypeRunoffBC <: Soil.AbstractSoilBC
Concrete type of Soil.AbstractSoilBC
for use in LSM models, where precipitation is passed in, but infiltration is computed prognostically. This infiltration is then used to set an upper boundary condition for the soil.
This is paired with Pond.PrognosticRunoff
: both are used at the same time, ensuring that the infiltration used for the boundary condition of soil is also used to compute the runoff for the surface water.
SoilCanopyModel
ClimaLand.PrognosticSoil
— Type PrognosticSoil{FT} <: AbstractSoilDriver
Concrete type of AbstractSoilDriver used for dispatch in cases where both a canopy model and soil model are run.
α_PAR
: Soil albedo for PARα_NIR
: Soil albedo for NIR
ClimaLand.RootExtraction
— TypeRootExtraction{FT} <: Soil.AbstractSoilSource{FT}
Concrete type of Soil.AbstractSoilSource, used for dispatch in an LSM with both soil and plant hydraulic components.
This is paired with the source term Canopy.PrognosticSoil
:both are used at the same time, ensuring that the water flux into the roots is extracted correctly from the soil.
LandSoilBiogeochemistry
Missing docstring for ClimaLand.PrognosticMet
. Check Documenter's build log for details.