#include <ModUEqTotEnergy.h>

Inherits Model.

Public Member Functions
	ModUEqTotEnergy (const int &numbTransports, const int &numbPhases)
	UEq model constructor.

	ModUEqTotEnergy (const std::string &name, const int &numbTransports)
	Generic model constructor (used by derived classes)

virtual	~ModUEqTotEnergy ()

virtual void	allocateCons (Flux **cons)
	Allocate conservative variable arrays.

virtual void	allocatePhase (Phase **phase)
	Instanciate fluid phase variable.

virtual void	allocateMixture (Mixture **mixture)
	Instanciate mixture variable.

virtual void	fulfillState (Phase *phases, Mixture mixture)

virtual void	fulfillStateRestart (Phase *, Mixture )

virtual void	initializeAugmentedVariables (Cell *)

virtual void	solveRiemannIntern (Cell &cellLeft, Cell &cellRight, const double &dxLeft, const double &dxRight, double &dtMax, std::vector< double > &boundData=DEFAULT_VEC_INTERFACE_DATA) const
	Cell to cell Riemann solver.

virtual void	reverseProjection (const Coord normal, const Coord tangent, const Coord binormal) const
	Flux reverse projection in the absolute Cartesian coordinate system.

virtual double	selectScalar (Phase *phases, Mixture mixture, Transport *transports, Variable nameVariable, int num=0) const
	Select a specific scalar variable.

virtual const double &	getSM ()
	Return the local fluid velocity.

virtual const Coord &	getVelocity (const Cell *cell) const
	Return the fluid velocity of the corresponding cell.

virtual Coord &	getVelocity (Cell *cell)

virtual const std::string &	whoAmI () const

Public Member Functions inherited from Model
	Model (const std::string &name, const int &numbTransports)
	Generic model constructor.

virtual	~Model ()

virtual void	allocatePhaseSolid (Phase **)
	Instanciate solid phase variable.

virtual void	allocatePhaseGradient (GradPhase **)
	Instanciate gradient phase variable.

virtual void	allocatePhaseSolidGradient (GradPhase **)
	Instanciate gradient solid-phase variable.

virtual void	allocateMixtureGradient (GradMixture **)
	Instanciate gradient mixture variable.

void	allocateEos (Cell &cell) const
	Associate equations of state.

void	initializeRelaxation (Cell *cell) const
	Initialize the theoritical critical pressure of the fluid (only required for PTMu relax)

virtual void	solveRiemannInternMRF (Cell &, Cell &, const double &, const double &, double &, const Coord &, const Coord &, const Coord &, const Coord &, const Coord &) const
	Cell to cell Riemann solver + compute fluxBuffMRF for MRF interface.

virtual void	solveRiemannWall (Cell &, const double &, double &, std::vector< double > &) const
	Wall half Riemann solver.

virtual void	solveRiemannPiston (Cell &, const double &, double &, std::vector< double > &, const double &) const
	Piston half Riemann solver.

virtual void	solveRiemannInletTank (Cell &, const double &, double &, const double , const double , const double &, const double &, std::vector< double > &) const
	Inlet tank half Riemann solver.

virtual void	solveRiemannInletInjStagState (Cell &, const double &, double &, const double, const double , const double , const double *, std::vector< double > &) const
	Inlet injection using stagnation state half Riemann solver.

virtual void	solveRiemannInletInjTemp (Cell &, const double &, double &, const double, const double , const double , std::vector< double > &) const
	Inlet injection using temperature half Riemann solver.

virtual void	solveRiemannOutletPressure (Cell &, const double &, double &, const double, std::vector< double > &) const
	Outlet at imposed pressure half Riemann solver.

virtual void	solveRiemannOutletMassflow (Cell &, const double &, double &, const double, std::vector< double > &) const
	Outlet at imposed massflow half Riemann solver.

virtual void	solveRiemannNullFlux () const
	No flux half Riemann solver (return null flux to use with 1D geometry with smooth varying cross section)

virtual void	solveRiemannTransportIntern (Cell &, Cell &)
	Cell to cell Riemann solver for transport equations.

virtual void	solveRiemannTransportWall ()
	Wall half Riemann solver for transport equations.

virtual void	solveRiemannTransportPiston (Cell &, double)
	Piston half Riemann solver for transport equations.

virtual void	solveRiemannTransportInletInjStagState (Cell &, double *)
	Inlet injection using stagnation state half Riemann solver for transport equations.

virtual void	solveRiemannTransportInletTank (Cell &, double *)
	Inlet tank half Riemann solver for transport equations.

virtual void	solveRiemannTransportOutletPressure (Cell &, double *)
	Outlet at imposed pressure half Riemann solver for transport equations.

void	relaxations (Cell *cell, const double &dt, Prim type=vecPhases) const

virtual void	lowMachSoundSpeed (double &, const double &, double &, const double &=Errors::defaultDouble, double &=Tools::uselessDouble) const

virtual void	addNonConsMrfFlux (Phase **)

virtual void	reverseProjectionMrfFlux (const Coord, const Coord, const Coord) const

virtual void	readCompactionParameters (tinyxml2::XMLElement *, std::string, const int &)
	Read compaction parameters.

virtual bool	compaction (const int &) const
	Return if compaction is activated or not.

virtual const double &	getDensityReference (const int &) const
	Return the compaction reference density of phase k.

virtual double	computeEnergyCompaction (const int &, const double &, const double &, const double &) const
	Return the compaction energy of the fluid/solid.

virtual double	computeCompactionPressure (const int &, const double &, const double &, const double &) const
	Compute the compaction pressure of the fluid/solid for relaxation.

virtual double	computeDerivativeCompactionFunctionF (const int &, const double &, const double &) const
	Compute the derivative of the compaction function f with respect to xi.

virtual double	computeCompactionPlasticity (const int &, const double &, const double &, const double &, const double &) const
	Compute the compaction plasticity term of the fluid/solid for relaxation.

virtual void	readSolidParameters (tinyxml2::XMLElement *, std::string, const int &)
	Read solid parameters.

virtual const double *	getDensityReference () const
	Return the reference density for each phase.

virtual const double *	getElasticParameterA () const
	Return the elastic parameter a of the one-parameter model for each phase.

virtual const double *	getShearModulus () const
	Return the shear modulus for each phase.

virtual const double *	getElasticityLimit () const
	Return the limit of elasticity for each phase.

virtual double	computeElasticEnergy (const int &, const Tensor &) const
	Compute the elastic energy of the solid.

virtual void	computeElasticEnergyAndStressTensor (const int &, const Tensor &, const double &, const double &, double &, Tensor &) const
	Compute the elastic energy and stress tensor of the solid.

virtual double	computeSquareLongitudinalWaveSpeed (const int &, const Phase &)
	Compute the square longitudinal wave speed of the solid.

virtual const Coord &	getVectorP (const Cell *) const

virtual Coord &	getVectorP (Cell *)

std::vector< Relaxation * > *	getRelaxations ()

void	printInfo () const

virtual void	setSmoothCrossSection1d (const bool &)

virtual const bool &	isSmoothCrossSection1d () const

virtual void	setLowMach (const bool &)

virtual void	setMachRefMin (const double &)

Static Private Attributes
static const std::string	NAME = "VELOCITYEQTOTENERGY"

Friends
class	FluxUEqTotEnergy

Additional Inherited Members
Protected Attributes inherited from Model
std::string	m_name
	Name of the required model.

std::vector< Relaxation * >	m_relaxations
	Vector of relaxation procedure.

bool	m_lowMach
	Low-Mach preconditioning (default: false)

double	m_machRefMin
	Minimum Mach number limit for L-M preconditionning used when local Mach number is below this value (default: 0.01)

bool	m_smoothCrossSection1d
	1D geometry with smooth cross section variation (default: false)

Constructor & Destructor Documentation

◆ ModUEqTotEnergy() [1/2]

ModUEqTotEnergy::ModUEqTotEnergy	(	const int &	numbTransports,
		const int &	numbPhases
	)

UEq model constructor.

Parameters

numbTransports	number of additional transport equations
numbPhases	number of phases

◆ ModUEqTotEnergy() [2/2]

ModUEqTotEnergy::ModUEqTotEnergy	(	const std::string &	name,
		const int &	numbTransports
	)

Generic model constructor (used by derived classes)

Parameters

name	model name
numbTransports	number of additional transport equations

◆ ~ModUEqTotEnergy()

ModUEqTotEnergy::~ModUEqTotEnergy ( )

virtual

Member Function Documentation

◆ allocateCons()

void ModUEqTotEnergy::allocateCons ( Flux ** )

virtual

Allocate conservative variable arrays.

Parameters

cons	conservative variable array to allocate

Reimplemented from Model.

◆ allocateMixture()

void ModUEqTotEnergy::allocateMixture ( Mixture ** )

virtual

Instanciate mixture variable.

Parameters

mixture mixture to instanciate

Reimplemented from Model.

◆ allocatePhase()

void ModUEqTotEnergy::allocatePhase ( Phase ** )

virtual

Instanciate fluid phase variable.

Parameters

phase phase to instanciate

Reimplemented from Model.

◆ fulfillState()

void ModUEqTotEnergy::fulfillState	(	Phase **	phases,
		Mixture *	mixture
	)

virtual

Complete multiphase state from volume fractions, pressures, densities and velocity

Reimplemented from Model.

◆ fulfillStateRestart()

virtual void ModUEqTotEnergy::fulfillStateRestart	(	Phase **	,
		Mixture *
	)

inlinevirtual

Does nothing for this model

Reimplemented from Model.

◆ getSM()

const double & ModUEqTotEnergy::getSM ( )

virtual

Return the local fluid velocity.

Returns: the velocity solution of the local Riemann problem

Reimplemented from Model.

◆ getVelocity() [1/2]

virtual Coord & ModUEqTotEnergy::getVelocity ( Cell * cell )

inlinevirtual

Reimplemented from Model.

◆ getVelocity() [2/2]

virtual const Coord & ModUEqTotEnergy::getVelocity ( const Cell * ) const

inlinevirtual

Return the fluid velocity of the corresponding cell.

Parameters

cell	pointer to corresponding cell

Returns: velocity

Reimplemented from Model.

◆ initializeAugmentedVariables()

virtual void ModUEqTotEnergy::initializeAugmentedVariables ( Cell * )

inlinevirtual

Does nothing for this model

Reimplemented from Model.

◆ reverseProjection()

void ModUEqTotEnergy::reverseProjection	(	const Coord	,
		const Coord	,
		const Coord
	)		const

virtual

Flux reverse projection in the absolute Cartesian coordinate system.

Parameters

normal	normal vector associated to the cell interface
tangent	tangent vector associated to the cell interface
binormal	binormal vector associated to the cell interface

Reimplemented from Model.

◆ selectScalar()

double ModUEqTotEnergy::selectScalar	(	Phase **	phases,
		Mixture *	mixture,
		Transport *	transports,
		Variable	nameVariable,
		int	num = `0`
	)		const

virtual

Select a specific scalar variable.

Parameters

phases	phases array variables
mixture	mixture variables
vecTransports	vector of transport variables
nameVariables	Name of the variable to select
numPhases	Phases number's

Reimplemented from Model.

◆ solveRiemannIntern()

void ModUEqTotEnergy::solveRiemannIntern	(	Cell &	,
		Cell &	,
		const double &	,
		const double &	,
		double &	,
		std::vector< double > &	= `DEFAULT_VEC_INTERFACE_DATA`
	)		const

virtual

Cell to cell Riemann solver.

Parameters

cellLeft	left cell
cellRight	right cell
dxLeft	left characteristic lenght
dxRight	right characteristic lenght
dtMax	maximum explicit time step
boundData	boundary dataset used for output

Reimplemented from Model.

◆ whoAmI()

virtual const std::string & ModUEqTotEnergy::whoAmI ( ) const

inlinevirtual

Reimplemented from Model.

Friends And Related Symbol Documentation

◆ FluxUEqTotEnergy

friend class FluxUEqTotEnergy

friend

Member Data Documentation

◆ NAME

const std::string ModUEqTotEnergy::NAME = "VELOCITYEQTOTENERGY"

staticprivate

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

/Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Models/UEqTotEnergy/ModUEqTotEnergy.h
/Users/fabien/depotsSephiroth/gitLab/ECOGEN/ecogen/src/Models/UEqTotEnergy/ModUEqTotEnergy.cpp

Public Member Functions

Static Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ ModUEqTotEnergy() [1/2]

◆ ModUEqTotEnergy() [2/2]

◆ ~ModUEqTotEnergy()

Member Function Documentation

◆ allocateCons()

◆ allocateMixture()

◆ allocatePhase()

◆ fulfillState()

◆ fulfillStateRestart()

◆ getSM()

◆ getVelocity() [1/2]

◆ getVelocity() [2/2]

◆ initializeAugmentedVariables()

◆ reverseProjection()

◆ selectScalar()

◆ solveRiemannIntern()

◆ whoAmI()

Friends And Related Symbol Documentation

◆ FluxUEqTotEnergy

Member Data Documentation

◆ NAME