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

#include <alsuq/stats/BoundedVariation.hpp>

Inheritance diagram for alsuq::stats::BoundedVariation:
alsuq::stats::StatisticsHelper alsuq::stats::Statistics alsfvm::io::Writer

Public Member Functions

 BoundedVariation (const StatisticsParameters &parameters)
 
virtual std::vector< std::string > getStatisticsNames () const override
 Returns a list of ['bv']. More...
 
virtual void computeStatistics (const alsfvm::volume::Volume &conservedVariables, const alsfvm::grid::Grid &grid, const alsfvm::simulator::TimestepInformation &timestepInformation) override
 
virtual void finalizeStatistics () override
 
- Public Member Functions inherited from alsuq::stats::StatisticsHelper
 StatisticsHelper (const StatisticsParameters &parameters)
 
void addWriter (const std::string &name, std::shared_ptr< alsfvm::io::Writer > &writer) override
 
virtual void combineStatistics () override
 Should be called at the end of the simulation. More...
 
virtual void writeStatistics (const alsfvm::grid::Grid &grid) override
 Writes the statistics to file. More...
 
- Public Member Functions inherited from alsuq::stats::Statistics
virtual ~Statistics ()
 
virtual void write (const alsfvm::volume::Volume &conservedVariables, const alsfvm::grid::Grid &grid, const alsfvm::simulator::TimestepInformation &timestepInformation) override
 
- 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 Member Functions inherited from alsuq::stats::StatisticsHelper
StatisticsSnapshotfindOrCreateSnapshot (const std::string &name, const alsfvm::simulator::TimestepInformation &timestepInformation, const alsfvm::volume::Volume &conservedVariables)
 
StatisticsSnapshotfindOrCreateSnapshot (const std::string &name, const alsfvm::simulator::TimestepInformation &timestepInformation, const alsfvm::volume::Volume &conservedVariables, size_t nx, size_t ny, size_t nz, const std::string &platform="default")
 
void makeOwnGrid (size_t nx, size_t ny, size_t nz)
 
- Protected Attributes inherited from alsuq::stats::StatisticsHelper
std::map< real, std::map< std::string, StatisticsSnapshot > > snapshots
 
- Protected Attributes inherited from alsfvm::io::Writer
std::map< std::string, boost::property_tree::ptree > attributesMap
 

Constructor & Destructor Documentation

◆ BoundedVariation()

alsuq::stats::BoundedVariation::BoundedVariation ( const StatisticsParameters parameters)

Member Function Documentation

◆ computeStatistics()

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

◆ finalizeStatistics()

void alsuq::stats::BoundedVariation::finalizeStatistics ( )
overridevirtual

To be called in the end, this could be to eg compute the variance through M_2-mean^2 or any other postprocessing needed

Implements alsuq::stats::Statistics.

◆ getStatisticsNames()

std::vector< std::string > alsuq::stats::BoundedVariation::getStatisticsNames ( ) const
overridevirtual

Returns a list of ['bv'].

Implements alsuq::stats::Statistics.


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