discretization/porenetwork/subcontrolvolume.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_PNM_SUBCONTROLVOLUME_HH
#define DUMUX_DISCRETIZATION_PNM_SUBCONTROLVOLUME_HH
 
#include <dune/geometry/affinegeometry.hh>
#include <dumux/common/math.hh>
#include <dumux/common/indextraits.hh>
#include <dumux/discretization/subcontrolvolumebase.hh>
 
namespace Dumux::PoreNetwork {
 
template<class GridView>
struct PNMDefaultScvGeometryTraits
{
    using Grid = typename GridView::Grid;
 
    static const int dim = Grid::dimension;
    static const int dimWorld = Grid::dimensionworld;
 
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
    using Scalar = typename Grid::ctype;
    using GlobalPosition = Dune::FieldVector<Scalar, dimWorld>;
    using CornerStorage = std::array<GlobalPosition, 2>;
    using Geometry = Dune::AffineGeometry<Scalar, 1, dimWorld>;
};
 
template<class GV,
         class T = PNMDefaultScvGeometryTraits<GV> >
class PNMSubControlVolume
: public Dumux::SubControlVolumeBase<PNMSubControlVolume<GV, T>, T>
{
    using ThisType = PNMSubControlVolume<GV, T>;
    using ParentType = Dumux::SubControlVolumeBase<ThisType, T>;
    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;
 
public:
    using GlobalPosition = typename T::GlobalPosition;
    using Traits = T;
 
    PNMSubControlVolume() = default;
 
    // the constructor in the box case
    template<class Corners>
    PNMSubControlVolume(GridIndexType dofIndex,
                        LocalIndexType scvIdx,
                        GridIndexType elementIndex,
                        Corners&& corners,
                        const Scalar volume)
    : center_((corners[0]+corners[1])/2.0),
      corners_(std::forward<CornerStorage>(corners)),
      volume_(volume),
      elementIndex_(elementIndex),
      localDofIdx_(scvIdx),
      dofIndex_(dofIndex)
    {}
 
    const GlobalPosition& center() const
    { return center_; }
 
    Scalar volume() const
    { return volume_; }
 
    LocalIndexType localDofIndex() const
    { return localDofIdx_; }
 
    LocalIndexType indexInElement() const
    { return localDofIdx_; }
 
    GridIndexType dofIndex() const
    { return dofIndex_; }
 
    // The position of the dof this scv is embedded in
    const GlobalPosition& dofPosition() const
    { return corners_[0]; }
 
    GridIndexType elementIndex() const
    { return elementIndex_; }
 
    [[deprecated("Will be removed after 3.7. Use fvGeometry.geometry(scv).corner(i).")]]
    const GlobalPosition& corner(LocalIndexType localIdx) const
    {
        assert(localIdx < corners_.size() && "provided index exceeds the number of corners");
        return corners_[localIdx];
    }
 
    [[deprecated("Will be removed after 3.7. Use fvGeometry.geometry(scv).")]]
    Geometry geometry() const
    {
        return Geometry(Dune::GeometryTypes::simplex(1), corners_);
    }
 
private:
    GlobalPosition center_;
    CornerStorage corners_;
    Scalar volume_;
    GridIndexType elementIndex_;
    LocalIndexType localDofIdx_;
    GridIndexType dofIndex_;
};
 
} // end namespace Dumux::PoreNetwork
 
#endif