Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Member Functions | List of all members
alsuq::stats::Statistics Class Referenceabstract

#include <alsuq/stats/Statistics.hpp>

Inheritance diagram for alsuq::stats::Statistics:
alsfvm::io::Writer alsuq::stats::FixedIntervalStatistics alsuq::stats::StatisticsHelper alsuq::stats::StatisticsTimer alsuq::stats::TimeIntegratedWriter alsuq::stats::BoundedVariation alsuq::stats::BoundedVariationDirection alsuq::stats::FunctionalStatistics alsuq::stats::MeanVariance alsuq::stats::OnePointMoment alsuq::stats::StructureBasic alsuq::stats::StructureBasicCUDA alsuq::stats::StructureCube alsuq::stats::StructureCubeCUDA alsuq::stats::StructureSurface alsuq::stats::StructureTwoPoints alsuq::stats::TimeIntegratedFunctionalStatistics

Public Member Functions

virtual ~Statistics ()
 
virtual void write (const alsfvm::volume::Volume &conservedVariables, const alsfvm::grid::Grid &grid, const alsfvm::simulator::TimestepInformation &timestepInformation) override
 
virtual void combineStatistics ()=0
 To be called when the statistics should be combined. More...
 
virtual void addWriter (const std::string &name, std::shared_ptr< alsfvm::io::Writer > &writer)=0
 
virtual std::vector< std::string > getStatisticsNames () const =0
 
virtual void computeStatistics (const alsfvm::volume::Volume &conservedVariables, const alsfvm::grid::Grid &grid, const alsfvm::simulator::TimestepInformation &timestepInformation)=0
 
virtual void finalizeStatistics ()=0
 
virtual void writeStatistics (const alsfvm::grid::Grid &grid)=0
 
- 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

Abstract base class for computing statistics (mean, variance, structure functions, etc)

Constructor & Destructor Documentation

◆ ~Statistics()

virtual alsuq::stats::Statistics::~Statistics ( )
inlinevirtual

Member Function Documentation

◆ addWriter()

virtual void alsuq::stats::Statistics::addWriter ( const std::string &  name,
std::shared_ptr< alsfvm::io::Writer > &  writer 
)
pure virtual

Adds a write for the given statistics name

Parameters
namethe name of the statitics (one of the names returned in getStatiticsNames()
writerthe writer to use

Implemented in alsuq::stats::FixedIntervalStatistics, alsuq::stats::TimeIntegratedWriter, alsuq::stats::StatisticsTimer, and alsuq::stats::StatisticsHelper.

◆ combineStatistics()

virtual void alsuq::stats::Statistics::combineStatistics ( )
pure virtual

◆ computeStatistics()

virtual void alsuq::stats::Statistics::computeStatistics ( const alsfvm::volume::Volume conservedVariables,
const alsfvm::grid::Grid grid,
const alsfvm::simulator::TimestepInformation timestepInformation 
)
pure virtual

◆ finalizeStatistics()

virtual void alsuq::stats::Statistics::finalizeStatistics ( )
pure virtual

◆ getStatisticsNames()

virtual std::vector<std::string> alsuq::stats::Statistics::getStatisticsNames ( ) const
pure virtual

◆ write()

void alsuq::stats::Statistics::write ( const alsfvm::volume::Volume conservedVariables,
const alsfvm::grid::Grid grid,
const alsfvm::simulator::TimestepInformation timestepInformation 
)
overridevirtual

Passes the information onto computeStats

Implements alsfvm::io::Writer.

◆ writeStatistics()

virtual void alsuq::stats::Statistics::writeStatistics ( const alsfvm::grid::Grid grid)
pure virtual

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