discretization/pq2/fvgridgeometry.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_PQ2_GRID_GEOMETRY_HH
#define DUMUX_DISCRETIZATION_PQ2_GRID_GEOMETRY_HH
 
#include <array>
#include <cstddef>
#include <memory>
#include <vector>
#include <utility>
#include <unordered_map>
#include <type_traits>
#include <span>
#include <ranges>
 
#include <dune/grid/common/mcmgmapper.hh>
#include <dune/geometry/type.hh>
#include <dune/localfunctions/lagrange/lagrangelfecache.hh>
 
#include <dumux/discretization/method.hh>
 
#include <dumux/common/indextraits.hh>
#include <dumux/common/defaultmappertraits.hh>
 
#include <dumux/geometry/center.hh>
#include <dumux/geometry/volume.hh>
 
#include <dumux/discretization/basegridgeometry.hh>
#include <dumux/discretization/pq1bubble/fvgridgeometry.hh>
#include <dumux/discretization/pq2/geometryhelper.hh>
#include <dumux/discretization/pq2/fvelementgeometry.hh>
#include <dumux/discretization/pq2/subcontrolvolume.hh>
#include <dumux/discretization/pq2/subcontrolvolumeface.hh>
#include <dumux/discretization/boundaryface.hh>
#include <dumux/discretization/extrusion.hh>
 
#include <dumux/discretization/periodicdofmap.hh>
#include <dumux/io/grid/periodicgridtraits.hh>
 
namespace Dumux {
 
namespace Detail {
 
template<class GV, class T>
using PQ2GeometryHelper_t = Dune::Std::detected_or_t<
    std::conditional_t<enablesHybridCVFE<T>,
        Dumux::HybridPQ2GeometryHelper<GV, typename T::SubControlVolume, typename T::SubControlVolumeFace>,
        void // we currently only support hybrid schemes
    >,
    SpecifiesGeometryHelper,
    T
>;
} // end namespace Detail
 
template <class GridView>
struct PQ2MapperTraits :public DefaultMapperTraits<GridView>
{
    using DofMapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>;

    static Dune::MCMGLayout layout()
    {
        return [](Dune::GeometryType gt, int dimgrid) {
            return (gt.dim() == 0) || (gt.dim() == 1)
                || (gt.dim() == dimgrid && gt == Dune::GeometryTypes::cube(dimgrid))
                || (dimgrid == 3 && gt == Dune::GeometryTypes::cube(dimgrid-1));
        };
    }
};

template<class GridView,
         class ScvRule = Dumux::QuadratureRules::MidpointQuadrature,
         class ScvfRule = Dumux::QuadratureRules::DuneQuadrature<2>,
         class ElementRule = Dumux::QuadratureRules::DuneQuadrature<4>,
         class IntersectionRule = Dumux::QuadratureRules::DuneQuadrature<4>,
         class BoundaryFaceRule = Dumux::QuadratureRules::DuneQuadrature<4>>
using PQ2QuadratureTraits = CVFE::DefaultQuadratureTraits<GridView, ScvRule, ScvfRule, ElementRule, IntersectionRule, BoundaryFaceRule>;

template<class GridView, class MapperTraits = PQ2MapperTraits<GridView>, class QuadratureTraits = PQ2QuadratureTraits<GridView>>
struct PQ2DefaultGridGeometryTraits
: public MapperTraits, public QuadratureTraits
{
    using SubControlVolume = PQ2SubControlVolume<GridView>;
    using SubControlVolumeFace = PQ2SubControlVolumeFace<GridView>;
 
    template<class GridGeometry, bool enableCache>
    using LocalView = PQ2FVElementGeometry<GridGeometry, enableCache>;
 
    using EnableHybridCVFE = std::true_type;
 
    // The maximum values correspond to cubes
    // This can be overwritten by the user when knowing the grid entity types
    static constexpr std::size_t maxNumElementDofs = []()
        {
            if constexpr (GridView::dimension == 1)
                return 3;
            else if constexpr (GridView::dimension == 2)
                return 9;
            else if constexpr (GridView::dimension == 3)
                return 27;
        }();
};

template<class Scalar,
         class GV,
         bool enableCaching = true,
         class Traits = PQ2DefaultGridGeometryTraits<GV>>
class PQ2FVGridGeometry
: public BaseGridGeometry<GV, Traits>
{
    using ThisType = PQ2FVGridGeometry<Scalar, GV, enableCaching, Traits>;
    using ParentType = BaseGridGeometry<GV, Traits>;
    using GridIndexType = typename IndexTraits<GV>::GridIndex;
    using LocalIndexType = typename IndexTraits<GV>::LocalIndex;
 
    using Element = typename GV::template Codim<0>::Entity;
    using CoordScalar = typename GV::ctype;
    static const int dim = GV::dimension;
    static const int dimWorld = GV::dimensionworld;
 
public:
    using DiscretizationMethod = DiscretizationMethods::PQ2;
    static constexpr DiscretizationMethod discMethod{};
 
    static constexpr bool enableHybridCVFE = Detail::enablesHybridCVFE<Traits>;
    static_assert(enableHybridCVFE, "Only hybrid scheme implemented for pq2");
 
    static constexpr std::size_t maxNumElementDofs = Traits::maxNumElementDofs;

    using BasicGridGeometry = BasicGridGeometry_t<GV, Traits>;
    using LocalView = typename Traits::template LocalView<ThisType, true>;
    using SubControlVolume = typename Traits::SubControlVolume;
    using SubControlVolumeFace = typename Traits::SubControlVolumeFace;
    using BoundaryFace = Experimental::BoundaryFace<GV>;
    using Extrusion = Extrusion_t<Traits>;
    using DofMapper = typename Traits::DofMapper;
    using FeCache = Dune::LagrangeLocalFiniteElementCache<CoordScalar, Scalar, dim, 2>;
    using GridView = GV;
    using SupportsPeriodicity = typename PeriodicGridTraits<typename GV::Grid>::SupportsPeriodicity;
    using ScvQuadratureRule = typename Traits::ScvQuadratureRule;
    using ScvfQuadratureRule = typename Traits::ScvfQuadratureRule;
    using ElementQuadratureRule = typename Traits::ElementQuadratureRule;
    using IntersectionQuadratureRule = typename Traits::IntersectionQuadratureRule;
    using BoundaryFaceQuadratureRule = typename Traits::BoundaryFaceQuadratureRule;

    PQ2FVGridGeometry(std::shared_ptr<BasicGridGeometry> gg)
    : ParentType(std::move(gg))
    , dofMapper_(this->gridView(), Traits::layout())
    , cache_(*this)
    , periodicGridTraits_(this->gridView().grid())
    {
        update_();
    }

    PQ2FVGridGeometry(const GridView& gridView)
    : PQ2FVGridGeometry(std::make_shared<BasicGridGeometry>(gridView))
    {}

    const DofMapper& dofMapper() const
    { return dofMapper_; }

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

    std::size_t numScvf() const
    { return numScvf_; }

    std::size_t numBoundaryScvf() const
    { return numBoundaryScvf_; }

    std::size_t numDofs() const
    { return this->dofMapper().size(); }

    void update(const GridView& gridView)
    {
        ParentType::update(gridView);
        update_();
    }

    void update(GridView&& gridView)
    {
        ParentType::update(std::move(gridView));
        update_();
    }

    const FeCache& feCache() const
    { return feCache_; }

    bool dofOnBoundary(GridIndexType dofIdx) const
    { return boundaryDofIndices_[dofIdx]; }

    bool dofOnPeriodicBoundary(GridIndexType dofIdx) const
    { return periodicDofMap_.count(dofIdx); }

    [[deprecated("Will be removed after release 3.11. Use periodicallyMappedDofs, returning a range of dofs")]]
    GridIndexType periodicallyMappedDof(GridIndexType dofIdx) const
    { return periodicDofMap_.at(dofIdx)[0]; }

    const std::ranges::range auto periodicallyMappedDofs(GridIndexType dofIdx) const
    { return std::views::all(periodicDofMap_.at(dofIdx)); }

    const std::unordered_map<GridIndexType, std::vector<GridIndexType>>& periodicDofMap() const
    { return periodicDofMap_; }

    friend inline LocalView localView(const PQ2FVGridGeometry& gg)
    { return { gg.cache_ }; }
 
private:
 
    class PQ2GridGeometryCache
    {
        friend class PQ2FVGridGeometry;
    public:
        using GeometryHelper = Detail::PQ2GeometryHelper_t<GV, Traits>;
        using DofHelper = typename GeometryHelper::DofHelper;
 
        explicit PQ2GridGeometryCache(const PQ2FVGridGeometry& gg)
        : gridGeometry_(&gg)
        {}
 
        const PQ2FVGridGeometry& gridGeometry() const
        { return *gridGeometry_; }

        const std::vector<SubControlVolume>& scvs(GridIndexType eIdx) const
        { return scvs_[eIdx]; }

        const std::vector<SubControlVolumeFace>& scvfs(GridIndexType eIdx) const
        { return scvfs_[eIdx]; }

        bool hasBoundaryScvf(GridIndexType eIdx) const
        { return hasBoundaryScvf_[eIdx]; }

        const std::vector<std::array<LocalIndexType, 2>>& scvfBoundaryGeometryKeys(GridIndexType eIdx) const
        { return scvfBoundaryGeometryKeys_.at(eIdx); }

        auto boundaryFaces(GridIndexType eIdx) const -> std::span<const BoundaryFace>
        {
            if (auto it = boundaryFaces_.find(eIdx); it != boundaryFaces_.end())
                return {it->second};
            return {};
        }

        const auto& boundaryFaceScvfRanges(GridIndexType eIdx) const
        { return boundaryFaceScvfRanges_.at(eIdx); }
 
    private:
        void clear_()
        {
            scvs_.clear();
            scvfs_.clear();
            hasBoundaryScvf_.clear();
            scvfBoundaryGeometryKeys_.clear();
            boundaryFaces_.clear();
            boundaryFaceScvfRanges_.clear();
        }
 
        std::vector<std::vector<SubControlVolume>> scvs_;
        std::vector<std::vector<SubControlVolumeFace>> scvfs_;
        std::vector<bool> hasBoundaryScvf_;
        std::unordered_map<GridIndexType, std::vector<std::array<LocalIndexType, 2>>> scvfBoundaryGeometryKeys_;
        std::unordered_map<GridIndexType, Dune::ReservedVector<typename PQ2FVGridGeometry::BoundaryFace, 2*dim>> boundaryFaces_;
        std::unordered_map<GridIndexType, Dune::ReservedVector<std::array<LocalIndexType, 2>, 2*dim>> boundaryFaceScvfRanges_;
 
        const PQ2FVGridGeometry* gridGeometry_;
    };
 
public:
    using Cache = PQ2GridGeometryCache;
 
private:
    using GeometryHelper = typename Cache::GeometryHelper;
    using DofHelper = typename GeometryHelper::DofHelper;
 
    void update_()
    {
        cache_.clear_();
        dofMapper_.update(this->gridView());
 
        auto numElements = this->gridView().size(0);
        cache_.scvs_.resize(numElements);
        cache_.scvfs_.resize(numElements);
        cache_.hasBoundaryScvf_.resize(numElements, false);
 
        boundaryDofIndices_.assign(numDofs(), false);
        periodicDofMap_.clear();
 
        numScv_ = 0;
        numScvf_ = 0;
        numBoundaryScvf_ = 0;
 
        // Build the scvs and scv faces
        for (const auto& element : elements(this->gridView()))
        {
            auto eIdx = this->elementMapper().index(element);
 
            // get the element geometry
            auto elementGeometry = element.geometry();
 
            const auto& localCoefficients = this->feCache().get(element.type()).localCoefficients();
 
            // instantiate the geometry helper
            GeometryHelper geometryHelper(elementGeometry);
 
            numScv_ += geometryHelper.numScv();
            // construct the sub control volumes
            cache_.scvs_[eIdx].resize(geometryHelper.numScv());
 
            for (LocalIndexType keyIdx = 0; keyIdx < localCoefficients.size(); ++keyIdx)
            {
                const auto& localKey = localCoefficients.localKey(keyIdx);
                // If the dof is a vertex, we construct scvs
                if(localKey.codim() == dim)
                {
                    const auto localIdx = localKey.subEntity();
                    // With the new localIdx, scvs can be constructed as for the Box method
                    auto corners = geometryHelper.getScvCorners(localIdx);
                    cache_.scvs_[eIdx][localIdx] = SubControlVolume(
                        geometryHelper.scvVolume(localIdx, corners),
                        DofHelper::dofPosition(elementGeometry, localKey),
                        Dumux::center(corners),
                        localIdx,
                        keyIdx,
                        eIdx,
                        DofHelper::dofIndex(this->dofMapper(), element, localKey),
                        false
                    );
                }
            }
 
            // construct the sub control volume faces, this is the same as for the Box method
            const auto numInteriorScvfs = GeometryHelper::numInteriorScvf(elementGeometry.type());
            numScvf_ += numInteriorScvfs;
            cache_.scvfs_[eIdx].resize(numInteriorScvfs);
            LocalIndexType scvfLocalIdx = 0;
            for (; scvfLocalIdx < numInteriorScvfs; ++scvfLocalIdx)
            {
                const auto scvPair = geometryHelper.getScvPairForScvf(scvfLocalIdx);
                const auto corners = geometryHelper.getScvfCorners(scvfLocalIdx);
                const auto area = Dumux::convexPolytopeVolume<dim-1>(
                    geometryHelper.getInteriorScvfGeometryType(scvfLocalIdx),
                    [&](unsigned int i){ return corners[i]; }
                );
 
                cache_.scvfs_[eIdx][scvfLocalIdx] = SubControlVolumeFace(
                    Dumux::center(corners),
                    area,
                    geometryHelper.normal(corners, scvPair),
                    std::move(scvPair),
                    scvfLocalIdx,
                    geometryHelper.isOverlappingScvf(scvfLocalIdx)
                );
            }
 
            // construct the sub control volume faces on the domain boundary
            LocalIndexType numBoundaryFaces = 0;
            for (const auto& intersection : intersections(this->gridView(), element))
            {
                if (intersection.boundary() && !intersection.neighbor())
                {
                    cache_.hasBoundaryScvf_[eIdx] = true;
 
                    // add one boundary face per boundary intersection
                    const auto isGeometry = intersection.geometry();
                    cache_.boundaryFaces_[eIdx].push_back(BoundaryFace{
                        isGeometry.center(),
                        isGeometry.volume(),
                        intersection.centerUnitOuterNormal(),
                        numBoundaryFaces++,
                        static_cast<LocalIndexType>(intersection.indexInInside()),
                        typename BoundaryFace::Traits::BoundaryFlag{intersection}
                    });
 
                    const auto localFacetIndex = intersection.indexInInside();
                    const auto numBoundaryScvf = GeometryHelper::numBoundaryScvf(elementGeometry.type(), localFacetIndex);
                    numScvf_ += numBoundaryScvf;
                    numBoundaryScvf_ += numBoundaryScvf;
 
                    // record the scvf subrange for this boundary face: {offset, count}
                    cache_.boundaryFaceScvfRanges_[eIdx].push_back(std::array<LocalIndexType, 2>{{
                        scvfLocalIdx,
                        static_cast<LocalIndexType>(numBoundaryScvf)
                    }});
 
                    for (unsigned int isScvfLocalIdx = 0; isScvfLocalIdx < numBoundaryScvf; ++isScvfLocalIdx)
                    {
                        // find the scvs this scvf is belonging to
                        const auto scvPair = geometryHelper.getScvPairForBoundaryScvf(localFacetIndex, isScvfLocalIdx);
                        const auto corners = geometryHelper.getBoundaryScvfCorners(localFacetIndex, isScvfLocalIdx);
                        const auto area = Dumux::convexPolytopeVolume<dim-1>(
                            geometryHelper.getBoundaryScvfGeometryType(isScvfLocalIdx),
                            [&](unsigned int i){ return corners[i]; }
                        );
                        cache_.scvfs_[eIdx].emplace_back(
                            Dumux::center(corners),
                            area,
                            intersection.centerUnitOuterNormal(),
                            std::move(scvPair),
                            scvfLocalIdx,
                            typename SubControlVolumeFace::Traits::BoundaryFlag{ intersection },
                            geometryHelper.isOverlappingBoundaryScvf(localFacetIndex)
                        );
 
                        // store look-up map to construct boundary scvf geometries
                        cache_.scvfBoundaryGeometryKeys_[eIdx].emplace_back(std::array<LocalIndexType, 2>{{
                            static_cast<LocalIndexType>(localFacetIndex),
                            static_cast<LocalIndexType>(isScvfLocalIdx)
                        }});
 
                        // increment local counter
                        scvfLocalIdx++;
                    }
 
                    for (LocalIndexType keyIdx = 0; keyIdx < localCoefficients.size(); ++keyIdx)
                    {
                        if(DofHelper::localDofOnIntersection(elementGeometry.type(), intersection.indexInInside(), localCoefficients.localKey(keyIdx)))
                        {
                            const auto dofIdxGlobal = DofHelper::dofIndex(this->dofMapper(), element, localCoefficients.localKey(keyIdx));
                            boundaryDofIndices_[dofIdxGlobal] = true;
                        }
                    }
                }
 
                // inform the grid geometry if we have periodic boundaries
                else if (periodicGridTraits_.isPeriodic(intersection))
                {
                    this->setPeriodic();
 
                    // find the mapped periodic vertex of all vertices on periodic boundaries
                    const auto eps = 1e-7*(elementGeometry.corner(1) - elementGeometry.corner(0)).two_norm();
                    for (int localDofIdx = 0; localDofIdx < localCoefficients.size(); ++localDofIdx)
                    {
                        if(!DofHelper::localDofOnIntersection(elementGeometry.type(), intersection.indexInInside(), localCoefficients.localKey(localDofIdx)))
                            continue;
 
                        const auto dofIdxGlobal = DofHelper::dofIndex(this->dofMapper(), element, localCoefficients.localKey(localDofIdx));
                        const auto dofPos = DofHelper::dofPosition(elementGeometry, localCoefficients.localKey(localDofIdx));
 
                        const auto& outside = intersection.outside();
                        const auto outsideGeometry = outside.geometry();
                        const auto& localCoefficientsOut = this->feCache().get(outsideGeometry.type()).localCoefficients();
                        for (const auto& isOutside : intersections(this->gridView(), outside))
                        {
                            // only check periodic vertices of the periodic neighbor
                            if (periodicGridTraits_.isPeriodic(isOutside))
                            {
                                for (int localDofIdxOut = 0; localDofIdxOut < localCoefficientsOut.size(); ++localDofIdxOut)
                                {
                                    const auto& localKeyOut = localCoefficientsOut.localKey(localDofIdxOut);
                                    if(!DofHelper::localDofOnIntersection(outsideGeometry.type(), isOutside.indexInInside(), localKeyOut))
                                        continue;
 
                                    const auto dofIdxGlobalOut = DofHelper::dofIndex(this->dofMapper(), outside, localKeyOut);
                                    const auto dofPosOutside =  DofHelper::dofPosition(outsideGeometry, localKeyOut);
                                    const auto shift = std::abs((this->bBoxMax()-this->bBoxMin())*intersection.centerUnitOuterNormal());
                                    if ((dofPosOutside - dofPos + shift*intersection.centerUnitOuterNormal()).two_norm() < eps)
                                        Dumux::Detail::addPeriodicallyMappedDof(periodicDofMap_, dofIdxGlobal, dofIdxGlobalOut);
                                }
                            }
                        }
                    }
                }
            }
        }
 
        Dumux::Detail::closePeriodicDofMap(periodicDofMap_);
 
        // error check: periodic boundaries currently don't work for pq2 in parallel
        if (this->isPeriodic() && this->gridView().comm().size() > 1)
            DUNE_THROW(Dune::NotImplemented, "Periodic boundaries for pq2 method for parallel simulations!");
    }
 
    DofMapper dofMapper_;
 
    const FeCache feCache_;
 
    std::size_t numScv_;
    std::size_t numScvf_;
    std::size_t numBoundaryScvf_;
 
    // dofs on the boundary
    std::vector<bool> boundaryDofIndices_;
 
    // a map for periodic boundary dofs
    std::unordered_map<GridIndexType, std::vector<GridIndexType>> periodicDofMap_;
 
    Cache cache_;
 
    PeriodicGridTraits<typename GridView::Grid> periodicGridTraits_;
};
 
} // end namespace Dumux
 
#endif