MeteoIODoc  MeteoIODoc-2.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
mio::SinGenerator Class Reference

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: the sinusoidal period (either "yearly" or "daily"), the minimum value, the maximum value and the offset specifying when the minimum value should be reached, within one period (expressed as fraction of such period). 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).

TA::generators = Sin
TA::Sin = yearly 268.26 285.56 0.0833

#include <SinGenerator.h>

Public Member Functions

 SinGenerator (const std::vector< std::string > &vecArgs, const std::string &i_algo)
 
bool generate (const size_t &param, MeteoData &md)
 
bool create (const size_t &param, std::vector< MeteoData > &vecMeteo)
 
- Public Member Functions inherited from mio::GeneratorAlgorithm
 GeneratorAlgorithm (const std::vector< std::string > &, const std::string &i_algo)
 
virtual ~GeneratorAlgorithm ()
 
std::string getAlgo () const
 

Additional Inherited Members

- Protected Attributes inherited from mio::GeneratorAlgorithm
const std::string algo
 
- 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
 

Constructor & Destructor Documentation

mio::SinGenerator::SinGenerator ( const std::vector< std::string > &  vecArgs,
const std::string &  i_algo 
)
inline

Member Function Documentation

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

Implements mio::GeneratorAlgorithm.

bool mio::SinGenerator::generate ( const size_t &  param,
MeteoData &  md 
)
virtual

Implements mio::GeneratorAlgorithm.

The documentation for this class was generated from the following files: