KOmegaSST< Transport > Class Template Reference

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

AMR-Wind API v0.1.0

CFD solver for wind plant simulations

Loading...

Searching...

No Matches

#include <KOmegaSST.H>

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

[legend]

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

[legend]

Public Member Functions
	KOmegaSST (CFDSim &sim)

	~KOmegaSST () override

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

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

void	post_advance_work () override
	No post advance work for this model.

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)

Protected Attributes
Field &	m_vel

Field &	m_f1

Field &	m_shear_prod

Field &	m_buoy_term

Field &	m_diss

Field &	m_sdr_src

Field &	m_sdr_diss

Field &	m_rho

Field &	m_walldist

Field *	m_tke

Field *	m_sdr

amrex::Real	m_beta_star {0.09}
	Turbulence constants.

amrex::Real	m_alpha1 {0.5555555555555556}

amrex::Real	m_alpha2 {0.44}

amrex::Real	m_beta1 {0.075}

amrex::Real	m_beta2 {0.0828}

amrex::Real	m_sigma_k1 {0.85}

amrex::Real	m_sigma_k2 {1.0}

amrex::Real	m_sigma_omega1 {0.5}

amrex::Real	m_sigma_omega2 {0.856}

amrex::Real	m_a1 {0.31}

amrex::Real	m_tke_amb {0.0}

amrex::Real	m_sdr_amb {0.0}

bool	m_include_buoyancy {false}
	Buoyancy modified constants.

amrex::Real	m_buoyancy_factor = 0.0

amrex::Real	m_sigma_t {0.85}

amrex::Vector< amrex::Real >	m_gravity {0.0, 0.0, -9.81}

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.

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

Detailed Description

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

K-Omega-SST RANS turbulence model

This also serves as the base class for all k-omega type RANS models

Turbulence model described in

Menter, F., Esch, T., "Elements of Industrial Heat Transfer Prediction", 16th Brazilian Congress of Mechanical Engineering (COBEM), Nov. 2001.

with updated coefficients from

Menter, F. R., Kuntz, M., and Langtry, R., "Ten Years of Industrial Experience with the SST Turbulence Model", Turbulence, Heat and Mass Transfer 4, 2003, pp. 625 - 632.

Also see

http://turbmodels.larc.nasa.gov/sst.html

Constructor & Destructor Documentation

◆ KOmegaSST()

template<typename Transport >

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

explicit

◆ ~KOmegaSST()

template<typename Transport >

amr_wind::turbulence::KOmegaSST< Transport >::~KOmegaSST ( )

overridedefault

Member Function Documentation

◆ identifier()

template<typename Transport >

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

inlinestatic

◆ model_coeffs()

template<typename Transport >

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

overridevirtual

Return turbulence model coefficients.

Implements amr_wind::turbulence::TurbulenceModel.

Reimplemented in amr_wind::turbulence::KOmegaSSTIDDES< Transport >.

◆ model_name()

template<typename Transport >

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

inlineoverridevirtual

String representation of this turbulence model for I/O.

Implements amr_wind::turbulence::TurbulenceModel.

Reimplemented in amr_wind::turbulence::KOmegaSSTIDDES< Transport >.

◆ parse_model_coeffs()

template<typename Transport >

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

overridevirtual

Parse turbulence model coefficients.

Implements amr_wind::turbulence::TurbulenceModel.

Reimplemented in amr_wind::turbulence::KOmegaSSTIDDES< Transport >.

◆ post_advance_work()

template<typename Transport >

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

inlineoverridevirtual

No post advance work for this model.

Implements amr_wind::turbulence::TurbulenceModel.

Reimplemented in amr_wind::turbulence::KOmegaSSTIDDES< Transport >.

◆ update_scalar_diff()

template<typename Transport >

void amr_wind::turbulence::KOmegaSST< 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::KOmegaSST< Transport >::update_turbulent_viscosity	(	const FieldState	fstate,
		const DiffusionType	diff_type )

overridevirtual

Update the turbulent viscosity field.

Implements amr_wind::turbulence::TurbulenceModel.

Reimplemented in amr_wind::turbulence::KOmegaSSTIDDES< Transport >.

Member Data Documentation

◆ m_a1

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_a1 {0.31}

protected

◆ m_alpha1

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_alpha1 {0.5555555555555556}

protected

◆ m_alpha2

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_alpha2 {0.44}

protected

◆ m_beta1

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_beta1 {0.075}

protected

◆ m_beta2

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_beta2 {0.0828}

protected

◆ m_beta_star

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_beta_star {0.09}

protected

Turbulence constants.

◆ m_buoy_term

template<typename Transport >

Field& amr_wind::turbulence::KOmegaSST< Transport >::m_buoy_term

protected

◆ m_buoyancy_factor

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_buoyancy_factor = 0.0

protected

◆ m_diss

template<typename Transport >

Field& amr_wind::turbulence::KOmegaSST< Transport >::m_diss

protected

◆ m_f1

template<typename Transport >

Field& amr_wind::turbulence::KOmegaSST< Transport >::m_f1

protected

◆ m_gravity

template<typename Transport >

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

protected

◆ m_include_buoyancy

template<typename Transport >

bool amr_wind::turbulence::KOmegaSST< Transport >::m_include_buoyancy {false}

protected

Buoyancy modified constants.

◆ m_rho

template<typename Transport >

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

protected

◆ m_sdr

template<typename Transport >

Field* amr_wind::turbulence::KOmegaSST< Transport >::m_sdr

protected

◆ m_sdr_amb

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_sdr_amb {0.0}

protected

◆ m_sdr_diss

template<typename Transport >

Field& amr_wind::turbulence::KOmegaSST< Transport >::m_sdr_diss

protected

◆ m_sdr_src

template<typename Transport >

Field& amr_wind::turbulence::KOmegaSST< Transport >::m_sdr_src

protected

◆ m_shear_prod

template<typename Transport >

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

protected

◆ m_sigma_k1

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_sigma_k1 {0.85}

protected

◆ m_sigma_k2

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_sigma_k2 {1.0}

protected

◆ m_sigma_omega1

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_sigma_omega1 {0.5}

protected

◆ m_sigma_omega2

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_sigma_omega2 {0.856}

protected

◆ m_sigma_t

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_sigma_t {0.85}

protected

◆ m_tke

template<typename Transport >

Field* amr_wind::turbulence::KOmegaSST< Transport >::m_tke

protected

◆ m_tke_amb

template<typename Transport >

amrex::Real amr_wind::turbulence::KOmegaSST< Transport >::m_tke_amb {0.0}

protected

◆ m_vel

template<typename Transport >

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

protected

◆ m_walldist

template<typename Transport >

Field& amr_wind::turbulence::KOmegaSST< Transport >::m_walldist

protected

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

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KOmegaSST()

◆ ~KOmegaSST()

Member Function Documentation

◆ identifier()

◆ model_coeffs()

◆ model_name()

◆ parse_model_coeffs()

◆ post_advance_work()

◆ update_scalar_diff()

◆ update_turbulent_viscosity()

Member Data Documentation

◆ m_a1

◆ m_alpha1

◆ m_alpha2

◆ m_beta1

◆ m_beta2

◆ m_beta_star

◆ m_buoy_term

◆ m_buoyancy_factor

◆ m_diss

◆ m_f1

◆ m_gravity

◆ m_include_buoyancy

◆ m_rho

◆ m_sdr

◆ m_sdr_amb

◆ m_sdr_diss

◆ m_sdr_src

◆ m_shear_prod

◆ m_sigma_k1

◆ m_sigma_k2

◆ m_sigma_omega1

◆ m_sigma_omega2

◆ m_sigma_t

◆ m_tke

◆ m_tke_amb

◆ m_vel

◆ m_walldist

KOmegaSST< Transport > Class Template Reference