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 Config &cfg)

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 ()

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

virtual void	process (Date &dateStart, Date &dateEnd)

std::string	getName () const

const ProcessingProperties &	getProperties () const

const std::string	toString () const

bool	skipStation (const std::string &station_id) const
	Should the provided station be skipped in the processing? More...

bool	noStationsRestrictions () const

const std::vector< DateRange >	getTimeRestrictions () const

bool	skipHeight (const double &height) const
	Should the provided height be skipped in the processing? More...

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)
	Read a data file structured as X Y value on each lines. More...

static void	readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y1, std::vector< double > &Y2)
	Read a data file structured as X Y1 Y2 value on each lines. More...

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)
	Read a correction file applicable to repeating time period. More...

static std::vector< offset_spec >	readCorrections (const std::string &filter, const std::string &filename, const double &TZ, const size_t &col_idx=2)
	Read a correction file, ie a file structured as timestamps followed by values on each lines. More...

static std::map< std::string, std::vector< DateRange > >	readDates (const std::string &filter, const std::string &filename, const double &TZ)
	Read a list of date ranges by stationIDs from a file. More...

Static Public Attributes inherited from mio::ProcessingBlock
static const double	default_height

Protected Member Functions inherited from mio::ProcessingBlock
	ProcessingBlock (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const Config &cfg)
	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

const std::vector< DateRange >	time_restrictions

std::set< double >	included_heights

std::set< double >	excluded_heights

bool	all_heights

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 Config &	cfg
	)

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: