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

#include <LaminarModel.H>

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

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

Public Member Functions
	Laminar (CFDSim &sim)
	~Laminar () override=default
std::string	model_name () const override
	String representation of this model for I/O.
void	update_turbulent_viscosity (const FieldState fstate, const DiffusionType diff_type) override
	Update the effective/turbulent viscosity field.
void	post_advance_work () override
	No post advance work for this model.
void	parse_model_coeffs () override
	No model specific coefficient for this model.
Field &	mu_turb () override
	Return the turbulent viscosity field (just the same as the effective field)
Field &	alpha_turb () override
	Return the thermal diffusivity field (just the same as effective field)
bool	is_turbulent () const override
	Indicate that this model is not a turbulent model type.
void	update_mueff (Field &mueff) override
	Interface to update effective viscosity (mu_eff = mu + mu_t)
void	update_alphaeff (Field &alphaeff) override
	Interface to update effective thermal diffusivity.
void	update_scalar_diff (Field &deff, const std::string &name) override
	Interface to update scalar diffusivity based on Schmidt number.
TurbulenceModel::CoeffsDictType	model_coeffs () const override
	Return model coefficients dictionary.
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
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)

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::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::Laminar< Transport >

Laminar model

Implementation of laminar flow model

Constructor & Destructor Documentation

Laminar()

template<typename Transport>

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

inlineexplicit

~Laminar()

template<typename Transport>

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

overridedefault

Member Function Documentation

alpha_turb()

template<typename Transport>

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

inlineoverridevirtual

Return the thermal diffusivity field (just the same as effective field)

Implements amr_wind::turbulence::TurbulenceModel.

identifier()

template<typename Transport>

std::string amr_wind::turbulence::Laminar< Transport >::identifier ( )

inlinestatic

is_turbulent()

template<typename Transport>

bool amr_wind::turbulence::Laminar< Transport >::is_turbulent ( ) const

inlineoverridevirtual

Indicate that this model is not a turbulent model type.

Reimplemented from amr_wind::turbulence::TurbulenceModel.

model_coeffs()

template<typename Transport>

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

overridevirtual

Return model coefficients dictionary.

Implements amr_wind::turbulence::TurbulenceModel.

model_name()

template<typename Transport>

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

inlineoverridevirtual

String representation of this model for I/O.

Implements amr_wind::turbulence::TurbulenceModel.

mu_turb()

template<typename Transport>

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

inlineoverridevirtual

Return the turbulent viscosity field (just the same as the effective field)

Implements amr_wind::turbulence::TurbulenceModel.

parse_model_coeffs()

template<typename Transport>

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

inlineoverridevirtual

No model specific coefficient for this model.

Implements amr_wind::turbulence::TurbulenceModel.

post_advance_work()

template<typename Transport>

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

inlineoverridevirtual

No post advance work for this model.

Implements amr_wind::turbulence::TurbulenceModel.

update_alphaeff()

template<typename Transport>

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

overridevirtual

Interface to update effective thermal diffusivity.

Implements amr_wind::turbulence::TurbulenceModel.

update_mueff()

template<typename Transport>

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

overridevirtual

Interface to update effective viscosity (mu_eff = mu + mu_t)

Implements amr_wind::turbulence::TurbulenceModel.

update_scalar_diff()

template<typename Transport>

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

overridevirtual

Interface to update scalar diffusivity based on Schmidt number.

Implements amr_wind::turbulence::TurbulenceModel.

update_turbulent_viscosity()

template<typename Transport>

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

overridevirtual

Update the effective/turbulent viscosity field.

Implements amr_wind::turbulence::TurbulenceModel.

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/LaminarModel.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/LaminarModel.cpp