Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
alsfvm::io::Writer Class Referenceabstract

The Writer class is an abstract interface to represent output writers. More...

#include <alsfvm/io/Writer.hpp>

Inheritance diagram for alsfvm::io::Writer:
alsfvm::functional::IntervalFunctionalWriter alsfvm::functional::TimeIntegrationFunctional alsfvm::io::CoarseGrainingIntervalWriter alsfvm::io::DLLWriter alsfvm::io::FixedIntervalWriter alsfvm::io::HDF5Writer alsfvm::io::NetCDFWriter alsfvm::io::PythonScript alsfvm::io::QueueWriter alsfvm::io::TimeIntegratedWriter alsuq::stats::Statistics

Public Member Functions

virtual ~Writer ()
 
virtual void write (const volume::Volume &conservedVariables, const grid::Grid &grid, const simulator::TimestepInformation &timestepInformation)=0
 write writes the data to disk More...
 
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)
 

Static Public Member Functions

static std::string getClassName ()
 

Protected Attributes

std::map< std::string, boost::property_tree::ptree > attributesMap
 

Detailed Description

The Writer class is an abstract interface to represent output writers.

Constructor & Destructor Documentation

◆ ~Writer()

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

Member Function Documentation

◆ addAttributes()

void alsfvm::io::Writer::addAttributes ( const std::string &  nameOfAttributes,
const boost::property_tree::ptree &  attributes 
)

Adds attributes to be written to the file (this is an optional feature, not every writer supports this. Attributes should be description of the simulation environment to help reproduce the output file (eg. numerical parameters, initial data, etc).

◆ finalize()

virtual void alsfvm::io::Writer::finalize ( const grid::Grid grid,
const simulator::TimestepInformation timestepInformation 
)
inlinevirtual

◆ getClassName()

static std::string alsfvm::io::Writer::getClassName ( )
inlinestatic

◆ write()

virtual void alsfvm::io::Writer::write ( const volume::Volume conservedVariables,
const grid::Grid grid,
const simulator::TimestepInformation timestepInformation 
)
pure virtual

Member Data Documentation

◆ attributesMap

std::map<std::string, boost::property_tree::ptree> alsfvm::io::Writer::attributesMap
protected

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