fub::AsOutput< Grid, Fn > Class Template Reference

#include <AsOutput.hpp>

Public Member Functions
	AsOutput (std::vector< std::ptrdiff_t > frequencies, std::vector< Duration > intervals, Fn fn)
	AsOutput (const std::map< std::string, pybind11::object > &vm, Fn fn)
void	operator() (const Grid &grid) override
	Invoke the actual output logic. More...
Duration	NextOutputTime (Duration time_point) override
	Returns the time point at which the simulation shall stop to do some output. More...
bool	ShallOutputNow (const Grid &grid) override
	Returns true if this output class shall be invoked at the specified time point. More...
void	Print (Log &log)

Protected Attributes
std::vector< std::ptrdiff_t >	frequencies_
std::vector< fub::Duration >	intervals_
Duration	smallest_time_step_size_

Private Attributes
Fn	fn_

Constructor & Destructor Documentation

AsOutput() [1/2]

template<typename Grid , typename Fn >

fub::AsOutput< Grid, Fn >::AsOutput ( std::vector< std::ptrdiff_t >  frequencies, std::vector< Duration >  intervals, Fn  fn  )

inline

AsOutput() [2/2]

template<typename Grid , typename Fn >

fub::AsOutput< Grid, Fn >::AsOutput ( const std::map< std::string, pybind11::object > &  vm, Fn  fn  )

inline

Member Function Documentation

NextOutputTime()

Duration fub::OutputAtFrequencyOrInterval< Grid >::NextOutputTime ( Duration  time_point )

inlineoverridevirtualinherited

Returns the time point at which the simulation shall stop to do some output.

Implements fub::BasicOutput< Grid >.

operator()()

template<typename Grid , typename Fn >

void fub::AsOutput< Grid, Fn >::operator() ( const Grid &  grid )

inlineoverridevirtual

Invoke the actual output logic.

Implements fub::BasicOutput< Grid >.

Print()

void fub::OutputAtFrequencyOrInterval< Grid >::Print ( Log &  log )

inlineinherited

ShallOutputNow()

bool fub::OutputAtFrequencyOrInterval< Grid >::ShallOutputNow ( const Grid &  grid )

inlineoverridevirtualinherited

Returns true if this output class shall be invoked at the specified time point.

Implements fub::BasicOutput< Grid >.

Member Data Documentation

fn_

template<typename Grid , typename Fn >

Fn fub::AsOutput< Grid, Fn >::fn_

private

frequencies_

std::vector<std::ptrdiff_t> fub::OutputAtFrequencyOrInterval< Grid >::frequencies_

protectedinherited

intervals_

std::vector<fub::Duration> fub::OutputAtFrequencyOrInterval< Grid >::intervals_

protectedinherited

smallest_time_step_size_

Duration fub::OutputAtFrequencyOrInterval< Grid >::smallest_time_step_size_

protectedinherited

---

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

• AsOutput.hpp