discretization/cvfe/elementfluxvariablescache.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_FLUXVARSCACHE_HH
#define DUMUX_DISCRETIZATION_CVFE_ELEMENT_FLUXVARSCACHE_HH
 
#include <cstddef>
#include <vector>
#include <utility>
 
#include <dune/common/std/type_traits.hh>
 
#include <dumux/common/concepts/ipdata_.hh>
#include <dumux/common/deprecated.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
 
namespace Dumux {
 
namespace Detail {
 
template<class FluxVariablesCache>
using DefinesScvfQuadratureRule = typename FluxVariablesCache::ScvfQuadratureRule;
 
template<class FluxVariablesCache>
using ScvfQuadratureRuleOrDefault_t = Dune::Std::detected_or_t<QuadratureRules::MidpointQuadrature,
                                                               DefinesScvfQuadratureRule,
                                                               FluxVariablesCache>;
 
} // namespace Detail

template<class GFVC, bool cachingEnabled, class ScvfQuadratureRule>
class CVFEElementFluxVariablesCacheImpl
{};

template<class GFVC, bool cachingEnabled>
using CVFEElementFluxVariablesCache = CVFEElementFluxVariablesCacheImpl<GFVC, cachingEnabled, Detail::ScvfQuadratureRuleOrDefault_t<typename GFVC::FluxVariablesCache>>;

template<class GFVC, class ScvfQR>
class CVFEElementFluxVariablesCacheImpl<GFVC, true, ScvfQR>
{
public:
    using GridFluxVariablesCache = GFVC;

    using FluxVariablesCache = typename GFVC::FluxVariablesCache;
 
    CVFEElementFluxVariablesCacheImpl(const GridFluxVariablesCache& global)
    : gridFluxVarsCachePtr_(&global) {}
 
    // Function is called prior to flux calculations on the element.
    // We assume the FVGeometries to be bound at this point
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
              const FVElementGeometry& fvGeometry,
              const ElementVolumeVariables& elemVolVars) &
    { bindElement(element, fvGeometry, elemVolVars); }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                           const FVElementGeometry& fvGeometry,
                                           const ElementVolumeVariables& elemVolVars) &&
    {
        this->bind(element, fvGeometry, elemVolVars);
        return std::move(*this);
    }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                     const FVElementGeometry& fvGeometry,
                     const ElementVolumeVariables& elemVolVars) &
    {
        const auto& gridDiscretization = Deprecated::gridGeometry(fvGeometry);
        eIdx_ = gridDiscretization.elementMapper().index(element);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                                  const FVElementGeometry& fvGeometry,
                                                  const ElementVolumeVariables& elemVolVars) &&
    {
        this->bindElement(element, fvGeometry, elemVolVars);
        return std::move(*this);
    }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bindScvf(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                  const FVElementGeometry& fvGeometry,
                  const ElementVolumeVariables& elemVolVars,
                  const typename FVElementGeometry::SubControlVolumeFace& scvf) &
    { bindElement(element, fvGeometry, elemVolVars); }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bindScvf(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                               const FVElementGeometry& fvGeometry,
                                               const ElementVolumeVariables& elemVolVars,
                                               const typename FVElementGeometry::SubControlVolumeFace& scvf) &&
    {
        this->bindScvf(element, fvGeometry, elemVolVars, scvf);
        return std::move(*this);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    void update(const typename FVElementGeometry::Element& element,
                const FVElementGeometry& fvGeometry,
                const ElementVolumeVariables& elemVolVars) {}
 
    // access operator
    template<class SubControlVolumeFace>
    const FluxVariablesCache& operator [](const SubControlVolumeFace& scvf) const
    {
        if constexpr (std::is_same_v<ScvfQR, QuadratureRules::MidpointQuadrature>)
            return gridFluxVarsCache().cache(eIdx_, scvf.index());
        else
            DUNE_THROW(Dune::NotImplemented, "CVFEElementFluxVariablesCache: Scvf access operator only implemented for MidpointQuadrature.");
    }
 
    // access cache for given interpolation point data
    template<Concept::ScvfIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    {
        if constexpr (std::is_same_v<ScvfQR, QuadratureRules::MidpointQuadrature>)
            return gridFluxVarsCache().cache(eIdx_, ipData.scvfIndex());
        else
            return gridFluxVarsCache().cache(eIdx_, ipData.scvfIndex(), ipData.qpIndex());
    }

    const GridFluxVariablesCache& gridFluxVarsCache() const
    {  return *gridFluxVarsCachePtr_; }
 
private:
    const GridFluxVariablesCache* gridFluxVarsCachePtr_;
    std::size_t eIdx_; 
};

template<class GFVC>
class CVFEElementFluxVariablesCacheImpl<GFVC, false, QuadratureRules::MidpointQuadrature>
{
public:
    using GridFluxVariablesCache = GFVC;

    using FluxVariablesCache = typename GFVC::FluxVariablesCache;
 
    CVFEElementFluxVariablesCacheImpl(const GridFluxVariablesCache& global)
    : gridFluxVarsCachePtr_(&global) {}
 
    // Function is called prior to flux calculations on the element.
    // We assume the FVGeometries to be bound at this point
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
              const FVElementGeometry& fvGeometry,
              const ElementVolumeVariables& elemVolVars) &
    {
        bindElement(element, fvGeometry, elemVolVars);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                           const FVElementGeometry& fvGeometry,
                                           const ElementVolumeVariables& elemVolVars) &&
    {
        this->bind(element, fvGeometry, elemVolVars);
        return std::move(*this);
    }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                     const FVElementGeometry& fvGeometry,
                     const ElementVolumeVariables& elemVolVars) &
    {
        // temporary resizing of the cache
        fluxVarsCache_.resize(fvGeometry.numScvf());
        for (auto&& scvf : scvfs(fvGeometry))
            (*this)[scvf].update(gridFluxVarsCache().problem(), element, fvGeometry, elemVolVars, scvf);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                                  const FVElementGeometry& fvGeometry,
                                                  const ElementVolumeVariables& elemVolVars) &&
    {
        this->bindElement(element, fvGeometry, elemVolVars);
        return std::move(*this);
    }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bindScvf(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                  const FVElementGeometry& fvGeometry,
                  const ElementVolumeVariables& elemVolVars,
                  const typename FVElementGeometry::SubControlVolumeFace& scvf) &
    {
        fluxVarsCache_.resize(fvGeometry.numScvf());
        (*this)[scvf].update(gridFluxVarsCache().problem(), element, fvGeometry, elemVolVars, scvf);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bindScvf(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                               const FVElementGeometry& fvGeometry,
                                               const ElementVolumeVariables& elemVolVars,
                                               const typename FVElementGeometry::SubControlVolumeFace& scvf) &&
    {
        this->bindScvf(element, fvGeometry, elemVolVars, scvf);
        return std::move(*this);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    void update(const typename FVElementGeometry::Element& element,
                const FVElementGeometry& fvGeometry,
                const ElementVolumeVariables& elemVolVars)
    {
        if constexpr (FluxVariablesCache::isSolDependent)
        {
            fluxVarsCache_.resize(fvGeometry.numScvf());
            for (const auto& scvf : scvfs(fvGeometry))
                (*this)[scvf].update(gridFluxVarsCache().problem(), element, fvGeometry, elemVolVars, scvf);
        }
    }
 
    // access operator
    template<class SubControlVolumeFace>
    const FluxVariablesCache& operator [](const SubControlVolumeFace& scvf) const
    { return fluxVarsCache_[scvf.index()]; }
 
    // access operator
    template<class SubControlVolumeFace>
    FluxVariablesCache& operator [](const SubControlVolumeFace& scvf)
    { return fluxVarsCache_[scvf.index()]; }
 
    // access cache for a given interpolation point data
    template<Concept::ScvfIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    { return fluxVarsCache_[ipData.scvfIndex()]; }
 
    // access cache for a given interpolation point data
    template<Concept::ScvfIpData IpData>
    FluxVariablesCache& operator [](const IpData& ipData)
    { return fluxVarsCache_[ipData.scvfIndex()]; }

    const GridFluxVariablesCache& gridFluxVarsCache() const
    {  return *gridFluxVarsCachePtr_; }
 
private:
    const GridFluxVariablesCache* gridFluxVarsCachePtr_;
    std::vector<FluxVariablesCache> fluxVarsCache_;
};

template<class GFVC, class ScvfQR>
class CVFEElementFluxVariablesCacheImpl<GFVC, false, ScvfQR>
{
public:
    using GridFluxVariablesCache = GFVC;

    using FluxVariablesCache = typename GFVC::FluxVariablesCache;
 
    CVFEElementFluxVariablesCacheImpl(const GridFluxVariablesCache& global)
    : gridFluxVarsCachePtr_(&global) {}
 
    // Function is called prior to flux calculations on the element.
    // We assume the FVGeometries to be bound at this point
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
              const FVElementGeometry& fvGeometry,
              const ElementVolumeVariables& elemVolVars) &
    {
        bindElement(element, fvGeometry, elemVolVars);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bind(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                           const FVElementGeometry& fvGeometry,
                                           const ElementVolumeVariables& elemVolVars) &&
    {
        this->bind(element, fvGeometry, elemVolVars);
        return std::move(*this);
    }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                     const FVElementGeometry& fvGeometry,
                     const ElementVolumeVariables& elemVolVars) &
    {
        // temporary resizing of the cache
        fluxVarsCache_.resize(fvGeometry.numScvf());
        for (auto&& scvf : scvfs(fvGeometry))
        {
            const auto quadRule = CVFE::quadratureRule(fvGeometry, scvf);
            fluxVarsCache_[scvf.index()].resize(std::ranges::size(quadRule));
            for (const auto& qpData : quadRule)
                fluxVarsCache_[scvf.index()][qpData.ipData().qpIndex()].update(
                    gridFluxVarsCache().problem(), element, fvGeometry, elemVolVars, qpData.ipData()
                );
        }
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bindElement(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                                  const FVElementGeometry& fvGeometry,
                                                  const ElementVolumeVariables& elemVolVars) &&
    {
        this->bindElement(element, fvGeometry, elemVolVars);
        return std::move(*this);
    }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    void bindScvf(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                  const FVElementGeometry& fvGeometry,
                  const ElementVolumeVariables& elemVolVars,
                  const typename FVElementGeometry::SubControlVolumeFace& scvf) &
    {
        fluxVarsCache_.resize(fvGeometry.numScvf());
        const auto quadRule = CVFE::quadratureRule(fvGeometry, scvf);
        fluxVarsCache_[scvf.index()].resize(std::ranges::size(quadRule));
        for (const auto& qpData : quadRule)
            fluxVarsCache_[scvf.index()][qpData.ipData().qpIndex()].update(
                gridFluxVarsCache().problem(), element, fvGeometry, elemVolVars, qpData.ipData()
            );
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    CVFEElementFluxVariablesCacheImpl bindScvf(const typename FVElementGeometry::GridGeometry::GridView::template Codim<0>::Entity& element,
                                               const FVElementGeometry& fvGeometry,
                                               const ElementVolumeVariables& elemVolVars,
                                               const typename FVElementGeometry::SubControlVolumeFace& scvf) &&
    {
        this->bindScvf(element, fvGeometry, elemVolVars, scvf);
        return std::move(*this);
    }

    template<class FVElementGeometry, class ElementVolumeVariables>
    void update(const typename FVElementGeometry::Element& element,
                const FVElementGeometry& fvGeometry,
                const ElementVolumeVariables& elemVolVars)
    {
        if constexpr (FluxVariablesCache::isSolDependent)
        {
            fluxVarsCache_.resize(fvGeometry.numScvf());
            for (const auto& scvf : scvfs(fvGeometry))
            {
                const auto quadRule = CVFE::quadratureRule(fvGeometry, scvf);
                fluxVarsCache_[scvf.index()].resize(std::ranges::size(quadRule));
                for (const auto& qpData : quadRule)
                    fluxVarsCache_[scvf.index()][qpData.ipData().qpIndex()].update(
                        gridFluxVarsCache().problem(), element, fvGeometry, elemVolVars, qpData.ipData()
                    );
            }
        }
    }
 
    // access cache for a given interpolation point data
    template<Concept::ScvfQpIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    { return fluxVarsCache_[ipData.scvfIndex()][ipData.qpIndex()]; }
 
    // access cache for a given interpolation point data
    template<Concept::ScvfQpIpData IpData>
    FluxVariablesCache& operator [](const IpData& ipData)
    { return fluxVarsCache_[ipData.scvfIndex()][ipData.qpIndex()]; }

    const GridFluxVariablesCache& gridFluxVarsCache() const
    {  return *gridFluxVarsCachePtr_; }
 
private:
    const GridFluxVariablesCache* gridFluxVarsCachePtr_;
    std::vector<std::vector<FluxVariablesCache>> fluxVarsCache_;
};
 
} // end namespace Dumux
 
#endif