Detailed Description

Sinusoid generator.

Generate a sinusoidal variation for this parameter, as provided in argument (please remember that it must be in SI units). The arguments that must be provided are the following:

TYPE: the sinusoidal period, either
- yearly
- daily
MIN: the minimum value (SI units, mandatory);
MAX: the maximum value (SI units, mandatory);
PHASE: the time offset specifying when the minimum value should be reached, within one period (expressed as fraction of such period, defaults to zero);

The example below generates a yearly sinusoidal variation for the air temperature, the minimum being 268.26 K and occuring at 1/12 of the period (which practically means, at the end of the first month).

[Generators]
TA::generator1  = Sin
TA::arg1::type  = yearly
TA::arg1::min   = 268.26
TA::arg1::max   = 285.56
TA::arg1::phase = 0.0833

#include <SinGenerator.h>

Public Member Functions
	SinGenerator (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &i_algo, const std::string &i_section, const double &TZ)

bool	generate (const size_t &param, MeteoData &md, const std::vector< MeteoData > &vecMeteo)

bool	create (const size_t &param, const size_t &ii_min, const size_t &ii_max, std::vector< MeteoData > &vecMeteo)
	Fill one time series of MeteoData for one station. More...

Public Member Functions inherited from mio::GeneratorAlgorithm
virtual	~GeneratorAlgorithm ()

virtual bool	generate (const size_t &param, MeteoData &md, const std::vector< MeteoData > &vecMeteo)=0

virtual bool	create (const size_t &param, const size_t &ii_min, const size_t &ii_max, std::vector< MeteoData > &vecMeteo)=0
	Fill one time series of MeteoData for one station. More...

bool	skipStation (const std::string &station_id) const
	Should this station be skipped, based on user-provided station ID restrictions? More...

bool	skipTimeStep (const Date &dt) const
	Should this timestep be skipped, based on user-provided time restrictions? More...

bool	skipHeight (const double &height) const

std::vector< DateRange >	getTimeRestrictions () const

std::string	getAlgo () const

Additional Inherited Members
Protected Member Functions inherited from mio::GeneratorAlgorithm
	GeneratorAlgorithm (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &i_algo, const std::string &i_section, const double &TZ)
	protected constructor only to be called by children More...

virtual void	parse_args (const std::vector< std::pair< std::string, std::string > > &)

void	initHeightRestrictions (const std::vector< std::pair< std::string, std::string > > vecArgs)

Static Protected Member Functions inherited from mio::GeneratorAlgorithm
static std::set< std::string >	initStationSet (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &keyword)

Protected Attributes inherited from mio::GeneratorAlgorithm
const std::vector< DateRange >	time_restrictions

const std::set< std::string >	excluded_stations

const std::set< std::string >	kept_stations

std::set< double >	included_heights

std::set< double >	excluded_heights

bool	all_heights

const std::string	algo

const std::string	section

Static Protected Attributes inherited from mio::GeneratorAlgorithm
static const double	soil_albedo = .23

static const double	snow_albedo = .85

static const double	snow_thresh = .1

static const double	default_height = IOUtils::nodata

Constructor & Destructor Documentation

◆ SinGenerator()

mio::SinGenerator::SinGenerator	(	const std::vector< std::pair< std::string, std::string > > &	vecArgs,
		const std::string &	i_algo,
		const std::string &	i_section,
		const double &	TZ
	)

inline

Member Function Documentation

◆ create()

bool mio::SinGenerator::create	(	const size_t &	param,
		const size_t &	ii_min,
		const size_t &	ii_max,
		std::vector< MeteoData > &	vecMeteo
	)

virtual

Fill one time series of MeteoData for one station.

This is used by the dataCreators to create a new parameter in one go for the whole timeseries.

Parameters

[in]	param	meteo parameter to generate
[in]	ii_min	minimum index to apply it to in vecMeteo
[in]	ii_max	maximum index to apply it to in vecMeteo
[in]	vecMeteo	meteo timeseries to process

Returns: true if all missing data points for the given parameter could be generated, false otherwise

Implements mio::GeneratorAlgorithm.

◆ generate()

bool mio::SinGenerator::generate	(	const size_t &	param,
		MeteoData &	md,
		const std::vector< MeteoData > &	vecMeteo
	)