discretization/staggered/freeflow/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_STAGGERED_FREE_FLOW_SUBCONTROLVOLUMEFACE_HH
#define DUMUX_DISCRETIZATION_STAGGERED_FREE_FLOW_SUBCONTROLVOLUMEFACE_HH
 
#include <array>
#include <utility>
#include <dune/common/fvector.hh>
#include <dune/geometry/type.hh>
#include <dune/geometry/multilineargeometry.hh>
 
#include <dumux/common/indextraits.hh>
#include <dumux/discretization/subcontrolvolumefacebase.hh>
#include <dumux/discretization/staggered/subcontrolvolumeface.hh>
#include <dumux/discretization/staggered/freeflow/staggeredgeometryhelper.hh>
 
#include <typeinfo>
 
namespace Dumux {
 
template<class GridView, int upwindSchemeOrder>
struct FreeFlowStaggeredDefaultScvfGeometryTraits
{
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
    using Scalar = typename GridView::ctype;
    using GeometryHelper = FreeFlowStaggeredGeometryHelper<GridView, upwindSchemeOrder>;
    using PairData = typename GeometryHelper::PairData;
    using AxisData = typename GeometryHelper::AxisData;
 
    using Grid = typename GridView::Grid;
    static constexpr int dim = Grid::dimension;
    static constexpr int dimWorld = Grid::dimensionworld;
 
    using Element = typename GridView::template Codim<0>::Entity;
    using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
    using Geometry = Dune::AxisAlignedCubeGeometry<Scalar, dim-1, dimWorld>;
};
 
template<class SubControlVolumeFace>
SubControlVolumeFace makeStaggeredBoundaryFace(const SubControlVolumeFace& scvf,
                                               const typename SubControlVolumeFace::GlobalPosition& newCenter)
{
    auto bf = scvf;
    bf.setCenter(newCenter);
    bf.setBoundary(true);
    bf.setIsGhostFace(true);
    return bf;
}
 
template<class GV,
         int upwindSchemeOrder,
         class T = FreeFlowStaggeredDefaultScvfGeometryTraits<GV, upwindSchemeOrder>>
class FreeFlowStaggeredSubControlVolumeFace
: public SubControlVolumeFaceBase<FreeFlowStaggeredSubControlVolumeFace<GV, upwindSchemeOrder, T>, T>
{
    using ThisType = FreeFlowStaggeredSubControlVolumeFace<GV, upwindSchemeOrder, T>;
    using ParentType = SubControlVolumeFaceBase<ThisType, T>;
    using Geometry = typename T::Geometry;
    using GridIndexType = typename IndexTraits<GV>::GridIndex;
    using LocalIndexType = typename IndexTraits<GV>::LocalIndex;
 
    using PairData = typename T::PairData;
    using AxisData = typename T::AxisData;
 
    using Scalar = typename T::Scalar;
    static const int dim = GV::dimension;
 
    static constexpr int numPairs = 2 * (dim - 1);
 
    static constexpr bool useHigherOrder = upwindSchemeOrder > 1;
 
public:
    using GlobalPosition = typename T::GlobalPosition;
 
    static constexpr int numCornersPerFace = 2 * (dim - 1);
 
    using Traits = T;
 
    // The default constructor
    FreeFlowStaggeredSubControlVolumeFace() = default;
 
    template <class Intersection>
    FreeFlowStaggeredSubControlVolumeFace(const Intersection& is,
                                          const typename Intersection::Geometry& isGeometry,
                                          GridIndexType scvfIndex,
                                          const std::vector<GridIndexType>& scvIndices,
                                          const typename T::GeometryHelper& geometryHelper)
    : ParentType(),
      area_(isGeometry.volume()),
      center_(isGeometry.center()),
      unitOuterNormal_(is.centerUnitOuterNormal()),
      scvfIndex_(scvfIndex),
      scvIndices_(scvIndices),
      boundary_(is.boundary()),
      axisData_(geometryHelper.axisData()),
      pairData_(std::move(geometryHelper.pairData())),
      localFaceIdx_(geometryHelper.localFaceIndex()),
      dirIdx_(geometryHelper.directionIndex()),
      outerNormalSign_(sign(unitOuterNormal_[directionIndex()])),
      isGhostFace_(false)
    {
        dimensions[0] = (isGeometry.corner(1) - isGeometry.corner(0)).two_norm();
        if constexpr (dim == 3)
            dimensions[1] = (isGeometry.corner(2) - isGeometry.corner(0)).two_norm();
    }
 
    const GlobalPosition& center() const
    {
        return center_;
    }
 
    const GlobalPosition& dofPosition() 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];
    }
 
    GridIndexType outsideScvIdx() const
    {
        return scvIndices_[1];
    }
 
    GridIndexType index() const
    {
        return scvfIndex_;
    }
 
    LocalIndexType localFaceIdx() const
    {
        return localFaceIdx_;
    }
 
    unsigned int directionIndex() const
    {
        return dirIdx_;
    }
 
    bool normalInPosCoordDir() const
    {
        return directionSign() > 0;
    }
 
    int directionSign() const
    {
        return outerNormalSign_;
    }
 
    const PairData& pairData(const int idx) const
    {
        return pairData_[idx];
    }
 
    const std::array<PairData, numPairs>& pairData() const
    {
        return pairData_;
    }
 
    const AxisData& axisData() const
    {
        return axisData_;
    }
 
    bool isGhostFace() const
    {
        return isGhostFace_;
    }
 
    Scalar faceLength(const int localSubFaceIdx) const
    {
        if (dim == 3 && localSubFaceIdx > 1)
            return dimensions[1];
        else
            return dimensions[0];
    }
 
    bool hasParallelNeighbor(const int localSubFaceIdx, const int parallelDegreeIdx) const
    {
        return pairData(localSubFaceIdx).hasParallelNeighbor[parallelDegreeIdx];
    }
 
    bool hasHalfParallelNeighbor(const int localSubFaceIdx) const
    {
        return pairData(localSubFaceIdx).hasHalfParallelNeighbor;
    }
 
    bool hasCornerParallelNeighbor(const int localSubFaceIdx) const
    {
        return pairData(localSubFaceIdx).hasCornerParallelNeighbor;
    }
 
    bool hasOuterLateral(const int localSubFaceIdx) const
    {
        return pairData(localSubFaceIdx).hasOuterLateral;
    }
 
    template<bool enable = useHigherOrder, std::enable_if_t<enable, int> = 0>
    bool hasBackwardNeighbor(const int backwardIdx) const
    {
        return axisData().hasBackwardNeighbor[backwardIdx];
    }
 
    template<bool enable = useHigherOrder, std::enable_if_t<enable, int> = 0>
    bool hasForwardNeighbor(const int forwardIdx) const
    {
        return axisData().hasForwardNeighbor[forwardIdx];
    }
 
    GridIndexType dofIndex() const
    {
        return axisData().selfDof;
    }
 
    GridIndexType dofIndexOpposingFace() const
    {
        return axisData().oppositeDof;
    }
 
    GridIndexType dofIndexForwardFace() const
    {
        return axisData().inAxisForwardDofs[0];
    }
 
    GridIndexType dofIndexBackwardFace() const
    {
        return axisData().inAxisBackwardDofs[0];
    }
 
    Scalar selfToOppositeDistance() const
    {
        return axisData().selfToOppositeDistance;
    }
 
    Scalar parallelDofsDistance(const int localSubFaceIdx, const int parallelDegreeIdx) const
    {
        if (parallelDegreeIdx == 0)
            return (faceLength(localSubFaceIdx) + pairData(localSubFaceIdx).parallelCellWidths[0]) * 0.5;
            // pairData(localSubFaceIdx).parallelCellWidths[0]) will return 0.0 if the subface perpendicular the scvf lies on a boundary
        else
        {
            assert((parallelDegreeIdx == 1) && "Only the width of the first two parallel cells (indices 0 and 1) is stored for each scvf.");
            return (pairData(localSubFaceIdx).parallelCellWidths[0] + pairData(localSubFaceIdx).parallelCellWidths[1]) * 0.5;
        }
    }
 
    void setCenter(const GlobalPosition& center)
    { center_ = center; }
 
    void setBoundary(bool boundaryFlag)
    { boundary_ = boundaryFlag; }
 
    void setIsGhostFace(bool isGhostFaceFlag)
    { isGhostFace_ = isGhostFaceFlag; }
 
private:
    std::array<Scalar, dim-1> dimensions;
    Scalar area_;
    GlobalPosition center_;
    GlobalPosition unitOuterNormal_;
    GridIndexType scvfIndex_;
    std::vector<GridIndexType> scvIndices_;
    bool boundary_;
 
    Scalar selfToOppositeDistance_;
    AxisData axisData_;
    std::array<PairData, numPairs> pairData_;
 
    int localFaceIdx_;
    unsigned int dirIdx_;
    int outerNormalSign_;
    bool isGhostFace_;
};
 
} // end namespace Dumux
 
#endif