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

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

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

Description

template<class Traits, class NSVolumeVariables>
class Dumux::ZeroEqVolumeVariables< Traits, NSVolumeVariables >

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

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	velocity () 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...

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	velocity_

DimVector	velocityMaximum_

DimMatrix	velocityGradients_

std::size_t	elementIdx_

std::size_t	wallElementIdx_

Scalar	wallDistance_

Scalar	karmanConstant_

Scalar	uStar_

Scalar	yPlus_

Scalar	uPlus_

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

export the indices type

Member Function Documentation

◆ calculateEddyDiffusivity()

template<class Traits , class NSVolumeVariables >

template<class Problem >

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

inlineinherited

Calculates the eddy diffusivity \(\mathrm{[m^2/s]}\) based on the kinematic eddy viscosity and the turbulent Schmidt number.

◆ 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

Calculates the eddy thermal conductivity \(\mathrm{[W/(m*K)]}\) based on the kinematic eddy viscosity and the turbulent Prandtl number.

◆ 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

Eddy thermal conductivity is zero for isothermal model.

◆ 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

Calculate and set the dynamic eddy viscosity.

Parameters

elemSol	A vector containing all primary variables connected to the element
problem	The object specifying the problem which ought to be simulated
element	An element which contains part of the control volume
scv	The sub-control volume
modelName	The name of the used model

◆ dynamicEddyViscosity()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the dynamic eddy viscosity \(\mathrm{[Pa s]}\) of the flow within the control volume.

◆ eddyDiffusivity()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Returns the eddy diffusivity \(\mathrm{[m^2/s]}\).

◆ eddyThermalConductivity()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Returns the eddy thermal conductivity \(\mathrm{[W/(m*K)]}\).

◆ effectiveDiffusionCoefficient()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Returns the binary diffusion coefficients for a phase in \([m^2/s]\).

◆ 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

Returns the effective thermal conductivity \(\mathrm{[W/(m*K)]}\) of the fluid-flow in the sub-control volume.

◆ effectiveViscosity()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the effective dynamic viscosity \(\mathrm{[Pa s]}\) of the fluid within the control volume.

◆ elementIdx()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the element Idx of the control volume.

◆ karmanConstant()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the Karman constant.

◆ kinematicEddyViscosity()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the kinematic eddy viscosity \(\mathrm{[m^2/s]}\) of the flow within the control volume.

◆ kinematicViscosity()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the kinematic viscosity \(\mathrm{[m^2/s]}\) of the fluid within the control volume.

◆ setDynamicEddyViscosity_()

template<class Traits , class NSVolumeVariables >

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

inlineprotectedinherited

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

◆ 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

Update all quantities for a given control volume.

Parameters

elemSol	A vector containing all primary variables connected to the element
problem	The object specifying the problem which ought to be simulated
element	An element which contains part of the control volume
scv	The 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

Update all quantities for a given control volume.

Parameters

elemSol	A vector containing all primary variables connected to the element
problem	The object specifying the problem which ought to be simulated
element	An element which contains part of the control volume
scv	The 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

Update all turbulent quantities for a given control volume.

Parameters

elemSol	A vector containing all primary variables connected to the element
problem	The object specifying the problem which ought to be simulated
element	An element which contains part of the control volume
scv	The sub-control volume

◆ uPlus()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the dimensionless velocity \(\mathrm{[-]}\).

◆ uStar()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the wall friction velocity \(\mathrm{[m/s]}\).

◆ velocity()

template<class Traits , class NSVolumeVariables >

DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocity ( ) const

inlineinherited

Return the velocity vector \(\mathrm{[m/s]}\) at the control volume center.

◆ velocityGradients()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the velocity gradients \(\mathrm{[1/s]}\) at the control volume center.

◆ velocityMaximum()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the maximum velocity vector \(\mathrm{[m/s]}\) of the wall segment.

◆ wallDistance()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the wall distance \(\mathrm{[m]}\) of the control volume.

◆ wallDistanceRough()

template<class Traits , class NSVolumeVariables >

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

inline

Return the wall distance \(\mathrm{[m]}\) including an additional roughness length.

◆ yPlus()

template<class Traits , class NSVolumeVariables >

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

inlineinherited

Return the dimensionless wall distance \(\mathrm{[-]}\).

◆ yPlusRough()

template<class Traits , class NSVolumeVariables >

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

inline

Return the dimensionless wall distance \(\mathrm{[-]}\) including an additional roughness length.

Member Data Documentation

◆ additionalRoughnessLength_

template<class Traits , class NSVolumeVariables >

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

protected

◆ 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_

protectedinherited

◆ uStar_

template<class Traits , class NSVolumeVariables >

Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::uStar_

protectedinherited

◆ velocity_

template<class Traits , class NSVolumeVariables >

DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocity_

protectedinherited

◆ velocityGradients_

template<class Traits , class NSVolumeVariables >

DimMatrix Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityGradients_

protectedinherited

◆ velocityMaximum_

template<class Traits , class NSVolumeVariables >

DimVector Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::velocityMaximum_

protectedinherited

◆ wallDistance_

template<class Traits , class NSVolumeVariables >

Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::wallDistance_

protectedinherited

◆ wallElementIdx_

template<class Traits , class NSVolumeVariables >

std::size_t Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::wallElementIdx_

protectedinherited

◆ yPlus_

template<class Traits , class NSVolumeVariables >

Scalar Dumux::RANSVolumeVariables< Traits, NSVolumeVariables >::yPlus_

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:

freeflow/rans/zeroeq/volumevariables.hh

Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ Indices

Member Function Documentation

◆ calculateEddyDiffusivity()

◆ calculateEddyThermalConductivity() [1/2]

◆ calculateEddyThermalConductivity() [2/2]

◆ calculateEddyViscosity()

◆ dynamicEddyViscosity()

◆ eddyDiffusivity()

◆ eddyThermalConductivity()

◆ effectiveDiffusionCoefficient()

◆ effectiveThermalConductivity()

◆ effectiveViscosity()

◆ elementIdx()

◆ karmanConstant()

◆ kinematicEddyViscosity()

◆ kinematicViscosity()

◆ setDynamicEddyViscosity_()

◆ update()

◆ updateNavierStokesVolVars()

◆ updateRANSProperties()

◆ uPlus()

◆ uStar()

◆ velocity()

◆ velocityGradients()

◆ velocityMaximum()

◆ wallDistance()

◆ wallDistanceRough()

◆ yPlus()

◆ yPlusRough()

Member Data Documentation

◆ additionalRoughnessLength_

◆ dynamicEddyViscosity_

◆ eddyDiffusivity_

◆ eddyThermalConductivity_

◆ elementIdx_

◆ karmanConstant_

◆ uPlus_

◆ uStar_

◆ velocity_

◆ velocityGradients_

◆ velocityMaximum_

◆ wallDistance_

◆ wallElementIdx_

◆ yPlus_

◆ yPlusRough_