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

A connection to route water from a SurfaceWater storage to another node following the gradient of the water level. More...

+ Inheritance diagram for DiffusiveSurfaceRunoff:
+ Collaboration diagram for DiffusiveSurfaceRunoff:

Detailed Description

A connection to route water from a SurfaceWater storage to another node following the gradient of the water level.

\[q_{runoff} = A_{cross} d_{eff}^{2/3} \frac{\sqrt{S}}{n}\]

where:

  • \(q_{runoff}\) is the surface runoff
  • \(A_{cross}\) is the wetted crossectional flux area, given as \(d_{eff} \cdot w\)
  • \(w\) is the width of the shared boundary between the surface water storage and the target node
  • \(d_{eff}\) is the effective flow depth of the surface water.The effective flow depth is defined as either the mean of the effective depth of the left and the right node (when use_depthmax=false) or the maximum of the efficitve depth. The effective depth for a surfacewater is always defined as:

    \[d_{eff} = \begin{cases} V/A-d_{puddle}\ & V/A>d_{puddle} \\ 0.0 & V/A<=d_{puddle} \end{cases}\]

    The right node might be not a surfacewater. If the right node is an OpenWaterStorage, then the effective depth is the depth of the OWS above the cell height of the left surfacewater, given by:

    \[d_{eff,ows} = \Psi_{ows} - z_{cell}\]

    In case of another node, the right node depth equals the effective depth of the left node.
  • \(V\) the volume of stored water in the surface in \(m^3\)
  • \(A\) the area of the cell in \(m^2\)
  • \(d_{puddle}=V_{puddle}/A\) the average depth of water in the surface water needed to start run off
  • \(S = \|\frac{\Delta h\|}{d}\) the slope between surfacewater center potential and the target node potential
  • \(n\) the manning roughness

The DiffusiveSurfaceRunoff can be used as a cell connecting flux as in:

cmf.connect_cells_with_flux(p, cmf.DiffusiveSurfaceRunoff)
connect_cells_with_flux(cells, connection, start_at_layer=0)
Definition __init__.py:30

This results in a connection of the surfacewater storage of each cell with the surface water storages of its neighbors see

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