discretization/cellcentered/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:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program is free software: you can redistribute it and/or modify    *
 *   it under the terms of the GNU General Public License as published by    *
 *   the Free Software Foundation, either version 3 of the License, or       *
 *   (at your option) any later version.                                     *
 *                                                                           *
 *   This program is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU General Public License for more details.                            *
 *                                                                           *
 *   You should have received a copy of the GNU General Public License       *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
#define DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
 
#include <dune/common/fvector.hh>
 
#include <dumux/common/optional.hh>
#include <dumux/common/indextraits.hh>
#include <dumux/discretization/subcontrolvolumebase.hh>
 
namespace Dumux {
 
template<class GridView>
struct CCDefaultScvGeometryTraits
{
    using Geometry = typename GridView::template Codim<0>::Geometry;
    using GridIndexType = typename IndexTraits<GridView>::GridIndex;
    using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
    using Scalar = typename GridView::ctype;
    using Element = typename GridView::template Codim<0>::Entity;
    using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
};
 
template<class GV,
         class T = CCDefaultScvGeometryTraits<GV> >
class CCSubControlVolume
: public SubControlVolumeBase<CCSubControlVolume<GV, T>, T>
{
    using ThisType = CCSubControlVolume<GV, T>;
    using ParentType = SubControlVolumeBase<ThisType, T>;
    using Geometry = typename T::Geometry;
    using GridIndexType = typename T::GridIndexType;
    using LocalIndexType = typename T::LocalIndexType;
    using Scalar = typename T::Scalar;
 
    // In the following, the correct parameter type for the geometry passed to
    // the constructor below is determined. It depends upon whether the
    // `geometry()` method of the `Element` returns a copy or a reference.
    // In the first case, the correct type is `Geometry&&`, while it is
    // `Geometry` for the second case. Although returning by copy is prescribed
    // by the Dune interface, the grid implementation CpGrid uses a const
    // reference as of Opm 2018.04. Once this is fixed, the parameter type can
    // be hardcoded to `Geometry&&` again.
    using Element = typename GV::template Codim<0>::Entity;
    using GeometryRT = decltype(std::declval<Element>().geometry());
    static constexpr bool grtIsReference = std::is_lvalue_reference<GeometryRT>::value;
    using GeometryParamType = std::conditional_t<grtIsReference, Geometry, Geometry&&>;
public:
    using GlobalPosition = typename T::GlobalPosition;
    using Traits = T;
 
    CCSubControlVolume() = default;
 
    // See the explanation above for deriving `GeometryParamType`.
    CCSubControlVolume(GeometryParamType geometry,
                       GridIndexType elementIndex)
    : ParentType()
    , geometry_(std::move(geometry))
    , center_(geometry_.value().center())
    , elementIndex_(elementIndex)
    {}
 
    CCSubControlVolume(const CCSubControlVolume& other) = default;
 
    CCSubControlVolume(CCSubControlVolume&& other) = default;
 
    CCSubControlVolume& operator=(const CCSubControlVolume& other)
    {
        // We want to use the default copy/move assignment.
        // But since geometry is not copy assignable :( we
        // have to construct it again
        geometry_.release();
        geometry_.emplace(other.geometry_.value());
        center_ = other.center_;
        elementIndex_ = other.elementIndex_;
        return *this;
    }
 
    CCSubControlVolume& operator=(CCSubControlVolume&& other) noexcept
    {
        // We want to use the default copy/move assignment.
        // But since geometry is not copy assignable :( we
        // have to construct it again
        geometry_.release();
        geometry_.emplace(std::move(other.geometry_.value()));
        center_ = std::move(other.center_);
        elementIndex_ = std::move(other.elementIndex_);
        return *this;
    }
 
    const GlobalPosition& center() const
    {
        return center_;
    }
 
    Scalar volume() const
    {
        return geometry().volume();
    }
 
    // e.g. for integration
    const Geometry& geometry() const
    {
        assert((geometry_));
        return geometry_.value();
    }
 
    GridIndexType dofIndex() const
    {
        return elementIndex();
    }
 
    LocalIndexType localDofIndex() const
    {
        return 0;
    }
 
    LocalIndexType indexInElement() const
    {
        return 0;
    }
 
    // The position of the dof this scv is embedded in
    const GlobalPosition& dofPosition() const
    {
        return center_;
    }
 
    GridIndexType elementIndex() const
    {
        return elementIndex_;
    }
 
    GlobalPosition corner(LocalIndexType localIdx) const
    {
        assert(localIdx < geometry().corners() && "provided index exceeds the number of corners");
        return geometry().corner(localIdx);
    }
 
private:
    // Work around the fact that geometry is not default constructible
    Optional<Geometry> geometry_;
    GlobalPosition center_;
    GridIndexType elementIndex_;
};
 
} // end namespace Dumux
 
#endif