2.0.0b10
catchment modelling framework
|
The connections in cmf hold the processes for the calculation of fluxes between water storages and model boundaries. More...
The connections in cmf hold the processes for the calculation of fluxes between water storages and model boundaries.
Represents a connection between flux_nodes, where water fluxes occur.
Public Member Functions | |
flux_connection (flux_node::ptr left, flux_node::ptr right, std::string _type) | |
Creates a flux connection between the flux_node left and right. | |
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 | |
const std::string | type |
A string describing the type of the connection. | |
flux_connection | ( | flux_node::ptr | left, |
flux_node::ptr | right, | ||
std::string | _type ) |
real conc | ( | cmf::math::Time | t, |
const cmf::water::solute & | _Solute ) |
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 | ( | ) |
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 | ) |
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