General class for additional physics. More...

#include <AddPhys.h>

Inherited by APEuler, and APUEq.

Public Member Functions
	AddPhys ()

virtual	~AddPhys ()

virtual void	addQuantityAddPhys (Cell *)
	Add the quantities for the additional physic.

virtual std::string	whoAmI () const

virtual double	computeEnergyAddPhys (QuantitiesAddPhys *)
	Compute and send back mass energy linked to the physic (0 if no linked energy)

void	computeFluxAddPhys (CellInterface *cellInterface)
	Compute the additional physic flux between two cells.

void	computeFluxAddPhysBoundary (CellInterface *cellInterface)
	Compute the additional physic flux at a domain boundary.

void	addNonConsAddPhys (Cell *cell)
	Add the non-conservative terms of the additional physic in a cell.

virtual void	solveFluxAddPhys (CellInterface *)
	Solve the additional physic flux between two cells.

virtual void	solveFluxAddPhysBoundary (CellInterface *)
	Solve the additional physic flux at a domain boundary.

virtual void	addFluxAddPhys (CellInterface *cellInterface, const double &coefAMR)
	Add the additional physic flux between two cells at the corresponding cell.

virtual void	subtractFluxAddPhys (CellInterface *cellInterface, const double &coefAMR)
	Subtract the additional physic flux between two cells at the corresponding cell.

virtual void	addNonCons (Cell *)
	Add the non-conservative terms of the corresponding additional physic in a cell.

virtual void	addSymmetricTermsRadialAxisOnX (Cell *)
	Add the symmetrical terms of the corresponding additional physic in a cell (when radial axis is on X)

virtual void	addSymmetricTermsRadialAxisOnY (Cell *)
	Add the symmetrical terms of the corresponding additional physic in a cell (when radial axis is on Y)

virtual void	reinitializeColorFunction (std::vector< Cell * > *, const int &)
	Reinitialize the color function for the surface-tension terms with the volume fraction equation.

virtual bool	reinitializationActivated ()
	Send back true if the reinitialization of the color function is activated.

virtual void	communicationsAddPhys (const int &, const int &)
	Communication of the additional physics quantities for parallel purposes with Adaptive Mesh Refinement.

virtual const int &	getNumTransportAssociated () const
	Return the associated number of the transport equation (only used for surface tension)

Detailed Description

General class for additional physics.

This is a pure virtual class: can not be instantiated

Constructor & Destructor Documentation

◆ AddPhys()

AddPhys::AddPhys ( )

◆ ~AddPhys()

AddPhys::~AddPhys ( )

virtual

Member Function Documentation

◆ addFluxAddPhys()

void AddPhys::addFluxAddPhys	(	CellInterface *	cellInterface,
		const double &	coefAMR
	)

virtual

Add the additional physic flux between two cells at the corresponding cell.

Parameters

cellInterface	cell interface
coefAMR	Adaptive Mesh Refinement coefficient for numerical scheme purposes

◆ addNonCons()

virtual void AddPhys::addNonCons ( Cell * )

inlinevirtual

Add the non-conservative terms of the corresponding additional physic in a cell.

Parameters

cell cell

Reimplemented in APEConductivity, APUEqConductivity, APUEqSurfaceTension, APEViscosity, and APUEqViscosity.

◆ addNonConsAddPhys()

void AddPhys::addNonConsAddPhys ( Cell * cell )

Add the non-conservative terms of the additional physic in a cell.

Parameters

cell cell

◆ addQuantityAddPhys()

virtual void AddPhys::addQuantityAddPhys ( Cell * )

inlinevirtual

Add the quantities for the additional physic.

Parameters

cell	corresponding cell

Reimplemented in APEConductivity, APUEqConductivity, APUEqSurfaceTension, APEViscosity, and APUEqViscosity.

◆ addSymmetricTermsRadialAxisOnX()

virtual void AddPhys::addSymmetricTermsRadialAxisOnX ( Cell * )

inlinevirtual

Add the symmetrical terms of the corresponding additional physic in a cell (when radial axis is on X)

Parameters

cell cell

Reimplemented in APEViscosity, APUEqSurfaceTension, and APUEqViscosity.

◆ addSymmetricTermsRadialAxisOnY()

virtual void AddPhys::addSymmetricTermsRadialAxisOnY ( Cell * )

inlinevirtual

Add the symmetrical terms of the corresponding additional physic in a cell (when radial axis is on Y)

Parameters

cell cell

Reimplemented in APEViscosity, APUEqSurfaceTension, and APUEqViscosity.

◆ communicationsAddPhys()

virtual void AddPhys::communicationsAddPhys	(	const int &	,
		const int &
	)

inlinevirtual

Communication of the additional physics quantities for parallel purposes with Adaptive Mesh Refinement.

Parameters

dim	dimension
lvl	level

Reimplemented in APEConductivity, APUEqConductivity, APUEqSurfaceTension, APEViscosity, and APUEqViscosity.

◆ computeEnergyAddPhys()

virtual double AddPhys::computeEnergyAddPhys ( QuantitiesAddPhys * )

inlinevirtual

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

Parameters

QPA	corresponding additional physic quantities

Reimplemented in APUEqSurfaceTension.

◆ computeFluxAddPhys()

void AddPhys::computeFluxAddPhys ( CellInterface * cellInterface )

Compute the additional physic flux between two cells.

Parameters

cellInterface cell interface

◆ computeFluxAddPhysBoundary()

void AddPhys::computeFluxAddPhysBoundary ( CellInterface * cellInterface )

Compute the additional physic flux at a domain boundary.

Parameters

cellInterface cell interface

◆ getNumTransportAssociated()

virtual const int & AddPhys::getNumTransportAssociated ( ) const

inlinevirtual

Return the associated number of the transport equation (only used for surface tension)

Reimplemented in APUEqSurfaceTension.

◆ reinitializationActivated()

virtual bool AddPhys::reinitializationActivated ( )

inlinevirtual

Send back true if the reinitialization of the color function is activated.

Reimplemented in APUEqSurfaceTension.

◆ reinitializeColorFunction()

virtual void AddPhys::reinitializeColorFunction	(	std::vector< Cell * > *	,
		const int &
	)

inlinevirtual

Reinitialize the color function for the surface-tension terms with the volume fraction equation.

Parameters

cellsLvl	cells vector for every level
lvl	level

Reimplemented in APUEqSurfaceTension.

◆ solveFluxAddPhys()

virtual void AddPhys::solveFluxAddPhys ( CellInterface * )

inlinevirtual

Solve the additional physic flux between two cells.

Parameters

cellInterface cell interface

Reimplemented in APEConductivity, APUEqConductivity, APUEqSurfaceTension, APEViscosity, and APUEqViscosity.

◆ solveFluxAddPhysBoundary()

virtual void AddPhys::solveFluxAddPhysBoundary ( CellInterface * )

inlinevirtual

Solve the additional physic flux at a domain boundary.

Parameters

cellInterface cell interface

Reimplemented in APEConductivity, APUEqConductivity, APUEqSurfaceTension, APEViscosity, and APUEqViscosity.

◆ subtractFluxAddPhys()

void AddPhys::subtractFluxAddPhys	(	CellInterface *	cellInterface,
		const double &	coefAMR
	)

virtual

Subtract the additional physic flux between two cells at the corresponding cell.

Parameters

cellInterface	cell interface
coefAMR	Adaptive Mesh Refinement coefficient for numerical scheme purposes

◆ whoAmI()

virtual std::string AddPhys::whoAmI ( ) const

inlinevirtual

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AddPhys()

◆ ~AddPhys()

Member Function Documentation

◆ addFluxAddPhys()

◆ addNonCons()

◆ addNonConsAddPhys()

◆ addQuantityAddPhys()

◆ addSymmetricTermsRadialAxisOnX()

◆ addSymmetricTermsRadialAxisOnY()

◆ communicationsAddPhys()

◆ computeEnergyAddPhys()

◆ computeFluxAddPhys()

◆ computeFluxAddPhysBoundary()

◆ getNumTransportAssociated()

◆ reinitializationActivated()

◆ reinitializeColorFunction()

◆ solveFluxAddPhys()

◆ solveFluxAddPhysBoundary()

◆ subtractFluxAddPhys()

◆ whoAmI()