Kosovic< Transport > Class Template Reference

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

AMR-Wind API v0.1.0

CFD solver for wind plant simulations

Loading...

Searching...

No Matches

#include <Kosovic.H>

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

[legend]

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

[legend]

Public Member Functions
	Kosovic (CFDSim &sim)
std::string	model_name () const override
	Model name for debugging purposes.
void	update_turbulent_viscosity (const FieldState fstate, const DiffusionType) override
	Update the turbulent viscosity field.
void	post_advance_work () override
	No post advance work for this model.
void	update_alphaeff (Field &alphaeff) override
	Update the effective thermal diffusivity field.
void	parse_model_coeffs () override
	Parse turbulence model coefficients.
TurbulenceModel::CoeffsDictType	model_coeffs () const override
	Return model coefficients dictionary.
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)

Private Attributes
amrex::Real	m_Cb {0.36}
	Kosovic coefficient (default value set for ABL simulations)
amrex::Real	m_Cs {0.135}
amrex::Real	m_C1 {2.1}
amrex::Real	m_C2 {2.1}
amrex::Real	m_Sk {0.5}
bool	m_surfaceRANS {false}
amrex::Real	m_surfaceFactor {0}
amrex::Real	m_switchLoc {24}
amrex::Real	m_surfaceRANSExp {2}
amrex::Real	m_LESTurnOff {1e15}
bool	m_writeTerms {false}
const Field &	m_vel
const Field &	m_rho
Field &	m_Nij
Field &	m_divNij
std::string	m_wall_het_model {"none"}
amrex::Real	m_monin_obukhov_length {constants::LARGE_NUM}
amrex::Real	m_kappa {0.41}
amrex::Real	m_gamma_m {5.0}
amrex::Real	m_beta_m {16.0}
amrex::Real	m_surface_roughness_z0 {0.1}

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::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.

Detailed Description

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

Kosovic LES Model

Constructor & Destructor Documentation

◆ Kosovic()

template<typename Transport>

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

explicit

Member Function Documentation

◆ identifier()

template<typename Transport>

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

inlinestatic

◆ model_coeffs()

template<typename Transport>

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

overridevirtual

Return model coefficients dictionary.

Implements amr_wind::turbulence::TurbulenceModel.

◆ model_name()

template<typename Transport>

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

inlineoverridevirtual

Model name for debugging purposes.

Implements amr_wind::turbulence::TurbulenceModel.

◆ parse_model_coeffs()

template<typename Transport>

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

overridevirtual

Parse turbulence model coefficients.

Implements amr_wind::turbulence::TurbulenceModel.

◆ post_advance_work()

template<typename Transport>

void amr_wind::turbulence::Kosovic< 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::Kosovic< Transport >::update_alphaeff ( Field & alphaeff )

overridevirtual

Update the effective thermal diffusivity field.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_turbulent_viscosity()

template<typename Transport>

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

overridevirtual

Update the turbulent viscosity field.

Implements amr_wind::turbulence::TurbulenceModel.

Member Data Documentation

◆ m_beta_m

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_beta_m {16.0}

private

◆ m_C1

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_C1 {2.1}

private

◆ m_C2

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_C2 {2.1}

private

◆ m_Cb

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_Cb {0.36}

private

Kosovic coefficient (default value set for ABL simulations)

◆ m_Cs

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_Cs {0.135}

private

◆ m_divNij

template<typename Transport>

Field& amr_wind::turbulence::Kosovic< Transport >::m_divNij

private

◆ m_gamma_m

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_gamma_m {5.0}

private

◆ m_kappa

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_kappa {0.41}

private

◆ m_LESTurnOff

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_LESTurnOff {1e15}

private

◆ m_monin_obukhov_length

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_monin_obukhov_length {constants::LARGE_NUM}

private

◆ m_Nij

template<typename Transport>

Field& amr_wind::turbulence::Kosovic< Transport >::m_Nij

private

◆ m_rho

template<typename Transport>

const Field& amr_wind::turbulence::Kosovic< Transport >::m_rho

private

◆ m_Sk

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_Sk {0.5}

private

◆ m_surface_roughness_z0

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_surface_roughness_z0 {0.1}

private

◆ m_surfaceFactor

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_surfaceFactor {0}

private

◆ m_surfaceRANS

template<typename Transport>

bool amr_wind::turbulence::Kosovic< Transport >::m_surfaceRANS {false}

private

◆ m_surfaceRANSExp

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_surfaceRANSExp {2}

private

◆ m_switchLoc

template<typename Transport>

amrex::Real amr_wind::turbulence::Kosovic< Transport >::m_switchLoc {24}

private

◆ m_vel

template<typename Transport>

const Field& amr_wind::turbulence::Kosovic< Transport >::m_vel

private

◆ m_wall_het_model

template<typename Transport>

std::string amr_wind::turbulence::Kosovic< Transport >::m_wall_het_model {"none"}

private

◆ m_writeTerms

template<typename Transport>

bool amr_wind::turbulence::Kosovic< Transport >::m_writeTerms {false}

private

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

/home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/LES/Kosovic.H
/home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/LES/Kosovic.cpp

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Kosovic()

Member Function Documentation

◆ identifier()

◆ model_coeffs()

◆ model_name()

◆ parse_model_coeffs()

◆ post_advance_work()

◆ update_alphaeff()

◆ update_turbulent_viscosity()

Member Data Documentation

◆ m_beta_m

◆ m_C1

◆ m_C2

◆ m_Cb

◆ m_Cs

◆ m_divNij

◆ m_gamma_m

◆ m_kappa

◆ m_LESTurnOff

◆ m_monin_obukhov_length

◆ m_Nij

◆ m_rho

◆ m_Sk

◆ m_surface_roughness_z0

◆ m_surfaceFactor

◆ m_surfaceRANS

◆ m_surfaceRANSExp

◆ m_switchLoc

◆ m_vel

◆ m_wall_het_model

◆ m_writeTerms

Kosovic< Transport > Class Template Reference