discretization/box/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-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_DISCRETIZATION_BOX_SUBCONTROLVOLUME_HH
#define DUMUX_DISCRETIZATION_BOX_SUBCONTROLVOLUME_HH
 
#include <dune/geometry/type.hh>
#include <dune/geometry/multilineargeometry.hh>
 
#include <dumux/common/math.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 BoxDefaultScvGeometryTraits
{
    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 GeometryTraits = BoxMLGeometryTraits<Scalar>;
    using Geometry = Dune::MultiLinearGeometry<Scalar, dim, dimWorld, GeometryTraits>;
    using CornerStorage = typename GeometryTraits::template CornerStorage<dim, dimWorld>::Type;
    using GlobalPosition = typename Geometry::GlobalCoordinate;
};

template<class GV,
         class T = BoxDefaultScvGeometryTraits<GV> >
class BoxSubControlVolume
{
    using ThisType = BoxSubControlVolume<GV, T>;
    using Geometry = typename T::Geometry;
    using GridIndexType = typename T::GridIndexType;
    using LocalIndexType = typename T::LocalIndexType;
    using Scalar = typename T::Scalar;
    static constexpr int dim = Geometry::mydimension;
 
public:
    using GlobalPosition = typename T::GlobalPosition;
    using Traits = T;

    BoxSubControlVolume() = default;
 
    // the constructor in the box case
    template<class Corners>
    BoxSubControlVolume(const Corners& corners,
                        LocalIndexType scvIdx,
                        GridIndexType elementIndex,
                        GridIndexType dofIndex)
    : dofPosition_(corners[0])
    , center_(Dumux::center(corners))
    , elementIndex_(elementIndex)
    , localDofIdx_(scvIdx)
    , dofIndex_(dofIndex)
    {
        // The corner list is defined such that the first entry is the vertex itself
        volume_ = Dumux::convexPolytopeVolume<dim>(
            Dune::GeometryTypes::cube(dim),
            [&](unsigned int i){ return corners[i]; }
        );
    }

    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 dofPosition_;
    }

    GridIndexType elementIndex() const
    {
        return elementIndex_;
    }
 
private:
    GlobalPosition dofPosition_;
    GlobalPosition center_;
    Scalar volume_;
    GridIndexType elementIndex_;
    LocalIndexType localDofIdx_;
    GridIndexType dofIndex_;
};
 
} // end namespace Dumux
 
#endif