Finite Volume Solver  prototype
A framework to build finite volume solvers for the AG Klein at the Freie Universität Berlin.
geometry/Geometry.hpp
Go to the documentation of this file.
1 // Copyright (c) 2018 Maikel Nadolski
2 //
3 // Permission is hereby granted, free of charge, to any person obtaining a copy
4 // of this software and associated documentation files (the "Software"), to deal
5 // in the Software without restriction, including without limitation the rights
6 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 // copies of the Software, and to permit persons to whom the Software is
8 // furnished to do so, subject to the following conditions:
9 //
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
12 //
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 // SOFTWARE.
20 
21 #ifndef FUB_GEOMETRY_GEOMETRY_HPP
22 #define FUB_GEOMETRY_GEOMETRY_HPP
23 
24 #include <array>
25 #include <memory>
26 
27 namespace fub {
28 
29 template <std::size_t Rank> struct Geometry {
30  virtual ~Geometry() = default;
31 
32  /// Returns a copy of the concrete geometry as a pointer to the base class.
33  virtual std::unique_ptr<Geometry> Clone() const = 0;
34 
35  /// Computes the minimum distance between geometry and point x.
36  virtual double ComputeDistanceTo(const std::array<double, Rank>& x) const = 0;
37 };
38 
39 } // namespace fub
40 
41 #endif
The fub namespace.
Definition: AnyBoundaryCondition.hpp:31
Definition: geometry/Geometry.hpp:29
virtual ~Geometry()=default
virtual double ComputeDistanceTo(const std::array< double, Rank > &x) const =0
Computes the minimum distance between geometry and point x.
virtual std::unique_ptr< Geometry > Clone() const =0
Returns a copy of the concrete geometry as a pointer to the base class.