amr_wind::turbulence::TurbModelBase< Transport > Class Template Reference

#include <TurbModelBase.H>

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

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

Public Member Functions
	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 void	update_turbulent_viscosity (const FieldState fstate, const DiffusionType diff_type)=0
virtual void	post_advance_work ()=0
	Do any post advance actions for the turbulence model.
virtual std::string	model_name () const =0
	String representation of this turbulence model for I/O.
virtual bool	is_turbulent () const
	Flag indicating whether the model is turbulent.
virtual void	parse_model_coeffs ()=0
	Parse turbulence model coefficients.
virtual CoeffsDictType	model_coeffs () const =0
	Return model coefficients dictionary.
Public Member Functions inherited from amr_wind::Factory< TurbulenceModel, CFDSim & >
virtual	~Factory ()=default

Protected Attributes
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.
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)
Public Attributes inherited from amr_wind::Factory< TurbulenceModel, CFDSim & >
friend	Base

Detailed Description

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

Turbulence model aspects common to both LES and RANS models

This class implements more of the common methods from TurbulenceModel that are common to most turbulence model. This is different from TurbModel in that that class is also valid for Laminar which isn't really a turbulence model but is a convenient way to represent the absence of a turbulence model.

Constructor & Destructor Documentation

TurbModelBase()

template<typename Transport >

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

inlineexplicit

Member Function Documentation

alpha_turb()

template<typename Transport >

Field & amr_wind::turbulence::TurbModelBase< Transport >::alpha_turb ( )

inlineoverridevirtual

Return the turbulent thermal diffusivity field.

Implements amr_wind::turbulence::TurbulenceModel.

mu_turb()

template<typename Transport >

Field & amr_wind::turbulence::TurbModelBase< Transport >::mu_turb ( )

inlineoverridevirtual

Return the turbulent viscosity field.

Implements amr_wind::turbulence::TurbulenceModel.

update_alphaeff()

template<typename Transport >

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

inlineoverridevirtual

Update the effective thermal diffusivity field

\(\alpha_\mathrm{eff} = \alpha + \alpha_t\)

Parameters

alphaeff

Effective diffusivity field

Implements amr_wind::turbulence::TurbulenceModel.

update_mueff()

template<typename Transport >

void amr_wind::turbulence::TurbModelBase< Transport >::update_mueff ( Field & mueff )

inlineoverridevirtual

Update the effective viscosity field

\(\mu_\mathrm{eff} = \mu + \mu_t\)

Parameters

mueff

Effective viscosity field

Implements amr_wind::turbulence::TurbulenceModel.

update_scalar_diff()

template<typename Transport >

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

inlineoverridevirtual

Interface to update scalar diffusivity based on Schmidt number.

Implements amr_wind::turbulence::TurbulenceModel.

Member Data Documentation

m_alpha_turb

template<typename Transport >

Field* amr_wind::turbulence::TurbModelBase< Transport >::m_alpha_turb {nullptr}

protected

Reference to thermal diffusivity field.

m_mu_turb

template<typename Transport >

Field& amr_wind::turbulence::TurbModelBase< Transport >::m_mu_turb

protected

Reference to the turbulent viscosity field.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/TurbModelBase.H