freeflow/rans/volumevariables.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-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_RANS_VOLUME_VARIABLES_HH
#define DUMUX_RANS_VOLUME_VARIABLES_HH
 
#include <dune/common/fvector.hh>
#include <dune/common/fmatrix.hh>
 
#include <dumux/common/parameters.hh>
 
namespace Dumux {
 
template <class Traits, class NSVolumeVariables>
class RANSVolumeVariables
: public NSVolumeVariables
{
    using NavierStokesParentType = NSVolumeVariables;
 
    using Scalar = typename Traits::PrimaryVariables::value_type;
 
    enum { dimWorld = Traits::ModelTraits::dim() };
    using DimVector = Dune::FieldVector<Scalar, dimWorld>;
    using DimMatrix = Dune::FieldMatrix<Scalar, dimWorld, dimWorld>;
 
    static constexpr bool enableEnergyBalance = Traits::ModelTraits::enableEnergyBalance();
 
public:
 
    template<class ElementSolution, class Problem, class Element, class SubControlVolume>
    void updateNavierStokesVolVars(const ElementSolution &elemSol,
                                   const Problem &problem,
                                   const Element &element,
                                   const SubControlVolume& scv)
    {
        NavierStokesParentType::update(elemSol, problem, element, scv);
    }
 
    template<class ElementSolution, class Problem, class Element, class SubControlVolume>
    void updateRANSProperties(const ElementSolution &elemSol,
                              const Problem &problem,
                              const Element &element,
                              const SubControlVolume& scv)
    {
        using std::abs;
        using std::max;
        using std::sqrt;
 
        // calculate characteristic properties of the turbulent flow
        elementIdx_ = problem.gridGeometry().elementMapper().index(element);
        wallDistance_ = problem.wallDistance(elementIdx_);
        ccVelocityVector_ = problem.ccVelocityVector(elementIdx_);
        velocityGradientTensor_ = problem.velocityGradientTensor(elementIdx_);
 
        karmanConstant_ = problem.karmanConstant();
        velocityMaximum_ = problem.velocityMaximum(elementIdx_);
        velocityMinimum_ = problem.velocityMinimum(elementIdx_);
        if (problem.isFlatWallBounded())
        {
            const auto flowDirectionAxis = problem.flowDirectionAxis(elementIdx_);
            const auto wallNormalAxis = problem.wallNormalAxis(elementIdx_);
            velocityMaximum_ = problem.velocityMaximum(problem.wallElementIndex(elementIdx_));
            velocityMinimum_ = problem.velocityMinimum(problem.wallElementIndex(elementIdx_));
            uStar_ = sqrt(problem.kinematicViscosity(problem.wallElementIndex(elementIdx_))
                        * abs(problem.velocityGradient(problem.wallElementIndex(elementIdx_), flowDirectionAxis, wallNormalAxis)));
            uStar_ = max(uStar_, 1e-10); // zero values lead to numerical problems in some turbulence models
            yPlus_ = wallDistance_ * uStar_ / problem.kinematicViscosity(elementIdx_);
            uPlus_ = problem.ccVelocity(elementIdx_, flowDirectionAxis) / uStar_;
        }
    }
 
    unsigned int elementIdx() const
    { return elementIdx_; }
 
    DimVector ccVelocityVector() const
    { return ccVelocityVector_; }
 
    DimVector velocityMaximum() const
    { return velocityMaximum_; }
 
    DimVector velocityMinimum() const
    { return velocityMinimum_; }
 
    DimMatrix velocityGradients() const
    { return velocityGradientTensor_; }
 
    Scalar wallDistance() const
    { return wallDistance_; }
 
    Scalar karmanConstant() const
    { return karmanConstant_; }
 
    Scalar uStar() const
    { return uStar_; }
 
    Scalar yPlus() const
    { return yPlus_; }
 
    Scalar uPlus() const
    { return uPlus_; }
 
    Scalar dynamicEddyViscosity() const
    { return dynamicEddyViscosity_; }
 
    Scalar effectiveViscosity() const
    { return NavierStokesParentType::viscosity() + dynamicEddyViscosity(); }
 
    Scalar kinematicEddyViscosity() const
    { return dynamicEddyViscosity() / NavierStokesParentType::density(); }
 
    Scalar kinematicViscosity() const
    { return NavierStokesParentType::viscosity() / NavierStokesParentType::density(); }
 
    template<class Problem>
    void calculateEddyDiffusivity(const Problem& problem)
    {
        eddyDiffusivity_ = kinematicEddyViscosity()
                           / problem.turbulentSchmidtNumber();
    }
 
    template<class Problem, bool eB = enableEnergyBalance, typename std::enable_if_t<eB, int> = 0>
    void calculateEddyThermalConductivity(const Problem& problem)
    {
        eddyThermalConductivity_ = kinematicEddyViscosity()
                                   * NavierStokesParentType::density()
                                   * NavierStokesParentType::heatCapacity()
                                   / problem.turbulentPrandtlNumber();
    }
 
    template<class Problem, bool eB = enableEnergyBalance, typename std::enable_if_t<!eB, int> = 0>
    void calculateEddyThermalConductivity(const Problem& problem)
    { eddyThermalConductivity_ = 0.0; }
 
    Scalar eddyDiffusivity() const
    { return eddyDiffusivity_; }
 
    Scalar eddyThermalConductivity() const
    { return eddyThermalConductivity_; }
 
    Scalar effectiveDiffusionCoefficient(int phaseIdx, int compIIdx, int compJIdx) const
    { return NavierStokesParentType::diffusionCoefficient(0, compIIdx, compJIdx) + eddyDiffusivity(); }
 
    template<bool eB = enableEnergyBalance, typename std::enable_if_t<eB, int> = 0>
    Scalar effectiveThermalConductivity() const
    {
        return NavierStokesParentType::thermalConductivity() + eddyThermalConductivity();
    }
 
protected:
    Scalar setDynamicEddyViscosity_(Scalar value)
    { return dynamicEddyViscosity_  = value; }
 
    DimVector ccVelocityVector_;
    DimVector velocityMaximum_;
    DimVector velocityMinimum_;
    DimMatrix velocityGradientTensor_;
    std::size_t elementIdx_;
    Scalar wallDistance_;
    Scalar karmanConstant_;
    Scalar uStar_ = 0.0;
    Scalar yPlus_ = 0.0;
    Scalar uPlus_ = 0.0;
    Scalar dynamicEddyViscosity_ = 0.0;
    Scalar eddyDiffusivity_ = 0.0;
    Scalar eddyThermalConductivity_ = 0.0;
};
} // end namespace Dumux
 
#endif