elementvariables.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_VARIABLES_HH
#define DUMUX_DISCRETIZATION_CVFE_ELEMENT_VARIABLES_HH
 
#include <type_traits>
#include <utility>
#include <vector>
 
#include <dumux/common/concepts/localdofs_.hh>
#include <dumux/discretization/elementsolution.hh>
 
#include "variablesdeflectionpolicy.hh"
 
namespace Dumux::Detail::CVFE {
 
template<class GVC, bool cachingEnabled>
class CVFEElementVariables;
 
template<class GVC>
class CVFEElementVariables<GVC, /*cachingEnabled*/true>
{
    class MutableVariablesView
    {
    public:
        MutableVariablesView(GVC& gridCache)
        : gridCache_(gridCache) {}
 
        using Variables = typename GVC::VolumeVariables;
 
        template<class LocalDof>
        Variables& operator [](const LocalDof& localDof) const
        { return gridCache_.volVars(localDof.elementIndex(), localDof.index()); }
    private:
        GVC& gridCache_;
    };
 
public:
    using GridVariablesCache = GVC;
    using GridVolumeVariables = GridVariablesCache;
 
    using MutableView = MutableVariablesView;
 
    using Variables = typename GridVariablesCache::VolumeVariables;
    using VolumeVariables = Variables;
 
    template<class FVElementGeometry>
    using DeflectionPolicy = VariablesDeflectionPolicy<MutableView, FVElementGeometry>;
 
    CVFEElementVariables(const GridVariablesCache& gridVariablesCache)
    : gridVariablesCachePtr_(&gridVariablesCache) {}
 
    const Variables& operator [](std::size_t localDofIdx) const
    { return gridVolVars().volVars(eIdx_, localDofIdx); }
 
    template<class ScvOrLocalDof, typename std::enable_if_t<!std::is_integral<ScvOrLocalDof>::value, int> = 0>
    const Variables& operator [](const ScvOrLocalDof& scvOrLocalDof) const
    {
        if constexpr (Concept::LocalDof<ScvOrLocalDof>)
            return gridVolVars().volVars(eIdx_, scvOrLocalDof.index());
        else
            return gridVolVars().volVars(eIdx_, scvOrLocalDof.localDofIndex());
    }
 
    template<class FVElementGeometry, class SolutionVector>
    CVFEElementVariables 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 variables.
    // function to be called before assembling an element, preparing the variables 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>
    CVFEElementVariables 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 variables 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) &
    {
        eIdx_ = fvGeometry.gridGeometry().elementMapper().index(element);
    }
 
    const GridVariablesCache& gridVolVars() const
    { return *gridVariablesCachePtr_; }
 
   MutableView asMutableView(GridVariablesCache& gridVars)
   { return { gridVars }; }
 
private:
    const GridVariablesCache* gridVariablesCachePtr_;
    std::size_t eIdx_;
};
 
template<class GVC>
class CVFEElementVariables<GVC, /*cachingEnabled*/false>
{
    using ThisType = CVFEElementVariables<GVC, /*cachingEnabled*/false>;
 
    class MutableVariablesView
    {
    public:
        MutableVariablesView(ThisType& view)
        : view_(view) {}
 
        using Variables = typename GVC::VolumeVariables;
 
        template<class LocalDof>
        Variables& operator [](const LocalDof& localDof) const
        { return view_[localDof]; }
    private:
        ThisType& view_;
    };
 
public:
    using GridVariablesCache = GVC;
    using GridVolumeVariables = GridVariablesCache;
 
    using MutableView = MutableVariablesView;
 
    using Variables = typename GridVariablesCache::VolumeVariables;
    using VolumeVariables = Variables;
 
    template<class FVElementGeometry>
    using DeflectionPolicy = VariablesDeflectionPolicy<MutableView, FVElementGeometry>;
 
    CVFEElementVariables(const GridVariablesCache& gridVarsCache)
    : gridVariablesCachePtr_(&gridVarsCache) {}
 
    template<class FVElementGeometry, class SolutionVector>
    CVFEElementVariables 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>
    CVFEElementVariables 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
        auto elemSol = elementSolution(element, sol, fvGeometry.gridGeometry());
 
        // resize variables to the required size
        variables_.resize(Dumux::Detail::LocalDofs::numLocalDofs(fvGeometry));
 
        // update variables related to localDofs
        for (const auto& localDof : localDofs(fvGeometry))
            variables_[localDof.index()].update(elemSol, gridVolVars().problem(), fvGeometry, ipData(fvGeometry, localDof));
    }
 
    const Variables& operator [](std::size_t localIdx) const
    { return variables_[localIdx]; }
 
    Variables& operator [](std::size_t localIdx)
    { return variables_[localIdx]; }
 
    template<class ScvOrLocalDof, typename std::enable_if_t<!std::is_integral<ScvOrLocalDof>::value, int> = 0>
    const Variables& operator [](const ScvOrLocalDof& scvOrLocalDof) const
    {
        if constexpr (Concept::LocalDof<ScvOrLocalDof>)
            return variables_[scvOrLocalDof.index()];
        else
            return variables_[scvOrLocalDof.localDofIndex()];
    }
 
    template<class ScvOrLocalDof, typename std::enable_if_t<!std::is_integral<ScvOrLocalDof>::value, int> = 0>
    Variables& operator [](const ScvOrLocalDof& scvOrLocalDof)
    {
        if constexpr (Concept::LocalDof<ScvOrLocalDof>)
            return variables_[scvOrLocalDof.index()];
        else
            return variables_[scvOrLocalDof.localDofIndex()];
    }
 
    const GridVariablesCache& gridVolVars() const
    { return *gridVariablesCachePtr_; }
 
   MutableView asMutableView(GridVariablesCache&)
   { return { *this }; }
 
private:
    const GridVariablesCache* gridVariablesCachePtr_;
    std::vector<Variables> variables_;
};
 
} // end namespace Dumux
 
#endif