Base class for defining the LES subgrid scale model. More...

#include <sgs_model.hpp>

Inheritance diagram for CSGSModel:

Public Member Functions
	CSGSModel (void)
	Constructor of the class.

virtual	~CSGSModel (void)
	Destructor of the class.

virtual su2double	ComputeEddyViscosity_2D (const su2double rho, const su2double dudx, const su2double dudy, const su2double dvdx, const su2double dvdy, const su2double lenScale, const su2double distToWall)
	Virtual function to determine the eddy viscosity for the given function arguments for a 2D simulation.

virtual su2double	ComputeEddyViscosity_3D (const su2double rho, const su2double dudx, const su2double dudy, const su2double dudz, const su2double dvdx, const su2double dvdy, const su2double dvdz, const su2double dwdx, const su2double dwdy, const su2double dwdz, const su2double lenScale, const su2double distToWall)
	Virtual function to determine the eddy viscosity for the given function arguments for a 3D simulation.

virtual void	ComputeGradEddyViscosity_2D (const su2double rho, const su2double drhodx, const su2double drhody, const su2double dudx, const su2double dudy, const su2double dvdx, const su2double dvdy, const su2double d2udx2, const su2double d2udy2, const su2double d2udxdy, const su2double d2vdx2, const su2double d2vdy2, const su2double d2vdxdy, const su2double lenScale, const su2double distToWall, su2double &dMuTdx, su2double &dMuTdy)
	Virtual function to determine the gradients of the eddy viscosity for the given function arguments for a 2D simulation.

virtual void	ComputeGradEddyViscosity_3D (const su2double rho, const su2double drhodx, const su2double drhody, const su2double drhodz, const su2double dudx, const su2double dudy, const su2double dudz, const su2double dvdx, const su2double dvdy, const su2double dvdz, const su2double dwdx, const su2double dwdy, const su2double dwdz, const su2double d2udx2, const su2double d2udy2, const su2double d2udz2, const su2double d2udxdy, const su2double d2udxdz, const su2double d2udydz, const su2double d2vdx2, const su2double d2vdy2, const su2double d2vdz2, const su2double d2vdxdy, const su2double d2vdxdz, const su2double d2vdydz, const su2double d2wdx2, const su2double d2wdy2, const su2double d2wdz2, const su2double d2wdxdy, const su2double d2wdxdz, const su2double d2wdydz, const su2double lenScale, const su2double distToWall, su2double &dMuTdx, su2double &dMuTdy, su2double &dMuTdz)
	Virtual function to determine the gradients of the eddy viscosity for the given function arguments for a 3D simulation.

Detailed Description

Base class for defining the LES subgrid scale model.

Author: : E. van der Weide, T. Economon, P. Urbanczyk

Version: 8.5.0 "Harrier"

Constructor & Destructor Documentation

◆ CSGSModel()

CSGSModel::CSGSModel ( void )

inline

Constructor of the class.

◆ ~CSGSModel()

CSGSModel::~CSGSModel ( void )

inlinevirtual

Destructor of the class.

Member Function Documentation

◆ ComputeEddyViscosity_2D()

su2double CSGSModel::ComputeEddyViscosity_2D	(	const su2double	rho,
		const su2double	dudx,
		const su2double	dudy,
		const su2double	dvdx,
		const su2double	dvdy,
		const su2double	lenScale,
		const su2double	distToWall
	)

inlinevirtual

Virtual function to determine the eddy viscosity for the given function arguments for a 2D simulation.

Parameters

[in]	rho	- Density
[in]	dudx	- x-derivative of the u-velocity.
[in]	dudy	- y-derivative of the u-velocity.
[in]	dvdx	- x-derivative of the v-velocity.
[in]	dvdy	- y-derivative of the v-velocity.
[in]	lenScale	- Length scale of the corresponding element.
[in]	distToWall	- Distance to the nearest wall.

Returns: Value of the dynamic eddy viscosity. For the base class 0 is returned.

Reimplemented in CSmagorinskyModel, CWALEModel, and CVremanModel.

◆ ComputeEddyViscosity_3D()

su2double CSGSModel::ComputeEddyViscosity_3D	(	const su2double	rho,
		const su2double	dudx,
		const su2double	dudy,
		const su2double	dudz,
		const su2double	dvdx,
		const su2double	dvdy,
		const su2double	dvdz,
		const su2double	dwdx,
		const su2double	dwdy,
		const su2double	dwdz,
		const su2double	lenScale,
		const su2double	distToWall
	)

inlinevirtual

Virtual function to determine the eddy viscosity for the given function arguments for a 3D simulation.

Parameters

[in]	rho	- Density
[in]	dudx	- x-derivative of the u-velocity.
[in]	dudy	- y-derivative of the u-velocity.
[in]	dudz	- z-derivative of the u-velocity.
[in]	dvdx	- x-derivative of the v-velocity.
[in]	dvdy	- y-derivative of the v-velocity.
[in]	dvdz	- z-derivative of the v-velocity.
[in]	dwdx	- x-derivative of the w-velocity.
[in]	dwdy	- y-derivative of the w-velocity.
[in]	dwdz	- z-derivative of the w-velocity.
[in]	lenScale	- Length scale of the corresponding element.
[in]	distToWall	- Distance to the nearest wall.

Returns: Value of the dynamic eddy viscosity. For the base class 0 is returned.

Reimplemented in CSmagorinskyModel, CWALEModel, and CVremanModel.

◆ ComputeGradEddyViscosity_2D()

void CSGSModel::ComputeGradEddyViscosity_2D	(	const su2double	rho,
		const su2double	drhodx,
		const su2double	drhody,
		const su2double	dudx,
		const su2double	dudy,
		const su2double	dvdx,
		const su2double	dvdy,
		const su2double	d2udx2,
		const su2double	d2udy2,
		const su2double	d2udxdy,
		const su2double	d2vdx2,
		const su2double	d2vdy2,
		const su2double	d2vdxdy,
		const su2double	lenScale,
		const su2double	distToWall,
		su2double &	dMuTdx,
		su2double &	dMuTdy
	)

inlinevirtual

Virtual function to determine the gradients of the eddy viscosity for the given function arguments for a 2D simulation.

Parameters

[in]	rho	- Density.
[in]	drhodx	- x-derivative of the density.
[in]	drhody	- y-derivative of the density.
[in]	dudx	- x-derivative of the u-velocity.
[in]	dudy	- y-derivative of the u-velocity.
[in]	dvdx	- x-derivative of the v-velocity.
[in]	dvdy	- y-derivative of the v-velocity.
[in]	d2udx2	- 2nd x-derivative of the u-velocity.
[in]	d2udy2	- 2nd y-derivative of the u-velocity.
[in]	d2udxdy	- x-y cross-derivative of the u-velocity.
[in]	d2vdx2	- 2nd x-derivative of the v-velocity.
[in]	d2vdy2	- 2nd y-derivative of the v-velocity.
[in]	d2vdxdy	- x-y cross-derivative of the v-velocity.
[in]	lenScale	- Length scale of the corresponding element.
[in]	distToWall	- Distance to the nearest wall.
[out]	dMuTdx	- x-derivative of the turbulent viscosity.
[out]	dMuTdy	- y-derivative of the turbulent viscosity.

Reimplemented in CSmagorinskyModel, CWALEModel, and CVremanModel.

◆ ComputeGradEddyViscosity_3D()

void CSGSModel::ComputeGradEddyViscosity_3D	(	const su2double	rho,
		const su2double	drhodx,
		const su2double	drhody,
		const su2double	drhodz,
		const su2double	dudx,
		const su2double	dudy,
		const su2double	dudz,
		const su2double	dvdx,
		const su2double	dvdy,
		const su2double	dvdz,
		const su2double	dwdx,
		const su2double	dwdy,
		const su2double	dwdz,
		const su2double	d2udx2,
		const su2double	d2udy2,
		const su2double	d2udz2,
		const su2double	d2udxdy,
		const su2double	d2udxdz,
		const su2double	d2udydz,
		const su2double	d2vdx2,
		const su2double	d2vdy2,
		const su2double	d2vdz2,
		const su2double	d2vdxdy,
		const su2double	d2vdxdz,
		const su2double	d2vdydz,
		const su2double	d2wdx2,
		const su2double	d2wdy2,
		const su2double	d2wdz2,
		const su2double	d2wdxdy,
		const su2double	d2wdxdz,
		const su2double	d2wdydz,
		const su2double	lenScale,
		const su2double	distToWall,
		su2double &	dMuTdx,
		su2double &	dMuTdy,
		su2double &	dMuTdz
	)

inlinevirtual

Virtual function to determine the gradients of the eddy viscosity for the given function arguments for a 3D simulation.

Parameters

[in]	rho	- Density.
[in]	drhodx	- x-derivative of the density.
[in]	drhody	- y-derivative of the density.
[in]	drhodz	- z-derivative of the density.
[in]	dudx	- x-derivative of the u-velocity.
[in]	dudy	- y-derivative of the u-velocity.
[in]	dudz	- z-derivative of the u-velocity.
[in]	dvdx	- x-derivative of the v-velocity.
[in]	dvdy	- y-derivative of the v-velocity.
[in]	dvdz	- z-derivative of the v-velocity.
[in]	dwdx	- x-derivative of the w-velocity.
[in]	dwdy	- y-derivative of the w-velocity.
[in]	dwdz	- z-derivative of the w-velocity.
[in]	d2udx2	- 2nd x-derivative of the u-velocity.
[in]	d2udy2	- 2nd y-derivative of the u-velocity.
[in]	d2udz2	- 2nd z-derivative of the u-velocity.
[in]	d2udxdy	- x-y cross-derivative of the u-velocity.
[in]	d2udxdz	- x-z cross-derivative of the u-velocity.
[in]	d2udydz	- y-z cross-derivative of the u-velocity.
[in]	d2vdx2	- 2nd x-derivative of the v-velocity.
[in]	d2vdy2	- 2nd y-derivative of the v-velocity.
[in]	d2vdz2	- 2nd z-derivative of the v-velocity.
[in]	d2vdxdy	- x-y cross-derivative of the v-velocity.
[in]	d2vdxdz	- x-z cross-derivative of the v-velocity.
[in]	d2vdydz	- y-z cross-derivative of the v-velocity.
[in]	d2wdx2	- 2nd x-derivative of the w-velocity.
[in]	d2wdy2	- 2nd y-derivative of the w-velocity.
[in]	d2wdz2	- 2nd z-derivative of the w-velocity.
[in]	d2wdxdy	- x-y cross-derivative of the w-velocity.
[in]	d2wdxdz	- x-z cross-derivative of the w-velocity.
[in]	d2wdydz	- y-z cross-derivative of the w-velocity.
[in]	lenScale	- Length scale of the corresponding element.
[in]	distToWall	- Distance to the nearest wall.
[out]	dMuTdx	- x-derivative of the turbulent viscosity.
[out]	dMuTdy	- y-derivative of the turbulent viscosity.
[out]	dMuTdz	- z-derivative of the turbulent viscosity.

Reimplemented in CSmagorinskyModel, CWALEModel, and CVremanModel.

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

SU2_CFD/include/sgs_model.hpp
SU2_CFD/include/sgs_model.inl

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CSGSModel()

◆ ~CSGSModel()

Member Function Documentation

◆ ComputeEddyViscosity_2D()

◆ ComputeEddyViscosity_3D()

◆ ComputeGradEddyViscosity_2D()

◆ ComputeGradEddyViscosity_3D()