discretization/cellcentered/mpfa/subcontrolvolumeface.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-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_DISCRETIZATION_CC_MPFA_SUBCONTROLVOLUMEFACE_HH
#define DUMUX_DISCRETIZATION_CC_MPFA_SUBCONTROLVOLUMEFACE_HH
 
#include <utility>
#include <vector>
#include <array>
 
#include <dune/common/reservedvector.hh>
#include <dune/common/fvector.hh>
#include <dune/geometry/type.hh>
#include <dune/geometry/multilineargeometry.hh>
 
#include <dumux/common/indextraits.hh>
#include <dumux/common/boundaryflag.hh>
 
namespace Dumux {
 
template<class GridView>
struct CCMpfaDefaultScvfGeometryTraits
{
    using Grid = typename GridView::Grid;
 
    static const int dim = Grid::dimension;
    static const int dimWorld = Grid::dimensionworld;
 
    using Scalar = typename Grid::ctype;
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
    using OutsideGridIndexStorage = typename std::conditional_t< (dim<dimWorld),
                                                                 std::vector<GridIndexType>,
                                                                 Dune::ReservedVector<GridIndexType, 1> >;
 
    // we use geometry traits that use static corner vectors to and a fixed geometry type
    template <class ct>
    struct ScvfMLGTraits : public Dune::MultiLinearGeometryTraits<ct>
    {
        // we use static vectors to store the corners as we know
        // the number of corners in advance (2^(dim-1) corners (1<<(dim-1))
        template< int mydim, int cdim >
        struct CornerStorage
        {
            using Type = std::array< Dune::FieldVector< ct, cdim >, (1<<(dim-1)) >;
        };
 
        // we know all scvfs will have the same geometry type
        template< int dim >
        struct hasSingleGeometryType
        {
            static const bool v = true;
            static const unsigned int topologyId = Dune::GeometryTypes::cube(dim).id();
        };
    };
 
    using Geometry = Dune::MultiLinearGeometry<Scalar, dim-1, dimWorld, ScvfMLGTraits<Scalar> >;
    using CornerStorage = typename ScvfMLGTraits<Scalar>::template CornerStorage<dim-1, dimWorld>::Type;
    using GlobalPosition = typename CornerStorage::value_type;
    using BoundaryFlag = Dumux::BoundaryFlag<Grid>;
};
 
template<class GV,
         class T = CCMpfaDefaultScvfGeometryTraits<GV> >
class CCMpfaSubControlVolumeFace
{
    using GridIndexType = typename T::GridIndexType;
    using Scalar = typename T::Scalar;
    using CornerStorage = typename T::CornerStorage;
    using OutsideGridIndexStorage = typename T::OutsideGridIndexStorage;
    using Geometry = typename T::Geometry;
    using BoundaryFlag = typename T::BoundaryFlag;
 
public:
    // Information on the intersection from which this scvf was constructed
    struct FacetInfo
    {
        GridIndexType elementIndex;
        int facetIndex;
        int facetCornerIndex;
    };
 
    using GlobalPosition = typename T::GlobalPosition;
    using Traits = T;
 
    template<class MpfaHelper, class Intersection>
    CCMpfaSubControlVolumeFace(const MpfaHelper& helper,
                               CornerStorage&& corners,
                               const Intersection& intersection,
                               FacetInfo facetInfo,
                               GridIndexType vIdxGlobal,
                               unsigned int vIdxLocal,
                               GridIndexType scvfIndex,
                               GridIndexType insideScvIdx,
                               const OutsideGridIndexStorage& outsideScvIndices,
                               Scalar q,
                               bool boundary)
    : boundary_(boundary)
    , vertexIndex_(vIdxGlobal)
    , scvfIndex_(scvfIndex)
    , insideScvIdx_(insideScvIdx)
    , outsideScvIndices_(outsideScvIndices)
    , vIdxInElement_(vIdxLocal)
    , corners_(std::move(corners))
    , center_(0.0)
    , unitOuterNormal_(intersection.centerUnitOuterNormal())
    , boundaryFlag_{intersection}
    , facetInfo_{std::move(facetInfo)}
    {
          // compute the center of the scvf
          for (const auto& corner : corners_)
              center_ += corner;
          center_ /= corners_.size();
 
          // use helper class to obtain area & integration point
          ipGlobal_ = helper.getScvfIntegrationPoint(corners_, q);
          area_ = helper.computeScvfArea(corners_);
    }
 
    Scalar area() const
    { return area_; }
 
    bool boundary() const
    { return boundary_; }
 
    GridIndexType index() const
    { return scvfIndex_; }
 
    GridIndexType vertexIndex() const
    { return vertexIndex_; }
 
    unsigned int vertexIndexInElement() const
    { return vIdxInElement_; }
 
    GridIndexType insideScvIdx() const
    { return insideScvIdx_; }
 
    std::size_t numOutsideScvs() const
    { return outsideScvIndices_.size(); }
 
    // Results in undefined behaviour if i >= numOutsideScvs()
    GridIndexType outsideScvIdx(int i = 0) const
    { return outsideScvIndices_[i]; }
 
    const OutsideGridIndexStorage& outsideScvIndices() const
    { return outsideScvIndices_; }
 
    [[deprecated("Will be removed after 3.8. Use fvGeometry.geometry(scvf).corners().")]]
    std::size_t corners() const
    { return corners_.size(); }
 
    [[deprecated("Will be removed after 3.8. Use fvGeometry.vertexCorner(scvf)")]]
    const GlobalPosition& vertexCorner() const
    { return corners_.back(); }
 
    [[deprecated("Will be removed after 3.8. Use fvGeometry.facetCorner(scvf)")]]
    const GlobalPosition& facetCorner() const
    { return corners_[0]; }
 
    const GlobalPosition& center() const
    { return center_; }
 
    const GlobalPosition& ipGlobal() const
    { return ipGlobal_; }
 
    const GlobalPosition& unitOuterNormal() const
    { return unitOuterNormal_; }
 
    typename BoundaryFlag::value_type boundaryFlag() const
    { return boundaryFlag_.get(); }
 
    const FacetInfo& facetInfo() const
    { return facetInfo_; }
 
private:
    bool boundary_;
    GridIndexType vertexIndex_;
    GridIndexType scvfIndex_;
    GridIndexType insideScvIdx_;
    OutsideGridIndexStorage outsideScvIndices_;
    unsigned int vIdxInElement_;
 
    CornerStorage corners_;
    GlobalPosition center_;
    GlobalPosition ipGlobal_;
    GlobalPosition unitOuterNormal_;
    Scalar area_;
    BoundaryFlag boundaryFlag_;
    FacetInfo facetInfo_;
};
 
} // end namespace Dumux
 
#endif