discretization/pq2/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_PQ2_SUBCONTROLVOLUMEFACE_HH
#define DUMUX_DISCRETIZATION_PQ2_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/discretization/pq2/geometryhelper.hh>
 
namespace Dumux {
 
template<class GridView>
struct PQ2DefaultScvfGeometryTraits
{
    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 = PQ2MLGeometryTraits<Scalar>;
    using Geometry = Dune::MultiLinearGeometry<Scalar, dim-1, dimWorld, GeometryTraits>;
    using CornerStorage = typename GeometryTraits::template CornerStorage<dim-1, dimWorld>::Type;
    using GlobalPosition = typename CornerStorage::value_type;
    using BoundaryFlag = Dumux::BoundaryFlag<Grid>;
};
 
template<class GV,
         class T = PQ2DefaultScvfGeometryTraits<GV> >
class PQ2SubControlVolumeFace
{
    using GridIndexType = typename T::GridIndexType;
    using LocalIndexType = typename T::LocalIndexType;
    using Scalar = typename T::Scalar;
    using CornerStorage = typename T::CornerStorage;
    using Geometry = typename T::Geometry;
    using BoundaryFlag = typename T::BoundaryFlag;
 
public:
    using GlobalPosition = typename T::GlobalPosition;
    using Traits = T;
 
    PQ2SubControlVolumeFace() = default;
 
    PQ2SubControlVolumeFace(const GlobalPosition& center,
                            const Scalar area,
                            const GlobalPosition& normal,
                            const std::array<LocalIndexType, 2>& scvIndices,
                            const LocalIndexType localScvfIdx,
                            bool overlapping = false)
    : center_(center)
    , unitOuterNormal_(normal)
    , area_(area)
    , localScvfIdx_(localScvfIdx)
    , scvIndices_(scvIndices)
    , boundary_(false)
    , overlapping_(overlapping)
    , boundaryFlag_{}
    { }
 
    PQ2SubControlVolumeFace(const GlobalPosition& center,
                            const Scalar area,
                            const GlobalPosition& normal,
                            const std::array<LocalIndexType, 2>& scvIndices,
                            const LocalIndexType localScvfIdx,
                            const BoundaryFlag& bFlag,
                            bool overlapping = false)
    : center_(center)
    , unitOuterNormal_(normal)
    , area_(area)
    , localScvfIdx_(localScvfIdx)
    , scvIndices_(scvIndices)
    , boundary_(true)
    , overlapping_(overlapping)
    , boundaryFlag_(bFlag)
    {}
 
    const GlobalPosition& center() const
    { return center_; }
 
    const GlobalPosition& ipGlobal() const
    { return center_; }
 
    Scalar area() const
    { return area_; }
 
    bool isOverlapping() const
    { return overlapping_; }
 
    bool boundary() const
    { return boundary_; }
 
    const GlobalPosition unitOuterNormal() const
    { return unitOuterNormal_; }
 
    GridIndexType insideScvIdx() const
    { return scvIndices_[0]; }
 
    GridIndexType outsideScvIdx() const
    { return scvIndices_[1]; }
 
    std::size_t numOutsideScvs() const
    { return static_cast<std::size_t>(!boundary()); }
 
    LocalIndexType index() const
    { return localScvfIdx_; }
 
    typename BoundaryFlag::value_type boundaryFlag() const
    { return boundaryFlag_.get(); }
 
private:
    GlobalPosition center_;
    GlobalPosition unitOuterNormal_;
    Scalar area_;
    LocalIndexType localScvfIdx_;
    std::array<LocalIndexType, 2> scvIndices_;
    bool boundary_;
    bool overlapping_;
    BoundaryFlag boundaryFlag_;
};
 
} // end namespace Dumux
 
#endif