porousmediumflow/boxdfm/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_POROUSMEDIUMFLOW_BOXDFM_GRID_FVGEOMETRY_HH
#define DUMUX_POROUSMEDIUMFLOW_BOXDFM_GRID_FVGEOMETRY_HH
 
#include <ranges>
#include <span>
#include <utility>
#include <unordered_map>
 
#include <dune/localfunctions/lagrange/lagrangelfecache.hh>
#include <dune/geometry/multilineargeometry.hh>
#include <dune/grid/common/mcmgmapper.hh>
 
#include <dumux/discretization/method.hh>
#include <dumux/common/indextraits.hh>
#include <dumux/common/defaultmappertraits.hh>
#include <dumux/discretization/basegridgeometry.hh>
#include <dumux/discretization/box/boxgeometryhelper.hh>
#include <dumux/discretization/extrusion.hh>
 
#include "fvelementgeometry.hh"
#include "geometryhelper.hh"
#include "subcontrolvolume.hh"
#include "subcontrolvolumeface.hh"
 
namespace Dumux {
 
namespace Detail {
template<class GV, class T>
using BoxDfmGeometryHelper_t = Dune::Std::detected_or_t<
    Dumux::BoxDfmGeometryHelper<GV, GV::dimension, typename T::SubControlVolume, typename T::SubControlVolumeFace>,
    SpecifiesGeometryHelper,
    T
>;
} // end namespace Detail

template<class GridView, class MapperTraits = DefaultMapperTraits<GridView>>
struct BoxDfmDefaultGridGeometryTraits
: public MapperTraits
{
    using SubControlVolume = BoxDfmSubControlVolume<GridView>;
    using SubControlVolumeFace = BoxDfmSubControlVolumeFace<GridView>;
 
    template<class GridGeometry, bool enableCache>
    using LocalView = BoxDfmFVElementGeometry<GridGeometry, enableCache>;
 
    // Mapper type for mapping edges
    using FacetMapper = Dune::MultipleCodimMultipleGeomTypeMapper<GridView>;
};

template<class Scalar,
         class GridView,
         bool enableGridGeometryCache = false,
         class Traits = BoxDfmDefaultGridGeometryTraits<GridView> >
class BoxDfmFVGridGeometry;

template<class Scalar, class GV, class Traits>
class BoxDfmFVGridGeometry<Scalar, GV, true, Traits>
: public BaseGridGeometry<GV, Traits>
{
    using ThisType = BoxDfmFVGridGeometry<Scalar, GV, true, 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;
    static_assert(dim == 2 || dim == 3, "The box-dfm GridGeometry is only implemented in 2 or 3 dimensions.");
 
public:
    using DiscretizationMethod = DiscretizationMethods::Box;
    static constexpr DiscretizationMethod discMethod{};

    using LocalView = typename Traits::template LocalView<ThisType, true>;
    using SubControlVolume = typename Traits::SubControlVolume;
    using SubControlVolumeFace = typename Traits::SubControlVolumeFace;
    using Extrusion = Extrusion_t<Traits>;
    using DofMapper = typename Traits::VertexMapper;
    using FeCache = Dune::LagrangeLocalFiniteElementCache<CoordScalar, Scalar, dim, 1>;
    using GridView = GV;

    template< class FractureGridAdapter >
    BoxDfmFVGridGeometry(const GridView gridView, const FractureGridAdapter& fractureGridAdapter)
    : ParentType(gridView)
    , cache_(*this)
    {
        update_(fractureGridAdapter);
    }

    const DofMapper& dofMapper() const
    { return this->vertexMapper(); }

    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->gridView().size(dim); }

    template< class FractureGridAdapter >
    void update(const GridView& gridView, const FractureGridAdapter& fractureGridAdapter)
    {
        ParentType::update(gridView);
        update_(fractureGridAdapter);
    }

    template< class FractureGridAdapter >
    void update(GridView&& gridView, const FractureGridAdapter& fractureGridAdapter)
    {
        ParentType::update(std::move(gridView));
        update_(fractureGridAdapter);
    }

    const FeCache& feCache() const { return feCache_; }
    bool dofOnBoundary(unsigned int dofIdx) const { return boundaryDofIndices_[dofIdx]; }
    bool dofOnFracture(unsigned int dofIdx) const { return fractureDofIndices_[dofIdx]; }
    bool dofOnPeriodicBoundary(std::size_t dofIdx) const { return false; }

    [[deprecated("Will be removed after release 3.11. Use periodicallyMappedDofs, returning a range of dofs")]]
    std::size_t periodicallyMappedDof(std::size_t dofIdx) const
    { DUNE_THROW(Dune::InvalidStateException, "Periodic boundaries are not supported by the box-dfm scheme"); }

    std::span<const std::size_t> periodicallyMappedDofs(std::size_t dofIdx) const
    { DUNE_THROW(Dune::InvalidStateException, "Periodic boundaries are not supported by the box-dfm scheme"); }

    friend inline LocalView localView(const BoxDfmFVGridGeometry& gg)
    { return { gg.cache_ }; }
 
private:
 
    class BoxDfmGridGeometryCache
    {
        friend class BoxDfmFVGridGeometry;
    public:
        using GeometryHelper = Detail::BoxDfmGeometryHelper_t<GV, Traits>;
 
        explicit BoxDfmGridGeometryCache(const BoxDfmFVGridGeometry& gg)
        : gridGeometry_(&gg)
        {}
 
        const BoxDfmFVGridGeometry& 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]; }
 
 
    private:
        void clear_()
        {
            scvs_.clear();
            scvfs_.clear();
        }
 
        std::vector<std::vector<SubControlVolume>> scvs_;
        std::vector<std::vector<SubControlVolumeFace>> scvfs_;
 
        const BoxDfmFVGridGeometry* gridGeometry_;
    };
 
public:
    using Cache = BoxDfmGridGeometryCache;
 
private:
    using GeometryHelper = typename Cache::GeometryHelper;
 
    template< class FractureGridAdapter >
    void update_(const FractureGridAdapter& fractureGridAdapter)
    {
        cache_.clear_();
 
        const auto numElements = this->gridView().size(0);
        cache_.scvs_.resize(numElements);
        cache_.scvfs_.resize(numElements);
 
        boundaryDofIndices_.assign(numDofs(), false);
        fractureDofIndices_.assign(this->gridView.size(dim), false);
 
        numScv_ = 0;
        numScvf_ = 0;
        numBoundaryScvf_ = 0;
        // Build the SCV and SCV faces
        for (const auto& element : elements(this->gridView()))
        {
            // fill the element map with seeds
            const auto eIdx = this->elementMapper().index(element);
 
            // count
            numScv_ += element.subEntities(dim);
            numScvf_ += element.subEntities(dim-1);
 
            // get the element geometry
            auto elementGeometry = element.geometry();
            const auto refElement = referenceElement(elementGeometry);
 
            // instantiate the geometry helper
            GeometryHelper geometryHelper(elementGeometry);
 
            // construct the sub control volumes
            cache_.scvs_[eIdx].resize(elementGeometry.corners());
            for (LocalIndexType scvLocalIdx = 0; scvLocalIdx < elementGeometry.corners(); ++scvLocalIdx)
            {
                const auto dofIdxGlobal = this->vertexMapper().subIndex(element, scvLocalIdx, dim);
 
                cache_.scvs_[eIdx][scvLocalIdx] = SubControlVolume(geometryHelper,
                                                                   scvLocalIdx,
                                                                   eIdx,
                                                                   dofIdxGlobal);
            }
 
            // construct the sub control volume faces
            LocalIndexType scvfLocalIdx = 0;
            cache_.scvfs_[eIdx].resize(element.subEntities(dim-1));
            for (; scvfLocalIdx < element.subEntities(dim-1); ++scvfLocalIdx)
            {
                // find the global and local scv indices this scvf is belonging 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))
                }};
 
                cache_.scvfs_[eIdx][scvfLocalIdx] = SubControlVolumeFace(geometryHelper,
                                                                         element,
                                                                         scvfLocalIdx,
                                                                         std::move(localScvIndices));
            }
 
            // construct the ...
            // ... sub-control volume faces on the domain boundary
            // ... sub-control volumes on fracture facets
            // ... sub-control volume faces on fracture facets
            // NOTE We do not construct fracture scvfs on boundaries here!
            //      That means specifying Neumann fluxes on only the fractures is not possible
            //      However, it is difficult to interpret this here as a fracture ending on the boundary
            //      could also be connected to a facet which is both boundary and fracture at the same time!
            //      In that case, the fracture boundary scvf wouldn't make sense. In order to do it properly
            //      we would have to find only those fractures that are at the boundary and aren't connected
            //      to a fracture which is a boundary.
            LocalIndexType scvLocalIdx = element.subEntities(dim);
            for (const auto& intersection : intersections(this->gridView(), element))
            {
                // first, obtain all vertex indices on this intersection
                const auto& isGeometry = intersection.geometry();
                const auto numCorners = isGeometry.corners();
                const auto idxInInside = intersection.indexInInside();
 
                std::vector<GridIndexType> isVertexIndices(numCorners);
                for (unsigned int vIdxLocal = 0; vIdxLocal < numCorners; ++vIdxLocal)
                    isVertexIndices[vIdxLocal] = this->vertexMapper().subIndex(element,
                                                                               refElement.subEntity(idxInInside, 1, vIdxLocal, dim),
                                                                               dim);
                // maybe add boundary scvf
                if (intersection.boundary() && !intersection.neighbor())
                {
                    numScvf_ += isGeometry.corners();
                    numBoundaryScvf_ += isGeometry.corners();
 
                    for (unsigned int isScvfLocalIdx = 0; isScvfLocalIdx < numCorners; ++isScvfLocalIdx)
                    {
                        // find the scvs this scvf is belonging to
                        const LocalIndexType insideScvIdx = static_cast<LocalIndexType>(refElement.subEntity(idxInInside, 1, isScvfLocalIdx, dim));
                        std::array<LocalIndexType, 2> localScvIndices{{insideScvIdx, insideScvIdx}};
                        cache_.scvfs_[eIdx].emplace_back(geometryHelper,
                                                         intersection,
                                                         isScvfLocalIdx,
                                                         scvfLocalIdx++,
                                                         std::move(localScvIndices));
                    }
 
                    // add all vertices on the intersection to the set of
                    // boundary vertices
                    const auto numFaceVerts = refElement.size(idxInInside, 1, dim);
                    for (int localVIdx = 0; localVIdx < numFaceVerts; ++localVIdx)
                    {
                        const auto vIdx = refElement.subEntity(idxInInside, 1, localVIdx, dim);
                        const auto vIdxGlobal = this->vertexMapper().subIndex(element, vIdx, dim);
                        boundaryDofIndices_[vIdxGlobal] = true;
                    }
                }
                // TODO: should use periodicGridTraits but carrying them around just to verify no
                // periodicity?
                // make sure we have no periodic boundaries
                else if (intersection.boundary() && intersection.neighbor())
                    DUNE_THROW(Dune::InvalidStateException, "Periodic boundaries are not supported by the box-dfm scheme");
 
                // maybe add fracture scvs & scvfs
                if (fractureGridAdapter.composeFacetElement(isVertexIndices))
                {
                    for (auto vIdx : isVertexIndices)
                        fractureDofIndices_[vIdx] = true;
 
                    // add fracture scv for each vertex of intersection
                    numScv_ += numCorners;
                    const auto curNumScvs = cache_.scvs_[eIdx].size();
                    cache_.scvs_[eIdx].reserve(curNumScvs+numCorners);
                    for (unsigned int vIdxLocal = 0; vIdxLocal < numCorners; ++vIdxLocal)
                        cache_.scvs_[eIdx].emplace_back(geometryHelper,
                                                        intersection,
                                                        isGeometry,
                                                        vIdxLocal,
                                                        static_cast<LocalIndexType>(refElement.subEntity(idxInInside, 1, vIdxLocal, dim)),
                                                        scvLocalIdx++,
                                                        idxInInside,
                                                        eIdx,
                                                        isVertexIndices[vIdxLocal]);
 
                    // add fracture scvf for each edge of the intersection in 3d
                    if (dim == 3)
                    {
                        const auto& faceRefElement = referenceElement(isGeometry);
                        for (unsigned int edgeIdx = 0; edgeIdx < faceRefElement.size(1); ++edgeIdx)
                        {
                            // inside/outside scv indices in face local node numbering
                            std::array<LocalIndexType, 2> localScvIndices{{
                                static_cast<LocalIndexType>(faceRefElement.subEntity(edgeIdx, 1, 0, dim-1)),
                                static_cast<LocalIndexType>(faceRefElement.subEntity(edgeIdx, 1, 1, dim-1))
                            }};
 
                            // add offset to get the right scv indices
                            std::for_each( localScvIndices.begin(),
                                           localScvIndices.end(),
                                           [curNumScvs] (auto& elemLocalIdx) { elemLocalIdx += curNumScvs; } );
 
                            // add scvf
                            numScvf_++;
                            cache_.scvfs_[eIdx].emplace_back(geometryHelper,
                                                             intersection,
                                                             edgeIdx,
                                                             scvfLocalIdx++,
                                                             std::move(localScvIndices),
                                                             intersection.boundary());
                        }
                    }
 
                    // dim == 2, intersection is an edge, make 1 scvf
                    else
                    {
                        // inside/outside scv indices in face local node numbering
                        std::array<LocalIndexType, 2> localScvIndices{{0, 1}};
 
                        // add offset such that the fracture scvs above are addressed
                        std::for_each( localScvIndices.begin(),
                                       localScvIndices.end(),
                                       [curNumScvs] (auto& elemLocalIdx) { elemLocalIdx += curNumScvs; } );
 
                        // add scvf
                        numScvf_++;
                        cache_.scvfs_[eIdx].emplace_back(geometryHelper,
                                                         intersection,
                                                         /*idxOnIntersection*/0,
                                                         scvfLocalIdx++,
                                                         std::move(localScvIndices),
                                                         intersection.boundary());
                    }
                }
            }
        }
    }
 
    const FeCache feCache_;
 
    // TODO do we need those?
    std::size_t numScv_;
    std::size_t numScvf_;
    std::size_t numBoundaryScvf_;
 
    // vertices on the boundary & fracture facets
    std::vector<bool> boundaryDofIndices_;
    std::vector<bool> fractureDofIndices_;
 
    Cache cache_;
};

template<class Scalar, class GV, class Traits>
class BoxDfmFVGridGeometry<Scalar, GV, false, Traits>
: public BaseGridGeometry<GV, Traits>
{
    using ThisType = BoxDfmFVGridGeometry<Scalar, GV, false, Traits>;
    using ParentType = BaseGridGeometry<GV, Traits>;
    using GridIndexType = typename GV::IndexSet::IndexType;
 
    static const int dim = GV::dimension;
    static const int dimWorld = GV::dimensionworld;
 
    using Element = typename GV::template Codim<0>::Entity;
    using Intersection = typename GV::Intersection;
    using CoordScalar = typename GV::ctype;
 
public:
    using DiscretizationMethod = DiscretizationMethods::Box;
    static constexpr DiscretizationMethod discMethod{};

    using LocalView = typename Traits::template LocalView<ThisType, false>;
    using SubControlVolume = typename Traits::SubControlVolume;
    using SubControlVolumeFace = typename Traits::SubControlVolumeFace;
    using Extrusion = Extrusion_t<Traits>;
    using DofMapper = typename Traits::VertexMapper;
    using FeCache = Dune::LagrangeLocalFiniteElementCache<CoordScalar, Scalar, dim, 1>;
    using GridView = GV;

    template< class FractureGridAdapter >
    BoxDfmFVGridGeometry(const GridView gridView, const FractureGridAdapter& fractureGridAdapter)
    : ParentType(gridView)
    , facetMapper_(gridView, Dune::mcmgLayout(Dune::template Codim<1>()))
    , cache_(*this)
    {
        update_(fractureGridAdapter);
    }

    const DofMapper& dofMapper() const
    { return this->vertexMapper(); }

    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->gridView().size(dim); }

    template< class FractureGridAdapter >
    void update(const GridView& gridView, const FractureGridAdapter& fractureGridAdapter)
    {
        ParentType::update(gridView);
        updateFacetMapper_();
        update_(fractureGridAdapter);
    }

    template< class FractureGridAdapter >
    void update(GridView&& gridView, const FractureGridAdapter& fractureGridAdapter)
    {
        ParentType::update(std::move(gridView));
        updateFacetMapper_();
        update_(fractureGridAdapter);
    }

    const FeCache& feCache() const { return feCache_; }
    bool dofOnBoundary(unsigned int dofIdx) const { return boundaryDofIndices_[dofIdx]; }
    bool dofOnFracture(unsigned int dofIdx) const { return fractureDofIndices_[dofIdx]; }
    bool dofOnPeriodicBoundary(std::size_t dofIdx) const { return false; }

    bool isOnFracture(const Element& element, const Intersection& intersection) const
    { return facetOnFracture_[facetMapper_.subIndex(element, intersection.indexInInside(), 1)]; }

    [[deprecated("Will be removed after release 3.11. Use periodicallyMappedDofs, returning a range of dofs")]]
    std::size_t periodicallyMappedDof(std::size_t dofIdx) const
    { DUNE_THROW(Dune::InvalidStateException, "Periodic boundaries are not supported by the box-dfm scheme"); }

    std::span<const std::size_t> periodicallyMappedDofs(std::size_t dofIdx) const
    { DUNE_THROW(Dune::InvalidStateException, "Periodic boundaries are not supported by the box-dfm scheme"); }

    friend inline LocalView localView(const BoxDfmFVGridGeometry& gg)
    { return { gg.cache_ }; }
 
private:
    class BoxDfmGridGeometryCache
    {
        friend class BoxDfmFVGridGeometry;
    public:
        using GeometryHelper = Detail::BoxDfmGeometryHelper_t<GV, Traits>;
 
        explicit BoxDfmGridGeometryCache(const BoxDfmFVGridGeometry& gg)
        : gridGeometry_(&gg)
        {}
 
        const BoxDfmFVGridGeometry& gridGeometry() const
        { return *gridGeometry_; }
 
    private:
        const BoxDfmFVGridGeometry* gridGeometry_;
    };
 
public:
    using Cache = BoxDfmGridGeometryCache;
 
private:
 
    void updateFacetMapper_()
    {
        facetMapper_.update(this->gridView());
    }
 
    template< class FractureGridAdapter >
    void update_(const FractureGridAdapter& fractureGridAdapter)
    {
        boundaryDofIndices_.assign(numDofs(), false);
        fractureDofIndices_.assign(numDofs(), false);
        facetOnFracture_.assign(this->gridView().size(1), false);
 
        // save global data on the grid's scvs and scvfs
        // TODO do we need those information?
        numScv_ = 0;
        numScvf_ = 0;
        numBoundaryScvf_ = 0;
        for (const auto& element : elements(this->gridView()))
        {
            numScv_ += element.subEntities(dim);
            numScvf_ += element.subEntities(dim-1);
 
            const auto elementGeometry = element.geometry();
            const auto refElement = referenceElement(elementGeometry);
 
            // store the sub control volume face indices on the domain boundary
            for (const auto& intersection : intersections(this->gridView(), element))
            {
                // first, obtain all vertex indices on this intersection
                const auto& isGeometry = intersection.geometry();
                const auto numCorners = isGeometry.corners();
                const auto idxInInside = intersection.indexInInside();
 
                std::vector<GridIndexType> isVertexIndices(numCorners);
                for (unsigned int vIdxLocal = 0; vIdxLocal < numCorners; ++vIdxLocal)
                    isVertexIndices[vIdxLocal] = this->vertexMapper().subIndex(element,
                                                                               refElement.subEntity(idxInInside, 1, vIdxLocal, dim),
                                                                               dim);
 
                if (intersection.boundary() && !intersection.neighbor())
                {
                    numScvf_ += numCorners;
                    numBoundaryScvf_ += numCorners;
 
                    // add all vertices on the intersection to the set of
                    // boundary vertices
                    const auto fIdx = intersection.indexInInside();
                    const auto numFaceVerts = refElement.size(fIdx, 1, dim);
                    for (int localVIdx = 0; localVIdx < numFaceVerts; ++localVIdx)
                    {
                        const auto vIdx = refElement.subEntity(fIdx, 1, localVIdx, dim);
                        const auto vIdxGlobal = this->vertexMapper().subIndex(element, vIdx, dim);
                        boundaryDofIndices_[vIdxGlobal] = true;
                    }
                }
 
                // make sure we have no periodic boundaries
                else if (intersection.boundary() && intersection.neighbor())
                    DUNE_THROW(Dune::InvalidStateException, "Periodic boundaries are not supported by the box-dfm scheme");
 
                // maybe add fracture scvs & scvfs
                if (fractureGridAdapter.composeFacetElement(isVertexIndices))
                {
                    facetOnFracture_[facetMapper_.subIndex(element, idxInInside, 1)] = true;
                    for (auto vIdx : isVertexIndices)
                        fractureDofIndices_[vIdx] = true;
 
                    const auto isGeometry = intersection.geometry();
                    numScv_ += isGeometry.corners();
                    numScvf_ += dim == 3 ? referenceElement(isGeometry).size(1) : 1;
                }
            }
        }
    }
 
    const FeCache feCache_;
 
    // Information on the global number of geometries
    // TODO do we need those information?
    std::size_t numScv_;
    std::size_t numScvf_;
    std::size_t numBoundaryScvf_;
 
    // vertices on the boundary & fracture facets
    std::vector<bool> boundaryDofIndices_;
    std::vector<bool> fractureDofIndices_;
 
    // facet mapper and markers which facets lie on interior boundaries
    typename Traits::FacetMapper facetMapper_;
    std::vector<bool> facetOnFracture_;
 
    Cache cache_;
};
 
} // end namespace Dumux
 
#endif