Alsvinn  0.5.3
The fast FVM simulator with UQ support
Statistics.hpp
Go to the documentation of this file.
1 /* Copyright (c) 2018 ETH Zurich, Kjetil Olsen Lye
2  * This program is free software: you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation, either version 3 of the License, or
5  * (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program. If not, see <http://www.gnu.org/licenses/>.
14  */
15 
16 #pragma once
17 #include "alsfvm/io/Writer.hpp"
19 
20 namespace alsuq {
21 namespace stats {
22 
26 public:
27  virtual ~Statistics() {}
28 
32  virtual void write(const alsfvm::volume::Volume& conservedVariables,
33  const alsfvm::grid::Grid& grid,
34  const alsfvm::simulator::TimestepInformation& timestepInformation) override;
35 
36 
38  virtual void combineStatistics() = 0;
39 
44  virtual void addWriter(const std::string& name,
45  std::shared_ptr<alsfvm::io::Writer>& writer) = 0;
46 
49  virtual std::vector<std::string> getStatisticsNames() const = 0;
50 
51 
52  virtual void computeStatistics(const alsfvm::volume::Volume& conservedVariables,
53  const alsfvm::grid::Grid& grid,
54  const alsfvm::simulator::TimestepInformation& timestepInformation) = 0;
55 
58  virtual void finalizeStatistics() = 0;
59 
60  virtual void writeStatistics(const alsfvm::grid::Grid& grid) = 0;
61 
62 };
63 } // namespace stats
64 } // namespace alsuq
virtual void combineStatistics()=0
To be called when the statistics should be combined.
virtual void writeStatistics(const alsfvm::grid::Grid &grid)=0
Definition: Grid.hpp:27
The Volume class represents a volume (a collection of cells with values for each cell (eg...
Definition: Volume.hpp:30
virtual void computeStatistics(const alsfvm::volume::Volume &conservedVariables, const alsfvm::grid::Grid &grid, const alsfvm::simulator::TimestepInformation &timestepInformation)=0
virtual void finalizeStatistics()=0
std::string name
Definition: EquationParameterFactory.cpp:39
const grid::Grid & grid
Definition: NumericalFluxFactory.cpp:104
The Writer class is an abstract interface to represent output writers.
Definition: Writer.hpp:28
virtual ~Statistics()
Definition: Statistics.hpp:27
virtual void addWriter(const std::string &name, std::shared_ptr< alsfvm::io::Writer > &writer)=0
Definition: Statistics.hpp:25
virtual void write(const alsfvm::volume::Volume &conservedVariables, const alsfvm::grid::Grid &grid, const alsfvm::simulator::TimestepInformation &timestepInformation) override
Definition: Statistics.cpp:21
Definition: Setup.hpp:22
virtual std::vector< std::string > getStatisticsNames() const =0
Definition: TimestepInformation.hpp:22