Detailed Description

Calculates flux out of a storage as a linear function of its volume.

This connection serves the same purpose as the old kinematic_wave connection, but the parameters are easier to explain

\[ q = \frac{V - V_{residual}}{t_r} \]

where:

\(V\) The actual volume of water stored in source
\(V_{residual} [m^3]\) The volume of water not flowing out (default = 0) \(t_r\) is the residence time in the source.

Public Member Functions
	LinearStorageConnection (WaterStorage::ptr source, flux_node::ptr target, real residencetime, real residual=0.0)
	Creates a linear storage connection or Nash-box.

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.

Public Attributes
real	residencetime
	Linear flow parameter traveltime in days.

real	residual
	residual volume of source

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

Constructor & Destructor Documentation

Creates a linear storage connection or Nash-box.

\[ q = \frac{V - V_{residual}}{t_r}} \]

Parameters

source	Water storage from which the water flows out. Flux is a function of source.volume
target	Target node (boundary condition or storage). Does not influence the strength of the flow
residencetime	\(t_r [days]\) The residence time of the water in this storage
residual	\(V_{residual} [m^3]\) The volume of water not flowing out (default = 0)

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)

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

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