QAPTurbulence Class Reference

General class for turbulent quantities. More...

#include <QAPTurbulence.h>

Inherits QuantitiesAddPhys.

Collaboration diagram for QAPTurbulence:

Public Member Functions
	QAPTurbulence (AddPhys *addPhys)
	~QAPTurbulence () override
void	computeQuantities (Cell *cell) override
	Compute the needed quantities for the additional physic.
void	setGrad (const Coord &grad, const int &num=-1) override
	Set the additional-physic gradient with the transmitted values.
const Coord &	getGrad (const int &num=-1) const override
	Get the additional-physic gradient.
void	setTurbulentViscosity (const double &turbulentViscosity) override
	Set the turbulent viscosity in the cell.
double	getTurbulentViscosity () const override
	Return the turbulent viscosity.
Public Member Functions inherited from QuantitiesAddPhys
	QuantitiesAddPhys (AddPhys *addPhys)
	Generic model constructor.
virtual	~QuantitiesAddPhys ()
double	computeEnergyAddPhys ()
	Compute and send back mass energy linked to the physic (0 if no linked energy).
virtual void	setGradU (const Coord &)
	Set the gradient of the velocity along the x-direction with the transmitted values.
virtual void	setGradV (const Coord &)
	Set the gradient of the velocity along the y-direction with the transmitted values.
virtual void	setGradW (const Coord &)
	Set the gradient of the velocity along the z-direction with the transmitted values.
virtual void	setGradTk (const int &, const Coord &)
	Set the gradient of the phase temperature with the transmitted values.
virtual Coord	getGradU () const
	Return the gradient of the velocity along the x-direction.
virtual Coord	getGradV () const
	Return the gradient of the velocity along the y-direction.
virtual Coord	getGradW () const
	Return the gradient of the velocity along the z-direction.
virtual const Coord &	getGradTk (const int &) const
	Return the gradient of the phase temperature.
AddPhys *	getAddPhys ()
	Return the corresponding additional-physic class of this quantities class.

Protected Attributes
std::vector< Coord >	m_grads
	Vector of the velocity gradients of the cell in x-, y- and z-directions (ex: m_grads[0] = (du/dx, du/dy, du/dz)).
double	m_turbulentViscosity
	Turbulent viscosity.
Protected Attributes inherited from QuantitiesAddPhys
AddPhys *	m_addPhys
	Corresponding additional-physic class of this quantities class.

Detailed Description

General class for turbulent quantities.

Constructor & Destructor Documentation

QAPTurbulence()

QAPTurbulence::QAPTurbulence

(

AddPhys *

addPhys

)

Here is the call graph for this function:

~QAPTurbulence()

QAPTurbulence::~QAPTurbulence ( )

override

Member Function Documentation

computeQuantities()

void QAPTurbulence::computeQuantities ( Cell * )

overridevirtual

Compute the needed quantities for the additional physic.

Parameters

cell	corresponding cell

Reimplemented from QuantitiesAddPhys.

Here is the call graph for this function:

getGrad()

const Coord & QAPTurbulence::getGrad ( const int & = -1 ) const

inlineoverridevirtual

Get the additional-physic gradient.

Parameters

num	number to determine the corresponding gradient

Reimplemented from QuantitiesAddPhys.

getTurbulentViscosity()

double QAPTurbulence::getTurbulentViscosity ( ) const

overridevirtual

Return the turbulent viscosity.

Reimplemented from QuantitiesAddPhys.

setGrad()

void QAPTurbulence::setGrad ( const Coord & , const int & = -1 )

overridevirtual

Set the additional-physic gradient with the transmitted values.

Parameters

grad	transmitted gradient
num	number to determine the corresponding gradient

Reimplemented from QuantitiesAddPhys.

setTurbulentViscosity()

void QAPTurbulence::setTurbulentViscosity ( const double & turbulentViscosity )

overridevirtual

Set the turbulent viscosity in the cell.

Reimplemented from QuantitiesAddPhys.

Member Data Documentation

m_grads

std::vector<Coord> QAPTurbulence::m_grads

protected

Vector of the velocity gradients of the cell in x-, y- and z-directions (ex: m_grads[0] = (du/dx, du/dy, du/dz)).

m_turbulentViscosity

double QAPTurbulence::m_turbulentViscosity

protected

Turbulent viscosity.

---

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

• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/AdditionalPhysics/Turbulence/QAPTurbulence.h
• /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/AdditionalPhysics/Turbulence/QAPTurbulence.cpp