multidomain/facet/box/fvelementgeometry.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
//
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_FACETCOUPLING_BOX_FV_ELEMENT_GEOMETRY_HH
#define DUMUX_FACETCOUPLING_BOX_FV_ELEMENT_GEOMETRY_HH
 
#include <algorithm>
#include <optional>
 
#include <dune/geometry/type.hh>
 
#include <dumux/common/indextraits.hh>
#include <dumux/discretization/scvandscvfiterators.hh>
#include <dumux/discretization/box/boxgeometryhelper.hh>
 
namespace Dumux {

template<class GG, bool enableGridGeometryCache>
class BoxFacetCouplingFVElementGeometry;

template<class GG>
class BoxFacetCouplingFVElementGeometry<GG, true>
{
    using GridView = typename GG::GridView;
    static constexpr int dim = GridView::dimension;
    static constexpr int dimWorld = GridView::dimensionworld;
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
    using CoordScalar = typename GridView::ctype;
    using FeLocalBasis = typename GG::FeCache::FiniteElementType::Traits::LocalBasisType;
    using GGCache = typename GG::Cache;
    using GeometryHelper = typename GGCache::GeometryHelper;
public:
    using Element = typename GridView::template Codim<0>::Entity;
    using SubControlVolume = typename GG::SubControlVolume;
    using SubControlVolumeFace = typename GG::SubControlVolumeFace;
    using GridGeometry = GG;
    static constexpr std::size_t maxNumElementScvs = (1<<dim);

    [[deprecated("This Constructor is deprecated and will be removed after release 3.11. Always use localView(gridGeometry).")]]
    BoxFacetCouplingFVElementGeometry(const GridGeometry& gridGeometry)
    : BoxFacetCouplingFVElementGeometry(gridGeometry.cache_) {}

    BoxFacetCouplingFVElementGeometry(const GGCache& ggCache)
    : ggCache_(&ggCache) {}

    const SubControlVolume& scv(LocalIndexType scvIdx) const
    { return ggCache_->scvs(eIdx_)[scvIdx]; }

    const SubControlVolumeFace& scvf(LocalIndexType scvfIdx) const
    { return ggCache_->scvfs(eIdx_)[scvfIdx]; }

    friend inline Dune::IteratorRange<typename std::vector<SubControlVolume>::const_iterator>
    scvs(const BoxFacetCouplingFVElementGeometry& fvGeometry)
    {
        using Iter = typename std::vector<SubControlVolume>::const_iterator;
        const auto& s = fvGeometry.ggCache_->scvs(fvGeometry.eIdx_);
        return Dune::IteratorRange<Iter>(s.begin(), s.end());
    }

    friend inline Dune::IteratorRange<typename std::vector<SubControlVolumeFace>::const_iterator>
    scvfs(const BoxFacetCouplingFVElementGeometry& fvGeometry)
    {
        using Iter = typename std::vector<SubControlVolumeFace>::const_iterator;
        const auto& s = fvGeometry.ggCache_->scvfs(fvGeometry.eIdx_);
        return Dune::IteratorRange<Iter>(s.begin(), s.end());
    }

    const FeLocalBasis& feLocalBasis() const
    { return gridGeometry().feCache().get(element_->type()).localBasis(); }

    std::size_t numScv() const
    { return ggCache_->scvs(eIdx_).size(); }

    std::size_t numScvf() const
    { return ggCache_->scvfs(eIdx_).size(); }

    BoxFacetCouplingFVElementGeometry bind(const Element& element) &&
    {
        this->bindElement(element);
        return std::move(*this);
    }

    void bind(const Element& element) &
    { this->bindElement(element); }

    BoxFacetCouplingFVElementGeometry bindElement(const Element& element) &&
    {
        this->bindElement(element);
        return std::move(*this);
    }

    void bindElement(const Element& element) &
    {
        element_ = element;
        elementGeometry_.emplace(element.geometry());
        eIdx_ = gridGeometry().elementMapper().index(element);
    }

    const GridGeometry& gridGeometry() const
    { return ggCache_->gridGeometry(); }

    bool isBound() const
    { return static_cast<bool>(element_); }

    const Element& element() const
    { return *element_; }

    const typename Element::Geometry& elementGeometry() const
    { return *elementGeometry_; }

    typename SubControlVolume::Traits::Geometry geometry(const SubControlVolume& scv) const
    {
        assert(isBound());
        const auto geo = element().geometry();
        return { Dune::GeometryTypes::cube(dim), GeometryHelper(geo).getScvCorners(scv.indexInElement()) };
    }

    typename SubControlVolumeFace::Traits::Geometry geometry(const SubControlVolumeFace& scvf) const
    {
        assert(isBound());
        using ScvfGeometry = typename SubControlVolumeFace::Traits::Geometry;
        const GeometryHelper geometryHelper(element().geometry());
        if (scvf.boundary() || scvf.interiorBoundary())
            return {
                Dune::GeometryTypes::cube(ScvfGeometry::mydimension),
                geometryHelper.getBoundaryScvfCorners(
                    scvf.facetIndexInElement(),
                    scvf.indexInElementFacet()
                )
            };
 
        return {
            Dune::GeometryTypes::cube(ScvfGeometry::mydimension),
            geometryHelper.getScvfCorners(scvf.index())
        };
    }
 
private:
    const GGCache* ggCache_;
 
    GridIndexType eIdx_;
    std::optional<Element> element_;
    std::optional<typename Element::Geometry> elementGeometry_;
};

template<class GG>
class BoxFacetCouplingFVElementGeometry<GG, false>
{
    using GridView = typename GG::GridView;
    static constexpr int dim = GridView::dimension;
    static constexpr int dimWorld = GridView::dimensionworld;
 
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
 
    using CoordScalar = typename GridView::ctype;
    using FeLocalBasis = typename GG::FeCache::FiniteElementType::Traits::LocalBasisType;
    using GGCache = typename GG::Cache;
    using GeometryHelper = typename GGCache::GeometryHelper;
public:
    using Element = typename GridView::template Codim<0>::Entity;
    using SubControlVolume = typename GG::SubControlVolume;
    using SubControlVolumeFace = typename GG::SubControlVolumeFace;
    using GridGeometry = GG;
    static constexpr std::size_t maxNumElementScvs = (1<<dim);

    [[deprecated("This Constructor is deprecated and will be removed after release 3.11. Always use localView(gridGeometry).")]]
    BoxFacetCouplingFVElementGeometry(const GridGeometry& gridGeometry)
    : BoxFacetCouplingFVElementGeometry(gridGeometry.cache_) {}

    BoxFacetCouplingFVElementGeometry(const GGCache& ggCache)
    : ggCache_(&ggCache) {}

    const SubControlVolume& scv(LocalIndexType scvIdx) const
    { return scvs_[scvIdx]; }

    const SubControlVolumeFace& scvf(LocalIndexType scvfIdx) const
    { return scvfs_[scvfIdx]; }

    friend inline Dune::IteratorRange<typename std::vector<SubControlVolume>::const_iterator>
    scvs(const BoxFacetCouplingFVElementGeometry& fvGeometry)
    {
        using Iter = typename std::vector<SubControlVolume>::const_iterator;
        return Dune::IteratorRange<Iter>(fvGeometry.scvs_.begin(), fvGeometry.scvs_.end());
    }

    friend inline Dune::IteratorRange<typename std::vector<SubControlVolumeFace>::const_iterator>
    scvfs(const BoxFacetCouplingFVElementGeometry& fvGeometry)
    {
        using Iter = typename std::vector<SubControlVolumeFace>::const_iterator;
        return Dune::IteratorRange<Iter>(fvGeometry.scvfs_.begin(), fvGeometry.scvfs_.end());
    }

    const FeLocalBasis& feLocalBasis() const
    { return gridGeometry().feCache().get(element_->type()).localBasis(); }

    std::size_t numScv() const
    { return scvs_.size(); }

    std::size_t numScvf() const
    { return scvfs_.size(); }

    BoxFacetCouplingFVElementGeometry bind(const Element& element) &&
    {
        this->bindElement(element);
        return std::move(*this);
    }

    void bind(const Element& element) &
    { this->bindElement(element); }

    BoxFacetCouplingFVElementGeometry bindElement(const Element& element) &&
    {
        this->bindElement(element);
        return std::move(*this);
    }

    void bindElement(const Element& element) &
    {
        element_ = element;
        elementGeometry_.emplace(element.geometry());
        eIdx_ = gridGeometry().elementMapper().index(element);
        makeElementGeometries_();
    }

    const GridGeometry& gridGeometry() const
    { return ggCache_->gridGeometry(); }

    bool isBound() const
    { return static_cast<bool>(element_); }

    const Element& element() const
    { return *element_; }

    const typename Element::Geometry& elementGeometry() const
    { return *elementGeometry_; }

    typename SubControlVolume::Traits::Geometry geometry(const SubControlVolume& scv) const
    {
        assert(isBound());
        const auto geo = element().geometry();
        return { Dune::GeometryTypes::cube(dim), GeometryHelper(geo).getScvCorners(scv.indexInElement()) };
    }

    typename SubControlVolumeFace::Traits::Geometry geometry(const SubControlVolumeFace& scvf) const
    {
        assert(isBound());
        using ScvfGeometry = typename SubControlVolumeFace::Traits::Geometry;
        GeometryHelper geometryHelper(element().geometry());
 
        if (scvf.boundary() || scvf.interiorBoundary())
            return {
                Dune::GeometryTypes::cube(ScvfGeometry::mydimension),
                geometryHelper.getBoundaryScvfCorners(
                     scvf.facetIndexInElement(),
                     scvf.indexInElementFacet()
                )
            };
 
        return {
            Dune::GeometryTypes::cube(ScvfGeometry::mydimension),
            geometryHelper.getScvfCorners(scvf.index())
        };
    }
 
private:
 
    void makeElementGeometries_()
    {
        // get the element geometry
        const auto& element = *element_;
        const auto elementGeometry = element.geometry();
        const auto refElement = referenceElement(elementGeometry);
 
        // get the sub control volume geometries of this element
        GeometryHelper geometryHelper(elementGeometry);
 
        // construct the sub control volumes
        scvs_.clear();
        scvs_.reserve(elementGeometry.corners());
        using LocalIndexType = typename SubControlVolumeFace::Traits::LocalIndexType;
        for (LocalIndexType scvLocalIdx = 0; scvLocalIdx < elementGeometry.corners(); ++scvLocalIdx)
            scvs_.emplace_back(geometryHelper.getScvCorners(scvLocalIdx),
                               scvLocalIdx,
                               eIdx_,
                               gridGeometry().vertexMapper().subIndex(element, scvLocalIdx, dim));
 
        // construct the sub control volume faces
        const auto numInnerScvf = (dim==1) ? 1 : element.subEntities(dim-1);
        scvfs_.clear();
        scvfs_.reserve(numInnerScvf);
 
        LocalIndexType scvfLocalIdx = 0;
        for (; scvfLocalIdx < numInnerScvf; ++scvfLocalIdx)
        {
            // find the local scv indices this scvf is connected to
            std::array<LocalIndexType, 2> localScvIndices{{
                static_cast<LocalIndexType>(refElement.subEntity(scvfLocalIdx, dim-1, 0, dim)),
                static_cast<LocalIndexType>(refElement.subEntity(scvfLocalIdx, dim-1, 1, dim))
            }};
 
            // create the sub-control volume face
            scvfs_.emplace_back(geometryHelper,
                                element,
                                scvfLocalIdx,
                                std::move(localScvIndices));
        }
 
        // construct the sub control volume faces on the domain/interior boundaries
        // skip handled facets (necessary for e.g. Dune::FoamGrid)
        std::vector<unsigned int> handledFacets;
        for (const auto& intersection : intersections(gridGeometry().gridView(), element))
        {
            if (std::count(handledFacets.begin(), handledFacets.end(), intersection.indexInInside()))
                continue;
 
            handledFacets.push_back(intersection.indexInInside());
 
            // determine if all corners live on the facet grid
            const auto isGeometry = intersection.geometry();
            const auto numFaceCorners = isGeometry.corners();
            const auto idxInInside = intersection.indexInInside();
            const auto boundary = intersection.boundary();
 
            std::vector<LocalIndexType> vIndicesLocal(numFaceCorners);
            for (int i = 0; i < numFaceCorners; ++i)
                vIndicesLocal[i] = static_cast<LocalIndexType>(refElement.subEntity(idxInInside, 1, i, dim));
 
            // if all vertices are living on the facet grid, this is an interiour boundary
            const bool isOnFacet = gridGeometry().isOnInteriorBoundary(element, intersection);
 
            if (isOnFacet || boundary)
            {
                for (unsigned int isScvfLocalIdx = 0; isScvfLocalIdx < isGeometry.corners(); ++isScvfLocalIdx)
                {
                    // find the inside scv this scvf is belonging to (localIdx = element local vertex index)
                    std::array<LocalIndexType, 2> localScvIndices{{
                        vIndicesLocal[isScvfLocalIdx], vIndicesLocal[isScvfLocalIdx]
                    }};
 
                    // create the sub-control volume face
                    scvfs_.emplace_back(geometryHelper,
                                        intersection,
                                        isScvfLocalIdx,
                                        scvfLocalIdx,
                                        std::move(localScvIndices),
                                        boundary,
                                        isOnFacet);
 
                    // increment local counter
                    scvfLocalIdx++;
                }
            }
        }
    }

    GridIndexType eIdx_;
    std::optional<Element> element_;
    std::optional<typename Element::Geometry> elementGeometry_;

    const GGCache* ggCache_;

    std::vector<SubControlVolume> scvs_;
    std::vector<SubControlVolumeFace> scvfs_;
};
 
} // end namespace Dumux
 
#endif