QuantitiesAddPhys Class Reference

General class for additional-physics quantities. More...

#include <QuantitiesAddPhys.h>

Inherited by QAPConductivity, QAPSurfaceTension, QAPTurbulence, and QAPViscosity.

Collaboration diagram for QuantitiesAddPhys:

Public Member Functions
	QuantitiesAddPhys (AddPhys *addPhys)
	Generic model constructor.
virtual	~QuantitiesAddPhys ()
virtual void	computeQuantities (Cell *)
	Compute the needed quantities for the additional physic.
double	computeEnergyAddPhys ()
	Compute and send back mass energy linked to the physic (0 if no linked energy).
virtual void	setGrad (const Coord &, const int &=-1)
	Set the additional-physic gradient with the transmitted values.
virtual const Coord &	getGrad (const int &=-1) const
	Get the additional-physic gradient.
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.
virtual double	getTurbulentViscosity () const
	Return the turbulent viscosity.
virtual void	setTurbulentViscosity (const double &)
	Set the turbulent viscosity in the cell.

Protected Attributes
AddPhys *	m_addPhys
	Corresponding additional-physic class of this quantities class.

Detailed Description

General class for additional-physics quantities.

This is a pure virtual class: can not be instantiated

Constructor & Destructor Documentation

QuantitiesAddPhys()

QuantitiesAddPhys::QuantitiesAddPhys

(

AddPhys *

addPhys

)

Generic model constructor.

Parameters

addPhys

corresponding additional physic

Here is the caller graph for this function:

~QuantitiesAddPhys()

QuantitiesAddPhys::~QuantitiesAddPhys ( )

virtual

Member Function Documentation

computeEnergyAddPhys()

double QuantitiesAddPhys::computeEnergyAddPhys

(

)

Compute and send back mass energy linked to the physic (0 if no linked energy).

computeQuantities()

virtual void QuantitiesAddPhys::computeQuantities ( Cell * )

inlinevirtual

Compute the needed quantities for the additional physic.

Parameters

cell	corresponding cell

Reimplemented in QAPConductivity, QAPSurfaceTension, QAPTurbulence, and QAPViscosity.

Here is the call graph for this function:

getAddPhys()

AddPhys * QuantitiesAddPhys::getAddPhys ( )

inline

Return the corresponding additional-physic class of this quantities class.

getGrad()

virtual const Coord & QuantitiesAddPhys::getGrad ( const int & = -1 ) const

inlinevirtual

Get the additional-physic gradient.

Parameters

num	number to determine the corresponding gradient

Reimplemented in QAPConductivity, QAPSurfaceTension, QAPTurbulence, and QAPViscosity.

Here is the call graph for this function:

Here is the caller graph for this function:

getGradTk()

virtual const Coord & QuantitiesAddPhys::getGradTk ( const int & ) const

inlinevirtual

Return the gradient of the phase temperature.

Parameters

phaseNum

number of the corresponding phase

Here is the call graph for this function:

getGradU()

virtual Coord QuantitiesAddPhys::getGradU ( ) const

inlinevirtual

Return the gradient of the velocity along the x-direction.

Here is the call graph for this function:

getGradV()

virtual Coord QuantitiesAddPhys::getGradV ( ) const

inlinevirtual

Return the gradient of the velocity along the y-direction.

Here is the call graph for this function:

getGradW()

virtual Coord QuantitiesAddPhys::getGradW ( ) const

inlinevirtual

Return the gradient of the velocity along the z-direction.

Here is the call graph for this function:

getTurbulentViscosity()

virtual double QuantitiesAddPhys::getTurbulentViscosity ( ) const

inlinevirtual

Return the turbulent viscosity.

Reimplemented in QAPTurbulence.

Here is the call graph for this function:

Here is the caller graph for this function:

setGrad()

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

inlinevirtual

Set the additional-physic gradient with the transmitted values.

Parameters

grad	transmitted gradient
num	number to determine the corresponding gradient

Reimplemented in QAPConductivity, QAPSurfaceTension, QAPTurbulence, and QAPViscosity.

Here is the call graph for this function:

setGradTk()

virtual void QuantitiesAddPhys::setGradTk ( const int & , const Coord &  )

inlinevirtual

Set the gradient of the phase temperature with the transmitted values.

Parameters

phaseNum	number of the corresponding phase
grad	transmitted gradient

Here is the call graph for this function:

setGradU()

virtual void QuantitiesAddPhys::setGradU ( const Coord & )

inlinevirtual

Set the gradient of the velocity along the x-direction with the transmitted values.

Parameters

grad	transmitted gradient

Here is the call graph for this function:

setGradV()

virtual void QuantitiesAddPhys::setGradV ( const Coord & )

inlinevirtual

Set the gradient of the velocity along the y-direction with the transmitted values.

Parameters

grad	transmitted gradient

Here is the call graph for this function:

setGradW()

virtual void QuantitiesAddPhys::setGradW ( const Coord & )

inlinevirtual

Set the gradient of the velocity along the z-direction with the transmitted values.

Parameters

grad	transmitted gradient

Here is the call graph for this function:

setTurbulentViscosity()

virtual void QuantitiesAddPhys::setTurbulentViscosity ( const double & )

inlinevirtual

Set the turbulent viscosity in the cell.

Reimplemented in QAPTurbulence.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_addPhys

AddPhys* QuantitiesAddPhys::m_addPhys

protected

Corresponding additional-physic class of this quantities class.

---

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

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