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:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
#define DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
 
#include <memory>
 
#include <dune/common/fvector.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::make_unique<Geometry>(std::move(geometry)))
    , center_(geometry_->center())
    , elementIndex_(elementIndex)
    {}
 
    CCSubControlVolume(const CCSubControlVolume& other)
    { deepCopy_(other); }
 
    CCSubControlVolume(CCSubControlVolume&& other) = default;
 
    CCSubControlVolume& operator=(const CCSubControlVolume& other)
    {
        deepCopy_(other);
        return *this;
    }
 
    CCSubControlVolume& operator=(CCSubControlVolume&& other) = default;
 
    const GlobalPosition& center() const
    {
        return center_;
    }
 
    Scalar volume() const
    {
        return geometry_->volume();
    }
 
    // e.g. for integration
    [[deprecated("Will be removed after 3.7. Use fvGeometry.geometry(scv).")]]
    const Geometry& geometry() const
    {
        return *geometry_;
    }
 
    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_;
    }
 
    [[deprecated("Will be removed after 3.7. Use fvGeometry.geometry(scv).corner(i).")]]
    GlobalPosition corner(LocalIndexType localIdx) const
    {
        return geometry_->corner(localIdx);
    }
 
private:
    void deepCopy_(const CCSubControlVolume& other)
    {
        if (other.geometry_)
            geometry_ = std::make_unique<Geometry>(*other.geometry_);
        else
            geometry_.reset();
        center_ = other.center_;
        elementIndex_ = other.elementIndex_;
    }
 
    // Work around the fact that geometry is not default-constructible and not copy-assignable
    std::unique_ptr<Geometry> geometry_;
    GlobalPosition center_;
    GridIndexType elementIndex_;
};
 
} // end namespace Dumux
 
#endif