QuantitiesAddPhys Class Reference

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

#include <QuantitiesAddPhys.h>

Inherited by QAPConductivity, QAPSurfaceTension, and QAPViscosity.

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.

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

~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, and QAPViscosity.

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 QAPSurfaceTension, QAPConductivity, and QAPViscosity.

getGradTk()

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

inlinevirtual

Return the gradient of the phase temperature.

Parameters

phaseNum

number of the corresponding phase

getGradU()

virtual Coord QuantitiesAddPhys::getGradU ( ) const

inlinevirtual

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

getGradV()

virtual Coord QuantitiesAddPhys::getGradV ( ) const

inlinevirtual

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

getGradW()

virtual Coord QuantitiesAddPhys::getGradW ( ) const

inlinevirtual

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

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 QAPSurfaceTension, QAPConductivity, and QAPViscosity.

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

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

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

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

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:

• /Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/AdditionalPhysics/QuantitiesAddPhys.h
• /Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/AdditionalPhysics/QuantitiesAddPhys.cpp