fem/gridvariablescache.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_FE_GRID_LOCAL_VARIABLES_HH
#define DUMUX_DISCRETIZATION_FE_GRID_LOCAL_VARIABLES_HH
 
#include <type_traits>
#include <utility>
#include <vector>
#include <ranges>
#include <memory>
 
#include <dumux/parallel/parallel_for.hh>
 
#include <dumux/common/concepts/localdofs_.hh>
 
// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/cvfe/elementsolution.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
#include "elementvariables.hh"
 
namespace Dumux::Experimental {
 
template<class P, class V, class IPD>
struct FEDefaultGridVariablesCacheTraits
{
    using Problem = P;
    using Variables = V;
    using InterpolationPointData = IPD;
 
    template<class GridVariablesCache, bool cachingEnabled>
    using LocalView = FEElementVariables<GridVariablesCache, cachingEnabled>;
};

template<class Traits, bool enableCaching, bool enableIpDataCaching = enableCaching>
class FEGridVariablesCache;
 
// specialization in case of storing the local variables
template<class Traits, bool enableIpDataCaching>
class FEGridVariablesCache<Traits, /*cachingEnabled*/true, enableIpDataCaching>
{
    using ThisType = FEGridVariablesCache<Traits, true, enableIpDataCaching>;
public:
    using Problem = typename Traits::Problem;

    using Variables = typename Traits::Variables;

    using InterpolationPointData = typename Traits::InterpolationPointData;

    static constexpr bool cachingEnabled = true;

    static constexpr bool interpolationPointDataCachingEnabled = enableIpDataCaching;
 
    static_assert(enableIpDataCaching || !InterpolationPointData::isSolDependent,
                  "Solution-dependent interpolation point data are stored together with the variables");

    using LocalView = typename Traits::template LocalView<ThisType, cachingEnabled>;

    using MutableLocalView = typename LocalView::MutableView;
 
    FEGridVariablesCache(const Problem& problem) : problemPtr_(&problem) {}
 
    template<class GridDiscretization, class SolutionVector>
    void init(const GridDiscretization& gridDiscretization, const SolutionVector& sol)
    {
        variables_.resize(gridDiscretization.gridView().size(0));
        if constexpr (enableIpDataCaching)
            ipDataCache_ = std::make_shared<std::vector<ElementInterpolationPointDataCache>>(gridDiscretization.gridView().size(0));
 
        Dumux::parallelFor(gridDiscretization.gridView().size(0), [&, &problem = problem()](const std::size_t eIdx)
        {
            const auto element = gridDiscretization.element(eIdx);
            const auto elemDisc = localView(gridDiscretization).bindElement(element);
 
            // get the element solution
            auto elemSol = elementSolution(element, sol, gridDiscretization);
 
            variables_[eIdx].resize(Dumux::Detail::LocalDofs::numLocalDofs(elemDisc));
            for (const auto& localDof : localDofs(elemDisc))
                variables_[eIdx][localDof.index()].update(elemSol, problem, elemDisc, ipData(elemDisc, localDof));
 
            if constexpr (enableIpDataCaching)
                (*ipDataCache_)[eIdx].update(problem, element, elemDisc, variables_[eIdx]);
        });
    }
 
    template<class GridDiscretization, class SolutionVector>
    void update(const GridDiscretization& gridDiscretization, const SolutionVector& sol)
    {
        if constexpr (InterpolationPointData::isSolDependent)
        {
            auto newIpDataCache = std::make_shared<std::vector<ElementInterpolationPointDataCache>>(*ipDataCache_);
 
            Dumux::parallelFor(gridDiscretization.gridView().size(0), [&, &problem = problem(), newIpDataCache](const std::size_t eIdx)
            {
                const auto element = gridDiscretization.element(eIdx);
                const auto elemDisc = localView(gridDiscretization).bindElement(element);
 
                // get the element solution
                auto elemSol = elementSolution(element, sol, gridDiscretization);
 
                for (const auto& localDof : localDofs(elemDisc))
                    variables_[eIdx][localDof.index()].update(elemSol, problem, elemDisc, ipData(elemDisc, localDof));
 
                (*newIpDataCache)[eIdx].update(problem, element, elemDisc, variables_[eIdx]);
            });
 
            ipDataCache_ = std::move(newIpDataCache);
        }
        else
        {
            Dumux::parallelFor(gridDiscretization.gridView().size(0), [&, &problem = problem()](const std::size_t eIdx)
            {
                const auto element = gridDiscretization.element(eIdx);
                const auto elemDisc = localView(gridDiscretization).bindElement(element);
 
                // get the element solution
                auto elemSol = elementSolution(element, sol, gridDiscretization);
 
                for (const auto& localDof : localDofs(elemDisc))
                    variables_[eIdx][localDof.index()].update(elemSol, problem, elemDisc, ipData(elemDisc, localDof));
            });
        }
    }
 
    template<class LocalDof>
    const Variables& variables(const LocalDof& localDof) const
    { return variables_[localDof.elementIndex()][localDof.index()]; }
 
    template<class LocalDof>
    Variables& variables(const LocalDof& localDof)
    { return variables_[localDof.elementIndex()][localDof.index()]; }
 
    const Variables& variables(const std::size_t eIdx, const std::size_t localIdx) const
    { return variables_[eIdx][localIdx]; }
 
    Variables& variables(const std::size_t eIdx, const std::size_t localIdx)
    { return variables_[eIdx][localIdx]; }

    const std::vector<Variables>& localDofVariables(const std::size_t eIdx) const
    { return variables_[eIdx]; }
 
    const InterpolationPointData& elementCache(std::size_t eIdx, std::size_t qpIdx) const
    { return (*ipDataCache_)[eIdx].elementCache(qpIdx); }
 
    InterpolationPointData& elementCache(std::size_t eIdx, std::size_t qpIdx)
    { return (*ipDataCache_)[eIdx].elementCache(qpIdx); }
 
    const InterpolationPointData& boundaryFaceCache(std::size_t eIdx, int bfIdx, std::size_t qpIdx) const
    { return (*ipDataCache_)[eIdx].boundaryFaceCache(bfIdx, qpIdx); }
 
    InterpolationPointData& boundaryFaceCache(std::size_t eIdx, int bfIdx, std::size_t qpIdx)
    { return (*ipDataCache_)[eIdx].boundaryFaceCache(bfIdx, qpIdx); }
 
    const auto& cache(std::size_t eIdx) const
    { return (*ipDataCache_)[eIdx]; }
 
    auto& cache(std::size_t eIdx)
    { return (*ipDataCache_)[eIdx]; }
 
    const Problem& problem() const
    { return *problemPtr_; }
 
private:
    using ElementInterpolationPointDataCache = Dumux::Detail::CVFE::ElementAndBoundaryInterpolationPointDataCache<InterpolationPointData>;
 
    const Problem* problemPtr_;
    std::vector<std::vector<Variables>> variables_;
    std::shared_ptr<std::vector<ElementInterpolationPointDataCache>> ipDataCache_;
};
 
// Specialization when the current local variables are not stored
template<class Traits, bool enableIpDataCaching>
class FEGridVariablesCache<Traits, /*cachingEnabled*/false, enableIpDataCaching>
{
    using ThisType = FEGridVariablesCache<Traits, false, enableIpDataCaching>;
 
public:
    using Problem = typename Traits::Problem;

    using Variables = typename Traits::Variables;

    static constexpr bool cachingEnabled = false;

    using InterpolationPointData = typename Traits::InterpolationPointData;

    static constexpr bool interpolationPointDataCachingEnabled = enableIpDataCaching;
 
    static_assert(!enableIpDataCaching || !InterpolationPointData::isSolDependent,
                  "Solution-dependent interpolation point data are stored together with the variables");

    using LocalView = typename Traits::template LocalView<ThisType, cachingEnabled>;

    using MutableLocalView = typename LocalView::MutableView;
 
    FEGridVariablesCache(const Problem& problem) : problemPtr_(&problem) {}
 
    template<class GridDiscretization, class SolutionVector>
    void init(const GridDiscretization& gridDiscretization, const SolutionVector& sol)
    {
        if constexpr (enableIpDataCaching)
        {
            auto ipDataCache = std::make_shared<std::vector<ElementInterpolationPointDataCache>>(gridDiscretization.gridView().size(0));
            Dumux::parallelFor(gridDiscretization.gridView().size(0), [&, &problem = problem()](const std::size_t eIdx)
            {
                const auto element = gridDiscretization.element(eIdx);
                const auto elemDisc = localView(gridDiscretization).bindElement(element);
                const auto elemSol = elementSolution(element, sol, gridDiscretization);
 
                std::vector<Variables> variables(Dumux::Detail::LocalDofs::numLocalDofs(elemDisc));
                for (const auto& localDof : localDofs(elemDisc))
                    variables[localDof.index()].update(elemSol, problem, elemDisc, ipData(elemDisc, localDof));
 
                (*ipDataCache)[eIdx].update(problem, element, elemDisc, variables);
            });
            ipDataCache_ = std::move(ipDataCache);
        }
    }
 
    template<class GridDiscretization, class SolutionVector>
    void update(const GridDiscretization& gridDiscretization, const SolutionVector& sol) {}
 
    const auto& cache(std::size_t eIdx) const
    { return (*ipDataCache_)[eIdx]; }
 
    const Problem& problem() const
    { return *problemPtr_;}
 
private:
    using ElementInterpolationPointDataCache = Dumux::Detail::CVFE::ElementAndBoundaryInterpolationPointDataCache<InterpolationPointData>;
 
    const Problem* problemPtr_;
    std::shared_ptr<const std::vector<ElementInterpolationPointDataCache>> ipDataCache_;
};
 
} // end namespace Dumux::Experimental
 
#endif