discretization/cvfe/hybrid/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_HYBRID_CVFE_ELEMENT_FLUXVARSCACHE_HH
#define DUMUX_DISCRETIZATION_HYBRID_CVFE_ELEMENT_FLUXVARSCACHE_HH
 
#include <array>
#include <cassert>
#include <cstddef>
#include <optional>
#include <ranges>
#include <type_traits>
#include <vector>
#include <utility>
 
#include <dumux/common/concepts/ipdata_.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
 
namespace Dumux {
 
template<class GFVC, bool cachingEnabled>
class HybridCVFEElementFluxVariablesCache;
 
template<class GFVC>
class HybridCVFEElementFluxVariablesCache<GFVC, true>
{
public:
    using GridFluxVariablesCache = GFVC;
 
    using FluxVariablesCache = typename GFVC::FluxVariablesCache;
 
    HybridCVFEElementFluxVariablesCache(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>
    HybridCVFEElementFluxVariablesCache 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) &
    { eIdx_ = fvGeometry.gridGeometry().elementMapper().index(element); }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    HybridCVFEElementFluxVariablesCache 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>
    HybridCVFEElementFluxVariablesCache 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 cache for given interpolation point data of an scvf quadrature point
    template<Concept::ScvfQpIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    {
        return gridFluxVarsCache().cache(eIdx_, ipData.scvfIndex(), ipData.qpIndex());
    }
 
    // access cache for given interpolation point data of a boundary face quadrature point
    template<Concept::BoundaryFaceQpIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    {
        return gridFluxVarsCache().boundaryFaceCache(eIdx_, ipData.boundaryFaceIndex(), ipData.qpIndex());
    }
 
    // access cache for given interpolation point data of an element quadrature point
    template<Concept::QIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    {
        return gridFluxVarsCache().elementCache(eIdx_, ipData.qpIndex());
    }
 
    const GridFluxVariablesCache& gridFluxVarsCache() const
    {  return *gridFluxVarsCachePtr_; }
 
private:
    const GridFluxVariablesCache* gridFluxVarsCachePtr_;
    std::size_t eIdx_; 
};
 
template<class GFVC>
class HybridCVFEElementFluxVariablesCache<GFVC, false>
{
    using GridGeometry = std::decay_t<decltype(std::declval<GFVC>().problem().gridGeometry())>;
    using GridView = typename GridGeometry::GridView;
 
    static constexpr std::size_t maxNumBoundaryFaces = GridView::dimension << 1;
 
public:
    using GridFluxVariablesCache = GFVC;
 
    using FluxVariablesCache = typename GFVC::FluxVariablesCache;
 
    HybridCVFEElementFluxVariablesCache(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>
    HybridCVFEElementFluxVariablesCache 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()
                );
        }
 
        // Resize element cache based on element quadrature rule
        const auto elemQuadRule = CVFE::quadratureRule(fvGeometry, element);
        elementCache_.resize(std::ranges::size(elemQuadRule));
        for (const auto& qpData : elemQuadRule)
            elementCache_[qpData.ipData().qpIndex()].update(gridFluxVarsCache().problem(), element, fvGeometry, elemVolVars, qpData.ipData());
 
        // Rebuild boundary face cache
        for (const auto& boundaryFace : boundaryFaces(fvGeometry))
        {
            auto& bfCache = boundaryFaceCache_[boundaryFace.index()];
            const auto quadRule = CVFE::quadratureRule(fvGeometry, boundaryFace);
            bfCache.resize(std::ranges::size(quadRule));
            for (const auto& qpData : quadRule)
                bfCache[qpData.ipData().qpIndex()].update(gridFluxVarsCache().problem(),
                                                          element,
                                                          fvGeometry,
                                                          elemVolVars,
                                                          qpData.ipData());
        }
    }
 
    template<class FVElementGeometry, class ElementVolumeVariables>
    HybridCVFEElementFluxVariablesCache 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>
    HybridCVFEElementFluxVariablesCache 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)
            bindElement(element, fvGeometry, elemVolVars);
    }
 
    // access cache for a given interpolation point data of an scvf quadrature point
    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 of an scvf quadrature point
    template<Concept::ScvfQpIpData IpData>
    FluxVariablesCache& operator [](const IpData& ipData)
    { return fluxVarsCache_[ipData.scvfIndex()][ipData.qpIndex()]; }
 
    // access cache for a given interpolation point data of a boundary face quadrature point
    template<Concept::BoundaryFaceQpIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    { return boundaryFaceCache_[ipData.boundaryFaceIndex()][ipData.qpIndex()]; }
 
    // access cache for a given interpolation point data of a boundary face quadrature point
    template<Concept::BoundaryFaceQpIpData IpData>
    FluxVariablesCache& operator [](const IpData& ipData)
    { return boundaryFaceCache_[ipData.boundaryFaceIndex()][ipData.qpIndex()]; }
 
    // access cache for a given interpolation point data of an element quadrature point
    template<Concept::QIpData IpData>
    const FluxVariablesCache& operator [](const IpData& ipData) const
    { return elementCache_[ipData.qpIndex()]; }
 
    // access cache for a given interpolation point data of an element quadrature point
    template<Concept::QIpData IpData>
    FluxVariablesCache& operator [](const IpData& ipData)
    { return elementCache_[ipData.qpIndex()]; }
 
    const GridFluxVariablesCache& gridFluxVarsCache() const
    {  return *gridFluxVarsCachePtr_; }
 
private:
    const GridFluxVariablesCache* gridFluxVarsCachePtr_;
    std::vector<std::vector<FluxVariablesCache>> fluxVarsCache_;
    std::vector<FluxVariablesCache> elementCache_;
    std::array<std::vector<FluxVariablesCache>, maxNumBoundaryFaces> boundaryFaceCache_;
};
 
} // end namespace Dumux
 
#endif