<<<<<<<< HEAD:docs/classcmf_1_1water_1_1waterbalance__connection.html
1.6.0
========
2.0.0b10
>>>>>>>> cmf2:docs/classcmf_1_1water_1_1_waterbalance_flux.html
catchment modelling framework
Loading...
Searching...
No Matches
WaterbalanceFlux Class Reference

Routes the sum of all other fluxes to a target. More...

+ Inheritance diagram for WaterbalanceFlux:
+ Collaboration diagram for WaterbalanceFlux:

Detailed Description

Routes the sum of all other fluxes to a target.

\[ q_{1,0} = \sum_{i=2}^N{q_{1,i}(V_1,V_i,t)}\]

where:

  • \(q_{i,j}\) is the flux between the two node i and j. Subscript 0 is the right node, subscript 1 is the left node and 2..N are the nodes connected to the left node, except for the right node

Public Member Functions

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.
 

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