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

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

#include <alsfvm/io/TimeIntegratedWriter.hpp>

Inheritance diagram for alsfvm::io::TimeIntegratedWriter:
alsfvm::io::Writer

Public Member Functions

 TimeIntegratedWriter (alsfvm::shared_ptr< Writer > &writer, real time, real timeRadius)
 
virtual ~TimeIntegratedWriter ()
 
virtual void write (const volume::Volume &conservedVariables, const grid::Grid &grid, const simulator::TimestepInformation &timestepInformation) override
 write writes the data to disk More...
 
virtual void finalize (const grid::Grid &grid, const simulator::TimestepInformation &timestepInformation) override
 This method should be called at the end of the simulation. More...
 
- Public Member Functions inherited from alsfvm::io::Writer
virtual ~Writer ()
 
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 TimeIntegratedWriter class is a decorator for another writer. Its purpose is to only call the underlying Writer object at fixed times around a time.

This will save every timestep at time tau for which |tau-T|<delta, for user specified T and delta.

Constructor & Destructor Documentation

◆ TimeIntegratedWriter()

alsfvm::io::TimeIntegratedWriter::TimeIntegratedWriter ( alsfvm::shared_ptr< Writer > &  writer,
real  time,
real  timeRadius 
)
Parameters
writerthe underlying writer to actually use.
timethe center of the time to write to
timeRadiusthe radius of the time ball to dump

◆ ~TimeIntegratedWriter()

virtual alsfvm::io::TimeIntegratedWriter::~TimeIntegratedWriter ( )
inlinevirtual

Member Function Documentation

◆ finalize()

void alsfvm::io::TimeIntegratedWriter::finalize ( const grid::Grid grid,
const simulator::TimestepInformation timestepInformation 
)
overridevirtual

This method should be called at the end of the simulation.

Reimplemented from alsfvm::io::Writer.

◆ write()

void alsfvm::io::TimeIntegratedWriter::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: