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

Lateral darcy flow between aquifer objects. More...

+ Inheritance diagram for aquifer_Darcy:
+ Collaboration diagram for aquifer_Darcy:

Detailed Description

Lateral darcy flow between aquifer objects.

\[v_{Darcy}=K_{1,2}\nabla\Psi \]

\[q = v_{Darcy} w \Delta z\]

Public Member Functions

 aquifer_Darcy (aquifer::ptr left, cmf::water::flux_node::ptr right, real width)
 Creates a new Darcy flow connection between two aquifers, or an aquifer and another node acting as Dirichlet boundary condition.
 
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

real flux_width
 w, the width of the connection between the aquifers
 
const std::string type
 A string describing the type of the connection.
 

Protected Member Functions

virtual real calc_q (cmf::math::Time t)
 Lateral darcy flow between aquifer objects.
 

Constructor & Destructor Documentation

◆ aquifer_Darcy()

aquifer_Darcy ( aquifer::ptr left,
cmf::water::flux_node::ptr right,
real width )

Creates a new Darcy flow connection between two aquifers, or an aquifer and another node acting as Dirichlet boundary condition.

Parameters
leftOne aquifer
rightAnother aquifer, or a flux node that can be interpreted as an Dirichlet boundary
widthWidth of the connection

Member Function Documentation

◆ calc_q()

virtual real calc_q ( cmf::math::Time t)
protectedvirtual

Lateral darcy flow between aquifer objects.

\[v_{Darcy}=K_{1,2}\nabla\Psi \]

\[q = v_{Darcy} w \Delta z\]

Implements flux_connection.

◆ 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