Hydraulic conductance and capacitance parameters of the leaf, stem and root compartments. More...

Detailed Description

Hydraulic conductance and capacitance parameters of the leaf, stem and root compartments.

A new instance holds the model defaults: a constant conductance of 0.5 mol/m²/s/MPa for each compartment, and pressure-volume curve parameters of -2 MPa osmotic potential at full turgor, 0.8 relative water content at turgor loss and an elasticity exponent of 1.

   LeafHydraulicConductance, StemHydraulicConductance, RootHydraulicConductance: HydraulicConductance

Example: >>> coeffs = PlantHydraulicsModelCoefficients() >>> coeffs.setLeafHydraulicConductance(0.05, -1.5, 2.0) >>> coeffs.setStemHydraulicConductance(0.5) >>> coeffs.setLeafHydraulicCapacitanceFromLibrary("pistachio")

Definition at line 262 of file PlantHydraulics.py.

Collaboration diagram for pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients:

Public Member Functions
	__init__ (self)

	__repr__ (self)

None	setLeafHydraulicConductance (self, float saturated_conductance, Optional[float] potential_at_half_saturated=None, Optional[float] sensitivity=None, bool temperature_dependence=False)
	Set leaf hydraulic conductance, constant or as a function of leaf water potential.

None	setLeafHydraulicConductanceTemperatureDependence (self, bool temperature_dependence)
	Toggle the temperature dependence of leaf hydraulic conductance, K(T) = K*(T/298.15)^7.

None	setStemHydraulicConductance (self, float saturated_conductance, Optional[float] potential_at_half_saturated=None, Optional[float] sensitivity=None, bool temperature_dependence=False)
	Set stem hydraulic conductance, constant or as a function of stem water potential.

None	setStemHydraulicConductanceTemperatureDependence (self, bool temperature_dependence)
	Toggle the temperature dependence of stem hydraulic conductance, K(T) = K*(T/298.15)^7.

None	setRootHydraulicConductance (self, float saturated_conductance, Optional[float] potential_at_half_saturated=None, Optional[float] sensitivity=None, bool temperature_dependence=False)
	Set root hydraulic conductance, constant or as a function of root water potential.

None	setRootHydraulicConductanceTemperatureDependence (self, bool temperature_dependence)
	Toggle the temperature dependence of root hydraulic conductance, K(T) = K*(T/298.15)^7.

None	setLeafHydraulicCapacitance (self, float osmotic_potential_at_full_turgor, Optional[float] relative_water_content_at_turgor_loss=None, Optional[float] cell_wall_elasticity_exponent=None, Optional[float] saturated_specific_water_content=None)
	Set leaf hydraulic capacitance, constant or from pressure-volume curve parameters.

None	setLeafHydraulicCapacitanceFromLibrary (self, str species)
	Set leaf hydraulic capacitance from the species library of pressure-volume curve parameters.

None	setStemHydraulicCapacitance (self, float osmotic_potential_at_full_turgor, Optional[float] relative_water_content_at_turgor_loss=None, Optional[float] cell_wall_elasticity_exponent=None)
	Set stem hydraulic capacitance, constant or from pressure-volume curve parameters.

None	setRootHydraulicCapacitance (self, float osmotic_potential_at_full_turgor, Optional[float] relative_water_content_at_turgor_loss=None, Optional[float] cell_wall_elasticity_exponent=None)
	Set root hydraulic capacitance, constant or from pressure-volume curve parameters.

None	validate (self, str method_name="PlantHydraulicsModelCoefficients")
	Raise ValueError if any compartment's parameters are missing, mistyped or out of range.

List[float]	to_list (self)
	Flat layout expected by the native interface (see pyhelios_wrapper_planthydraulics.h).

'PlantHydraulicsModelCoefficients'	from_list (cls, Sequence[float] values)
	Build coefficients from the flat layout written by to_list().

Public Attributes
	LeafHydraulicConductance = HydraulicConductance()

	StemHydraulicConductance = HydraulicConductance()

	RootHydraulicConductance = HydraulicConductance()

Optional[HydraulicCapacitance]	LeafHydraulicCapacitance = HydraulicCapacitance()
	HydraulicCapacitance, or None when the leaf capacitance comes from the.

	StemHydraulicCapacitance = HydraulicCapacitance()

	RootHydraulicCapacitance = HydraulicCapacitance()

Optional[str]	leaf_capacitance_species = None
	Species name whose library leaf capacitance is used, or None.

Constructor & Destructor Documentation

◆ init()

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.__init__ ( self )

Definition at line 274 of file PlantHydraulics.py.

Member Function Documentation

◆ repr()

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.__repr__ ( self )

Definition at line 283 of file PlantHydraulics.py.

◆ from_list()

'PlantHydraulicsModelCoefficients' pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.from_list	(		cls,
		Sequence[float]	values )

Build coefficients from the flat layout written by to_list().

Definition at line 500 of file PlantHydraulics.py.

◆ setLeafHydraulicCapacitance()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setLeafHydraulicCapacitance	(		self,
		float	osmotic_potential_at_full_turgor,
		Optional[float]	relative_water_content_at_turgor_loss = None,
		Optional[float]	cell_wall_elasticity_exponent = None,
		Optional[float]	saturated_specific_water_content = None )

Set leaf hydraulic capacitance, constant or from pressure-volume curve parameters.

   Called with a single argument, that value is a constant capacitance (mol/m²/MPa, typical range
   0.005 to 0.5). Otherwise the arguments are pressure-volume curve parameters.

   The model computes leaf relative water content, turgor pressure and osmotic potential from
   the pressure-volume curve parameters. A constant capacitance resets those parameters to
   their defaults (-2 MPa, 0.8, 1) and otherwise only changes the optional
   "hydraulic_capacitance" output.

Parameters

osmotic_potential_at_full_turgor	Osmotic potential at full turgor (MPa), or the constant capacitance (mol/m²/MPa) when it is the only argument.
relative_water_content_at_turgor_loss	Relative water content at the turgor loss point (unitless). Typical range 0.7 to 0.95.
cell_wall_elasticity_exponent	Exponent of the turgor pressure versus relative water content relationship (unitless). Typical range 1 to 2. Defaults to 1.
saturated_specific_water_content	Saturated specific water content (mol/m²). Defaults to 1.

Definition at line 389 of file PlantHydraulics.py.

◆ setLeafHydraulicCapacitanceFromLibrary()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setLeafHydraulicCapacitanceFromLibrary	(		self,
		str	species )

Set leaf hydraulic capacitance from the species library of pressure-volume curve parameters.

   The library values are held by the native plugin and applied when the coefficients are passed
   to PlantHydraulicsModel.setModelCoefficients(). LeafHydraulicCapacitance stays None unless it
   is later replaced by setLeafHydraulicCapacitance().

Parameters

species Species name. See pyhelios.PlantHydraulics.AVAILABLE_SPECIES.

Exceptions

ValueError If the species is not in the library

Definition at line 411 of file PlantHydraulics.py.

◆ setLeafHydraulicConductance()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setLeafHydraulicConductance	(		self,
		float	saturated_conductance,
		Optional[float]	potential_at_half_saturated = None,
		Optional[float]	sensitivity = None,
		bool	temperature_dependence = False )

Set leaf hydraulic conductance, constant or as a function of leaf water potential.

Parameters

saturated_conductance	Conductance at a water potential of zero (mol/m²/s/MPa). Typical range 0.001 to 1. With no other arguments this is a constant conductance.
potential_at_half_saturated	Water potential at which conductance is half its saturated value (MPa).
sensitivity	Steepness of the decline in conductance with water potential (unitless). Defaults to 5 when potential_at_half_saturated is given.
temperature_dependence	If True, conductance is scaled by (T/298.15)^7.

Definition at line 306 of file PlantHydraulics.py.

◆ setLeafHydraulicConductanceTemperatureDependence()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setLeafHydraulicConductanceTemperatureDependence	(		self,
		bool	temperature_dependence )

Toggle the temperature dependence of leaf hydraulic conductance, K(T) = K*(T/298.15)^7.

Definition at line 315 of file PlantHydraulics.py.

◆ setRootHydraulicCapacitance()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setRootHydraulicCapacitance	(		self,
		float	osmotic_potential_at_full_turgor,
		Optional[float]	relative_water_content_at_turgor_loss = None,
		Optional[float]	cell_wall_elasticity_exponent = None )

Set root hydraulic capacitance, constant or from pressure-volume curve parameters.

   Called with a single argument, that value is a constant capacitance (typical range 0.005 to 2).
   Root capacitance is used only by non-steady-state runs, which require it to be constant;
   pressure-volume curve parameters are accepted but never used by the model.

Parameters

osmotic_potential_at_full_turgor	Osmotic potential at full turgor (MPa), or the constant capacitance when it is the only argument.
relative_water_content_at_turgor_loss	Relative water content at the turgor loss point (unitless).
cell_wall_elasticity_exponent	Exponent of the turgor pressure versus relative water content relationship (unitless). Defaults to 1.

Definition at line 450 of file PlantHydraulics.py.

◆ setRootHydraulicConductance()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setRootHydraulicConductance	(		self,
		float	saturated_conductance,
		Optional[float]	potential_at_half_saturated = None,
		Optional[float]	sensitivity = None,
		bool	temperature_dependence = False )

Set root hydraulic conductance, constant or as a function of root water potential.

Parameters

saturated_conductance	Conductance at a water potential of zero (mol/m²/s/MPa). Typical range 0.001 to 1. With no other arguments this is a constant conductance.
potential_at_half_saturated	Water potential at which conductance is half its saturated value (MPa).
sensitivity	Steepness of the decline in conductance with water potential (unitless). Defaults to 5 when potential_at_half_saturated is given.
temperature_dependence	If True, conductance is scaled by (T/298.15)^7.

Definition at line 354 of file PlantHydraulics.py.

◆ setRootHydraulicConductanceTemperatureDependence()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setRootHydraulicConductanceTemperatureDependence	(		self,
		bool	temperature_dependence )

Toggle the temperature dependence of root hydraulic conductance, K(T) = K*(T/298.15)^7.

Definition at line 363 of file PlantHydraulics.py.

◆ setStemHydraulicCapacitance()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setStemHydraulicCapacitance	(		self,
		float	osmotic_potential_at_full_turgor,
		Optional[float]	relative_water_content_at_turgor_loss = None,
		Optional[float]	cell_wall_elasticity_exponent = None )

Set stem hydraulic capacitance, constant or from pressure-volume curve parameters.

   Called with a single argument, that value is a constant capacitance (typical range 0.005 to 2).
   Stem capacitance is used only by non-steady-state runs, which require it to be constant;
   pressure-volume curve parameters are accepted but never used by the model.

Parameters

osmotic_potential_at_full_turgor	Osmotic potential at full turgor (MPa), or the constant capacitance when it is the only argument.
relative_water_content_at_turgor_loss	Relative water content at the turgor loss point (unitless).
cell_wall_elasticity_exponent	Exponent of the turgor pressure versus relative water content relationship (unitless). Defaults to 1.

Definition at line 429 of file PlantHydraulics.py.

◆ setStemHydraulicConductance()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setStemHydraulicConductance	(		self,
		float	saturated_conductance,
		Optional[float]	potential_at_half_saturated = None,
		Optional[float]	sensitivity = None,
		bool	temperature_dependence = False )

Set stem hydraulic conductance, constant or as a function of stem water potential.

Parameters

saturated_conductance	Conductance at a water potential of zero (mol/m²/s/MPa). Typical range 0.001 to 1. With no other arguments this is a constant conductance.
potential_at_half_saturated	Water potential at which conductance is half its saturated value (MPa).
sensitivity	Steepness of the decline in conductance with water potential (unitless). Defaults to 5 when potential_at_half_saturated is given.
temperature_dependence	If True, conductance is scaled by (T/298.15)^7.

Definition at line 330 of file PlantHydraulics.py.

◆ setStemHydraulicConductanceTemperatureDependence()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.setStemHydraulicConductanceTemperatureDependence	(		self,
		bool	temperature_dependence )

Toggle the temperature dependence of stem hydraulic conductance, K(T) = K*(T/298.15)^7.

Definition at line 339 of file PlantHydraulics.py.

◆ to_list()

List[float] pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.to_list ( self )

Flat layout expected by the native interface (see pyhelios_wrapper_planthydraulics.h).

Definition at line 487 of file PlantHydraulics.py.

◆ validate()

None pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.validate	(		self,
		str	method_name = "PlantHydraulicsModelCoefficients" )

Raise ValueError if any compartment's parameters are missing, mistyped or out of range.

Definition at line 458 of file PlantHydraulics.py.

Member Data Documentation

◆ leaf_capacitance_species

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.leaf_capacitance_species = None

Species name whose library leaf capacitance is used, or None.

Definition at line 281 of file PlantHydraulics.py.

◆ LeafHydraulicCapacitance

Optional[HydraulicCapacitance] pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.LeafHydraulicCapacitance = HydraulicCapacitance()

HydraulicCapacitance, or None when the leaf capacitance comes from the.

Definition at line 278 of file PlantHydraulics.py.

◆ LeafHydraulicConductance

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.LeafHydraulicConductance = HydraulicConductance()

Definition at line 275 of file PlantHydraulics.py.

◆ RootHydraulicCapacitance

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.RootHydraulicCapacitance = HydraulicCapacitance()

Definition at line 280 of file PlantHydraulics.py.

◆ RootHydraulicConductance

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.RootHydraulicConductance = HydraulicConductance()

Definition at line 277 of file PlantHydraulics.py.

◆ StemHydraulicCapacitance

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.StemHydraulicCapacitance = HydraulicCapacitance()

Definition at line 279 of file PlantHydraulics.py.

◆ StemHydraulicConductance

pyhelios.PlantHydraulics.PlantHydraulicsModelCoefficients.StemHydraulicConductance = HydraulicConductance()

Definition at line 276 of file PlantHydraulics.py.

The documentation for this class was generated from the following file:

pyhelios/PlantHydraulics.py

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __repr__()

◆ from_list()

◆ setLeafHydraulicCapacitance()

◆ setLeafHydraulicCapacitanceFromLibrary()

◆ setLeafHydraulicConductance()

◆ setLeafHydraulicConductanceTemperatureDependence()

◆ setRootHydraulicCapacitance()

◆ setRootHydraulicConductance()

◆ setRootHydraulicConductanceTemperatureDependence()

◆ setStemHydraulicCapacitance()

◆ setStemHydraulicConductance()

◆ setStemHydraulicConductanceTemperatureDependence()

◆ to_list()

◆ validate()

Member Data Documentation

◆ leaf_capacitance_species

◆ LeafHydraulicCapacitance

◆ LeafHydraulicConductance

◆ RootHydraulicCapacitance

◆ RootHydraulicConductance

◆ StemHydraulicCapacitance

◆ StemHydraulicConductance

◆ init()

◆ repr()