Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | List of all members
alsfvm::functional::IntervalFunctionalWriter Class Reference

The IntervalFunctionalWriter class is a decorator for another writer. Its purpose is to only call the underlying Writer object at fixed time intervals. More...

#include <alsfvm/functional/IntervalFunctionalWriter.hpp>

Inheritance diagram for alsfvm::functional::IntervalFunctionalWriter:
alsfvm::io::Writer

Public Member Functions

 IntervalFunctionalWriter (volume::VolumeFactory volumeFactory, io::WriterPointer writer, FunctionalPointer functional)
 
virtual void write (const volume::Volume &conservedVariables, const grid::Grid &grid, const simulator::TimestepInformation &timestepInformation) override
 write writes the data to disk More...
 
- Public Member Functions inherited from alsfvm::io::Writer
virtual ~Writer ()
 
virtual void finalize (const grid::Grid &grid, const simulator::TimestepInformation &timestepInformation)
 This method should be called at the end of the simulation. More...
 
void addAttributes (const std::string &nameOfAttributes, const boost::property_tree::ptree &attributes)
 

Additional Inherited Members

- Static Public Member Functions inherited from alsfvm::io::Writer
static std::string getClassName ()
 
- Protected Attributes inherited from alsfvm::io::Writer
std::map< std::string, boost::property_tree::ptree > attributesMap
 

Detailed Description

The IntervalFunctionalWriter class is a decorator for another writer. Its purpose is to only call the underlying Writer object at fixed time intervals.

This class is useful if you only want to save every x seconds of simulation. This class assume you already decorates it with the alsfvm::io::FixedIntervalWriter

Constructor & Destructor Documentation

◆ IntervalFunctionalWriter()

alsfvm::functional::IntervalFunctionalWriter::IntervalFunctionalWriter ( volume::VolumeFactory  volumeFactory,
io::WriterPointer  writer,
FunctionalPointer  functional 
)

Member Function Documentation

◆ write()

void alsfvm::functional::IntervalFunctionalWriter::write ( const volume::Volume conservedVariables,
const grid::Grid grid,
const simulator::TimestepInformation timestepInformation 
)
overridevirtual

write writes the data to disk

Parameters
conservedVariablesthe conservedVariables to write
gridthe grid that is used (describes the whole domain)
timestepInformation

Implements alsfvm::io::Writer.


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