version 3.8
Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables > Class Template Reference

Volume variables for the single-phase 0-Eq. model.

#include <dumux/freeflow/rans/zeroeq/volumevariables.hh>

Inheritance diagram for Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >:

Public Types

using Indices = typename Traits::ModelTraits::Indices
 export the indices type More...
 

Public Member Functions

template<class ElementSolution , class Problem , class Element , class SubControlVolume >
void update (const ElementSolution &elemSol, const Problem &problem, const Element &element, const SubControlVolume &scv)
 Update all quantities for a given control volume. More...
 
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
void updateRANSProperties (const ElementSolution &elemSol, const Problem &problem, const Element &element, const SubControlVolume &scv)
 Update all turbulent quantities for a given control volume. More...
 
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
Scalar calculateEddyViscosity (const ElementSolution &elemSol, const Problem &problem, const Element &element, const SubControlVolume &scv, const std::string modelName)
 Calculate and set the dynamic eddy viscosity. More...
 
Scalar wallDistanceRough () const
 Return the wall distance \(\mathrm{[m]}\) including an additional roughness length. More...
 
Scalar yPlusRough () const
 Return the dimensionless wall distance \(\mathrm{[-]}\) including an additional roughness length. More...
 
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
void updateNavierStokesVolVars (const ElementSolution &elemSol, const Problem &problem, const Element &element, const SubControlVolume &scv)
 Update all quantities for a given control volume. More...
 
unsigned int elementIdx () const
 Return the element Idx of the control volume. More...
 
DimVector ccVelocityVector () const
 Return the velocity vector \(\mathrm{[m/s]}\) at the control volume center. More...
 
DimVector velocityMaximum () const
 Return the maximum velocity vector \(\mathrm{[m/s]}\) of the wall segment. More...
 
DimVector velocityMinimum () const
 Return the minimum velocity vector \(\mathrm{[m/s]}\) of the wall segment. More...
 
DimMatrix velocityGradients () const
 Return the velocity gradients \(\mathrm{[1/s]}\) at the control volume center. More...
 
Scalar wallDistance () const
 Return the wall distance \(\mathrm{[m]}\) of the control volume. More...
 
Scalar karmanConstant () const
 Return the Karman constant. More...
 
Scalar uStar () const
 Return the wall friction velocity \(\mathrm{[m/s]}\). More...
 
Scalar yPlus () const
 Return the dimensionless wall distance \(\mathrm{[-]}\). More...
 
Scalar uPlus () const
 Return the dimensionless velocity \(\mathrm{[-]}\). More...
 
Scalar dynamicEddyViscosity () const
 Return the dynamic eddy viscosity \(\mathrm{[Pa s]}\) of the flow within the control volume. More...
 
Scalar effectiveViscosity () const
 Return the effective dynamic viscosity \(\mathrm{[Pa s]}\) of the fluid within the control volume. More...
 
Scalar kinematicEddyViscosity () const
 Return the kinematic eddy viscosity \(\mathrm{[m^2/s]}\) of the flow within the control volume. More...
 
Scalar kinematicViscosity () const
 Return the kinematic viscosity \(\mathrm{[m^2/s]}\) of the fluid within the control volume. More...
 
template<class Problem >
void calculateEddyDiffusivity (const Problem &problem)
 Calculates the eddy diffusivity \(\mathrm{[m^2/s]}\) based on the kinematic eddy viscosity and the turbulent Schmidt number. More...
 
template<class Problem , bool eB = enableEnergyBalance, typename std::enable_if_t< eB, int > = 0>
void calculateEddyThermalConductivity (const Problem &problem)
 Calculates the eddy thermal conductivity \(\mathrm{[W/(m*K)]}\) based on the kinematic eddy viscosity and the turbulent Prandtl number. More...
 
template<class Problem , bool eB = enableEnergyBalance, typename std::enable_if_t<!eB, int > = 0>
void calculateEddyThermalConductivity (const Problem &problem)
 Eddy thermal conductivity is zero for isothermal model. More...
 
Scalar eddyDiffusivity () const
 Returns the eddy diffusivity \(\mathrm{[m^2/s]}\). More...
 
Scalar eddyThermalConductivity () const
 Returns the eddy thermal conductivity \(\mathrm{[W/(m*K)]}\). More...
 
Scalar effectiveDiffusionCoefficient (int phaseIdx, int compIIdx, int compJIdx) const
 Returns the binary diffusion coefficients for a phase in \([m^2/s]\). More...
 
template<bool eB = enableEnergyBalance, typename std::enable_if_t< eB, int > = 0>
Scalar effectiveThermalConductivity () const
 Returns the effective thermal conductivity \(\mathrm{[W/(m*K)]}\) of the fluid-flow in the sub-control volume. More...
 

Protected Member Functions

Scalar setDynamicEddyViscosity_ (Scalar value)
 Sets the dynamic eddy viscosity \(\mathrm{[Pa s]}\). More...
 

Protected Attributes

Scalar additionalRoughnessLength_ = 0.0
 
Scalar yPlusRough_ = 0.0
 
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
 

Member Typedef Documentation

◆ Indices

template<class Traits , class NSVolumeVariables >
using Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::Indices = typename Traits::ModelTraits::Indices

Member Function Documentation

◆ calculateEddyDiffusivity()

template<class Traits , class NSVolumeVariables >
template<class Problem >
void Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::calculateEddyDiffusivity ( const Problem &  problem)
inlineinherited

◆ calculateEddyThermalConductivity() [1/2]

template<class Traits , class NSVolumeVariables >
template<class Problem , bool eB = enableEnergyBalance, typename std::enable_if_t< eB, int > = 0>
void Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::calculateEddyThermalConductivity ( const Problem &  problem)
inlineinherited

◆ calculateEddyThermalConductivity() [2/2]

template<class Traits , class NSVolumeVariables >
template<class Problem , bool eB = enableEnergyBalance, typename std::enable_if_t<!eB, int > = 0>
void Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::calculateEddyThermalConductivity ( const Problem &  problem)
inlineinherited

◆ calculateEddyViscosity()

template<class Traits , class NSVolumeVariables >
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
Scalar Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::calculateEddyViscosity ( const ElementSolution &  elemSol,
const Problem &  problem,
const Element &  element,
const SubControlVolume &  scv,
const std::string  modelName 
)
inline
Parameters
elemSolA vector containing all primary variables connected to the element
problemThe object specifying the problem which ought to be simulated
elementAn element which contains part of the control volume
scvThe sub-control volume
modelNameThe name of the used model

◆ ccVelocityVector()

template<class Traits , class NSVolumeVariables >
DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::ccVelocityVector ( ) const
inlineinherited

◆ dynamicEddyViscosity()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::dynamicEddyViscosity ( ) const
inlineinherited

◆ eddyDiffusivity()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::eddyDiffusivity ( ) const
inlineinherited

◆ eddyThermalConductivity()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::eddyThermalConductivity ( ) const
inlineinherited

◆ effectiveDiffusionCoefficient()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::effectiveDiffusionCoefficient ( int  phaseIdx,
int  compIIdx,
int  compJIdx 
) const
inlineinherited

◆ effectiveThermalConductivity()

template<class Traits , class NSVolumeVariables >
template<bool eB = enableEnergyBalance, typename std::enable_if_t< eB, int > = 0>
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::effectiveThermalConductivity ( ) const
inlineinherited

◆ effectiveViscosity()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::effectiveViscosity ( ) const
inlineinherited

◆ elementIdx()

template<class Traits , class NSVolumeVariables >
unsigned int Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::elementIdx ( ) const
inlineinherited

◆ karmanConstant()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::karmanConstant ( ) const
inlineinherited

◆ kinematicEddyViscosity()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::kinematicEddyViscosity ( ) const
inlineinherited

◆ kinematicViscosity()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::kinematicViscosity ( ) const
inlineinherited

◆ setDynamicEddyViscosity_()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::setDynamicEddyViscosity_ ( Scalar  value)
inlineprotectedinherited

◆ update()

template<class Traits , class NSVolumeVariables >
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
void Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::update ( const ElementSolution &  elemSol,
const Problem &  problem,
const Element &  element,
const SubControlVolume &  scv 
)
inline
Parameters
elemSolA vector containing all primary variables connected to the element
problemThe object specifying the problem which ought to be simulated
elementAn element which contains part of the control volume
scvThe sub-control volume

◆ updateNavierStokesVolVars()

template<class Traits , class NSVolumeVariables >
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
void Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::updateNavierStokesVolVars ( const ElementSolution &  elemSol,
const Problem &  problem,
const Element &  element,
const SubControlVolume &  scv 
)
inlineinherited
Parameters
elemSolA vector containing all primary variables connected to the element
problemThe object specifying the problem which ought to be simulated
elementAn element which contains part of the control volume
scvThe sub-control volume

◆ updateRANSProperties()

template<class Traits , class NSVolumeVariables >
template<class ElementSolution , class Problem , class Element , class SubControlVolume >
void Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::updateRANSProperties ( const ElementSolution &  elemSol,
const Problem &  problem,
const Element &  element,
const SubControlVolume &  scv 
)
inline
Parameters
elemSolA vector containing all primary variables connected to the element
problemThe object specifying the problem which ought to be simulated
elementAn element which contains part of the control volume
scvThe sub-control volume

◆ uPlus()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::uPlus ( ) const
inlineinherited

◆ uStar()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::uStar ( ) const
inlineinherited

◆ velocityGradients()

template<class Traits , class NSVolumeVariables >
DimMatrix Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityGradients ( ) const
inlineinherited

◆ velocityMaximum()

template<class Traits , class NSVolumeVariables >
DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityMaximum ( ) const
inlineinherited

◆ velocityMinimum()

template<class Traits , class NSVolumeVariables >
DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityMinimum ( ) const
inlineinherited

◆ wallDistance()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::wallDistance ( ) const
inlineinherited

◆ wallDistanceRough()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::wallDistanceRough ( ) const
inline

◆ yPlus()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::yPlus ( ) const
inlineinherited

◆ yPlusRough()

template<class Traits , class NSVolumeVariables >
Scalar Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::yPlusRough ( ) const
inline

Member Data Documentation

◆ additionalRoughnessLength_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::additionalRoughnessLength_ = 0.0
protected

◆ ccVelocityVector_

template<class Traits , class NSVolumeVariables >
DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::ccVelocityVector_
protectedinherited

◆ dynamicEddyViscosity_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::dynamicEddyViscosity_ = 0.0
protectedinherited

◆ eddyDiffusivity_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::eddyDiffusivity_ = 0.0
protectedinherited

◆ eddyThermalConductivity_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::eddyThermalConductivity_ = 0.0
protectedinherited

◆ elementIdx_

template<class Traits , class NSVolumeVariables >
std::size_t Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::elementIdx_
protectedinherited

◆ karmanConstant_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::karmanConstant_
protectedinherited

◆ uPlus_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::uPlus_ = 0.0
protectedinherited

◆ uStar_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::uStar_ = 0.0
protectedinherited

◆ velocityGradientTensor_

template<class Traits , class NSVolumeVariables >
DimMatrix Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityGradientTensor_
protectedinherited

◆ velocityMaximum_

template<class Traits , class NSVolumeVariables >
DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityMaximum_
protectedinherited

◆ velocityMinimum_

template<class Traits , class NSVolumeVariables >
DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityMinimum_
protectedinherited

◆ wallDistance_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::wallDistance_
protectedinherited

◆ yPlus_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::yPlus_ = 0.0
protectedinherited

◆ yPlusRough_

template<class Traits , class NSVolumeVariables >
Scalar Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >::yPlusRough_ = 0.0
protected

The documentation for this class was generated from the following file: