cvfe/elementvolumevariables.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_CVFE_ELEMENT_VOLUMEVARIABLES_HH
#define DUMUX_DISCRETIZATION_CVFE_ELEMENT_VOLUMEVARIABLES_HH
 
#include <type_traits>
#include <utility>
#include <vector>
 
#include <dumux/common/concepts/localdofs_.hh>
#include <dumux/common/deprecated.hh>
#include <dumux/discretization/elementsolution.hh>
 
namespace Dumux {

template<class GVV, bool cachingEnabled>
class CVFEElementVolumeVariables;

template<class GVV>
class CVFEElementVolumeVariables<GVV, /*cachingEnabled*/true>
{
    class MutableVariablesView
    {
    public:
        MutableVariablesView(GVV& gridCache)
        : gridCache_(gridCache) {}
 
        using VolumeVariables = typename GVV::VolumeVariables;
 
        template<class SubControlVolume>
        VolumeVariables& operator [](const SubControlVolume& scv) const
        { return gridCache_.volVars(scv.elementIndex(), scv.indexInElement()); }
    private:
        GVV& gridCache_;
    };
 
public:
    using GridVolumeVariables = GVV;

    using MutableView = MutableVariablesView;

    using VolumeVariables = typename GridVolumeVariables::VolumeVariables;

    CVFEElementVolumeVariables(const GridVolumeVariables& gridVolVars)
    : gridVolVarsPtr_(&gridVolVars) {}
 
    const VolumeVariables& operator [](std::size_t scvIdx) const
    { return gridVolVars().volVars(eIdx_, scvIdx); }
 
    template<class ScvOrLocalDof, typename std::enable_if_t<!std::is_integral<ScvOrLocalDof>::value, int> = 0>
    const VolumeVariables& operator [](const ScvOrLocalDof& scvOrLocalDof) const
    {
        if constexpr (Concept::LocalDof<ScvOrLocalDof>)
            return gridVolVars().volVars(eIdx_, scvOrLocalDof.index());
        else
            return gridVolVars().volVars(eIdx_, scvOrLocalDof.indexInElement());
    }

    template<class FVElementGeometry, class SolutionVector>
    CVFEElementVolumeVariables bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                   const FVElementGeometry& fvGeometry,
                                   const SolutionVector& sol)  &&
    {
        this->bindElement(element, fvGeometry, sol);
        return std::move(*this);
    }
 
    // For compatibility reasons with the case of not storing the vol vars.
    // function to be called before assembling an element, preparing the vol vars within the stencil
    template<class FVElementGeometry, class SolutionVector>
    void bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
              const FVElementGeometry& fvGeometry,
              const SolutionVector& sol) &
    {
        bindElement(element, fvGeometry, sol);
    }

    template<class FVElementGeometry, class SolutionVector>
    CVFEElementVolumeVariables bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                          const FVElementGeometry& fvGeometry,
                                          const SolutionVector& sol)  &&
    {
        this->bindElement(element, fvGeometry, sol);
        return std::move(*this);
    }
 
    // function to prepare the vol vars within the element
    template<class FVElementGeometry, class SolutionVector>
    void bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                     const FVElementGeometry& fvGeometry,
                     const SolutionVector& sol) &
    {
        const auto& gridDiscretization = Deprecated::gridGeometry(fvGeometry);
        eIdx_ = gridDiscretization.elementMapper().index(element);
    }

    const GridVolumeVariables& gridVolVars() const
    { return *gridVolVarsPtr_; }

    MutableView asMutableView(GridVolumeVariables& gridVolVars)
    { return { gridVolVars }; }
 
private:
    const GridVolumeVariables* gridVolVarsPtr_;
    std::size_t eIdx_;
};
 

template<class GVV>
class CVFEElementVolumeVariables<GVV, /*cachingEnabled*/false>
{
    using ThisType = CVFEElementVolumeVariables<GVV, /*cachingEnabled*/false>;
 
    class MutableVariablesView
    {
    public:
        MutableVariablesView(ThisType& view)
        : view_(view) {}
 
        using VolumeVariables = typename GVV::VolumeVariables;
 
        template<class SubControlVolume>
        VolumeVariables& operator [](const SubControlVolume& scv) const
        { return view_[scv]; }
    private:
        ThisType& view_;
    };
 
public:
    using GridVolumeVariables = GVV;

    using MutableView = MutableVariablesView;

    using VolumeVariables = typename GridVolumeVariables::VolumeVariables;

    CVFEElementVolumeVariables(const GridVolumeVariables& gridVolVars)
    : gridVolVarsPtr_(&gridVolVars) {}

    template<class FVElementGeometry, class SolutionVector>
    CVFEElementVolumeVariables bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                   const FVElementGeometry& fvGeometry,
                                   const SolutionVector& sol)  &&
    {
        this->bindElement(element, fvGeometry, sol);
        return std::move(*this);
    }
 
    // specialization for control-volume finite element, simply forwards to the bindElement method
    template<class FVElementGeometry, class SolutionVector>
    void bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
              const FVElementGeometry& fvGeometry,
              const SolutionVector& sol) &
    {
        bindElement(element, fvGeometry, sol);
    }

    template<class FVElementGeometry, class SolutionVector>
    CVFEElementVolumeVariables bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                          const FVElementGeometry& fvGeometry,
                                          const SolutionVector& sol)  &&
    {
        this->bindElement(element, fvGeometry, sol);
        return std::move(*this);
    }
 
    // specialization for control-volume finite element
    template<class FVElementGeometry, class SolutionVector>
    void bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                     const FVElementGeometry& fvGeometry,
                     const SolutionVector& sol) &
    {
        // get the solution at the dofs of the element
        const auto& gridDiscretization = Deprecated::gridGeometry(fvGeometry);
        auto elemSol = elementSolution(element, sol, gridDiscretization);
 
        // resize volume variables to the required size
        volumeVariables_.resize(fvGeometry.numScv());
        for (auto&& scv : scvs(fvGeometry))
            volumeVariables_[scv.indexInElement()].update(elemSol, gridVolVars().problem(), element, scv);
    }
 
    const VolumeVariables& operator [](std::size_t scvIdx) const
    { return volumeVariables_[scvIdx]; }
 
    VolumeVariables& operator [](std::size_t scvIdx)
    { return volumeVariables_[scvIdx]; }
 
    template<class ScvOrLocalDof, typename std::enable_if_t<!std::is_integral<ScvOrLocalDof>::value, int> = 0>
    const VolumeVariables& operator [](const ScvOrLocalDof& scvOrLocalDof) const
    {
        if constexpr (Concept::LocalDof<ScvOrLocalDof>)
            return volumeVariables_[scvOrLocalDof.index()];
        else
            return volumeVariables_[scvOrLocalDof.indexInElement()];
    }
 
    template<class ScvOrLocalDof, typename std::enable_if_t<!std::is_integral<ScvOrLocalDof>::value, int> = 0>
    VolumeVariables& operator [](const ScvOrLocalDof& scvOrLocalDof)
    {
        if constexpr (Concept::LocalDof<ScvOrLocalDof>)
            return volumeVariables_[scvOrLocalDof.index()];
        else
            return volumeVariables_[scvOrLocalDof.indexInElement()];
    }

    const GridVolumeVariables& gridVolVars() const
    { return *gridVolVarsPtr_; }

    MutableView asMutableView(GridVolumeVariables&)
    { return { *this }; }
 
private:
    const GridVolumeVariables* gridVolVarsPtr_;
    std::vector<VolumeVariables> volumeVariables_;
};
 
} // end namespace Dumux
 
#endif