OneEqKsgsM84< Transport > Class Template Reference

AMR-Wind API: amr_wind::turbulence::OneEqKsgsM84< Transport > Class Template Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
amr_wind::turbulence::OneEqKsgsM84< Transport > Class Template Reference
Turbulence models | Physics models » Wind energy modeling » ABL

#include <OneEqKsgs.H>

Inheritance diagram for amr_wind::turbulence::OneEqKsgsM84< Transport >:
[legend]
Collaboration diagram for amr_wind::turbulence::OneEqKsgsM84< Transport >:
[legend]

Public Member Functions

 OneEqKsgsM84 (CFDSim &sim)
 ~OneEqKsgsM84 () override
std::string model_name () const override
 String representation of this turbulence model for I/O.
void update_turbulent_viscosity (const FieldState fstate, const DiffusionType) override
 Update the turbulent viscosity field.
void post_advance_work () override
 Do any post advance work.
void update_alphaeff (Field &alphaeff) override
 Update the effective thermal diffusivity field.
void update_scalar_diff (Field &deff, const std::string &name) override
 Update the effective scalar diffusivity field.
void parse_model_coeffs () override
 Parse turbulence model coefficients.
TurbulenceModel::CoeffsDictType model_coeffs () const override
 Return turbulence model coefficients.
Public Member Functions inherited from amr_wind::turbulence::OneEqKsgs< Transport >
 OneEqKsgs (CFDSim &sim)
 ~OneEqKsgs () override
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

Field & m_temperature
amrex::Vector< amrex::Real > m_gravity {0.0, 0.0, -9.81}
 Gravity vector (m/s^2)
bool m_hybrid_rl {false}
 Hybrid RANS-LES with Nalu-wind.
Field * m_sdr

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::OneEqKsgs< Transport >
Field & m_vel
Field & m_turb_lscale
Field & m_shear_prod
Field & m_buoy_prod
Field & m_dissip
Field & m_rho
Field * m_tke {nullptr}
amrex::Real m_Ce {0.1}
 Turbulence constant.
amrex::Real m_Ceps {0.93}
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::OneEqKsgsM84< Transport >

1-equation subgrid scale TKE turbulence model

Implements the model described in Moeng 1984 paper

See also
amr_wind::pde::tke::KsgsM84Src

Constructor & Destructor Documentation

◆ OneEqKsgsM84()

template<typename Transport>
amr_wind::turbulence::OneEqKsgsM84< Transport >::OneEqKsgsM84 ( CFDSim & sim)
explicit

◆ ~OneEqKsgsM84()

template<typename Transport>
amr_wind::turbulence::OneEqKsgsM84< Transport >::~OneEqKsgsM84 ( )
overridedefault

Member Function Documentation

◆ identifier()

template<typename Transport>
std::string amr_wind::turbulence::OneEqKsgsM84< Transport >::identifier ( )
inlinestatic

◆ model_coeffs()

template<typename Transport>
TurbulenceModel::CoeffsDictType amr_wind::turbulence::OneEqKsgsM84< Transport >::model_coeffs ( ) const
overridevirtual

Return turbulence model coefficients.

Implements amr_wind::turbulence::TurbulenceModel.

◆ model_name()

template<typename Transport>
std::string amr_wind::turbulence::OneEqKsgsM84< Transport >::model_name ( ) const
inlineoverridevirtual

String representation of this turbulence model for I/O.

Implements amr_wind::turbulence::TurbulenceModel.

◆ parse_model_coeffs()

template<typename Transport>
void amr_wind::turbulence::OneEqKsgsM84< Transport >::parse_model_coeffs ( )
overridevirtual

Parse turbulence model coefficients.

Implements amr_wind::turbulence::TurbulenceModel.

◆ post_advance_work()

template<typename Transport>
void amr_wind::turbulence::OneEqKsgsM84< Transport >::post_advance_work ( )
overridevirtual

Do any post advance work.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_alphaeff()

template<typename Transport>
void amr_wind::turbulence::OneEqKsgsM84< Transport >::update_alphaeff ( Field & alphaeff)
overridevirtual

Update the effective thermal diffusivity field.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_scalar_diff()

template<typename Transport>
void amr_wind::turbulence::OneEqKsgsM84< Transport >::update_scalar_diff ( Field & deff,
const std::string & name )
overridevirtual

Update the effective scalar diffusivity field.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_turbulent_viscosity()

template<typename Transport>
void amr_wind::turbulence::OneEqKsgsM84< Transport >::update_turbulent_viscosity ( const FieldState fstate,
const DiffusionType  )
overridevirtual

Update the turbulent viscosity field.

Implements amr_wind::turbulence::TurbulenceModel.

Member Data Documentation

◆ m_gravity

template<typename Transport>
amrex::Vector<amrex::Real> amr_wind::turbulence::OneEqKsgsM84< Transport >::m_gravity {0.0, 0.0, -9.81}
private

Gravity vector (m/s^2)

◆ m_hybrid_rl

template<typename Transport>
bool amr_wind::turbulence::OneEqKsgsM84< Transport >::m_hybrid_rl {false}
private

Hybrid RANS-LES with Nalu-wind.

◆ m_sdr

template<typename Transport>
Field* amr_wind::turbulence::OneEqKsgsM84< Transport >::m_sdr
private

◆ m_temperature

template<typename Transport>
Field& amr_wind::turbulence::OneEqKsgsM84< Transport >::m_temperature
private
The documentation for this class was generated from the following files:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/LES/OneEqKsgs.H
  • /home/runner/work/amr-wind/amr-wind/amr-wind/turbulence/LES/OneEqKsgs.cpp
Generated by doxygen 1.14.0