Utopia 2
Framework for studying models of complex & adaptive systems.
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Utopia::Models::Geomorphology::GeomorphologyCell Struct Reference

The full cell struct for the Geomorphology model. More...

#include <Geomorphology.hh>

Public Member Functions

double waterline () const
 The height of the waterline.
 
template<class RNG >
 GeomorphologyCell (const DataIO::Config &cfg, const std::shared_ptr< RNG > &rng)
 Construct a cell from a configuration node and an RNG.
 

Public Attributes

double rock
 The cells topgraphic height.
 
double watercolumn
 The cells watercontent.
 
double drainage_area
 The drainage area.
 
bool was_drained
 Was called for drainage area calculation.
 
bool is_outflow
 Whether the cell is an outflow boundary cell.
 

Detailed Description

The full cell struct for the Geomorphology model.

Constructor & Destructor Documentation

◆ GeomorphologyCell()

template<class RNG >
Utopia::Models::Geomorphology::GeomorphologyCell::GeomorphologyCell ( const DataIO::Config cfg,
const std::shared_ptr< RNG > &  rng 
)
inline

Construct a cell from a configuration node and an RNG.

Initializes cell with normal_distributed(mean, var) rock height. The distribution is cut for values below 0, giving a minimal height of 0.

44 :
45 rock(0.), watercolumn(0.), drainage_area(1.), was_drained(false),
46 is_outflow(false)
47 {
48 std::normal_distribution<> init_height{
49 get_as<double>("initial_height_mean", cfg),
50 get_as<double>("initial_height_var", cfg)
51 };
52 rock = init_height(*rng);
53 }
Container select_entities(const Manager &mngr, const DataIO::Config &sel_cfg)
Select entities according to parameters specified in a configuration.
Definition select.hh:213
bool was_drained
Was called for drainage area calculation.
Definition Geomorphology.hh:31
double rock
The cells topgraphic height.
Definition Geomorphology.hh:19
double watercolumn
The cells watercontent.
Definition Geomorphology.hh:22
bool is_outflow
Whether the cell is an outflow boundary cell.
Definition Geomorphology.hh:34
double drainage_area
The drainage area.
Definition Geomorphology.hh:28

Member Function Documentation

◆ waterline()

double Utopia::Models::Geomorphology::GeomorphologyCell::waterline ( ) const
inline

The height of the waterline.

25{ return rock + watercolumn; };

Member Data Documentation

◆ drainage_area

double Utopia::Models::Geomorphology::GeomorphologyCell::drainage_area

The drainage area.

◆ is_outflow

bool Utopia::Models::Geomorphology::GeomorphologyCell::is_outflow

Whether the cell is an outflow boundary cell.

◆ rock

double Utopia::Models::Geomorphology::GeomorphologyCell::rock

The cells topgraphic height.

◆ was_drained

bool Utopia::Models::Geomorphology::GeomorphologyCell::was_drained

Was called for drainage area calculation.

◆ watercolumn

double Utopia::Models::Geomorphology::GeomorphologyCell::watercolumn

The cells watercontent.


The documentation for this struct was generated from the following file: