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

RainfallStation describes a rainfall timeseries in mm/day at a certain place. More...

+ Collaboration diagram for RainfallStation:

Detailed Description

RainfallStation describes a rainfall timeseries in mm/day at a certain place.

Use RainfallStationReference or IDWRainfall to distribute the data into space

Public Member Functions

 RainfallStation (const RainfallStation &copy)
 copy c'tor
 
std::string tostring () const
 Returns the name and the mean yearly rainfall.
 
void use_for_cell (cmf::upslope::Cell &c)
 Connects a cell with this rainfall station.
 

Static Public Member Functions

static ptr create (size_t Id, std::string Name, cmf::math::timeseries Data, cmf::geometry::point position)
 Creates a new RainfallStation.
 

Public Attributes

cmf::water::SoluteTimeseries concentration
 Contains the solute cocentration data.
 
cmf::math::timeseries data
 The timeseries data.
 
const size_t id
 A numerical identifier.
 
cmf::geometry::point Location
 Location of the station.
 
const std::string name
 The name of the station.
 

Member Function Documentation

◆ create()

static ptr create ( size_t Id,
std::string Name,
cmf::math::timeseries Data,
cmf::geometry::point position )
static

Creates a new RainfallStation.

Is called by RainfallStationList::add. Using RainfallStationList::add is in most cases the better choice, eg. from Python

project.rainfall_stations.add("Name", cmf.timeseries.from_file('rainfall.bin'), (65124,78009,187))
RainfallStation::ptr add(std::string Name, cmf::math::timeseries Data, cmf::geometry::point Position)
Creates a new RainfallStation and adds it to the list.
Definition precipitation.h:172
The study area, holding all cells, outlets and streams.
Definition project.h:53
cmf::atmosphere::RainfallStationList rainfall_stations
The rainfall stations of the project.
Definition project.h:75
The main namespace of the model framework. Contains the other namespaces and the project class.
Definition __init__.py:1
Returns
A new rainfall station
Parameters
IdAn identifying number
NameName of the station
DataRainfall timeseries
positionSpatial position of the new station