API documentation for the constants module

This submodule contains dataclasses containing core constants used across the Virtual Ecosystem. This includes universal constants but also constants that may be shared across model.

Note that true universal constants are defined as class variables of dataclasses. This prevents them being changed by user specified configuration.

Classes:

CoreConsts([placeholder, standard_pressure, ...])

Core constants for use across the Virtual Ecosystem modules.

class virtual_ecosystem.core.constants.CoreConsts(placeholder: float = 123.4, standard_pressure: float = 101.325, standard_mole: float = 44.642, molar_heat_capacity_air: float = 29.19, gravity: float = 6.6743e-11, stefan_boltzmann_constant: float = 5.670374419e-08, von_karmans_constant: float = 0.4, depth_of_active_soil_layer: float = 0.25, meters_to_mm: float = 1000.0, molecular_weight_air: float = 28.96, gas_constant_water_vapour: float = 461.51, seconds_to_day: float = 86400.0, characteristic_dimension_leaf: float = 0.01)

Core constants for use across the Virtual Ecosystem modules.

Attributes:

characteristic_dimension_leaf	Characteristic dimension of leaf, typically around 0.7 * leaf width, [m].
depth_of_active_soil_layer	Depth of the biogeochemically active soil layer [m].
gas_constant_water_vapour	Gas constant for water vapour, [J kg-1 K-1]
gravity	Newtonian constant of gravitation, [m s-1].
meters_to_mm	Factor to convert variable unit from meters to millimeters.
molar_heat_capacity_air	Molar heat capacity of air, [J mol-1 K-1].
molecular_weight_air	Molecular weight of air, [g mol-1].
placeholder	A placeholder configurable constant.
seconds_to_day	Factor to convert variable unit from seconds to day.
standard_mole	Moles of ideal gas in 1 m^3 air at standard atmosphere.
standard_pressure	Standard atmospheric pressure, [kPa]
stefan_boltzmann_constant	Stefan-Boltzmann constant, [W m-2 K-4].
von_karmans_constant	Von Karman's constant, [unitless].
zero_Celsius	Conversion constant from Kelvin to Celsius (°).

characteristic_dimension_leaf: float = 0.01

Characteristic dimension of leaf, typically around 0.7 * leaf width, [m].

depth_of_active_soil_layer: float = 0.25

Depth of the biogeochemically active soil layer [m].

The soil model considered a homogenous layer in which all significant nutrient processes take place. This is a major assumption of the model. The value is taken from Fatichi et al. (2019). No empirical source is provided for this value.

gas_constant_water_vapour: float = 461.51

Gas constant for water vapour, [J kg-1 K-1]

gravity: float = 6.6743e-11

Newtonian constant of gravitation, [m s-1].

meters_to_mm: float = 1000.0

Factor to convert variable unit from meters to millimeters.

molar_heat_capacity_air: float = 29.19

Molar heat capacity of air, [J mol-1 K-1].

molecular_weight_air: float = 28.96

Molecular weight of air, [g mol-1].

placeholder: float = 123.4

A placeholder configurable constant.

seconds_to_day: float = 86400.0

Factor to convert variable unit from seconds to day.

standard_mole: float = 44.642

Moles of ideal gas in 1 m^3 air at standard atmosphere.

standard_pressure: float = 101.325

Standard atmospheric pressure, [kPa]

stefan_boltzmann_constant: float = 5.670374419e-08

Stefan-Boltzmann constant, [W m-2 K-4].

The Stefan-Boltzmann constant relates the energy radiated by a black body to its temperature.

von_karmans_constant: float = 0.4

Von Karman’s constant, [unitless].

The von Karman’s constant describes the logarithmic velocity profile of a turbulent fluid near a no-slip boundary.

zero_Celsius: ClassVar[float] = 273.15

Conversion constant from Kelvin to Celsius (°).