freeflow/navierstokes/momentum/cvfe/localresidual.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_NAVIERSTOKES_MOMENTUM_CVFE_LOCAL_RESIDUAL_HH
#define DUMUX_NAVIERSTOKES_MOMENTUM_CVFE_LOCAL_RESIDUAL_HH
 
#include <dune/common/hybridutilities.hh>
#include <dune/geometry/quadraturerules.hh>
 
#include <dumux/common/properties.hh>
#include <dumux/common/numeqvector.hh>
#include <dumux/common/concepts/variables_.hh>
#include <dumux/common/typetraits/localdofs_.hh>
#include <dumux/common/boundaryflag.hh>
 
#include <dumux/discretization/defaultlocaloperator.hh>
#include <dumux/discretization/extrusion.hh>
#include <dumux/discretization/method.hh>
#include <dumux/discretization/fem/interpolationpointdata.hh>
#include <dumux/discretization/cvfe/interpolationpointdata.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
 
#include <dumux/freeflow/navierstokes/momentum/cvfe/flux.hh>
#include <dumux/freeflow/navierstokes/momentum/cvfe/felocalresidual.hh>
 
namespace Dumux {
 
namespace Detail {
 
template<class P, class FVG, class EV, class IPD>
using SourceWithIpDataInterface = decltype(
    std::declval<P>().source(std::declval<FVG>(), std::declval<EV>(), std::declval<IPD>())
);
 
template<class P, class FVG, class EV, class IPD>
constexpr inline bool hasProblemSourceWithIpDataInterface()
{ return Dune::Std::is_detected<SourceWithIpDataInterface, P, FVG, EV, IPD>::value; }
 
} // end namespace Detail
 
template<class TypeTag>
class NavierStokesMomentumCVFELocalResidual
: public DiscretizationDefaultLocalOperator<TypeTag>
{
    using ParentType = DiscretizationDefaultLocalOperator<TypeTag>;
 
    using GridVariables = GetPropType<TypeTag, Properties::GridVariables>;
 
    using GridVariablesCache = Concept::GridVariablesCache_t<GridVariables>;
    using ElementVariables = typename GridVariablesCache::LocalView;
    using Variables = Concept::Variables_t<GridVariables>;
 
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using Problem = GetPropType<TypeTag, Properties::Problem>;
    using GridGeometry = GetPropType<TypeTag, Properties::GridGeometry>;
    using FVElementGeometry = typename GridGeometry::LocalView;
    using SubControlVolume = typename FVElementGeometry::SubControlVolume;
    using SubControlVolumeFace = typename FVElementGeometry::SubControlVolumeFace;
    using GridView = typename GridGeometry::GridView;
    using Element = typename GridView::template Codim<0>::Entity;
    using ElementBoundaryTypes = GetPropType<TypeTag, Properties::ElementBoundaryTypes>;
    using Indices = typename GetPropType<TypeTag, Properties::ModelTraits>::Indices;
    using PrimaryVariables = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using NumEqVector = Dumux::NumEqVector<PrimaryVariables>;
 
    using Extrusion = Extrusion_t<GridGeometry>;
 
    using ModelTraits = GetPropType<TypeTag, Properties::ModelTraits>;
 
    static constexpr auto dim = GridView::dimension;
 
    using LocalBasis = typename GridGeometry::FeCache::FiniteElementType::Traits::LocalBasisType;
    using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
    using BaseIpData = Dumux::CVFE::InterpolationPointData<typename GridView::template Codim<0>::Entity::Geometry::LocalCoordinate, GlobalPosition>;
    using FluxHelper = NavierStokesMomentumFluxCVFE<GridGeometry, NumEqVector>;
    using FeResidual = NavierStokesMomentumFELocalResidual<Scalar, NumEqVector, LocalBasis, Extrusion>;
 
    using FluxFunctionHelper = NavierStokesMomentumFluxFunctionCVFE<GridGeometry, NumEqVector>;
 
public:
    using ElementResidualVector = typename ParentType::ElementResidualVector;
    using ParentType::ParentType;
 
    NumEqVector computeStorage(const Problem& problem,
                               const FVElementGeometry& fvGeometry,
                               const SubControlVolume& scv,
                               const Variables& vars,
                               const bool isPreviousStorage) const
    {
        return problem.density(fvGeometry.element(), fvGeometry, ipData(fvGeometry, scv), isPreviousStorage) * vars.velocity();
    }
 
    NumEqVector storageIntegral(const FVElementGeometry& fvGeometry,
                                const ElementVariables& elemVars,
                                const SubControlVolume& scv,
                                bool isPreviousTimeLevel) const
    {
        const auto& vars = elemVars[scv];
        // We apply mass lumping
        NumEqVector storage = this->asImp().problem().density(fvGeometry.element(), fvGeometry, ipData(fvGeometry, scv), isPreviousTimeLevel)
                            * vars.velocity();
 
        storage *= Extrusion::volume(fvGeometry, scv) * vars.extrusionFactor();
 
        return storage;
    }
 
    NumEqVector computeSource(const Problem& problem,
                              const Element& element,
                              const FVElementGeometry& fvGeometry,
                              const ElementVariables& elemVars,
                              const SubControlVolume& scv) const
    {
        NumEqVector source;
 
        if constexpr (Detail::hasProblemSourceWithIpDataInterface<Problem, FVElementGeometry, ElementVariables, BaseIpData>())
        {
            source = problem.source(fvGeometry, elemVars, ipData(fvGeometry, scv.center()));
 
            // ToDo: point source data with ipData
            // add contribution from possible point sources
            if (!problem.pointSourceMap().empty())
                source += problem.scvPointSources(element, fvGeometry, elemVars, scv);
        }
        else
            source = ParentType::computeSource(problem, element, fvGeometry, elemVars, scv);
 
 
        // add rho*g (note that gravity might be zero in case it's disabled in the problem)
        const auto& data = ipData(fvGeometry, scv);
        source +=  problem.density(element, fvGeometry, data) * problem.gravity();
 
        // Axisymmetric problems in 2D feature an extra source term arising from the transformation to cylindrical coordinates.
        // See Ferziger/Peric: Computational methods for Fluid Dynamics (2020)
        // https://doi.org/10.1007/978-3-319-99693-6
        // Chapter 9.9 and Eq. (9.81) and comment on finite volume methods
        if constexpr (dim == 2 && isRotationalExtrusion<Extrusion>)
        {
            // the radius with respect to the rotation axis
            const auto r = scv.center()[Extrusion::radialAxis] - fvGeometry.gridGeometry().bBoxMin()[Extrusion::radialAxis];
 
            // The velocity term is new with respect to Cartesian coordinates and handled below as a source term
            // It only enters the balance of the momentum balance in radial direction
            source[Extrusion::radialAxis] += -2.0*problem.effectiveViscosity(element, fvGeometry, data)
                * elemVars[scv].velocity(Extrusion::radialAxis) / (r*r);
 
            // Pressure term (needed because we incorporate pressure in terms of a surface integral).
            // grad(p) becomes div(pI) + (p/r)*n_r in cylindrical coordinates. The second term
            // is new with respect to Cartesian coordinates and handled below as a source term.
            source[Extrusion::radialAxis] += problem.pressure(element, fvGeometry, data)/r;
        }
 
        return source;
    }
 
    NumEqVector sourceIntegral(const FVElementGeometry& fvGeometry,
                               const ElementVariables& elemVars,
                               const SubControlVolume& scv) const
    {
        static_assert(!(dim == 2 && isRotationalExtrusion<Extrusion>), "Rotational extrusion source terms are not implemented for integral interface.");
 
        const auto& problem = this->asImp().problem();
 
        NumEqVector source(0.0);
        for (const auto& qpData : CVFE::quadratureRule(fvGeometry, scv))
        {
            source += qpData.weight() * (problem.source(fvGeometry, elemVars, qpData.ipData())
                                        + problem.density(fvGeometry.element(), fvGeometry, qpData.ipData()) * problem.gravity());
        }
 
        // ToDo: point source data with ipData
        // add contribution from possible point sources
        if (!problem.pointSourceMap().empty())
            source += Extrusion::volume(fvGeometry, scv) * problem.scvPointSources(fvGeometry.element(), fvGeometry, elemVars, scv);
 
        source *= elemVars[scv].extrusionFactor();
 
        return source;
    }
 
    template<class ElementFluxVariablesCache>
    NumEqVector computeFlux(const Problem& problem,
                            const Element& element,
                            const FVElementGeometry& fvGeometry,
                            const ElementVariables& elemVars,
                            const SubControlVolumeFace& scvf,
                            const ElementFluxVariablesCache& elemFluxVarsCache) const
    {
        using FluxContext = NavierStokesMomentumFluxContext<Problem, FVElementGeometry, ElementVariables, ElementFluxVariablesCache>;
        FluxContext context(problem, fvGeometry, elemVars, elemFluxVarsCache, scvf);
        FluxHelper fluxHelper;
 
        NumEqVector flux(0.0);
        flux += fluxHelper.advectiveMomentumFlux(context);
        flux += fluxHelper.diffusiveMomentumFlux(context);
        flux += fluxHelper.pressureContribution(context);
        return flux;
    }
 
    template<class ElementFluxVariablesCache>
    [[deprecated("This function is deprecated and will be removed after release 3.11. "
                 "Use fluxIntegral without elemFluxVarsCache instead.")]]
    NumEqVector fluxIntegral(const FVElementGeometry& fvGeometry,
                             const ElementVariables& elemVars,
                             const ElementFluxVariablesCache& elemFluxVarsCache,
                             const SubControlVolumeFace& scvf) const
    {
        using FluxVariablesCache = typename ElementFluxVariablesCache::FluxVariablesCache;
        using FluxFunctionContext = NavierStokesMomentumFluxFunctionContext<Problem, FVElementGeometry, ElementVariables, FluxVariablesCache>;
 
        const auto& problem = this->asImp().problem();
 
        NumEqVector flux(0.0);
        GlobalPosition velIntegral(0.0);
        FluxFunctionHelper fluxFunctionHelper;
 
        for (const auto& qpData : CVFE::quadratureRule(fvGeometry, scvf))
        {
            const auto& fluxVarsCache = elemFluxVarsCache[qpData.ipData()];
            FluxFunctionContext context(this->problem(), fvGeometry, elemVars, fluxVarsCache);
 
            velIntegral += context.velocity() * qpData.weight();
            flux += qpData.weight() * ( fluxFunctionHelper.diffusiveMomentumFluxIntegrand(context, qpData.ipData())
                                      + fluxFunctionHelper.pressureFluxIntegrand(context, qpData.ipData()) );
        }
        flux += fluxFunctionHelper.advectiveMomentumFluxIntegral(problem, fvGeometry, elemVars, scvf, velIntegral);
 
        flux *= elemVars[fvGeometry.scv(scvf.insideScvIdx())].extrusionFactor();
 
        return flux;
    }
 
    NumEqVector fluxIntegral(const FVElementGeometry& fvGeometry,
                             const ElementVariables& elemVars,
                             const SubControlVolumeFace& scvf) const
    {
        const auto& problem = this->asImp().problem();
 
        NumEqVector flux(0.0);
        GlobalPosition velIntegral(0.0);
        FluxFunctionHelper fluxFunctionHelper;
        using FluxFunctionContext = NavierStokesMomentumFluxFunctionContext<Problem, FVElementGeometry, ElementVariables, typename GridVariablesCache::InterpolationPointData>;
 
        for (const auto& qpData : CVFE::quadratureRule(fvGeometry, scvf))
        {
            const auto& ipCache = cache(elemVars, qpData.ipData());
            FluxFunctionContext context(this->problem(), fvGeometry, elemVars, ipCache);
 
            velIntegral += context.velocity() * qpData.weight();
            flux += qpData.weight() * ( fluxFunctionHelper.diffusiveMomentumFluxIntegrand(context, qpData.ipData())
                                      + fluxFunctionHelper.pressureFluxIntegrand(context, qpData.ipData()) );
        }
        flux += fluxFunctionHelper.advectiveMomentumFluxIntegral(problem, fvGeometry, elemVars, scvf, velIntegral);
 
        flux *= elemVars[fvGeometry.scv(scvf.insideScvIdx())].extrusionFactor();
 
        return flux;
    }
 
    void addToElementStorageResidual(ElementResidualVector& residual,
                                     const Problem& problem,
                                     const Element& element,
                                     const FVElementGeometry& fvGeometry,
                                     const ElementVariables& prevElemVolVars,
                                     const ElementVariables& curElemVolVars) const
    {
        FeResidual::addStorageTerms(
            residual, problem, fvGeometry, prevElemVolVars, curElemVolVars, this->timeLoop().timeStepSize()
        );
    }
 
    template<class ElementFluxVariablesCache>
    [[deprecated("This function is deprecated and will be removed after release 3.11. "
                 "Use addToElementFluxAndSourceResidual without elemFluxVarsCache instead.")]]
    void addToElementFluxAndSourceResidual(ElementResidualVector& residual,
                                           const Problem& problem,
                                           const Element& element,
                                           const FVElementGeometry& fvGeometry,
                                           const ElementVariables& elemVars,
                                           const ElementFluxVariablesCache& elemFluxVarsCache,
                                           const ElementBoundaryTypes &elemBcTypes) const
    {
        FeResidual::addFluxAndSourceTerms(
            residual, problem, fvGeometry, elemVars, elemFluxVarsCache, elemBcTypes
        );
    }
 
    void addToElementFluxAndSourceResidual(ElementResidualVector& residual,
                                           const Problem& problem,
                                           const Element& element,
                                           const FVElementGeometry& fvGeometry,
                                           const ElementVariables& elemVars,
                                           const ElementBoundaryTypes &elemBcTypes) const
    {
        FeResidual::addFluxAndSourceTerms(
            residual, problem, fvGeometry, elemVars, elemBcTypes
        );
    }
 
};
 
} // end namespace Dumux
 
#endif