Alsvinn  0.5.3
The fast FVM simulator with UQ support
Functional.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/volume/Volume.hpp"
19 #include "alsfvm/grid/Grid.hpp"
20 
21 namespace alsfvm {
22 namespace functional {
23 
24 
29 class Functional {
30 public:
33 
34  virtual ~Functional() {}
35 
55  virtual void operator()(volume::Volume& conservedVolumeOut,
56  const volume::Volume& conservedVolumeIn,
57  const real weight,
58  const grid::Grid& grid
59  ) = 0;
60 
66  virtual ivec3 getFunctionalSize(const grid::Grid& grid) const = 0;
67 
68  virtual ivec3 getGhostCellSizes(const grid::Grid& grid,
69  const volume::Volume& volume) const;
70 
71  virtual std::string getPlatformToAllocateOn(const std::string& platform) const;
72 };
73 
74 typedef alsfvm::shared_ptr<Functional> FunctionalPointer;
75 } // namespace functional
76 } // namespace alsfvm
alsutils::parameters::Parameters Parameters
To be used to pass parameters to the constructors.
Definition: Functional.hpp:32
Definition: Grid.hpp:27
virtual std::string getPlatformToAllocateOn(const std::string &platform) const
Definition: Functional.cpp:26
Holds general parameters based on a boost::property tree.
Definition: Parameters.hpp:24
The Volume class represents a volume (a collection of cells with values for each cell (eg...
Definition: Volume.hpp:30
virtual ivec3 getFunctionalSize(const grid::Grid &grid) const =0
double real
Definition: types.hpp:65
const grid::Grid & grid
Definition: NumericalFluxFactory.cpp:104
alsfvm::shared_ptr< Functional > FunctionalPointer
Definition: Functional.hpp:74
virtual ~Functional()
Definition: Functional.hpp:34
virtual ivec3 getGhostCellSizes(const grid::Grid &grid, const volume::Volume &volume) const
Definition: Functional.cpp:21
virtual void operator()(volume::Volume &conservedVolumeOut, const volume::Volume &conservedVolumeIn, const real weight, const grid::Grid &grid)=0
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