MR::WatershedGraph::BasinInfo Struct Reference

associated with each vertex in graph More...

#include <MRWatershedGraph.h>

Public Member Functions
	BasinInfo ()
float	amountTillOverflow () const
float	approxLevel () const
	approximate current level of water (z-coordinate) in the basin
void	updateAccVolume (float amount)
	updates accumulated volume in the basin to the moment of given precipitation amount

Public Attributes
VertId	lowestVert
	in the whole basin
float	lowestLevel = FLT_MAX
	lowest level (z-coordinate of lowestVert) in the basin
float	area = 0
	precipitation area that flows in this basin (and if it is full, continue flowing next)
float	lowestBdLevel = FLT_MAX
	lowest position on the boundary of the basin
float	maxVolume = 0
	full water volume to be accumulated in the basin till water reaches the lowest height on the boundary
float	accVolume = 0
	accumulated water volume in the basin so far
float	lastUpdateAmount = 0
	the amount when accVolume was last updated
float	lastMergeLevel = FLT_MAX
	water level in the basin when it was formed (by merge or creation)
float	lastMergeVolume = 0
	water volume in the basin when it was formed (by merge or creation)
Graph::EdgeId	overflowVia
	when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary

Detailed Description

associated with each vertex in graph

Constructor & Destructor Documentation

BasinInfo()

MR::WatershedGraph::BasinInfo::BasinInfo ( )

inline

Member Function Documentation

amountTillOverflow()

float MR::WatershedGraph::BasinInfo::amountTillOverflow ( ) const

inline

amount of precipitation (in same units as mesh coordinates and water level), which can be added before overflowing the basin

approxLevel()

float MR::WatershedGraph::BasinInfo::approxLevel ( ) const

inline

approximate current level of water (z-coordinate) in the basin

updateAccVolume()

void MR::WatershedGraph::BasinInfo::updateAccVolume ( float amount )

inline

updates accumulated volume in the basin to the moment of given precipitation amount

Member Data Documentation

accVolume

float MR::WatershedGraph::BasinInfo::accVolume = 0

accumulated water volume in the basin so far

area

float MR::WatershedGraph::BasinInfo::area = 0

precipitation area that flows in this basin (and if it is full, continue flowing next)

lastMergeLevel

float MR::WatershedGraph::BasinInfo::lastMergeLevel = FLT_MAX

water level in the basin when it was formed (by merge or creation)

lastMergeVolume

float MR::WatershedGraph::BasinInfo::lastMergeVolume = 0

water volume in the basin when it was formed (by merge or creation)

lastUpdateAmount

float MR::WatershedGraph::BasinInfo::lastUpdateAmount = 0

the amount when accVolume was last updated

lowestBdLevel

float MR::WatershedGraph::BasinInfo::lowestBdLevel = FLT_MAX

lowest position on the boundary of the basin

lowestLevel

float MR::WatershedGraph::BasinInfo::lowestLevel = FLT_MAX

lowest level (z-coordinate of lowestVert) in the basin

lowestVert

VertId MR::WatershedGraph::BasinInfo::lowestVert

in the whole basin

maxVolume

float MR::WatershedGraph::BasinInfo::maxVolume = 0

full water volume to be accumulated in the basin till water reaches the lowest height on the boundary

overflowVia

Graph::EdgeId MR::WatershedGraph::BasinInfo::overflowVia

when level=lowestBdLevel, volume=0, all water from this basin overflows via this boundary

---

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

• MRWatershedGraph.h