AMD< Transport > Class Template Reference

Kynema-SGF API: kynema_sgf::turbulence::AMD< Transport > Class Template Reference

Kynema-SGF API v0.1.0

CFD solver for wind plant simulations

Loading...

Searching...

No Matches

#include <AMD.H>

Inheritance diagram for kynema_sgf::turbulence::AMD< Transport >:

[legend]

Collaboration diagram for kynema_sgf::turbulence::AMD< Transport >:

[legend]

Public Member Functions
	AMD (CFDSim &sim)
std::string	model_name () const override
	Model name for debugging purposes.
void	update_turbulent_viscosity (FieldState fstate, DiffusionType) override
	Update the turbulent viscosity field.
template<typename IndexSelector>
void	update_turbulent_viscosity (FieldState fstate, const IndexSelector &idxOp)
void	update_alphaeff (Field &alphaeff) override
	Update the effective thermal diffusivity field.
TurbulenceModel::CoeffsDictType	model_coeffs () const override
	Return model coefficients dictionary.
void	parse_model_coeffs () override
	Parse turbulence model coefficients for this model.
void	post_advance_work () override
	No post advance work for this model.
void	post_init_actions () override
	Actions to perform post initialization.
void	post_regrid_actions () override
	Actions to perform post regrid.
Public Member Functions inherited from kynema_sgf::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 kynema_sgf::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 kynema_sgf::turbulence::TurbulenceModel
	~TurbulenceModel () override=default
virtual bool	is_turbulent () const
	Flag indicating whether the model is turbulent.
Public Member Functions inherited from kynema_sgf::Factory< TurbulenceModel, CFDSim & >
virtual	~Factory ()=default

Static Public Member Functions
static std::string	identifier ()
Static Public Member Functions inherited from kynema_sgf::turbulence::TurbulenceModel
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)

Private Attributes
amrex::Real	m_C {0.333333333333333_rt}
	Poincare coefficient (default value set for 2nd order Kynema-SGF discretization)
int	m_normal_dir {2}
	Wall-normal direction axis.
const Field &	m_vel
const Field &	m_temperature
const Field &	m_rho
FieldPlaneAveraging	m_pa_temp
amrex::Vector< amrex::Real >	m_gravity {0.0_rt, 0.0_rt, -9.81_rt}
std::unique_ptr< ScratchField >	m_gradVel
std::unique_ptr< ScratchField >	m_gradT

Additional Inherited Members
Public Types inherited from kynema_sgf::turbulence::TurbModel< Transport >
using	TransportType = Transport
Public Types inherited from kynema_sgf::turbulence::TurbulenceModel
using	CoeffsDictType = std::unordered_map<std::string, amrex::Real>
	Default identifier used by factor methods.
Public Attributes inherited from kynema_sgf::Factory< TurbulenceModel, CFDSim & >
friend	Base
Protected Attributes inherited from kynema_sgf::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 kynema_sgf::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 kynema_sgf::turbulence::AMD< Transport >

AMD LES Model

Constructor & Destructor Documentation

◆ AMD()

template<typename Transport>

kynema_sgf::turbulence::AMD< Transport >::AMD ( CFDSim & sim )

explicit

Member Function Documentation

◆ identifier()

template<typename Transport>

std::string kynema_sgf::turbulence::AMD< Transport >::identifier ( )

inlinestatic

◆ model_coeffs()

template<typename Transport>

TurbulenceModel::CoeffsDictType kynema_sgf::turbulence::AMD< Transport >::model_coeffs ( ) const

nodiscardoverridevirtual

Return model coefficients dictionary.

Implements kynema_sgf::turbulence::TurbulenceModel.

◆ model_name()

template<typename Transport>

std::string kynema_sgf::turbulence::AMD< Transport >::model_name ( ) const

inlinenodiscardoverridevirtual

Model name for debugging purposes.

Implements kynema_sgf::turbulence::TurbulenceModel.

◆ parse_model_coeffs()

template<typename Transport>

void kynema_sgf::turbulence::AMD< Transport >::parse_model_coeffs ( )

overridevirtual

Parse turbulence model coefficients for this model.

Implements kynema_sgf::turbulence::TurbulenceModel.

◆ post_advance_work()

template<typename Transport>

void kynema_sgf::turbulence::AMD< Transport >::post_advance_work ( )

inlineoverridevirtual

No post advance work for this model.

Implements kynema_sgf::turbulence::TurbulenceModel.

◆ post_init_actions()

template<typename Transport>

void kynema_sgf::turbulence::AMD< Transport >::post_init_actions ( )

overridevirtual

Actions to perform post initialization.

Reimplemented from kynema_sgf::turbulence::TurbulenceModel.

◆ post_regrid_actions()

template<typename Transport>

void kynema_sgf::turbulence::AMD< Transport >::post_regrid_actions ( )

overridevirtual

Actions to perform post regrid.

Reimplemented from kynema_sgf::turbulence::TurbulenceModel.

◆ update_alphaeff()

template<typename Transport>

void kynema_sgf::turbulence::AMD< Transport >::update_alphaeff ( Field & alphaeff )

overridevirtual

Update the effective thermal diffusivity field.

Implements kynema_sgf::turbulence::TurbulenceModel.

◆ update_turbulent_viscosity() [1/2]

template<typename Transport>

template<typename IndexSelector>

void kynema_sgf::turbulence::AMD< Transport >::update_turbulent_viscosity	(	FieldState	fstate,
		const IndexSelector &	idxOp )

◆ update_turbulent_viscosity() [2/2]

template<typename Transport>

void kynema_sgf::turbulence::AMD< Transport >::update_turbulent_viscosity	(	FieldState	fstate,
		DiffusionType	)

overridevirtual

Update the turbulent viscosity field.

Implements kynema_sgf::turbulence::TurbulenceModel.

Member Data Documentation

◆ m_C

template<typename Transport>

amrex::Real kynema_sgf::turbulence::AMD< Transport >::m_C {0.333333333333333_rt}

private

Poincare coefficient (default value set for 2nd order Kynema-SGF discretization)

◆ m_gradT

template<typename Transport>

std::unique_ptr<ScratchField> kynema_sgf::turbulence::AMD< Transport >::m_gradT

private

◆ m_gradVel

template<typename Transport>

std::unique_ptr<ScratchField> kynema_sgf::turbulence::AMD< Transport >::m_gradVel

private

◆ m_gravity

template<typename Transport>

amrex::Vector<amrex::Real> kynema_sgf::turbulence::AMD< Transport >::m_gravity {0.0_rt, 0.0_rt, -9.81_rt}

private

◆ m_normal_dir

template<typename Transport>

int kynema_sgf::turbulence::AMD< Transport >::m_normal_dir {2}

private

Wall-normal direction axis.

◆ m_pa_temp

template<typename Transport>

FieldPlaneAveraging kynema_sgf::turbulence::AMD< Transport >::m_pa_temp

private

◆ m_rho

template<typename Transport>

const Field& kynema_sgf::turbulence::AMD< Transport >::m_rho

private

◆ m_temperature

template<typename Transport>

const Field& kynema_sgf::turbulence::AMD< Transport >::m_temperature

private

◆ m_vel

template<typename Transport>

const Field& kynema_sgf::turbulence::AMD< Transport >::m_vel

private

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

/home/runner/work/kynema-sgf/kynema-sgf/src/turbulence/LES/AMD.H
/home/runner/work/kynema-sgf/kynema-sgf/src/turbulence/LES/AMD.cpp

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AMD()

Member Function Documentation

◆ identifier()

◆ model_coeffs()

◆ model_name()

◆ parse_model_coeffs()

◆ post_advance_work()

◆ post_init_actions()

◆ post_regrid_actions()

◆ update_alphaeff()

◆ update_turbulent_viscosity() [1/2]

◆ update_turbulent_viscosity() [2/2]

Member Data Documentation

◆ m_C

◆ m_gradT

◆ m_gradVel

◆ m_gravity

◆ m_normal_dir

◆ m_pa_temp

◆ m_rho

◆ m_temperature

◆ m_vel

AMD< Transport > Class Template Reference