KLAxell< Transport > Class Template Reference

AMR-Wind API: amr_wind::turbulence::KLAxell< Transport > Class Template Reference

#include <KLAxell.H>

Inheritance diagram for amr_wind::turbulence::KLAxell< Transport >:

Collaboration diagram for amr_wind::turbulence::KLAxell< Transport >:

Public Member Functions
	KLAxell (CFDSim &sim)

std::string	model_name () const override
	String representation of this turbulence model for I/O.

void	update_turbulent_viscosity (const FieldState fstate, const DiffusionType) override
	Update the turbulent viscosity field.

void	post_advance_work () override
	Do any post advance work.

void	update_alphaeff (Field &alphaeff) override
	Update the effective thermal diffusivity field.

void	update_scalar_diff (Field &deff, const std::string &name) override
	Update the effective scalar diffusivity field.

void	parse_model_coeffs () override
	Parse turbulence model coefficients.

TurbulenceModel::CoeffsDictType	model_coeffs () const override
	Return turbulence model coefficients.

Public Member Functions inherited from amr_wind::turbulence::TurbModelBase< Transport >
	TurbModelBase (CFDSim &sim)

Field &	mu_turb () override
	Return the turbulent viscosity field.

Field &	alpha_turb () override
	Return the turbulent thermal diffusivity field.

void	update_mueff (Field &mueff) override

void	update_alphaeff (Field &alphaeff) override

void	update_scalar_diff (Field &deff, const std::string &name) override
	Interface to update scalar diffusivity based on Schmidt number.

Public Member Functions inherited from amr_wind::turbulence::TurbModel< Transport >
	TurbModel (CFDSim &sim)

void	register_mueff_field (Field &mueff) override
	Register the effective viscosity (for momentum field)

void	register_alphaeff_field (Field &alphaeff) override
	Register the thermal diffusivity field.

std::unique_ptr< ScratchField >	mu () override
	Return the dynamic viscosity field.

std::unique_ptr< ScratchField >	alpha () override
	Return the thermal diffusivity field.

std::unique_ptr< ScratchField >	scalar_diffusivity (const std::string &name) override
	Return the scalar diffusivity field.

Field &	mueff () override
	Return the effective dynamic viscosity field.

Field &	alphaeff () override
	Return the effective thermal diffusivity field.

Public Member Functions inherited from amr_wind::turbulence::TurbulenceModel
	~TurbulenceModel () override=default

virtual bool	is_turbulent () const
	Flag indicating whether the model is turbulent.

Public Member Functions inherited from amr_wind::Factory< TurbulenceModel, CFDSim & >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	identifier ()

Static Public Member Functions inherited from amr_wind::turbulence::TurbulenceModel
static std::string	base_identifier ()

Static Public Member Functions inherited from amr_wind::Factory< TurbulenceModel, CFDSim & >
static std::unique_ptr< TurbulenceModel >	create (const std::string &key, Args... args)

static void	print (std::ostream &os)

Private Attributes
Field &	m_vel

Field &	m_turb_lscale

Field &	m_shear_prod

Field &	m_buoy_prod

Field &	m_dissip

Field &	m_rho

Field *	m_tke {nullptr}

amrex::Real	m_Cmu {0.556}
	Turbulence constant.

amrex::Real	m_Cmu_prime {0.556}

amrex::Real	m_Cb_stable {0.25}

amrex::Real	m_Cb_unstable {0.35}

amrex::Real	m_prandtl {1.0}

Field &	m_temperature

amrex::Vector< amrex::Real >	m_gravity {0.0, 0.0, -9.81}
	Gravity vector (m/s^2)

amrex::Real	m_surf_flux {0}

amrex::Real	m_meso_sponge_start {2000}

Additional Inherited Members
Public Types inherited from amr_wind::turbulence::TurbModel< Transport >
using	TransportType = Transport

Public Types inherited from amr_wind::turbulence::TurbulenceModel
using	CoeffsDictType = std::unordered_map<std::string, amrex::Real>
	Default identifier used by factor methods.

Public Attributes inherited from amr_wind::Factory< TurbulenceModel, CFDSim & >
friend	Base

Protected Attributes inherited from amr_wind::turbulence::TurbModelBase< Transport >
Field &	m_mu_turb
	Reference to the turbulent viscosity field.

Field *	m_alpha_turb {nullptr}
	Reference to thermal diffusivity field.

Protected Attributes inherited from amr_wind::turbulence::TurbModel< Transport >
CFDSim &	m_sim

Transport	m_transport
	Transport properties instance.

Field *	m_mueff {nullptr}
	Reference to the effective viscosity field.

Field *	m_alphaeff {nullptr}
	Reference to the thermal diffusivity field.

Detailed Description

template<typename Transport>
class amr_wind::turbulence::KLAxell< Transport >

Base class for 1-Equation RANS TKE turbulence model

Constructor & Destructor Documentation

◆ KLAxell()

template<typename Transport >

amr_wind::turbulence::KLAxell< Transport >::KLAxell ( CFDSim & sim )

explicit

Member Function Documentation

◆ identifier()

template<typename Transport >

static std::string amr_wind::turbulence::KLAxell< Transport >::identifier ( )

inlinestatic

◆ model_coeffs()

template<typename Transport >

TurbulenceModel::CoeffsDictType amr_wind::turbulence::KLAxell< Transport >::model_coeffs ( ) const

overridevirtual

Return turbulence model coefficients.

Implements amr_wind::turbulence::TurbulenceModel.

◆ model_name()

template<typename Transport >

std::string amr_wind::turbulence::KLAxell< Transport >::model_name ( ) const

inlineoverridevirtual

String representation of this turbulence model for I/O.

Implements amr_wind::turbulence::TurbulenceModel.

◆ parse_model_coeffs()

template<typename Transport >

void amr_wind::turbulence::KLAxell< Transport >::parse_model_coeffs ( )

overridevirtual

Parse turbulence model coefficients.

Implements amr_wind::turbulence::TurbulenceModel.

◆ post_advance_work()

template<typename Transport >

void amr_wind::turbulence::KLAxell< Transport >::post_advance_work ( )

overridevirtual

Do any post advance work.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_alphaeff()

template<typename Transport >

void amr_wind::turbulence::KLAxell< Transport >::update_alphaeff ( Field & alphaeff )

overridevirtual

Update the effective thermal diffusivity field.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_scalar_diff()

template<typename Transport >

void amr_wind::turbulence::KLAxell< Transport >::update_scalar_diff	(	Field &	deff,
		const std::string &	name )

overridevirtual

Update the effective scalar diffusivity field.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_turbulent_viscosity()

template<typename Transport >

void amr_wind::turbulence::KLAxell< Transport >::update_turbulent_viscosity	(	const FieldState	fstate,
		const DiffusionType	)

overridevirtual

Update the turbulent viscosity field.

Implements amr_wind::turbulence::TurbulenceModel.

Member Data Documentation

◆ m_buoy_prod

template<typename Transport >

Field& amr_wind::turbulence::KLAxell< Transport >::m_buoy_prod

private

◆ m_Cb_stable

template<typename Transport >

amrex::Real amr_wind::turbulence::KLAxell< Transport >::m_Cb_stable {0.25}

private

◆ m_Cb_unstable

template<typename Transport >

amrex::Real amr_wind::turbulence::KLAxell< Transport >::m_Cb_unstable {0.35}

private

◆ m_Cmu

template<typename Transport >

amrex::Real amr_wind::turbulence::KLAxell< Transport >::m_Cmu {0.556}

private

Turbulence constant.

◆ m_Cmu_prime

template<typename Transport >

amrex::Real amr_wind::turbulence::KLAxell< Transport >::m_Cmu_prime {0.556}

private

◆ m_dissip

template<typename Transport >

Field& amr_wind::turbulence::KLAxell< Transport >::m_dissip

private

◆ m_gravity

template<typename Transport >

amrex::Vector<amrex::Real> amr_wind::turbulence::KLAxell< Transport >::m_gravity {0.0, 0.0, -9.81}

private

Gravity vector (m/s^2)

◆ m_meso_sponge_start

template<typename Transport >

amrex::Real amr_wind::turbulence::KLAxell< Transport >::m_meso_sponge_start {2000}

private

◆ m_prandtl

template<typename Transport >

amrex::Real amr_wind::turbulence::KLAxell< Transport >::m_prandtl {1.0}

private

◆ m_rho

template<typename Transport >

Field& amr_wind::turbulence::KLAxell< Transport >::m_rho

private

◆ m_shear_prod

template<typename Transport >

Field& amr_wind::turbulence::KLAxell< Transport >::m_shear_prod

private

◆ m_surf_flux

template<typename Transport >

amrex::Real amr_wind::turbulence::KLAxell< Transport >::m_surf_flux {0}

private

◆ m_temperature

template<typename Transport >

Field& amr_wind::turbulence::KLAxell< Transport >::m_temperature

private

◆ m_tke

template<typename Transport >

Field* amr_wind::turbulence::KLAxell< Transport >::m_tke {nullptr}

private

◆ m_turb_lscale

template<typename Transport >

Field& amr_wind::turbulence::KLAxell< Transport >::m_turb_lscale

private

◆ m_vel

template<typename Transport >

Field& amr_wind::turbulence::KLAxell< Transport >::m_vel

private

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

/home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/RANS/KLAxell.H
/home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/RANS/KLAxell.cpp

KLAxell&lt; Transport &gt; Class Template Reference

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KLAxell()

Member Function Documentation

◆ identifier()

◆ model_coeffs()

◆ model_name()

◆ parse_model_coeffs()

◆ post_advance_work()

◆ update_alphaeff()

◆ update_scalar_diff()

◆ update_turbulent_viscosity()

Member Data Documentation

◆ m_buoy_prod

◆ m_Cb_stable

◆ m_Cb_unstable

◆ m_Cmu

◆ m_Cmu_prime

◆ m_dissip

◆ m_gravity

◆ m_meso_sponge_start

◆ m_prandtl

◆ m_rho

◆ m_shear_prod

◆ m_surf_flux

◆ m_temperature

◆ m_tke

◆ m_turb_lscale

◆ m_vel

KLAxell< Transport > Class Template Reference