Alsvinn  0.5.3
The fast FVM simulator with UQ support
LogEntropy.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
18 
19 namespace alsfvm {
20 namespace functional {
21 
46 class LogEntropy : public Functional {
47 public:
48 
51 
71  virtual void operator()(volume::Volume& conservedVolumeOut,
72  const volume::Volume& conservedVolumeIn,
73  const real weight,
74  const grid::Grid& grid
75  ) override;
76 
78  virtual ivec3 getFunctionalSize(const grid::Grid& grid) const override;
79 
80 
81 private:
82 
83  const real gamma;
84 
85 };
86 } // namespace functional
87 } // namespace alsfvm
Definition: LogEntropy.hpp:46
Definition: Grid.hpp:27
virtual ivec3 getFunctionalSize(const grid::Grid &grid) const override
Returns grid.getDimensions()
Definition: LogEntropy.cpp:81
simulator::SimulatorParameters & parameters
Definition: CellComputerFactory.cpp:60
Holds general parameters based on a boost::property tree.
Definition: Parameters.hpp:24
LogEntropy(const Parameters &parameters)
Uses no parameter.
Definition: LogEntropy.cpp:8
The Volume class represents a volume (a collection of cells with values for each cell (eg...
Definition: Volume.hpp:30
virtual void operator()(volume::Volume &conservedVolumeOut, const volume::Volume &conservedVolumeIn, const real weight, const grid::Grid &grid) override
Definition: LogEntropy.cpp:14
double real
Definition: types.hpp:65
const grid::Grid & grid
Definition: NumericalFluxFactory.cpp:104
Various utility functions to implement the tecno flux.
Definition: types.hpp:30
functional
Definition: FunctionalStatistics.cpp:76
Abstract base class to represent a functional.
Definition: Functional.hpp:29