2.0.0b10
catchment modelling framework
Loading...
Searching...
No Matches
DarcyKinematic Class Reference

A simple kinemtic wave model for subsurface flux. More...

+ Inheritance diagram for DarcyKinematic:
+ Collaboration diagram for DarcyKinematic:

Detailed Description

A simple kinemtic wave model for subsurface flux.

\[ q = \frac{\Delta z_{surface}}{d} K(\theta)_{source} A_{cross} \]

Public Member Functions

 DarcyKinematic (cmf::upslope::SoilLayer::ptr left, cmf::water::flux_node::ptr right, real FlowWidth, real Distance=0)
 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.
 

Constructor & Destructor Documentation

◆ DarcyKinematic()

DarcyKinematic ( cmf::upslope::SoilLayer::ptr left,
cmf::water::flux_node::ptr right,
real FlowWidth,
real Distance = 0 )

Creates the connection.

Parameters
leftLeft node of the connection (needs to be soil water storage)
rightRight node of the connection (can be any node)
FlowWidththe width of the connection - is multiplied by layer thickness to get the interface area
Distancethe length of the connection. If 0, the distance is calculated from the position of the nodes

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