Richards Class Reference

Calculates flow according to the Richards equation. More...

Inheritance diagram for Richards:

Collaboration diagram for Richards:

Detailed Description

Calculates flow according to the Richards equation.

\begin{eqnarray*} q_{Richards} &=& \frac{\Delta\Psi_{tot}}{d} K(\theta) A \\ \Psi_{tot} &= &\Psi_{M}(\theta) + h \end{eqnarray*}

where

• \( \Delta\Psi_{tot} [m]\) is the difference of the total water potentials of the two soil layers
• \( d [m]\) is the distance between the two soil layers
• \( K(\theta)\left[\frac m{day}\right]\) is the geometric mean conductivity (see SoilType::Kunsat)
• \( A [m^2]\) is the crosssectional area of the flux
• \( \Psi_M(\theta) [m]\) is the matrix potential (see SoilType::MatrixPotential)
• \( h [m]\) is the height of a soil layer above sea level

Public Member Functions
	Richards (cmf::upslope::SoilLayer::ptr left, cmf::water::flux_node::ptr right)
	Creates a Richards equation connection between two soil layers (left and right, rather top and bottom) of the same cell.
real	conc (cmf::math::Time t, const cmf::water::solute &_Solute)
	Returns the concentration of the flux.
flux_node::ptr	get_target (const flux_node &inquirer)
	Returns the other end of a connection than the asking end.
flux_node::ptr	get_target (int index) const
	With index 0, the left node is returned, with index 1 the right node of the connection.
real	get_tracer_filter ()
	A value ranging from 0 to 1 to filter tracers out of the water flux.
real	get_tracer_filter (solute S)
	A value ranging from 0 to 1 to filter tracers out of the water flux.
bool	kill_me ()
	Deregisters this connection from its nodes. Returns true if only one reference is left.
flux_node::ptr	left_node () const
	Returns the left node of this connection.
real	q (const flux_node &inquirer, cmf::math::Time t)
	Returns the current flux through a connection. Negative signs mean out of the inquirer, positive are inflows to the inquirer.
void	refresh (cmf::math::Time t)
	Performes a new calculation of the flux.
flux_node::ptr	right_node () const
	returns the right node of this connection
void	set_tracer_filter (real value)
	A value ranging from 0 to 1 to filter tracers out of the water flux.

Static Public Member Functions
static void	use_for_cell (cmf::upslope::Cell &cell, bool no_override=true)
	Connects all layers of the cell with the Richards equation.

Public Attributes
const std::string	type
	A string describing the type of the connection.

Member Function Documentation

conc()

real conc ( cmf::math::Time t, const cmf::water::solute & _Solute )

inherited

Returns the concentration of the flux.

If not overridden, it returns the concentration of the source of the flux (direction depending)

get_tracer_filter()

real get_tracer_filter ( )

inherited

A value ranging from 0 to 1 to filter tracers out of the water flux.

1.0 is no filter and 0.0 means no solute is crossing this connection

set_tracer_filter()

void set_tracer_filter ( real value )

inherited

A value ranging from 0 to 1 to filter tracers out of the water flux.

1.0 is no filter and 0.0 means no solute is crossing this connection

use_for_cell()

static void use_for_cell ( cmf::upslope::Cell & cell, bool no_override = true )

static

Connects all layers of the cell with the Richards equation.

Connects all layers of the cell with the Richards equation. If no_override=true (default), then only unconnected layers will be connected. Existing connections will be replaced by Richards otherwise