discretization/facecentered/diamond/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_DISCRETIZATION_FACECENTERED_DIAMOND_FV_ELEMENT_GEOMETRY_HH
#define DUMUX_DISCRETIZATION_FACECENTERED_DIAMOND_FV_ELEMENT_GEOMETRY_HH
 
#include <type_traits>
#include <optional>
#include <ranges>
#include <span>
 
#include <dune/common/reservedvector.hh>
#include <dune/common/iteratorrange.hh>
 
#include <dumux/common/indextraits.hh>
#include <dumux/discretization/scvandscvfiterators.hh>
#include <dumux/discretization/facecentered/diamond/geometryhelper.hh>
#include <dumux/discretization/cvfe/interpolationpointdata.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
 
namespace Dumux {

template<class GG, bool cachingEnabled>
class FaceCenteredDiamondFVElementGeometry;

template<class GG>
class FaceCenteredDiamondFVElementGeometry<GG, /*cachingEnabled*/true>
{
    using ThisType = FaceCenteredDiamondFVElementGeometry<GG, /*cachingEnabled*/true>;
    using GridView = typename GG::GridView;
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::SmallLocalIndex;
    using FeLocalBasis = typename GG::FeCache::FiniteElementType::Traits::LocalBasisType;
    using GGCache = typename GG::Cache;
    using GeometryHelper = typename GGCache::GeometryHelper;
 
    using BaseIpData = CVFE::InterpolationPointData<
                        typename GridView::template Codim<0>::Entity::Geometry::LocalCoordinate,
                        typename GridView::template Codim<0>::Entity::Geometry::GlobalCoordinate
                        >;
 
public:
    using SubControlVolume = typename GG::SubControlVolume;
    using SubControlVolumeFace = typename GG::SubControlVolumeFace;
    using BoundaryFace = typename GG::BoundaryFace;
    using Element = typename GridView::template Codim<0>::Entity;
    using GridGeometry = GG;
    using ScvQuadratureRule = typename GG::ScvQuadratureRule;
    using ScvfQuadratureRule = typename GG::ScvfQuadratureRule;

    static constexpr std::size_t maxNumElementScvs = 2*GridView::dimension;
 
    FaceCenteredDiamondFVElementGeometry(const GGCache& ggCache)
    : ggCache_(&ggCache)
    {}

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

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

    friend inline auto
    scvs(const FaceCenteredDiamondFVElementGeometry& 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 auto
    scvfs(const FaceCenteredDiamondFVElementGeometry& 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());
    }

    friend inline Dune::IteratorRange<typename std::vector<SubControlVolumeFace>::const_iterator>
    scvfs(const FaceCenteredDiamondFVElementGeometry& fvGeometry, const BoundaryFace& boundaryFace)
    {
        using Iter = typename std::vector<SubControlVolumeFace>::const_iterator;
        const auto& s = fvGeometry.ggCache_->scvfs(fvGeometry.eIdx_);
        const auto& range = fvGeometry.ggCache_->boundaryFaceScvfRanges(fvGeometry.eIdx_)[boundaryFace.index()];
        return Dune::IteratorRange<Iter>(s.begin() + range[0], s.begin() + range[0] + range[1]);
    }

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

    std::size_t numLocalDofs() const
    {
        return numScv();
    }

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

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

    bool hasBoundaryScvf() const
    { return ggCache_->hasBoundaryScvf(eIdx_); }

    bool hasBoundaryFaces() const
    { return hasBoundaryScvf(); }

    const BoundaryFace& boundaryFace(LocalIndexType bfIdx) const
    { return ggCache_->boundaryFaces(eIdx_)[bfIdx]; }

    friend inline std::ranges::view auto
    boundaryFaces(const FaceCenteredDiamondFVElementGeometry& fvGeometry)
    {
        const auto& v = fvGeometry.ggCache_->boundaryFaces(fvGeometry.eIdx_);
        return std::ranges::views::all(v);
    }

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

    FaceCenteredDiamondFVElementGeometry 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);
    }

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

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

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

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

    std::size_t elementIndex() const
    { return eIdx_; }

    std::size_t intersectionIndex(const SubControlVolumeFace& scvf) const
    {
        // Since scvs are constructed around intersections, they have the same index
        return scvf.insideScvIdx();
    }

    typename SubControlVolume::Traits::Geometry geometry(const SubControlVolume& scv) const
    {
        assert(isBound());
        return {
            SubControlVolume::Traits::geometryType((*elementGeometry_).type()),
            GeometryHelper(*elementGeometry_).getScvCorners(scv.indexInElement())
        };
    }

    typename SubControlVolumeFace::Traits::Geometry geometry(const SubControlVolumeFace& scvf) const
    {
        assert(isBound());
        if (scvf.boundary())
        {
            // use the information that each boundary scvf corresponds to one scv constructed around the same facet
            const auto localFacetIndex = scvf.insideScvIdx();
            return {
                referenceElement(*elementGeometry_).type(localFacetIndex, 1),
                GeometryHelper(*elementGeometry_).getBoundaryScvfCorners(localFacetIndex)
            };
        }
        else
        {
            return {
                SubControlVolumeFace::Traits::interiorGeometryType((*elementGeometry_).type()),
                GeometryHelper(*elementGeometry_).getScvfCorners(scvf.index())
            };
        }
    }

    typename BoundaryFace::Traits::Geometry geometry(const BoundaryFace& boundaryFace) const
    {
        assert(isBound());
        const auto& elemGeo = elementGeometry();
        const auto faceGeoInRef = referenceElement(elemGeo).template geometry<1>(boundaryFace.intersectionIndex());
        typename BoundaryFace::Traits::CornerStorage corners;
        for (int i = 0; i < faceGeoInRef.corners(); ++i)
            corners.push_back(elemGeo.global(faceGeoInRef.corner(i)));
        return { faceGeoInRef.type(), corners };
    }

    friend inline auto localDofs(const FaceCenteredDiamondFVElementGeometry& fvGeometry,
                                 const BoundaryFace& boundaryFace)
    {
        const auto localDofIdx = boundaryFace.intersectionIndex();
        return std::views::single(CVFE::LocalDof{
            static_cast<LocalIndexType>(localDofIdx),
            static_cast<GridIndexType>(fvGeometry.scv(localDofIdx).dofIndex()),
            static_cast<GridIndexType>(fvGeometry.elementIndex())
        });
    }

    friend inline auto ipData(const FaceCenteredDiamondFVElementGeometry& fvGeometry, const SubControlVolume& scv)
    {
        const auto type = fvGeometry.element().type();
        const auto& localKey = fvGeometry.gridGeometry().feCache().get(type).localCoefficients().localKey(scv.localDofIndex());
 
        return CVFE::LocalDofInterpolationPointData{ GeometryHelper::localDofPosition(type, localKey), scv.dofPosition(), scv.localDofIndex() };
    }

    template<class LocalDof>
    friend inline auto ipData(const FaceCenteredDiamondFVElementGeometry& fvGeometry, const LocalDof& localDof)
    {
        const auto type = fvGeometry.element().type();
        const auto& localKey = fvGeometry.gridGeometry().feCache().get(type).localCoefficients().localKey(localDof.index());
        const auto& localPos = GeometryHelper::localDofPosition(type, localKey);
 
        return CVFE::LocalDofInterpolationPointData{ localPos, fvGeometry.elementGeometry().global(localPos), localDof.index() };
    }

    friend inline auto ipData(const FaceCenteredDiamondFVElementGeometry& fvGeometry, const typename Element::Geometry::GlobalCoordinate& globalPos)
    {
        // Create ipData that does not automatically calculate the local position but only if it is called
        return CVFE::InterpolationPointDataLocalMapping{
            [&] (const typename Element::Geometry::GlobalCoordinate& pos) { return fvGeometry.elementGeometry().local(pos); },
            globalPos
        };
    }

    friend inline auto ipData(const FaceCenteredDiamondFVElementGeometry& fvGeometry, const SubControlVolumeFace& scvf)
    {
        return CVFE::FaceInterpolationPointData<BaseIpData, LocalIndexType>
                    { scvf.unitOuterNormal(), scvf.index(), fvGeometry.elementGeometry().local(scvf.ipGlobal()), scvf.ipGlobal() };
    }
 
private:
    std::optional<Element> element_;
    std::optional<typename Element::Geometry> elementGeometry_;
    GridIndexType eIdx_;
    const GGCache* ggCache_;
};
 
} // end namespace Dumux
 
#endif