NANDRAD::OutputGrid Class Reference

Detailed Description

An OutputGrid defines time intervals with a given output step size per interval.

Definition at line 33 of file NANDRAD_OutputGrid.h.

#include <NANDRAD_OutputGrid.h>

Public Member Functions
NANDRAD_READWRITE NANDRAD_COMPARE_WITH_NAME void	checkIntervalDefinition () const
	Checks input parameters and throws an IBK::Exception if some input values are wrong. More...
IBK::Parameter	intervalParameter (unsigned int intervalIndex, Interval::para_t p) const
	Returns a parameter of the intervals handled in this OutputGrid, if needed, parameters are created/computed on the fly.
IBK::Parameter	lastIntervalParameter (Interval::para_t p) const
	Returns a parameter of the last interval handled in this OutputGrid, if needed, parameters are created/computed on the fly. More...
void	setupIntervals ()
	Computes START parameters in all intervals. More...
bool	isActive (double t) const
	Returns true, if the time point t matches an output grid point defined by this grid. More...
double	computeNextOutputTime (double tOutCurrent) const
	Computes and returns next output time point past tOutCurrent that is scheduled with this output grid.

Public Attributes
std::string	m_name
	Descriptive name for this output grid. More...
std::vector< Interval >	m_intervals
	The start/duration/end of each interval in [s]. More...

Member Function Documentation

checkIntervalDefinition()

NANDRAD_READWRITE NANDRAD_COMPARE_WITH_NAME void NANDRAD::OutputGrid::checkIntervalDefinition

(

)

const

Checks input parameters and throws an IBK::Exception if some input values are wrong.

Note

This function should be called after readXML() during solver initialization, and before setupIntervals() is called.

lastIntervalParameter()

IBK::Parameter NANDRAD::OutputGrid::lastIntervalParameter

(

Interval::para_t

p

)

const

Returns a parameter of the last interval handled in this OutputGrid, if needed, parameters are created/computed on the fly.

Calls

See also

intervalParameter().

setupIntervals()

void NANDRAD::OutputGrid::setupIntervals

(

)

Computes START parameters in all intervals.

Call this function after interval parameters have been checked with checkIntervalDefinition().

isActive()

bool NANDRAD::OutputGrid::isActive

(

double

t

)

const

Returns true, if the time point t matches an output grid point defined by this grid.

Parameters

t	Time point as absolute time offset to Midnight, January 1st of the start year.

Warning

This function expects that checkParameters() was previously called.

Member Data Documentation

m_name

std::string NANDRAD::OutputGrid::m_name

Descriptive name for this output grid.

Definition at line 78 of file NANDRAD_OutputGrid.h.

m_intervals

std::vector<Interval> NANDRAD::OutputGrid::m_intervals

The start/duration/end of each interval in [s].

The time points are defined the same as the simulation time itself.

Definition at line 83 of file NANDRAD_OutputGrid.h.

---

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

• NANDRAD_OutputGrid.h