fub::amrex::cutcell::DebugOutput Class Reference

#include <DebugOutput.hpp>

Public Member Functions
	DebugOutput (const ProgramOptions &opts, const std::shared_ptr< DebugStorage > &storage)
	Read program options from opts and enable the storage. More...
void	operator() (const GriddingAlgorithm &grid) override
	Write out the debug storage on the grid. 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 GriddingAlgorithm &grid) override
	Returns true if this output class shall be invoked at the specified time point. More...
template<typename Log >
void	Print (Log &log)
virtual void	operator() (const GriddingAlgorithm &grid)=0
	Invoke the actual output logic. More...

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

Private Attributes
std::string	directory_
	This is the base directory where the snapshots will be output to. More...

Constructor & Destructor Documentation

DebugOutput()

fub::amrex::cutcell::DebugOutput::DebugOutput ( const ProgramOptions &  opts, const std::shared_ptr< DebugStorage > &  storage  )

explicit

Read program options from opts and enable the storage.

Member Function Documentation

NextOutputTime()

template<typename GriddingAlgorithm >

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

inlineoverridevirtualinherited

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

Implements fub::BasicOutput< GriddingAlgorithm >.

operator()() [1/2]

void fub::amrex::cutcell::DebugOutput::operator() ( const GriddingAlgorithm &  grid )

override

Write out the debug storage on the grid.

operator()() [2/2]

template<typename GriddingAlgorithm >

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

pure virtualinherited

Invoke the actual output logic.

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

Print()

template<typename GriddingAlgorithm >

template<typename Log >

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

inlineinherited

ShallOutputNow()

template<typename GriddingAlgorithm >

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

inlineoverridevirtualinherited

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

Implements fub::BasicOutput< GriddingAlgorithm >.

Member Data Documentation

directory_

std::string fub::amrex::cutcell::DebugOutput::directory_

private

This is the base directory where the snapshots will be output to.

frequencies_

template<typename GriddingAlgorithm >

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

protectedinherited

intervals_

template<typename GriddingAlgorithm >

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

protectedinherited

smallest_time_step_size_

template<typename GriddingAlgorithm >

Duration fub::OutputAtFrequencyOrInterval< GriddingAlgorithm >::smallest_time_step_size_

protectedinherited

---

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

• cutcell/output/DebugOutput.hpp