MeteoIODoc  MeteoIODoc-2.9.0
mio::TimeLoop Class Reference

Detailed Description

Loops over a specific time period.

This filter repeats a given time period over an over (for example, for simulation spin-up). It takes the following arguments (all dates are ISO formatted date where the time can be ommitted to mean "00:00:00"):

  • REF_START: start of the repeated period, mandatory argument;
  • REF_END: end of the repeated period, mandatory argument;
  • MATCH_DATE: date in the output data that matches the start date of the repeated period, mandatory argument;

The MATCH_DATE argument is used to define a "synchronization point": from this point on, the reference data will be copied over and over (please keep in mind that copying exactly a month of data will still lead to some drift over the years as not every month has the same number of days).

TIME::filter1 = TimeLoop
TIME::arg1::ref_start = 2018-01-01 ;this assumes 00:00:00
TIME::arg1::ref_end = 2018-02-01
TIME::arg1::match_date = 2019-03-01 ;this assumes that the data from ref_start will be copied as data for 2019-03-01

The example above copies over and over the timestamps from 2018-01-01T00:00:00 to 2018-02-01T00:00:00 while making sure that the timesteps of 2018-01-01T00:00:00 are copied to 2019-03-01T00:00:00. To do a ten years simulation spin up, then run your simulation for example as "my_model 2000-01-01 2010-01-01".

#include <TimeFilters.h>

Public Member Functions

 TimeLoop (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const double &TZ)
 
void process (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< MeteoData > &ovec)
 
void process (Date &dateStart, Date &dateEnd)
 
- Public Member Functions inherited from mio::ProcessingBlock
virtual ~ProcessingBlock ()
 
std::string getName () const
 
const ProcessingPropertiesgetProperties () const
 
const std::string toString () const
 
bool skipStation (const std::string &station_id) const
 
bool noStationsRestrictions () const
 

Additional Inherited Members

- Static Public Member Functions inherited from mio::ProcessingBlock
static void readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y)
 
static void readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y1, std::vector< double > &Y2)
 
static std::vector< double > readCorrections (const std::string &filter, const std::string &filename, const size_t &col_idx, const char &c_type, const double &init)
 
static std::vector< offset_specreadCorrections (const std::string &filter, const std::string &filename, const double &TZ, const size_t &col_idx=2)
 
static std::map< std::string, std::vector< dates_range > > readDates (const std::string &filter, const std::string &filename, const double &TZ)
 
static std::set< std::string > initStationSet (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &keyword)
 
- Protected Member Functions inherited from mio::ProcessingBlock
 ProcessingBlock (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name)
 protected constructor only to be called by children More...
 
- Static Protected Member Functions inherited from mio::ProcessingBlock
static void extract_dbl_vector (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< double > &ovec)
 
static void extract_dbl_vector (const unsigned int &param, const std::vector< const MeteoData *> &ivec, std::vector< double > &ovec)
 
- Protected Attributes inherited from mio::ProcessingBlock
const std::set< std::string > excluded_stations
 
const std::set< std::string > kept_stations
 
ProcessingProperties properties
 
const std::string block_name
 
- Static Protected Attributes inherited from mio::ProcessingBlock
static const double soil_albedo = .23
 
static const double snow_albedo = .85
 
static const double snow_thresh = .1
 parametrize the albedo from HS More...
 

Constructor & Destructor Documentation

◆ TimeLoop()

mio::TimeLoop::TimeLoop ( const std::vector< std::pair< std::string, std::string > > &  vecArgs,
const std::string &  name,
const double &  TZ 
)

Member Function Documentation

◆ process() [1/2]

void mio::TimeLoop::process ( const unsigned int &  param,
const std::vector< MeteoData > &  ivec,
std::vector< MeteoData > &  ovec 
)
virtual

Implements mio::ProcessingBlock.

◆ process() [2/2]

void mio::TimeLoop::process ( Date dateStart,
Date dateEnd 
)
virtual

Reimplemented from mio::ProcessingBlock.


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