AMDNoTherm< Transport > Class Template Reference

AMR-Wind API: amr_wind::turbulence::AMDNoTherm< 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::AMDNoTherm< Transport > Class Template Reference
Turbulence models

#include <AMDNoTherm.H>

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

Public Member Functions

 AMDNoTherm (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.
 
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.
 
- 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_C {0.333333333333333}
 
const Field & m_vel
 
const Field & m_rho
 

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

AMD LES Model

Constructor & Destructor Documentation

◆ AMDNoTherm()

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

Member Function Documentation

◆ identifier()

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

◆ model_coeffs()

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

Return model coefficients dictionary.

Implements amr_wind::turbulence::TurbulenceModel.

◆ model_name()

template<typename Transport >
std::string amr_wind::turbulence::AMDNoTherm< 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::AMDNoTherm< Transport >::parse_model_coeffs ( )
overridevirtual

Parse turbulence model coefficients for this model.

Implements amr_wind::turbulence::TurbulenceModel.

◆ post_advance_work()

template<typename Transport >
void amr_wind::turbulence::AMDNoTherm< Transport >::post_advance_work ( )
inlineoverridevirtual

No post advance work for this model.

Implements amr_wind::turbulence::TurbulenceModel.

◆ update_turbulent_viscosity()

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

Update the turbulent viscosity field.

Implements amr_wind::turbulence::TurbulenceModel.

Member Data Documentation

◆ m_C

template<typename Transport >
amrex::Real amr_wind::turbulence::AMDNoTherm< Transport >::m_C {0.333333333333333}
private

Poincare coefficient (default value set for 2nd order AMR-wind discretization)

◆ m_rho

template<typename Transport >
const Field& amr_wind::turbulence::AMDNoTherm< Transport >::m_rho
private

◆ m_vel

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