fub::BasicOutput< GriddingAlgorithm > Struct Template Reference

This is a abstract base class for an output strategy. More...

#include <BasicOutput.hpp>

Public Member Functions
virtual	~BasicOutput ()=default
	The destructor needs to be virtual to prevent leaking resources. More...
virtual Duration	NextOutputTime (Duration time_point)=0
	Returns the time point at which the simulation shall stop to do some output. More...
virtual bool	ShallOutputNow (const GriddingAlgorithm &grid)=0
	Returns true if this output class shall be invoked at the specified time point. More...
virtual void	operator() (const GriddingAlgorithm &grid)=0
	Invoke the actual output logic. More...

Detailed Description

template<typename GriddingAlgorithm>
struct fub::BasicOutput< GriddingAlgorithm >

This is a abstract base class for an output strategy.

Objects of this class are intended to be passt to the fub::RunSimulation function.

Constructor & Destructor Documentation

~BasicOutput()

template<typename GriddingAlgorithm >

virtual fub::BasicOutput< GriddingAlgorithm >::~BasicOutput ( )

virtualdefault

The destructor needs to be virtual to prevent leaking resources.

Member Function Documentation

NextOutputTime()

template<typename GriddingAlgorithm >

virtual Duration fub::BasicOutput< GriddingAlgorithm >::NextOutputTime ( Duration  time_point )

pure virtual

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

Implemented in fub::OutputAtFrequencyOrInterval< GriddingAlgorithm >, fub::OutputAtFrequencyOrInterval< MultiBlockGriddingAlgorithm >, fub::OutputAtFrequencyOrInterval< amrex::MultiBlockGriddingAlgorithm >, fub::OutputAtFrequencyOrInterval< Grid >, fub::OutputAtFrequencyOrInterval< MultiBlockGriddingAlgorithm2 >, fub::OutputAtFrequencyOrInterval< amrex::MultiBlockGriddingAlgorithm2 >, and fub::MultipleOutputs< Grid >.

operator()()

template<typename GriddingAlgorithm >

virtual void fub::BasicOutput< GriddingAlgorithm >::operator() ( const GriddingAlgorithm &  grid )

pure virtual

Invoke the actual output logic.

Implemented in fub::MultipleOutputs< Grid >, fub::CounterOutput< Grid, PrintDuration >, fub::AnyOutput< Grid >, and fub::AsOutput< Grid, Fn >.

ShallOutputNow()

template<typename GriddingAlgorithm >

virtual bool fub::BasicOutput< GriddingAlgorithm >::ShallOutputNow ( const GriddingAlgorithm &  grid )

pure virtual

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

Implemented in fub::OutputAtFrequencyOrInterval< GriddingAlgorithm >, fub::OutputAtFrequencyOrInterval< Grid >, and fub::MultipleOutputs< Grid >.

---

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

• BasicOutput.hpp