freeflow/navierstokes/mass/1p/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_FREEFLOW_NAVIERSTOKES_MASS_1P_LOCAL_RESIDUAL_HH
#define DUMUX_FREEFLOW_NAVIERSTOKES_MASS_1P_LOCAL_RESIDUAL_HH
 
#include <type_traits>
 
#include <dumux/common/numeqvector.hh>
#include <dumux/common/properties.hh>
#include <dumux/common/parameters.hh>
#include <dumux/common/concepts/variables_.hh>
#include <dumux/discretization/defaultlocaloperator.hh>
#include <dumux/discretization/extrusion.hh>
#include <dumux/discretization/cvfe/quadraturerules.hh>
#include <dumux/freeflow/navierstokes/mass/1p/felocalresidual.hh>
 
namespace Dumux {

template<class Problem>
struct ImplementsAuxiliaryFluxNavierStokesMassOneP
: public std::false_type
{};

template<class TypeTag>
class NavierStokesMassOnePLocalResidual
: 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 ElementDiscretization = typename GridGeometry::LocalView;
    using SubControlVolume = typename ElementDiscretization::SubControlVolume;
    using SubControlVolumeFace = typename ElementDiscretization::SubControlVolumeFace;
    using GridView = typename GridGeometry::GridView;
    using Element = typename GridView::template Codim<0>::Entity;
    using NumEqVector = Dumux::NumEqVector<GetPropType<TypeTag, Properties::PrimaryVariables>>;
    using ModelTraits = GetPropType<TypeTag, Properties::ModelTraits>;
 
    using Extrusion = Extrusion_t<GridGeometry>;
    using FeResidual = NavierStokesMassOnePFELocalResidualTerms<Scalar, typename ModelTraits::Indices>;
 
public:
    using ParentType::ParentType;

    template<class ElementResidualVector>
    void addToElementStorage(ElementResidualVector& storage,
                             const Problem& problem,
                             const Element& element,
                             const ElementDiscretization& elemDisc,
                             const ElementVariables& elemVars,
                             bool isPreviousTimeLevel) const
    {
        FeResidual::addStorageTerms(storage, problem, elemDisc, elemVars, isPreviousTimeLevel);
    }

    template<class ElementResidualVector>
    void addToElementFluxAndSourceResidual(ElementResidualVector& residual,
                                           const Problem& problem,
                                           const Element& element,
                                           const ElementDiscretization& elemDisc,
                                           const ElementVariables& elemVars) const
    {
        FeResidual::addFluxAndSourceTerms(residual, problem, elemDisc, elemVars);
    }

    NumEqVector computeStorage(const Problem& problem,
                               const SubControlVolume& scv,
                               const Variables& vars) const
    {
        NumEqVector storage(0.0);
        storage[ModelTraits::Indices::conti0EqIdx] = vars.density();
 
        // consider energy storage for non-isothermal models
        if constexpr (ModelTraits::enableEnergyBalance())
            storage[ModelTraits::Indices::energyEqIdx] = vars.density() * vars.internalEnergy();
 
        return storage;
    }

    NumEqVector storageIntegral(const ElementDiscretization& elemDisc,
                                const ElementVariables& elemVars,
                                const SubControlVolume& scv,
                                bool isPreviousTimeLevel) const
    {
        const auto& vars = elemVars[scv];
        // We apply mass lumping here
        NumEqVector storage(0.0);
        storage[ModelTraits::Indices::conti0EqIdx] = vars.density();
 
        // consider energy storage for non-isothermal models
        if constexpr (ModelTraits::enableEnergyBalance())
            storage[ModelTraits::Indices::energyEqIdx] = vars.density() * vars.internalEnergy();
 
        storage *= Extrusion::volume(elemDisc, scv) * vars.extrusionFactor();
 
        return storage;
    }

    template<class ElementFluxVariablesCache>
    NumEqVector computeFlux(const Problem& problem,
                            const Element& element,
                            const ElementDiscretization& elemDisc,
                            const ElementVariables& elemVars,
                            const SubControlVolumeFace& scvf,
                            const ElementFluxVariablesCache& elemFluxVarsCache) const
    {
        using FluxVariables = GetPropType<TypeTag, Properties::FluxVariables>;
        FluxVariables fluxVars;
        fluxVars.init(problem, element, elemDisc, elemVars, scvf, elemFluxVarsCache);
        auto flux = fluxVars.flux(0);
 
        // the auxiliary flux is enabled if the trait is specialized for the problem
        // this can be used, for example, to implement flux stabilization terms
        if constexpr (ImplementsAuxiliaryFluxNavierStokesMassOneP<Problem>::value)
            flux += problem.auxiliaryFlux(element, elemDisc, elemVars, elemFluxVarsCache, scvf);
 
        return flux;
    }

    NumEqVector fluxIntegral(const ElementDiscretization& elemDisc,
                             const ElementVariables& elemVars,
                             const SubControlVolumeFace& scvf) const
    {
        static_assert(!ModelTraits::enableEnergyBalance(),
                      "The flux integral does not include the energy balance");
 
        const auto& problem = this->asImp().problem();
        Scalar volumeFlux = 0.0;
        for (const auto& qpData : CVFE::quadratureRule(elemDisc, scvf))
        {
            const auto& faceIpData = qpData.ipData();
            volumeFlux += qpData.weight() * (problem.velocity(elemDisc, faceIpData) * faceIpData.unitOuterNormal());
        }
 
        static const auto upwindWeight
            = getParamFromGroup<Scalar>(this->problem().paramGroup(), "Flux.UpwindWeight", 1.0);
 
        const auto& insideVars = elemVars[elemDisc.scv(scvf.insideScvIdx())];
        const auto& outsideVars = elemVars[elemDisc.scv(scvf.outsideScvIdx())];
        const bool insideIsUpwind = volumeFlux > 0.0;
        const auto& upwindVars = insideIsUpwind ? insideVars : outsideVars;
        const auto& downwindVars = insideIsUpwind ? outsideVars : insideVars;
 
        NumEqVector flux(0.0);
        flux[ModelTraits::Indices::conti0EqIdx]
            = volumeFlux * (upwindWeight * upwindVars.density() + (1.0 - upwindWeight) * downwindVars.density());
 
        // the auxiliary flux is enabled if the trait is specialized for the problem
        // this can be used, for example, to implement flux stabilization terms
        if constexpr (ImplementsAuxiliaryFluxNavierStokesMassOneP<Problem>::value)
            flux += problem.auxiliaryFlux(elemDisc.element(), elemDisc, elemVars, scvf);
 
        return flux * insideVars.extrusionFactor();
    }
};
 
} // end namespace Dumux
 
#endif