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

A simple implementation of RainSource. More...

+ Inheritance diagram for ConstantRainSource:
+ Collaboration diagram for ConstantRainSource:

Detailed Description

A simple implementation of RainSource.

Returns intensity for any time step.

Public Types

typedef std::shared_ptr< ConstantRainSourceptr
 shared pointer
 

Public Member Functions

 ConstantRainSource (cmf::project &_project, cmf::geometry::point location, real _intensity)
 Creates a new ConstantRainSource.
 
virtual real conc (cmf::math::Time t, const cmf::water::solute &Solute) const
 Returns the concentration of a solute in the rainfall at time t.
 
cmf::water::flux_connectionconnection_to (const cmf::water::flux_node &target)
 Returns the connection between this and target.
 
real flux_to (const cmf::water::flux_node &target, cmf::math::Time t)
 Returns the actual flux between this and target (positive sign means "from this into target")
 
cmf::geometry::point get_3d_flux (cmf::math::Time t)
 Returns the sum of all flux vectors.
 
real get_intensity (cmf::math::Time t) const
 Returns the actual rainfall intensity in mm/day.
 
virtual real get_potential (cmf::math::Time=cmf::math::never) const
 Returns the water potential of the node in m waterhead.
 
cmf::projectget_project () const
 Returns the project, this node is part of.
 
virtual double is_empty () const
 Returns false.
 
virtual bool is_storage () const
 true, if this is a waterstorage
 
real operator() (cmf::math::Time t) const
 Functor declaration RainSource(t) = RainSource.get_intensity(t)
 
virtual bool RecalcFluxes (cmf::math::Time t)
 Pure flux_nodes do not influence fluxes, therefore no recalculation of fluxes is required by flux_node.
 
bool remove_connection (cmf::water::flux_node::ptr To)
 Remove the connection.
 
void set_conc (const cmf::water::solute &Solute, real value)
 Sets the concentration of a solute in the rainfall.
 
virtual void set_potential (real new_potential)
 Sets the potential of this flux node.
 
real waterbalance (cmf::math::Time t, const flux_connection *Without=0) const
 Returns the sum of all fluxes (positive and negative) at time t.
 

Public Attributes

real intensity
 The rain fall intensity in mm/day. This value is returned by.
 
std::string Name
 The Name of this node.
 
const int node_id
 The Id of the node.
 
cmf::geometry::point position
 The spatial position of the node.
 

Constructor & Destructor Documentation

◆ ConstantRainSource()

ConstantRainSource ( cmf::project & _project,
cmf::geometry::point location,
real _intensity )

Creates a new ConstantRainSource.

Consider using Cell::set_rainfall for internal creation of a constant rain source, instead of direct use

Parameters
_projectThe project the rain source is belonging to.
locationThe location of the rain source
_intensityThe constant rainfall intensity in mm/day

Member Function Documentation

◆ get_potential()

virtual real get_potential ( cmf::math::Time = cmf::math::never) const
virtualinherited

Returns the water potential of the node in m waterhead.

The base class water storage always returns the height of the location

Reimplemented in MacroPore, SoilLayer, DirichletBoundary, and WaterStorage.

◆ RecalcFluxes()

virtual bool RecalcFluxes ( cmf::math::Time t)
virtualinherited

Pure flux_nodes do not influence fluxes, therefore no recalculation of fluxes is required by flux_node.

WaterStorage overrides this, since state changes require an update of the fluxes

Reimplemented from flux_node.

◆ waterbalance()

real waterbalance ( cmf::math::Time t,
const flux_connection * Without = 0 ) const
inherited

Returns the sum of all fluxes (positive and negative) at time t.


Single fluxes can be excluded from the calculation

Parameters
tTime of the query
WithoutA flux_connection that is excluded from the waterbalance (e.g. to prevent closed circuits)