kynema_sgf::turbulence::TurbulenceModel Class Reference

#include <TurbulenceModel.H>

Inheritance diagram for kynema_sgf::turbulence::TurbulenceModel:

Collaboration diagram for kynema_sgf::turbulence::TurbulenceModel:

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

Public Member Functions
	~TurbulenceModel () override=default
virtual void	update_turbulent_viscosity (FieldState fstate, DiffusionType diff_type)=0
virtual void	post_advance_work ()=0
	Do any post advance actions for the turbulence model.
virtual void	register_mueff_field (Field &mueff)=0
	Register the effective viscosity (for momentum field)
virtual void	register_alphaeff_field (Field &alphaeff)=0
	Register the thermal diffusivity field.
virtual std::string	model_name () const =0
	String representation of this turbulence model for I/O.
virtual std::unique_ptr< ScratchField >	mu ()=0
	Return the dynamic viscosity (laminar) field.
virtual std::unique_ptr< ScratchField >	alpha ()=0
	Return the thermal diffusivity (laminar) field for enthalpy/temperature.
virtual std::unique_ptr< ScratchField >	scalar_diffusivity (const std::string &name)=0
	Return the scalar diffusivity field.
virtual Field &	mu_turb ()=0
	Return the turbulent dynamic viscosity field.
virtual Field &	alpha_turb ()=0
	Return the turbulent dynamic viscosity field.
virtual Field &	mueff ()=0
	Return the effective dynamic viscosity field.
virtual Field &	alphaeff ()=0
	Return the effective thermal diffusivity field.
virtual bool	is_turbulent () const
	Flag indicating whether the model is turbulent.
virtual void	update_mueff (Field &mueff)=0
	Interface to update effective viscosity.
virtual void	update_alphaeff (Field &alphaeff)=0
	Interface to update effective thermal diffusivity.
virtual void	update_scalar_diff (Field &deff, const std::string &name)=0
	Interface to update scalar diffusivity based on Schmidt number.
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 kynema_sgf::Factory< TurbulenceModel, CFDSim & >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	base_identifier ()
Static Public Member Functions inherited from kynema_sgf::Factory< TurbulenceModel, CFDSim & >
static std::unique_ptr< TurbulenceModel >	create (const std::string &key, Args... args)
static void	print (std::ostream &os)

Additional Inherited Members
Public Attributes inherited from kynema_sgf::Factory< TurbulenceModel, CFDSim & >
friend	Base

Detailed Description

Abstract representation of a turbulence model

This class is an abstract representation of a turbulence model used in Kynema-SGF. Subclasses must implement the methods defined in this class to interact with Equation Systems.

Member Typedef Documentation

CoeffsDictType

using kynema_sgf::turbulence::TurbulenceModel::CoeffsDictType = std::unordered_map<std::string, amrex::Real>

Default identifier used by factor methods.

Constructor & Destructor Documentation

~TurbulenceModel()

kynema_sgf::turbulence::TurbulenceModel::~TurbulenceModel ( )

overridedefault

Member Function Documentation

alpha()

virtual std::unique_ptr< ScratchField > kynema_sgf::turbulence::TurbulenceModel::alpha ( )

pure virtual

Return the thermal diffusivity (laminar) field for enthalpy/temperature.

Implemented in kynema_sgf::turbulence::TurbModel< Transport >.

alpha_turb()

virtual Field & kynema_sgf::turbulence::TurbulenceModel::alpha_turb ( )

pure virtual

Return the turbulent dynamic viscosity field.

Implemented in kynema_sgf::turbulence::Laminar< Transport >, and kynema_sgf::turbulence::TurbModelBase< Transport >.

alphaeff()

virtual Field & kynema_sgf::turbulence::TurbulenceModel::alphaeff ( )

pure virtual

Return the effective thermal diffusivity field.

Implemented in kynema_sgf::turbulence::TurbModel< Transport >.

base_identifier()

std::string kynema_sgf::turbulence::TurbulenceModel::base_identifier ( )

inlinestatic

is_turbulent()

virtual bool kynema_sgf::turbulence::TurbulenceModel::is_turbulent ( ) const

inlinenodiscardvirtual

Flag indicating whether the model is turbulent.

Reimplemented in kynema_sgf::turbulence::Laminar< Transport >.

model_coeffs()

virtual CoeffsDictType kynema_sgf::turbulence::TurbulenceModel::model_coeffs ( ) const

nodiscardpure virtual

Return model coefficients dictionary.

Implemented in kynema_sgf::turbulence::AMD< Transport >, kynema_sgf::turbulence::AMDNoTherm< Transport >, kynema_sgf::turbulence::KLAxell< Transport >, kynema_sgf::turbulence::KOmegaSST< Transport >, kynema_sgf::turbulence::KOmegaSSTIDDES< Transport >, kynema_sgf::turbulence::Kosovic< Transport >, kynema_sgf::turbulence::Laminar< Transport >, kynema_sgf::turbulence::OneEqKsgsM84< Transport >, kynema_sgf::turbulence::OneEqKsgsS94< Transport >, and kynema_sgf::turbulence::Smagorinsky< Transport >.

model_name()

virtual std::string kynema_sgf::turbulence::TurbulenceModel::model_name ( ) const

nodiscardpure virtual

String representation of this turbulence model for I/O.

Implemented in kynema_sgf::turbulence::AMD< Transport >, kynema_sgf::turbulence::AMDNoTherm< Transport >, kynema_sgf::turbulence::KLAxell< Transport >, kynema_sgf::turbulence::KOmegaSST< Transport >, kynema_sgf::turbulence::KOmegaSSTIDDES< Transport >, kynema_sgf::turbulence::Kosovic< Transport >, kynema_sgf::turbulence::Laminar< Transport >, kynema_sgf::turbulence::OneEqKsgsM84< Transport >, kynema_sgf::turbulence::OneEqKsgsS94< Transport >, and kynema_sgf::turbulence::Smagorinsky< Transport >.

mu()

virtual std::unique_ptr< ScratchField > kynema_sgf::turbulence::TurbulenceModel::mu ( )

pure virtual

Return the dynamic viscosity (laminar) field.

Implemented in kynema_sgf::turbulence::TurbModel< Transport >.

mu_turb()

virtual Field & kynema_sgf::turbulence::TurbulenceModel::mu_turb ( )

pure virtual

Return the turbulent dynamic viscosity field.

Implemented in kynema_sgf::turbulence::Laminar< Transport >, and kynema_sgf::turbulence::TurbModelBase< Transport >.

mueff()

virtual Field & kynema_sgf::turbulence::TurbulenceModel::mueff ( )

pure virtual

Return the effective dynamic viscosity field.

Implemented in kynema_sgf::turbulence::TurbModel< Transport >.

parse_model_coeffs()

virtual void kynema_sgf::turbulence::TurbulenceModel::parse_model_coeffs ( )

pure virtual

Parse turbulence model coefficients.

Implemented in kynema_sgf::turbulence::AMD< Transport >, kynema_sgf::turbulence::AMDNoTherm< Transport >, kynema_sgf::turbulence::KLAxell< Transport >, kynema_sgf::turbulence::KOmegaSST< Transport >, kynema_sgf::turbulence::KOmegaSSTIDDES< Transport >, kynema_sgf::turbulence::Kosovic< Transport >, kynema_sgf::turbulence::Laminar< Transport >, kynema_sgf::turbulence::OneEqKsgsM84< Transport >, kynema_sgf::turbulence::OneEqKsgsS94< Transport >, and kynema_sgf::turbulence::Smagorinsky< Transport >.

post_advance_work()

virtual void kynema_sgf::turbulence::TurbulenceModel::post_advance_work ( )

pure virtual

Do any post advance actions for the turbulence model.

Implemented in kynema_sgf::turbulence::AMD< Transport >, kynema_sgf::turbulence::AMDNoTherm< Transport >, kynema_sgf::turbulence::KLAxell< Transport >, kynema_sgf::turbulence::KOmegaSST< Transport >, kynema_sgf::turbulence::KOmegaSSTIDDES< Transport >, kynema_sgf::turbulence::Kosovic< Transport >, kynema_sgf::turbulence::Laminar< Transport >, kynema_sgf::turbulence::OneEqKsgsM84< Transport >, kynema_sgf::turbulence::OneEqKsgsS94< Transport >, and kynema_sgf::turbulence::Smagorinsky< Transport >.

register_alphaeff_field()

virtual void kynema_sgf::turbulence::TurbulenceModel::register_alphaeff_field ( Field & alphaeff )

pure virtual

Register the thermal diffusivity field.

Implemented in kynema_sgf::turbulence::TurbModel< Transport >.

register_mueff_field()

virtual void kynema_sgf::turbulence::TurbulenceModel::register_mueff_field ( Field & mueff )

pure virtual

Register the effective viscosity (for momentum field)

Implemented in kynema_sgf::turbulence::TurbModel< Transport >.

scalar_diffusivity()

virtual std::unique_ptr< ScratchField > kynema_sgf::turbulence::TurbulenceModel::scalar_diffusivity ( const std::string & name )

pure virtual

Return the scalar diffusivity field.

Implemented in kynema_sgf::turbulence::TurbModel< Transport >.

update_alphaeff()

virtual void kynema_sgf::turbulence::TurbulenceModel::update_alphaeff ( Field & alphaeff )

pure virtual

Interface to update effective thermal diffusivity.

Implemented in kynema_sgf::turbulence::AMD< Transport >, kynema_sgf::turbulence::KLAxell< Transport >, kynema_sgf::turbulence::Kosovic< Transport >, kynema_sgf::turbulence::Laminar< Transport >, kynema_sgf::turbulence::OneEqKsgsM84< Transport >, and kynema_sgf::turbulence::TurbModelBase< Transport >.

update_mueff()

virtual void kynema_sgf::turbulence::TurbulenceModel::update_mueff ( Field & mueff )

pure virtual

Interface to update effective viscosity.

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

Implemented in kynema_sgf::turbulence::Laminar< Transport >, and kynema_sgf::turbulence::TurbModelBase< Transport >.

update_scalar_diff()

virtual void kynema_sgf::turbulence::TurbulenceModel::update_scalar_diff ( Field & deff, const std::string & name )

pure virtual

Interface to update scalar diffusivity based on Schmidt number.

Implemented in kynema_sgf::turbulence::KLAxell< Transport >, kynema_sgf::turbulence::KOmegaSST< Transport >, kynema_sgf::turbulence::Laminar< Transport >, kynema_sgf::turbulence::OneEqKsgsM84< Transport >, kynema_sgf::turbulence::OneEqKsgsS94< Transport >, and kynema_sgf::turbulence::TurbModelBase< Transport >.

update_turbulent_viscosity()

virtual void kynema_sgf::turbulence::TurbulenceModel::update_turbulent_viscosity ( FieldState fstate, DiffusionType diff_type )

pure virtual

Update the turbulent viscosity field

This method is called at the beginning of each predictor/corrector step to update the turbulent viscosity field. The exact effective viscosity for each equation system is handled by the concrete implementation of PDESystem.

Parameters

fstate	State used for updates to differentiate logic in predictor and corrector steps.
diff_type	diffusion solve type

Implemented in kynema_sgf::turbulence::AMD< Transport >, kynema_sgf::turbulence::AMDNoTherm< Transport >, kynema_sgf::turbulence::KLAxell< Transport >, kynema_sgf::turbulence::KOmegaSST< Transport >, kynema_sgf::turbulence::KOmegaSSTIDDES< Transport >, kynema_sgf::turbulence::Kosovic< Transport >, kynema_sgf::turbulence::Laminar< Transport >, kynema_sgf::turbulence::OneEqKsgsM84< Transport >, kynema_sgf::turbulence::OneEqKsgsS94< Transport >, and kynema_sgf::turbulence::Smagorinsky< Transport >.

---

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

• /home/runner/work/kynema-sgf/kynema-sgf/src/turbulence/TurbulenceModel.H