Canoe
Comprehensive Atmosphere N' Ocean Engine
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TurbulenceModel Class Reference

#include <turbulence_model.hpp>

Inheritance diagram for TurbulenceModel:
[legend]

Public Member Functions

 TurbulenceModel (MeshBlock *pmb, ParameterInput *pin)
 
virtual ~TurbulenceModel ()
 
virtual void DriveTurbulence (Real dt)
 
virtual void Initialize ()
 
virtual void SetDiffusivity (AthenaArray< Real > &nu, AthenaArray< Real > &kappa, const AthenaArray< Real > &w, const AthenaArray< Real > &bc, int il, int iu, int jl, int ju, int kl, int ku)
 

Public Attributes

AthenaArray< Real > w
 
AthenaArray< Real > u
 
AthenaArray< Real > mut
 

Protected Attributes

MeshBlock * pmy_block
 

Detailed Description

Definition at line 18 of file turbulence_model.hpp.

Constructor & Destructor Documentation

◆ TurbulenceModel()

TurbulenceModel::TurbulenceModel ( MeshBlock *  pmb,
ParameterInput *  pin 
)

Definition at line 23 of file turbulence_model.cpp.

◆ ~TurbulenceModel()

TurbulenceModel::~TurbulenceModel ( )
virtual

Definition at line 39 of file turbulence_model.cpp.

Member Function Documentation

◆ DriveTurbulence()

virtual void TurbulenceModel::DriveTurbulence ( Real  dt)
inlinevirtual

Reimplemented in KEpsilonTurbulence.

Definition at line 30 of file turbulence_model.hpp.

◆ Initialize()

virtual void TurbulenceModel::Initialize ( )
inlinevirtual

Reimplemented in KEpsilonTurbulence.

Definition at line 31 of file turbulence_model.hpp.

◆ SetDiffusivity()

virtual void TurbulenceModel::SetDiffusivity ( AthenaArray< Real > &  nu,
AthenaArray< Real > &  kappa,
const AthenaArray< Real > &  w,
const AthenaArray< Real > &  bc,
int  il,
int  iu,
int  jl,
int  ju,
int  kl,
int  ku 
)
inlinevirtual

Reimplemented in KEpsilonTurbulence.

Definition at line 32 of file turbulence_model.hpp.

Member Data Documentation

◆ w

AthenaArray<Real> TurbulenceModel::w

Definition at line 24 of file turbulence_model.hpp.

◆ u

AthenaArray<Real> TurbulenceModel::u

Definition at line 24 of file turbulence_model.hpp.

◆ mut

AthenaArray<Real> TurbulenceModel::mut

Definition at line 27 of file turbulence_model.hpp.

◆ pmy_block

MeshBlock* TurbulenceModel::pmy_block
protected

Definition at line 38 of file turbulence_model.hpp.

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