2.0.0b10
catchment modelling framework
|
Linear storage based flux from macro pore to macro pore. More...
Inherits BaseMacroFlow.
Linear storage based flux from macro pore to macro pore.
\[ q = A_{cell} K_{macro} \left(\frac{V_{upper}}{C_{upper}}\right)^\beta \left(1-\frac{V_{lower}}{C_{lower}}\right) \]
where:
Public Member Functions | |
KinematicMacroFlow (cmf::water::WaterStorage::ptr left, cmf::water::flux_node::ptr right, real beta=1.) | |
Creates the connection. | |
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. | |
KinematicMacroFlow | ( | cmf::water::WaterStorage::ptr | left, |
cmf::water::flux_node::ptr | right, | ||
real | beta = 1. ) |
Creates the connection.
left,right | the nodes between the connection should be created. |
beta | a conceptional curve shape parameter for the relation between storage and outflow |
|
inherited |
Returns the concentration of the flux.
If not overridden, it returns the concentration of the source of the flux (direction depending)
|
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
|
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