discretization/box/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_BOX_SUBCONTROLVOLUMEFACE_HH
#define DUMUX_DISCRETIZATION_BOX_SUBCONTROLVOLUMEFACE_HH
 
#include <utility>
 
#include <dune/geometry/type.hh>
#include <dune/geometry/multilineargeometry.hh>
 
#include <dumux/common/boundaryflag.hh>
#include <dumux/common/indextraits.hh>
#include <dumux/geometry/volume.hh>
#include <dumux/geometry/center.hh>
#include <dumux/discretization/box/boxgeometryhelper.hh>
 
namespace Dumux {
 
template<class GridView>
struct BoxDefaultScvfGeometryTraits
{
    using Grid = typename GridView::Grid;
    static constexpr int dim = Grid::dimension;
    static constexpr int dimWorld = Grid::dimensionworld;
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
    using Scalar = typename Grid::ctype;
    using GeometryTraits = BoxMLGeometryTraits<Scalar>;
    using Geometry = Dune::MultiLinearGeometry<Scalar, dim-1, dimWorld, GeometryTraits>;
    using CornerStorage = typename GeometryTraits::template CornerStorage<dim-1, dimWorld>::Type;
    using GlobalPosition = typename Geometry::GlobalCoordinate;
    using BoundaryFlag = Dumux::BoundaryFlag<Grid>;
};
 
template<class GV,
         class T = BoxDefaultScvfGeometryTraits<GV> >
class BoxSubControlVolumeFace
{
    using ThisType = BoxSubControlVolumeFace<GV, T>;
    using GridIndexType = typename T::GridIndexType;
    using LocalIndexType = typename T::LocalIndexType;
    using Scalar = typename T::Scalar;
    using Geometry = typename T::Geometry;
    using BoundaryFlag = typename T::BoundaryFlag;
    static constexpr int dim = Geometry::mydimension;
 
public:
    using GlobalPosition = typename T::GlobalPosition;
    using Traits = T;
 
    BoxSubControlVolumeFace() = default;
 
    template<class Corners, class Element>
    BoxSubControlVolumeFace(const Corners& corners,
                            const GlobalPosition& normal,
                            const Element& element,
                            GridIndexType scvfIndex,
                            std::array<LocalIndexType, 2>&& scvIndices)
    : center_(Dumux::center(corners))
    , unitOuterNormal_(normal)
    , scvfIndex_(scvfIndex)
    , scvIndices_(std::move(scvIndices))
    , boundaryFlag_{}
    {
        area_ = Dumux::convexPolytopeVolume<dim>(
            Dune::GeometryTypes::cube(dim),
            [&](unsigned int i){ return corners[i]; }
        );
    }
 
    template<class Corners, class Intersection>
    BoxSubControlVolumeFace(const Corners& corners,
                            const GlobalPosition& normal,
                            const Intersection& intersection,
                            LocalIndexType indexInIntersection,
                            GridIndexType scvfIndex,
                            std::array<LocalIndexType, 2>&& scvIndices)
    : center_(Dumux::center(corners))
    , unitOuterNormal_(normal)
    , scvfIndex_(scvfIndex)
    , scvIndices_(std::move(scvIndices))
    , boundaryFlag_{intersection}
    {
        area_ = Dumux::convexPolytopeVolume<dim>(
            Dune::GeometryTypes::cube(dim),
            [&](unsigned int i){ return corners[i]; }
        );
    }
 
    const GlobalPosition& center() const
    {
        return center_;
    }
 
    const GlobalPosition& ipGlobal() const
    {
        return center_;
    }
 
    Scalar area() const
    {
        return area_;
    }
 
    bool boundary() const
    {
        return static_cast<bool>(boundaryFlag_);
    }
 
    const GlobalPosition& unitOuterNormal() const
    {
        return unitOuterNormal_;
    }
 
    LocalIndexType insideScvIdx() const
    {
        return scvIndices_[0];
    }
 
    // Results in undefined behaviour if i >= numOutsideScvs()
    LocalIndexType outsideScvIdx(int i = 0) const
    {
        assert(!boundary());
        return scvIndices_[1];
    }
 
    std::size_t numOutsideScvs() const
    {
        return static_cast<std::size_t>(!boundary());
    }
 
    GridIndexType index() const
    {
        return scvfIndex_;
    }
 
    typename BoundaryFlag::value_type boundaryFlag() const
    {
        return boundaryFlag_.get();
    }
 
private:
    GlobalPosition center_;
    GlobalPosition unitOuterNormal_;
    Scalar area_;
    GridIndexType scvfIndex_;
    std::array<LocalIndexType, 2> scvIndices_;
    BoundaryFlag boundaryFlag_;
};
 
} // end namespace Dumux
 
#endif