discretization/cellcentered/tpfa/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-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_DISCRETIZATION_CC_TPFA_SUBCONTROLVOLUMEFACE_HH
#define DUMUX_DISCRETIZATION_CC_TPFA_SUBCONTROLVOLUMEFACE_HH
 
#include <utility>
#include <vector>
 
#include <dune/common/reservedvector.hh>
#include <dune/geometry/type.hh>
#include <dune/geometry/multilineargeometry.hh>
 
#include <dumux/common/boundaryflag.hh>
#include <dumux/common/indextraits.hh>
 
namespace Dumux {

template<class GridView>
struct CCTpfaDefaultScvfGeometryTraits
{
    using Grid = typename GridView::Grid;
 
    static constexpr int dim = Grid::dimension;
    static constexpr int dimWorld = Grid::dimensionworld;
 
    using Scalar = typename Grid::ctype;
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
    using GridIndexStorage = typename std::conditional_t< (dim<dimWorld),
                                                          std::vector<GridIndexType>,
                                                          Dune::ReservedVector<GridIndexType, 2> >;
 
    // 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 = Dune::ReservedVector< Dune::FieldVector< ct, cdim >, (1<<(dim-1)) >;
        };
    };
 
    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 = CCTpfaDefaultScvfGeometryTraits<GV> >
class CCTpfaSubControlVolumeFace
{
    using ThisType = CCTpfaSubControlVolumeFace<GV, T>;
    using GridIndexType = typename T::GridIndexType;
    using Scalar = typename T::Scalar;
    using CornerStorage = typename T::CornerStorage;
    using GridIndexStorage = typename T::GridIndexStorage;
    using BoundaryFlag = typename T::BoundaryFlag;
 
public:
    using GlobalPosition = typename T::GlobalPosition;
    using Traits = T;
 
    // the default constructor
    CCTpfaSubControlVolumeFace() = default;

    template <class Intersection>
    CCTpfaSubControlVolumeFace(const Intersection& is,
                               const typename Intersection::Geometry& isGeometry,
                               GridIndexType scvfIndex,
                               const GridIndexStorage& scvIndices,
                               bool isBoundary)
    : area_(isGeometry.volume())
    , center_(isGeometry.center())
    , unitOuterNormal_(is.centerUnitOuterNormal())
    , scvfIndex_(scvfIndex)
    , scvIndices_(scvIndices)
    , boundary_(isBoundary)
    , boundaryFlag_{is}
    {}

    const GlobalPosition& center() const
    {
        return center_;
    }

    const GlobalPosition& ipGlobal() const
    {
        // Return center for now
        return center_;
    }

    Scalar area() const
    {
        return area_;
    }

    bool boundary() const
    {
        return boundary_;
    }

    const GlobalPosition& unitOuterNormal() const
    {
        return unitOuterNormal_;
    }

    GridIndexType insideScvIdx() const
    {
        return scvIndices_[0];
    }

    // Results in undefined behaviour if i >= numOutsideScvs()
    GridIndexType outsideScvIdx(int i = 0) const
    {
        return scvIndices_[i+1];
    }

    std::size_t numOutsideScvs() const
    {
        return scvIndices_.size()-1;
    }

    GridIndexType index() const
    {
        return scvfIndex_;
    }

    typename BoundaryFlag::value_type boundaryFlag() const
    {
        return boundaryFlag_.get();
    }
 
private:
    Scalar area_;
    GlobalPosition center_;
    GlobalPosition unitOuterNormal_;
    GridIndexType scvfIndex_;
    GridIndexStorage scvIndices_;
    bool boundary_;
    BoundaryFlag boundaryFlag_;
};
 
} // end namespace Dumux
 
#endif