diff --git a/dumux/discretization/basefvgridgeometry.hh b/dumux/discretization/basefvgridgeometry.hh
index f8b5854919989dbfb0ab072702f1ea373d51ca0a..70a7808f0f146a0721b5792752c73810d2259da3 100644
--- a/dumux/discretization/basefvgridgeometry.hh
+++ b/dumux/discretization/basefvgridgeometry.hh
@@ -24,15 +24,7 @@
#ifndef DUMUX_DISCRETIZATION_BASE_FV_GRID_GEOMETRY_HH
#define DUMUX_DISCRETIZATION_BASE_FV_GRID_GEOMETRY_HH
-#include <dune/grid/common/mcmgmapper.hh>
-
-#include <dumux/common/entitymap.hh>
-#include <dumux/common/indextraits.hh>
-#include <dumux/common/geometry/boundingboxtree.hh>
-#include <dumux/common/geometry/geometricentityset.hh>
-
-//! make the local view function available whenever we use the grid geometry
-#include <dumux/discretization/localview.hh>
+#include "basegridgeometry.hh"
namespace Dumux {
@@ -42,202 +34,19 @@ namespace Dumux {
* \tparam Impl the type of the actual implementation
* \tparam GV the grid view type
* \tparam Traits the fv geometry traits
+ * \note This has been deprecated in favour of a discretization-scheme
+ * agnostic implementation in Dumux::BaseGridGeometry.
*/
template<class Impl, class GV, class Traits>
-class BaseFVGridGeometry
+class DUNE_DEPRECATED_MSG("Use BaseGridGeometry instead. Will be removed after 3.1!")
+BaseFVGridGeometry : public BaseGridGeometry<GV, Traits>
{
- using ElementMap = EntityMap<GV, 0>;
- using ElementSet = GridViewGeometricEntitySet<GV, 0, typename Traits::ElementMapper>;
- using BoundingBoxTree = Dumux::BoundingBoxTree<ElementSet>;
-
- static constexpr int dim = GV::dimension;
- static constexpr int dimWorld = GV::dimensionworld;
-
- using GridIndexType = typename IndexTraits<GV>::GridIndex;
+ using ParentType = BaseGridGeometry<GV, Traits>;
using Element = typename GV::template Codim<0>::Entity;
- using SubControlVolume = typename Traits::SubControlVolume;
public:
- //! export the grid type
- using Grid = typename GV::Grid;
- //! export the grid view type
- using GridView = GV;
- //! export the global coordinate type
- using GlobalCoordinate = typename Element::Geometry::GlobalCoordinate;
- //! export the element mapper type
- using ElementMapper = typename Traits::ElementMapper;
- //! export the vertex mapper type
- using VertexMapper = typename Traits::VertexMapper;
-
- /*!
- * \ingroup Discretization
- * \brief Constructor computes the bouding box of the entire domain, for e.g. setting boundary conditions
- * \param gridView the grid view on which to construct the grid geometry
- */
- BaseFVGridGeometry(const GridView& gridView)
- : gridView_(gridView)
- , elementMapper_(gridView, Dune::mcmgElementLayout())
- , vertexMapper_(gridView, Dune::mcmgVertexLayout())
- , bBoxMin_(std::numeric_limits<double>::max())
- , bBoxMax_(-std::numeric_limits<double>::max())
- {
- computeGlobalBoundingBox_();
- }
-
- /*!
- * \brief Update all fvElementGeometries (do this again after grid adaption)
- */
- void update()
- {
- //! Update the mappers
- vertexMapper_.update();
- elementMapper_.update();
-
- //! Compute the bouding box of the entire domain, for e.g. setting boundary conditions
- computeGlobalBoundingBox_();
-
- //! reset bounding box tree and the element map until requested the next time
- boundingBoxTree_.release();
- elementMap_.reset();
- }
-
- /*!
- * \brief Return the gridView this grid geometry object lives on
- */
- const GridView& gridView() const
- { return gridView_; }
-
- /*!
- * \brief Returns the mapper for vertices to indices for constant grids.
- */
- const VertexMapper &vertexMapper() const
- { return vertexMapper_; }
-
- /*!
- * \brief Returns the mapper for elements to indices for constant grids.
- */
- const ElementMapper &elementMapper() const
- { return elementMapper_; }
-
- /*!
- * \brief Returns the mapper for vertices to indices for possibly adaptive grids.
- */
- VertexMapper &vertexMapper()
- { return vertexMapper_; }
-
- /*!
- * \brief Returns the mapper for elements to indices for possibly adaptive grids.
- */
- ElementMapper &elementMapper()
- { return elementMapper_; }
-
- /*!
- * \brief Returns the bounding box tree of the grid
- */
- const BoundingBoxTree& boundingBoxTree() const
- {
- if(!boundingBoxTree_)
- {
- elementMap(); // make sure the element map is built
- boundingBoxTree_ = std::make_unique<BoundingBoxTree>
- ( std::make_shared<ElementSet>(gridView_, elementMapper(), elementMap_) );
- }
-
- return *boundingBoxTree_;
- }
-
- /*!
- * \brief Returns the element index to element map
- */
- const ElementMap& elementMap() const
- {
- if(!elementMap_)
- elementMap_ = std::make_shared<ElementMap>(gridView_.grid(), elementMapper_);
-
- return *elementMap_;
- }
-
- //! Get an element from a sub control volume contained in it
- Element element(const SubControlVolume& scv) const
- { return elementMap()[scv.elementIndex()]; }
-
- //! Get an element from a global element index
- Element element(GridIndexType eIdx) const
- { return elementMap()[eIdx]; }
-
- /*!
- * \brief The coordinate of the corner of the GridView's bounding
- * box with the smallest values.
- */
- const GlobalCoordinate &bBoxMin() const
- { return bBoxMin_; }
-
- /*!
- * \brief The coordinate of the corner of the GridView's bounding
- * box with the largest values.
- */
- const GlobalCoordinate &bBoxMax() const
- { return bBoxMax_; }
-
- /*!
- * \brief Returns if the grid geometry is periodic (at all)
- */
- bool isPeriodic() const
- { return periodic_; }
-
- /*!
- * \brief Set the periodicity of the grid geometry
- */
- void setPeriodic(bool value = true)
- { periodic_ = value; }
-
-private:
-
- //! Compute the bouding box of the entire domain, for e.g. setting boundary conditions
- void computeGlobalBoundingBox_()
- {
- // calculate the bounding box of the local partition of the grid view
- for (const auto& vertex : vertices(gridView_))
- {
- for (int i=0; i<dimWorld; i++)
- {
- using std::min;
- using std::max;
- bBoxMin_[i] = min(bBoxMin_[i], vertex.geometry().corner(0)[i]);
- bBoxMax_[i] = max(bBoxMax_[i], vertex.geometry().corner(0)[i]);
- }
- }
-
- // communicate to get the bounding box of the whole domain
- if (gridView_.comm().size() > 1)
- {
- for (int i = 0; i < dimWorld; ++i)
- {
- bBoxMin_[i] = gridView_.comm().min(bBoxMin_[i]);
- bBoxMax_[i] = gridView_.comm().max(bBoxMax_[i]);
- }
- }
- }
-
- //! the process grid view
- const GridView gridView_;
-
- //! entity mappers
- ElementMapper elementMapper_;
- VertexMapper vertexMapper_;
-
- //! the bounding box tree of the grid view for effecient element intersections
- mutable std::unique_ptr<BoundingBoxTree> boundingBoxTree_;
-
- //! a map from element index to elements (needed in the bounding box tree and for assembling cell-centered discretization)
- mutable std::shared_ptr<ElementMap> elementMap_;
-
- //! the bounding box of the whole domain
- GlobalCoordinate bBoxMin_;
- GlobalCoordinate bBoxMax_;
-
- //! if the grid geometry has periodic boundaries
- bool periodic_ = false;
+ BaseFVGridGeometry(const GV& gridView)
+ : BaseGridGeometry<GV, Traits>(gridView) {}
};
} // end namespace Dumux
diff --git a/dumux/discretization/basegridgeometry.hh b/dumux/discretization/basegridgeometry.hh
new file mode 100644
index 0000000000000000000000000000000000000000..0e9ace70448ec443d7e70837074d8826b70ce772
--- /dev/null
+++ b/dumux/discretization/basegridgeometry.hh
@@ -0,0 +1,252 @@
+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*****************************************************************************
+ * See the file COPYING for full copying permissions. *
+ * *
+ * This program is free software: you can redistribute it and/or modify *
+ * it under the terms of the GNU General Public License as published by *
+ * the Free Software Foundation, either version 3 of the License, or *
+ * (at your option) any later version. *
+ * *
+ * This program is distributed in the hope that it will be useful, *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
+ * GNU General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU General Public License *
+ * along with this program. If not, see <http://www.gnu.org/licenses/>. *
+ *****************************************************************************/
+/*!
+ * \file
+ * \ingroup Discretization
+ * \brief Base class for grid geometries
+ */
+#ifndef DUMUX_DISCRETIZATION_BASE_GRID_GEOMETRY_HH
+#define DUMUX_DISCRETIZATION_BASE_GRID_GEOMETRY_HH
+
+#include <type_traits>
+
+#include <dune/grid/common/mcmgmapper.hh>
+
+#include <dumux/common/entitymap.hh>
+#include <dumux/common/indextraits.hh>
+#include <dumux/common/geometry/boundingboxtree.hh>
+#include <dumux/common/geometry/geometricentityset.hh>
+
+//! make the local view function available whenever we use the grid geometry
+#include <dumux/discretization/localview.hh>
+
+namespace Dumux {
+
+/*!
+ * \ingroup Discretization
+ * \brief Base class for all finite volume grid geometries
+ * \tparam GV the grid view type
+ * \tparam Traits traits class
+ */
+template<class GV, class Traits>
+class BaseGridGeometry
+{
+ using ElementMap = EntityMap<GV, 0>;
+ using ElementSet = GridViewGeometricEntitySet<GV, 0, typename Traits::ElementMapper>;
+ using BoundingBoxTree = Dumux::BoundingBoxTree<ElementSet>;
+
+ static constexpr int dim = GV::dimension;
+ static constexpr int dimWorld = GV::dimensionworld;
+
+ using GridIndexType = typename IndexTraits<GV>::GridIndex;
+ using Element = typename GV::template Codim<0>::Entity;
+
+public:
+ //! export the grid type
+ using Grid = typename GV::Grid;
+ //! export the grid view type
+ using GridView = GV;
+ //! export the global coordinate type
+ using GlobalCoordinate = typename Element::Geometry::GlobalCoordinate;
+ //! export the element mapper type
+ using ElementMapper = typename Traits::ElementMapper;
+ //! export the vertex mapper type
+ using VertexMapper = typename Traits::VertexMapper;
+
+ /*!
+ * \ingroup Discretization
+ * \brief Constructor computes the bouding box of the entire domain, for e.g. setting boundary conditions
+ * \param gridView the grid view on which to construct the grid geometry
+ */
+ BaseGridGeometry(const GridView& gridView)
+ : gridView_(gridView)
+ , elementMapper_(gridView, Dune::mcmgElementLayout())
+ , vertexMapper_(gridView, Dune::mcmgVertexLayout())
+ , bBoxMin_(std::numeric_limits<double>::max())
+ , bBoxMax_(-std::numeric_limits<double>::max())
+ {
+ computeGlobalBoundingBox_();
+ }
+
+ /*!
+ * \brief Update all fvElementGeometries (do this again after grid adaption)
+ */
+ void update()
+ {
+ //! Update the mappers
+ vertexMapper_.update();
+ elementMapper_.update();
+
+ //! Compute the bouding box of the entire domain, for e.g. setting boundary conditions
+ computeGlobalBoundingBox_();
+
+ //! reset bounding box tree and the element map until requested the next time
+ boundingBoxTree_.release();
+ elementMap_.reset();
+ }
+
+ /*!
+ * \brief Return the gridView this grid geometry object lives on
+ */
+ const GridView& gridView() const
+ { return gridView_; }
+
+ /*!
+ * \brief Returns the mapper for vertices to indices for constant grids.
+ */
+ const VertexMapper &vertexMapper() const
+ { return vertexMapper_; }
+
+ /*!
+ * \brief Returns the mapper for elements to indices for constant grids.
+ */
+ const ElementMapper &elementMapper() const
+ { return elementMapper_; }
+
+ /*!
+ * \brief Returns the mapper for vertices to indices for possibly adaptive grids.
+ */
+ VertexMapper &vertexMapper()
+ { return vertexMapper_; }
+
+ /*!
+ * \brief Returns the mapper for elements to indices for possibly adaptive grids.
+ */
+ ElementMapper &elementMapper()
+ { return elementMapper_; }
+
+ /*!
+ * \brief Returns the bounding box tree of the grid
+ */
+ const BoundingBoxTree& boundingBoxTree() const
+ {
+ if(!boundingBoxTree_)
+ {
+ elementMap(); // make sure the element map is built
+ boundingBoxTree_ = std::make_unique<BoundingBoxTree>
+ ( std::make_shared<ElementSet>(gridView_, elementMapper(), elementMap_) );
+ }
+
+ return *boundingBoxTree_;
+ }
+
+ /*!
+ * \brief Returns the element index to element map
+ */
+ const ElementMap& elementMap() const
+ {
+ if(!elementMap_)
+ elementMap_ = std::make_shared<ElementMap>(gridView_.grid(), elementMapper_);
+
+ return *elementMap_;
+ }
+
+ /*!
+ * \brief Get an element from a sub-control volume
+ * \note This interface is deprecated
+ */
+ template<class Scv, std::enable_if_t<!std::is_arithmetic<Scv>::value, int> = 0 >
+ Element DUNE_DEPRECATED_MSG("Use element(elementIndex) instead. Will be removed after 3.1!")
+ element(const Scv& scv) const
+ { return elementMap()[scv.elementIndex()]; }
+
+ /*!
+ * \brief Get an element from a global element index
+ */
+ Element element(GridIndexType eIdx) const
+ { return elementMap()[eIdx]; }
+
+ /*!
+ * \brief The coordinate of the corner of the GridView's bounding
+ * box with the smallest values.
+ */
+ const GlobalCoordinate &bBoxMin() const
+ { return bBoxMin_; }
+
+ /*!
+ * \brief The coordinate of the corner of the GridView's bounding
+ * box with the largest values.
+ */
+ const GlobalCoordinate &bBoxMax() const
+ { return bBoxMax_; }
+
+ /*!
+ * \brief Returns if the grid geometry is periodic (at all)
+ */
+ bool isPeriodic() const
+ { return periodic_; }
+
+ /*!
+ * \brief Set the periodicity of the grid geometry
+ */
+ void setPeriodic(bool value = true)
+ { periodic_ = value; }
+
+private:
+
+ //! Compute the bouding box of the entire domain, for e.g. setting boundary conditions
+ void computeGlobalBoundingBox_()
+ {
+ // calculate the bounding box of the local partition of the grid view
+ for (const auto& vertex : vertices(gridView_))
+ {
+ for (int i=0; i<dimWorld; i++)
+ {
+ using std::min;
+ using std::max;
+ bBoxMin_[i] = min(bBoxMin_[i], vertex.geometry().corner(0)[i]);
+ bBoxMax_[i] = max(bBoxMax_[i], vertex.geometry().corner(0)[i]);
+ }
+ }
+
+ // communicate to get the bounding box of the whole domain
+ if (gridView_.comm().size() > 1)
+ {
+ for (int i = 0; i < dimWorld; ++i)
+ {
+ bBoxMin_[i] = gridView_.comm().min(bBoxMin_[i]);
+ bBoxMax_[i] = gridView_.comm().max(bBoxMax_[i]);
+ }
+ }
+ }
+
+ //! the process grid view
+ const GridView gridView_;
+
+ //! entity mappers
+ ElementMapper elementMapper_;
+ VertexMapper vertexMapper_;
+
+ //! the bounding box tree of the grid view for effecient element intersections
+ mutable std::unique_ptr<BoundingBoxTree> boundingBoxTree_;
+
+ //! a map from element index to elements (needed in the bounding box tree and for assembling cell-centered discretization)
+ mutable std::shared_ptr<ElementMap> elementMap_;
+
+ //! the bounding box of the whole domain
+ GlobalCoordinate bBoxMin_;
+ GlobalCoordinate bBoxMax_;
+
+ //! if the grid geometry has periodic boundaries
+ bool periodic_ = false;
+};
+
+} // end namespace Dumux
+
+#endif