cvfelocalresidual.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_CVFE_LOCAL_RESIDUAL_HH
#define DUMUX_CVFE_LOCAL_RESIDUAL_HH
 
#include <dune/common/std/type_traits.hh>
#include <dune/geometry/type.hh>
#include <dune/istl/matrix.hh>
 
#include <dumux/common/typetraits/localdofs_.hh>
#include <dumux/common/typetraits/boundary_.hh>
#include <dumux/common/properties.hh>
#include <dumux/common/numeqvector.hh>
#include <dumux/common/concepts/ipdata_.hh>
#include <dumux/assembly/fvlocalresidual.hh>
#include <dumux/discretization/extrusion.hh>
#include <dumux/discretization/cvfe/interpolationpointdata.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
 
namespace Dumux::Detail {
 
template<class Imp, class P, class G, class S, class V>
using TimeInfoInterfaceCVFEDetector = decltype(
    std::declval<Imp>().computeStorage(
        std::declval<P>(), std::declval<G>(), std::declval<S>(), std::declval<V>(), true
    )
);
 
template<class Imp, class P, class G, class S, class V>
constexpr inline bool hasTimeInfoInterfaceCVFE()
{ return Dune::Std::is_detected<TimeInfoInterfaceCVFEDetector, Imp, P, G, S, V>::value; }
 
template<class Imp>
using SCVFIsOverlappingDetector = decltype(
    std::declval<Imp>().isOverlapping()
);
 
template<class Imp>
constexpr inline bool hasScvfIsOverlapping()
{ return Dune::Std::is_detected<SCVFIsOverlappingDetector, Imp>::value; }
 
template<class Problem>
using ProvidesIntegralInterfaceDetector = decltype(Problem::providesIntegralInterface());
 
template<class Problem>
constexpr inline bool providesIntegralInterface()
{
    if constexpr (Dune::Std::is_detected<ProvidesIntegralInterfaceDetector, Problem>::value)
        return Problem::providesIntegralInterface();
    else
        return false;
}
 
} // end namespace Dumux::Detail
 
 
namespace Dumux {
 
template<class TypeTag>
class CVFELocalResidual : public FVLocalResidual<TypeTag>
{
    using ParentType = FVLocalResidual<TypeTag>;
    using Implementation = GetPropType<TypeTag, Properties::LocalResidual>;
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using Problem = GetPropType<TypeTag, Properties::Problem>;
    using GridGeometry = GetPropType<TypeTag, Properties::GridGeometry>;
    using GridView = typename GridGeometry::GridView;
    using Element = typename GridView::template Codim<0>::Entity;
    using ElementBoundaryTypes = GetPropType<TypeTag, Properties::ElementBoundaryTypes>;
    using FVElementGeometry = typename GridGeometry::LocalView;
    using GridVolumeVariables = GetPropType<TypeTag, Properties::GridVolumeVariables>;
    using ElementVolumeVariables = typename GridVolumeVariables::LocalView;
    using VolumeVariables = typename GridVolumeVariables::VolumeVariables;
    using SubControlVolume = typename FVElementGeometry::SubControlVolume;
    using SubControlVolumeFace = typename FVElementGeometry::SubControlVolumeFace;
    using ElementFluxVariablesCache = typename GetPropType<TypeTag, Properties::GridFluxVariablesCache>::LocalView;
    using PrimaryVariables = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using NumEqVector = Dumux::NumEqVector<PrimaryVariables>;
    using Extrusion = Extrusion_t<GridGeometry>;
 
public:
    using ElementResidualVector = typename ParentType::ElementResidualVector;
    using ParentType::ParentType;
 
    using ParentType::evalStorage;
    ElementResidualVector evalStorage(const Element& element,
                                      const FVElementGeometry& fvGeometry,
                                      const ElementVolumeVariables& prevElemVolVars,
                                      const ElementVolumeVariables& curElemVolVars) const
    {
        assert(!this->isStationary() && "no time loop set for storage term evaluation");
 
        // initialize the residual vector for all scvs in this element
        ElementResidualVector residual(Detail::LocalDofs::numLocalDofs(fvGeometry));
 
        // evaluate the volume terms (storage + source terms)
        // forward to the local residual specialized for the discretization methods
        for (const auto& scv : scvs(fvGeometry))
            this->asImp().evalStorage(residual, this->problem(), element, fvGeometry, prevElemVolVars, curElemVolVars, scv);
 
        // allow for additional contributions (e.g. hybrid CVFE schemes)
        this->asImp().addToElementStorageResidual(residual, this->problem(), element, fvGeometry, prevElemVolVars, curElemVolVars);
 
        return residual;
    }
 
    ElementResidualVector evalFluxAndSource(const Element& element,
                                            const FVElementGeometry& fvGeometry,
                                            const ElementVolumeVariables& elemVolVars,
                                            const ElementFluxVariablesCache& elemFluxVarsCache,
                                            const ElementBoundaryTypes &bcTypes) const
    {
        // initialize the residual vector for all scvs in this element
        ElementResidualVector residual(Detail::LocalDofs::numLocalDofs(fvGeometry));
 
        // evaluate the volume terms (storage + source terms)
        // forward to the local residual specialized for the discretization methods
        for (const auto& scv : scvs(fvGeometry))
            this->asImp().evalSource(residual, this->problem(), element, fvGeometry, elemVolVars, scv);
 
        // forward to the local residual specialized for the discretization methods
        for (auto&& scvf : scvfs(fvGeometry))
            this->asImp().evalFlux(residual, this->problem(), element, fvGeometry, elemVolVars, bcTypes, elemFluxVarsCache, scvf);
 
        // allow for additional contributions (e.g. hybrid CVFE schemes)
        this->asImp().addToElementFluxAndSourceResidual(residual, this->problem(), element, fvGeometry, elemVolVars, elemFluxVarsCache, bcTypes);
 
        return residual;
    }
 
    void addToElementStorageResidual(ElementResidualVector& residual,
                                     const Problem& problem,
                                     const Element& element,
                                     const FVElementGeometry& fvGeometry,
                                     const ElementVolumeVariables& prevElemVolVars,
                                     const ElementVolumeVariables& curElemVolVars) const
    {}
 
    void addToElementFluxAndSourceResidual(ElementResidualVector& residual,
                                           const Problem& problem,
                                           const Element& element,
                                           const FVElementGeometry& fvGeometry,
                                           const ElementVolumeVariables& curElemVolVars,
                                           const ElementFluxVariablesCache& elemFluxVarsCache,
                                           const ElementBoundaryTypes &bcTypes) const
    {}
 
    void evalFlux(ElementResidualVector& residual,
                  const Problem& problem,
                  const Element& element,
                  const FVElementGeometry& fvGeometry,
                  const ElementVolumeVariables& elemVolVars,
                  const ElementBoundaryTypes& elemBcTypes,
                  const ElementFluxVariablesCache& elemFluxVarsCache,
                  const SubControlVolumeFace& scvf) const
    {
        const auto flux = this->asImp().evalFlux(problem, element, fvGeometry, elemVolVars, elemBcTypes, elemFluxVarsCache, scvf);
        if (!scvf.boundary())
        {
            const auto& insideScv = fvGeometry.scv(scvf.insideScvIdx());
            const auto& outsideScv = fvGeometry.scv(scvf.outsideScvIdx());
            residual[insideScv.localDofIndex()] += flux;
 
            // for control-volume finite element schemes with overlapping control volumes
            if constexpr (Detail::hasScvfIsOverlapping<SubControlVolumeFace>())
            {
                if (!scvf.isOverlapping())
                    residual[outsideScv.localDofIndex()] -= flux;
            }
            else
                residual[outsideScv.localDofIndex()] -= flux;
        }
        else
        {
            const auto& insideScv = fvGeometry.scv(scvf.insideScvIdx());
            residual[insideScv.localDofIndex()] += flux;
        }
    }
 
    NumEqVector evalFlux(const Problem& problem,
                         const Element& element,
                         const FVElementGeometry& fvGeometry,
                         const ElementVolumeVariables& elemVolVars,
                         const ElementBoundaryTypes& elemBcTypes,
                         const ElementFluxVariablesCache& elemFluxVarsCache,
                         const SubControlVolumeFace& scvf) const
    {
        NumEqVector flux(0.0);
 
        if constexpr (Detail::providesIntegralInterface<Problem>())
        {
            if(!scvf.boundary())
                flux += this->asImp().fluxIntegral(fvGeometry, elemVolVars, elemFluxVarsCache, scvf);
            else
            {
                const auto& bcTypes = bcTypes_(problem, fvGeometry, scvf, elemBcTypes);
 
                // Treat Neumann and Robin ("solution dependent Neumann") boundary conditions.
                // For Dirichlet there is no addition to the residual here but they
                // are enforced strongly by replacing the residual entry afterwards.
                if (bcTypes.hasNeumann())
                {
                    NumEqVector boundaryFluxes = problem.boundaryFluxIntegral(fvGeometry, elemVolVars, elemFluxVarsCache, scvf);
 
                    // only add fluxes to equations for which Neumann is set
                    for (int eqIdx = 0; eqIdx < NumEqVector::dimension; ++eqIdx)
                        if (bcTypes.isNeumann(eqIdx))
                            flux[eqIdx] += boundaryFluxes[eqIdx];
                }
            }
        }
        else
        {
            if(!scvf.boundary())
            {
                flux += this->asImp().computeFlux(problem, element, fvGeometry, elemVolVars, scvf, elemFluxVarsCache);
            }
            else
            {
                const auto& bcTypes = bcTypes_(problem, fvGeometry, scvf, elemBcTypes);
 
                // Treat Neumann and Robin ("solution dependent Neumann") boundary conditions.
                // For Dirichlet there is no addition to the residual here but they
                // are enforced strongly by replacing the residual entry afterwards.
                if (bcTypes.hasNeumann())
                {
                    NumEqVector boundaryFluxes;
                    boundaryFluxes = problem.neumann(element, fvGeometry, elemVolVars, elemFluxVarsCache, scvf);
                    // multiply neumann fluxes with the area and the extrusion factor
                    const auto& scv = fvGeometry.scv(scvf.insideScvIdx());
                    boundaryFluxes *= Extrusion::area(fvGeometry, scvf) * elemVolVars[scv].extrusionFactor();
 
                    // only add fluxes to equations for which Neumann is set
                    for (int eqIdx = 0; eqIdx < NumEqVector::dimension; ++eqIdx)
                        if (bcTypes.isNeumann(eqIdx))
                            flux[eqIdx] += boundaryFluxes[eqIdx];
                }
            }
       }
 
        return flux;
    }
 
    void evalStorage(ElementResidualVector& residual,
                     const Problem& problem,
                     const Element& element,
                     const FVElementGeometry& fvGeometry,
                     const ElementVolumeVariables& prevElemVolVars,
                     const ElementVolumeVariables& curElemVolVars,
                     const SubControlVolume& scv) const
    {
        if constexpr (Detail::providesIntegralInterface<Problem>())
        {
            NumEqVector prevStorage = this->asImp().storageIntegral(fvGeometry, prevElemVolVars, scv, /*previous time level?*/true);
            NumEqVector storage = this->asImp().storageIntegral(fvGeometry, curElemVolVars, scv, /*previous time level?*/false);
 
            storage -= prevStorage;
            storage /= this->timeLoop().timeStepSize();
 
            residual[scv.localDofIndex()] += storage;
        }
        else
        {
            const auto& curVolVars = curElemVolVars[scv];
            const auto& prevVolVars = prevElemVolVars[scv];
 
            // Compute storage with the model specific storage residual
            // This addresses issues #792/#940 in ad-hoc way by additionally providing crude time level information (previous or current)
            // to the low-level interfaces if this is supported by the LocalResidual implementation
            NumEqVector prevStorage = computeStorageImpl_(problem, fvGeometry, scv, prevVolVars, /*previous time level?*/true);
            NumEqVector storage = computeStorageImpl_(problem, fvGeometry, scv, curVolVars, /*previous time level?*/false);
 
            prevStorage *= prevVolVars.extrusionFactor();
            storage *= curVolVars.extrusionFactor();
 
            storage -= prevStorage;
            storage *= Extrusion::volume(fvGeometry, scv);
            storage /= this->timeLoop().timeStepSize();
 
            residual[scv.localDofIndex()] += storage;
        }
    }
 
    using ParentType::evalSource;
    void evalSource(ElementResidualVector& residual,
                    const Problem& problem,
                    const Element& element,
                    const FVElementGeometry& fvGeometry,
                    const ElementVolumeVariables& curElemVolVars,
                    const SubControlVolume& scv) const
    {
        NumEqVector source(0.0);
        if constexpr (Detail::providesIntegralInterface<Problem>())
            source = this->asImp().sourceIntegral(fvGeometry, curElemVolVars, scv);
        else
        {
            source = this->asImp().computeSource(problem, element, fvGeometry, curElemVolVars, scv);
            source *= Extrusion::volume(fvGeometry, scv);
 
            const auto& curVolVars = curElemVolVars[scv];
            source *= curVolVars.extrusionFactor();
        }
        residual[scv.localDofIndex()] -= source;
    }
 
private:
    NumEqVector computeStorageImpl_(const Problem& problem,
                                    const FVElementGeometry& fvGeometry,
                                    const SubControlVolume& scv,
                                    const VolumeVariables& volVars,
                                    [[maybe_unused]] bool isPreviousTimeStep) const
    {
        if constexpr (Detail::hasTimeInfoInterfaceCVFE<Implementation, Problem, FVElementGeometry, SubControlVolume, VolumeVariables>())
            return this->asImp().computeStorage(problem, fvGeometry, scv, volVars, isPreviousTimeStep);
        else
            return this->asImp().computeStorage(problem, scv, volVars);
    }
 
    auto bcTypes_(const Problem& problem,
                  const FVElementGeometry& fvGeometry,
                  const SubControlVolumeFace& scvf,
                  const ElementBoundaryTypes& elemBcTypes) const
    {
        // Check if problem supports the new boundaryTypes function for element intersections
        // then we can always get bcTypes for intersections and the associated scvfs
        if constexpr (Detail::hasProblemBoundaryTypesForIntersectionFunction<Problem, FVElementGeometry, typename GridView::Intersection>())
            return elemBcTypes.get(fvGeometry, scvf);
        else
            return elemBcTypes.get(fvGeometry, fvGeometry.scv(scvf.insideScvIdx()));
    }
 
};
 
} // end namespace Dumux
 
#endif