Variant of the standard k-epsilon turbulence model with additional source terms to handle the changes in turbulence in porous regions represented by the powerLawLopesdaCosta porosity model. More...

Inheritance diagram for kEpsilonLopesdaCosta< BasicMomentumTransportModel >:

[legend]

Collaboration diagram for kEpsilonLopesdaCosta< BasicMomentumTransportModel >:

[legend]

Public Types
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

Public Types inherited from eddyViscosity< RASModel< BasicMomentumTransportModel > >
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

Public Types inherited from linearViscousStress< BasicMomentumTransportModel >
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

Public Member Functions
	TypeName ("kEpsilonLopesdaCosta")
	Runtime type information. More...

	kEpsilonLopesdaCosta (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity, const word &type=typeName)
	Construct from components. More...

	kEpsilonLopesdaCosta (const kEpsilonLopesdaCosta &)=delete
	Disallow default bitwise copy construction. More...

virtual	~kEpsilonLopesdaCosta ()
	Destructor. More...

virtual bool	read ()
	Re-read model coefficients if they have changed. More...

tmp< volScalarField >	DkEff () const
	Return the effective diffusivity for k. More...

tmp< volScalarField >	DepsilonEff () const
	Return the effective diffusivity for epsilon. More...

virtual tmp< volScalarField >	k () const
	Return the turbulence kinetic energy. More...

virtual tmp< volScalarField >	epsilon () const
	Return the turbulence kinetic energy dissipation rate. More...

virtual tmp< volScalarField >	omega () const
	Return the turbulence specific dissipation rate. More...

virtual void	correct ()
	Solve the turbulence equations and correct the turbulence viscosity. More...

void	operator= (const kEpsilonLopesdaCosta &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from eddyViscosity< RASModel< BasicMomentumTransportModel > >
	eddyViscosity (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
	Construct from components. More...

virtual	~eddyViscosity ()
	Destructor. More...

virtual tmp< volScalarField >	nut () const
	Return the turbulence viscosity. More...

virtual tmp< scalarField >	nut (const label patchi) const
	Return the turbulence viscosity on patch. More...

virtual tmp< volSymmTensorField >	R () const
	Return the Reynolds stress tensor [m^2/s^2]. More...

virtual void	validate ()
	Validate the turbulence fields after construction. More...

Public Member Functions inherited from linearViscousStress< BasicMomentumTransportModel >
	linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
	Construct from components. More...

virtual	~linearViscousStress ()
	Destructor. More...

virtual tmp< surfaceVectorField >	devTau () const
	Return the effective surface stress. More...

virtual tmp< fvVectorMatrix >	divDevTau (volVectorField &U) const
	Return the source term for the momentum equation. More...

virtual tmp< fvVectorMatrix >	divDevTau (const volScalarField &rho, volVectorField &U) const
	Return the source term for the momentum equation. More...

template<class RhoFieldType >
Foam::tmp< Foam::fvVectorMatrix >	DivDevTau (const RhoFieldType &rho, volVectorField &U) const

Protected Member Functions
void	setPorosityCoefficient (volScalarField::Internal &C, const porosityModels::powerLawLopesdaCosta &pm)

void	setCdAv (volScalarField::Internal &C, const porosityModels::powerLawLopesdaCosta &pm)

void	setPorosityCoefficients ()

tmp< volScalarField >	boundEpsilon ()
	Bound epsilon and return Cmu*sqr(k) for nut. More...

virtual void	correctNut ()
	Correct the eddy-viscosity nut. More...

virtual tmp< fvScalarMatrix >	kSource (const volScalarField::Internal &magU, const volScalarField::Internal &magU3) const

virtual tmp< fvScalarMatrix >	epsilonSource (const volScalarField::Internal &magU, const volScalarField::Internal &magU3) const

Protected Member Functions inherited from linearViscousStress< BasicMomentumTransportModel >
template<class RhoFieldType >
tmp< fvVectorMatrix >	DivDevTau (const RhoFieldType &rho, volVectorField &U) const
	Return the source term for the momentum equation. More...

Protected Attributes
volScalarField	Cmu_

volScalarField::Internal	C1_

volScalarField::Internal	C2_

volScalarField	sigmak_

volScalarField	sigmaEps_

volScalarField::Internal	CdAv_

volScalarField::Internal	betap_

volScalarField::Internal	betad_

volScalarField::Internal	C4_

volScalarField::Internal	C5_

volScalarField	k_

volScalarField	epsilon_

Protected Attributes inherited from eddyViscosity< RASModel< BasicMomentumTransportModel > >
volScalarField	nut_

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::RASModels::kEpsilonLopesdaCosta< BasicMomentumTransportModel >

Variant of the standard k-epsilon turbulence model with additional source terms to handle the changes in turbulence in porous regions represented by the powerLawLopesdaCosta porosity model.

Reference:

    Costa, J. C. P. L. D. (2007).
    Atmospheric flow over forested and non-forested complex terrain.

The default model coefficients are

    kEpsilonLopesdaCostaCoeffs
    {
        Cmu         0.09;
        C1          1.44;
        C2          1.92;
        sigmak      1.0;
        sigmaEps    1.3;
    }

See also: Foam::RASModels::kEpsilon Foam::porosityModels::powerLawLopesdaCosta

Source files

Definition at line 77 of file kEpsilonLopesdaCosta.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 145 of file kEpsilonLopesdaCosta.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 146 of file kEpsilonLopesdaCosta.H.

Constructor & Destructor Documentation

◆ kEpsilonLopesdaCosta() [1/2]

kEpsilonLopesdaCosta	(	const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const viscosity &	viscosity,
		const word &	type = `typeName`
	)

Construct from components.

Definition at line 178 of file kEpsilonLopesdaCosta.C.

References Foam::bound(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::boundEpsilon(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::k_, and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficients().

Here is the call graph for this function:

◆ kEpsilonLopesdaCosta() [2/2]

kEpsilonLopesdaCosta ( const kEpsilonLopesdaCosta< BasicMomentumTransportModel > & )

delete

Disallow default bitwise copy construction.

◆ ~kEpsilonLopesdaCosta()

virtual ~kEpsilonLopesdaCosta ( )

inlinevirtual

Destructor.

Definition at line 172 of file kEpsilonLopesdaCosta.H.

Member Function Documentation

◆ setPorosityCoefficient()

void setPorosityCoefficient	(	volScalarField::Internal &	C,
		const porosityModels::powerLawLopesdaCosta &	pm
	)

protected

Definition at line 42 of file kEpsilonLopesdaCosta.C.

References cells, powerLawLopesdaCosta::dict(), forAll, dictionary::found(), dictionary::lookup(), and porosityModel::zoneName().

Here is the call graph for this function:

◆ setCdAv()

void setCdAv	(	volScalarField::Internal &	C,
		const porosityModels::powerLawLopesdaCosta &	pm
	)

protected

Definition at line 64 of file kEpsilonLopesdaCosta.C.

References powerLawLopesdaCostaZone::Av(), cells, powerLawLopesdaCosta::dict(), forAll, dictionary::found(), dictionary::lookup(), and porosityModel::zoneName().

Here is the call graph for this function:

◆ setPorosityCoefficients()

void setPorosityCoefficients

protected

Definition at line 88 of file kEpsilonLopesdaCosta.C.

References forAll, fvModels(), porosityForce::model(), and dictionary::New().

Referenced by kEpsilonLopesdaCosta< BasicMomentumTransportModel >::kEpsilonLopesdaCosta().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ boundEpsilon()

tmp< volScalarField > boundEpsilon

protected

Bound epsilon and return Cmu*sqr(k) for nut.

Definition at line 130 of file kEpsilonLopesdaCosta.C.

References Foam::max(), and Foam::sqr().

Referenced by kEpsilonLopesdaCosta< BasicMomentumTransportModel >::kEpsilonLopesdaCosta().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctNut()

void correctNut

protectedvirtual

Correct the eddy-viscosity nut.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 139 of file kEpsilonLopesdaCosta.C.

References dictionary::New().

Here is the call graph for this function:

◆ kSource()

tmp< fvScalarMatrix > kSource	(	const volScalarField::Internal &	magU,
		const volScalarField::Internal &	magU3
	)		const

protectedvirtual

Definition at line 148 of file kEpsilonLopesdaCosta.C.

References Foam::fvm::Su().

Here is the call graph for this function:

◆ epsilonSource()

tmp< fvScalarMatrix > epsilonSource	(	const volScalarField::Internal &	magU,
		const volScalarField::Internal &	magU3
	)		const

protectedvirtual

Definition at line 160 of file kEpsilonLopesdaCosta.C.

References Foam::fvm::Su().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "kEpsilonLopesdaCosta< BasicMomentumTransportModel >" )

Runtime type information.

◆ read()

bool read

virtual

Re-read model coefficients if they have changed.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 346 of file kEpsilonLopesdaCosta.C.

References Foam::read().

Here is the call graph for this function:

◆ DkEff()

tmp<volScalarField> DkEff ( ) const

inline

Return the effective diffusivity for k.

Definition at line 182 of file kEpsilonLopesdaCosta.H.

References GeometricField< Type, GeoMesh, PrimitiveField >::New(), and eddyViscosity< RASModel< BasicMomentumTransportModel > >::nut_.

Here is the call graph for this function:

◆ DepsilonEff()

tmp<volScalarField> DepsilonEff ( ) const

inline

Return the effective diffusivity for epsilon.

Definition at line 192 of file kEpsilonLopesdaCosta.H.

References GeometricField< Type, GeoMesh, PrimitiveField >::New(), and eddyViscosity< RASModel< BasicMomentumTransportModel > >::nut_.

Here is the call graph for this function:

◆ k()

virtual tmp<volScalarField> k ( ) const

inlinevirtual

Return the turbulence kinetic energy.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 202 of file kEpsilonLopesdaCosta.H.

References kEpsilonLopesdaCosta< BasicMomentumTransportModel >::k_.

◆ epsilon()

virtual tmp<volScalarField> epsilon ( ) const

inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 208 of file kEpsilonLopesdaCosta.H.

References kEpsilonLopesdaCosta< BasicMomentumTransportModel >::epsilon_.

◆ omega()

virtual tmp<volScalarField> omega ( ) const

inlinevirtual

Return the turbulence specific dissipation rate.

Definition at line 214 of file kEpsilonLopesdaCosta.H.

References kEpsilonLopesdaCosta< BasicMomentumTransportModel >::Cmu_, kEpsilonLopesdaCosta< BasicMomentumTransportModel >::epsilon_, kEpsilonLopesdaCosta< BasicMomentumTransportModel >::k_, and GeometricField< Type, GeoMesh, PrimitiveField >::New().

Here is the call graph for this function:

◆ correct()

void correct

virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 360 of file kEpsilonLopesdaCosta.C.

References Foam::fvc::absolute(), alpha(), Foam::bound(), tmp< T >::clear(), fvConstraints::constrain(), Foam::MULES::correct(), Foam::fvm::ddt(), Foam::dev(), Foam::fvc::div(), Foam::fvm::div(), fvConstraints(), fvModels(), Foam::constant::universal::G, Foam::fvc::grad(), Foam::fvm::laplacian(), Foam::mag(), dictionary::New(), nut, Foam::pow3(), tmp< T >::ref(), rho, Foam::solve(), fvModels::source(), Foam::fvm::Sp(), Foam::fvm::SuSp(), Foam::twoSymm(), and U.

Here is the call graph for this function:

◆ operator=()

void operator= ( const kEpsilonLopesdaCosta< BasicMomentumTransportModel > & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ Cmu_

volScalarField Cmu_

protected

Definition at line 87 of file kEpsilonLopesdaCosta.H.

Referenced by kEpsilonLopesdaCosta< BasicMomentumTransportModel >::omega().

◆ C1_

volScalarField::Internal C1_

protected

Definition at line 88 of file kEpsilonLopesdaCosta.H.

◆ C2_

volScalarField::Internal C2_

protected

Definition at line 89 of file kEpsilonLopesdaCosta.H.

◆ sigmak_

volScalarField sigmak_

protected

Definition at line 90 of file kEpsilonLopesdaCosta.H.

◆ sigmaEps_

volScalarField sigmaEps_

protected

Definition at line 91 of file kEpsilonLopesdaCosta.H.

◆ CdAv_

volScalarField::Internal CdAv_

protected

Definition at line 95 of file kEpsilonLopesdaCosta.H.

◆ betap_

volScalarField::Internal betap_

protected

Definition at line 96 of file kEpsilonLopesdaCosta.H.

◆ betad_

volScalarField::Internal betad_

protected

Definition at line 97 of file kEpsilonLopesdaCosta.H.

◆ C4_

volScalarField::Internal C4_

protected

Definition at line 98 of file kEpsilonLopesdaCosta.H.

◆ C5_

volScalarField::Internal C5_

protected

Definition at line 99 of file kEpsilonLopesdaCosta.H.

◆ k_

volScalarField k_

protected

Definition at line 104 of file kEpsilonLopesdaCosta.H.

Referenced by kEpsilonLopesdaCosta< BasicMomentumTransportModel >::k(), kEpsilonLopesdaCosta< BasicMomentumTransportModel >::kEpsilonLopesdaCosta(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::omega().

◆ epsilon_

volScalarField epsilon_

protected

Definition at line 105 of file kEpsilonLopesdaCosta.H.

Referenced by kEpsilonLopesdaCosta< BasicMomentumTransportModel >::epsilon(), and kEpsilonLopesdaCosta< BasicMomentumTransportModel >::omega().

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

src/atmosphericModels/kEpsilonLopesdaCosta/kEpsilonLopesdaCosta.H
src/atmosphericModels/kEpsilonLopesdaCosta/kEpsilonLopesdaCosta.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class BasicMomentumTransportModel> class Foam::RASModels::kEpsilonLopesdaCosta< BasicMomentumTransportModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

Constructor & Destructor Documentation

◆ kEpsilonLopesdaCosta() [1/2]

◆ kEpsilonLopesdaCosta() [2/2]

◆ ~kEpsilonLopesdaCosta()

Member Function Documentation

◆ setPorosityCoefficient()

◆ setCdAv()

◆ setPorosityCoefficients()

◆ boundEpsilon()

◆ correctNut()

◆ kSource()

◆ epsilonSource()

◆ TypeName()

◆ read()

◆ DkEff()

◆ DepsilonEff()

◆ k()

◆ epsilon()

◆ omega()

◆ correct()

◆ operator=()

Member Data Documentation

◆ Cmu_

◆ C1_

◆ C2_

◆ sigmak_

◆ sigmaEps_

◆ CdAv_

◆ betap_

◆ betad_

◆ C4_

◆ C5_

◆ k_

◆ epsilon_

template<class BasicMomentumTransportModel>
class Foam::RASModels::kEpsilonLopesdaCosta< BasicMomentumTransportModel >