Abstract class for mathematical flow models. More...

#include <Model.h>

Inherited by ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Public Member Functions
	Model (const std::string &name, const int &numbTransports)
	Generic model constructor.
virtual	~Model ()
virtual void	allocateCons (Flux **)
	Allocate conservative variable arrays.
virtual void	allocatePhase (Phase **)
	Instanciate fluid phase variable.
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	allocateMixture (Mixture **)
	Instanciate mixture 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	fulfillState (Phase *, Mixture )
	Complete a thermodynamics state frome minimum variables depending on the model.
virtual void	fulfillStateResume (Phase *, Mixture )
	Complete some variables if necessary when resuming a simulation.
virtual void	initializeAugmentedVariables (Cell *)
	Complete the augmented variables (such as the ones of Navier-Stokes-Korteweg model).
virtual void	solveRiemannIntern (Cell &, Cell &, const double &, const double &, double &, std::vector< double > &=DEFAULT_VEC_INTERFACE_DATA) const
	Cell to cell Riemann solver.
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	solveRiemannSymmetry (Cell &cellLeft, const double &dxLeft, double &dtMax, std::vector< double > &boundData) const
	Symmetry half Riemann solver.
virtual void	solveRiemannMovingWall (Cell &, const double &, double &, double, std::vector< double > &) const
	Moving wall 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	solveRiemannTransportMovingWall (Cell &, double)
	Moving wall 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.
virtual void	reverseProjection (const Coord, const Coord, const Coord) const
	Flux reverse projection in the absolute Cartesian coordinate system.
void	relaxations (Cell *cell, const double &dt, Prim type=vecPhases) const
	Run all the relaxations.
virtual void	correctionEnergy (Cell *, Prim=vecPhases) const
	Energy correction after relaxations (only for PUEq model).
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_dkappadxi (const int &, const double &, const double &, const double &) const
	Compute the compaction pressure term including the derivative d kappa_k / d xi_k.
virtual double	computeCompactionPressure_dkappadalpha (const int &, const double &, const double &, const double &) const
	Compute the compaction pressure term including the derivative d kappa_k / d alpha_k.
virtual double	computeCompactionPlasticity (const int &, const double &, const double &, const double &, const double &, 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 *	getChi () const
	Return the chi 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 double	selectScalar (Phase *, Mixture , Transport *, Variable, int=0) const
	Select a specific scalar variable.
virtual const double &	getSM ()
	Return the local fluid velocity.
virtual const Coord &	getVelocity (const Cell *) const
	Return the fluid velocity of the corresponding cell.
virtual Coord &	getVelocity (Cell *)
virtual const Coord &	getVectorP (const Cell *) const
virtual Coord &	getVectorP (Cell *)
std::vector< Relaxation * > *	getRelaxations ()
void	printInfo () const
virtual const std::string &	whoAmI () const
virtual void	setSmoothCrossSection1d (const bool &)
virtual const bool &	isSmoothCrossSection1d () const
const bool &	getLowMach () const
void	setLowMach (const bool &lowMach)
virtual void	setMachRefMin (const double &machRefMin)
virtual void	setPhaseSlope (Phase &, int)
	Set the slope values for the extrapolation within the cell.
virtual void	setSlopeDistance (const double &)
	Set the geometric distance over which the in-cell slopes extrapolate (cell width along the face normal).

Protected Attributes
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)

Detailed Description

Abstract class for mathematical flow models.

Constructor & Destructor Documentation

◆ Model()

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

Generic model constructor.

Parameters

name	model name
numbTransports	number of additional transport equations

Here is the caller graph for this function:

◆ ~Model()

Model::~Model ( )

virtual

Member Function Documentation

◆ addNonConsMrfFlux()

virtual void Model::addNonConsMrfFlux ( Phase ** )

inlinevirtual

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ allocateCons()

virtual void Model::allocateCons ( Flux ** )

inlinevirtual

Allocate conservative variable arrays.

Parameters

cons	conservative variable array to allocate

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModNEqDEM, ModNEqHLL, ModNEqHLLAC, ModNEqHLLC4Waves, ModPTUEq, ModPUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ allocateEos()

void Model::allocateEos ( Cell & cell ) const

Associate equations of state.

Parameters

cell	original cell for equation of state linking

Here is the call graph for this function:

◆ allocateMixture()

virtual void Model::allocateMixture ( Mixture ** )

inlinevirtual

Instanciate mixture variable.

Parameters

mixture mixture to instanciate

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModPUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ allocateMixtureGradient()

virtual void Model::allocateMixtureGradient ( GradMixture ** )

inlinevirtual

Instanciate gradient mixture variable.

Parameters

mixture mixture to instanciate

Reimplemented in ModEuler, ModEulerHomogeneous, ModNEq, ModPTUEq, and ModUEq.

Here is the call graph for this function:

◆ allocatePhase()

virtual void Model::allocatePhase ( Phase ** )

inlinevirtual

Instanciate fluid phase variable.

Parameters

phase phase to instanciate

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModPUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ allocatePhaseGradient()

virtual void Model::allocatePhaseGradient ( GradPhase ** )

inlinevirtual

Instanciate gradient phase variable.

Parameters

phase phase to instanciate

Reimplemented in ModEuler, ModEulerHomogeneous, ModNEq, ModPTUEq, and ModUEq.

Here is the call graph for this function:

◆ allocatePhaseSolid()

virtual void Model::allocatePhaseSolid ( Phase ** )

inlinevirtual

Instanciate solid phase variable.

Parameters

phase phase to instanciate

◆ allocatePhaseSolidGradient()

virtual void Model::allocatePhaseSolidGradient ( GradPhase ** )

inlinevirtual

Instanciate gradient solid-phase variable.

Parameters

phase phase to instanciate

Here is the call graph for this function:

◆ compaction()

virtual bool Model::compaction ( const int & ) const

inlinevirtual

Return if compaction is activated or not.

Parameters

k	phase number

Here is the call graph for this function:

◆ computeCompactionPlasticity()

virtual double Model::computeCompactionPlasticity	(	const int &	,
		const double &	,
		const double &	,
		const double &	,
		const double &	,
		double &	) const

inlinevirtual

Compute the compaction plasticity term of the fluid/solid for relaxation.

Parameters

k	phase number
alpha	volume fraction ( \( \alpha \))
density	density ( \( \rho \))
lambda	compaction variable ( \( \lambda \))
pc	compaction pressure ( \( p_c \))
f	compaction function f ( \( f \)) return \( \dlambda \) (compaction plasticity)

Here is the call graph for this function:

◆ computeCompactionPressure_dkappadalpha()

virtual double Model::computeCompactionPressure_dkappadalpha	(	const int &	,
		const double &	,
		const double &	,
		const double &	) const

inlinevirtual

Compute the compaction pressure term including the derivative d kappa_k / d alpha_k.

Parameters

k	phase number
alpha	volume fraction ( \( \alpha \))
density	density ( \( \rho \))
lambda	compaction variable ( \( \lambda \)) return \( \frac{\partial \kappa_k}{\partial \alpha_k} \) (compaction pressure)

Here is the call graph for this function:

◆ computeCompactionPressure_dkappadxi()

virtual double Model::computeCompactionPressure_dkappadxi	(	const int &	,
		const double &	,
		const double &	,
		const double &	) const

inlinevirtual

Compute the compaction pressure term including the derivative d kappa_k / d xi_k.

Parameters

k	phase number
alpha	volume fraction ( \( \alpha \))
density	density ( \( \rho \))
lambda	compaction variable ( \( \lambda \)) return \( \frac{\partial \kappa_k}{\partial \xi_k} \) (compaction pressure)

Here is the call graph for this function:

◆ computeElasticEnergy()

virtual double Model::computeElasticEnergy	(	const int &	,
		const Tensor &	) const

inlinevirtual

Compute the elastic energy of the solid.

Parameters

k	phase number
cobase	cobase tensor ( \( e^\beta \))

Here is the call graph for this function:

◆ computeElasticEnergyAndStressTensor()

virtual void Model::computeElasticEnergyAndStressTensor	(	const int &	,
		const Tensor &	,
		const double &	,
		const double &	,
		double &	,
		Tensor &	) const

inlinevirtual

Compute the elastic energy and stress tensor of the solid.

Parameters

k	phase number
cobase	cobase tensor ( \( e^\beta \))
pressure	pressure ( \( p \))
density	density ( \( \rho \))
elasticEnergy	elastic energy ( \( e^e \))
stressTensor	stress tensor ( \( \sigma \))

Here is the call graph for this function:

◆ computeEnergyCompaction()

virtual double Model::computeEnergyCompaction	(	const int &	,
		const double &	,
		const double &	,
		const double &	) const

inlinevirtual

Return the compaction energy of the fluid/solid.

Parameters

k	phase number
alpha	volume fraction ( \( \alpha \))
density	density ( \( \rho \))
lambda	compaction variable ( \( \lambda \)) return \( \kappa \) (compaction energy)

Here is the call graph for this function:

◆ computeSquareLongitudinalWaveSpeed()

virtual double Model::computeSquareLongitudinalWaveSpeed	(	const int &	,
		const Phase &	)

inlinevirtual

Compute the square longitudinal wave speed of the solid.

Parameters

k	phase number
phase	phase object

Returns: square longitudinal wave speed

Here is the call graph for this function:

◆ correctionEnergy()

virtual void Model::correctionEnergy	(	Cell *	,
		Prim	= vecPhases ) const

inlinevirtual

Energy correction after relaxations (only for PUEq model).

Parameters

cell	cell
type	primitive-variable type

Reimplemented in ModPUEq.

◆ fulfillState()

virtual void Model::fulfillState	(	Phase **	,
		Mixture *	)

inlinevirtual

Complete a thermodynamics state frome minimum variables depending on the model.

Parameters

phases	phases array variables
mixture	mixture variables

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ fulfillStateResume()

virtual void Model::fulfillStateResume	(	Phase **	,
		Mixture *	)

inlinevirtual

Complete some variables if necessary when resuming a simulation.

Parameters

phases	phases array variables
mixture	mixture variables

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModPUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ getChi()

virtual const double * Model::getChi ( ) const

inlinevirtual

Return the chi modulus for each phase.

Here is the call graph for this function:

◆ getDensityReference() [1/2]

virtual const double * Model::getDensityReference ( ) const

inlinevirtual

Return the reference density for each phase.

Here is the call graph for this function:

◆ getDensityReference() [2/2]

virtual const double & Model::getDensityReference ( const int & ) const

inlinevirtual

Return the compaction reference density of phase k.

Parameters

k	phase number

Here is the call graph for this function:

◆ getElasticityLimit()

virtual const double * Model::getElasticityLimit ( ) const

inlinevirtual

Return the limit of elasticity for each phase.

Here is the call graph for this function:

◆ getElasticParameterA()

virtual const double * Model::getElasticParameterA ( ) const

inlinevirtual

Return the elastic parameter a of the one-parameter model for each phase.

Here is the call graph for this function:

◆ getLowMach()

const bool & Model::getLowMach ( ) const

inline

◆ getRelaxations()

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

inline

◆ getShearModulus()

virtual const double * Model::getShearModulus ( ) const

inlinevirtual

Return the shear modulus for each phase.

Here is the call graph for this function:

◆ getSM()

virtual const double & Model::getSM ( )

inlinevirtual

Return the local fluid velocity.

Returns: the velocity solution of the local Riemann problem

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ getVectorP() [1/2]

virtual Coord & Model::getVectorP ( Cell * )

inlinevirtual

Here is the call graph for this function:

◆ getVectorP() [2/2]

virtual const Coord & Model::getVectorP ( const Cell * ) const

inlinevirtual

Here is the call graph for this function:

◆ getVelocity() [1/2]

virtual Coord & Model::getVelocity ( Cell * )

inlinevirtual

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ getVelocity() [2/2]

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

inlinevirtual

Return the fluid velocity of the corresponding cell.

Parameters

cell	pointer to corresponding cell

Returns: velocity

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ initializeAugmentedVariables()

virtual void Model::initializeAugmentedVariables ( Cell * )

inlinevirtual

Complete the augmented variables (such as the ones of Navier-Stokes-Korteweg model).

Parameters

cell cell

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ initializeRelaxation()

void Model::initializeRelaxation ( Cell * cell ) const

Initialize the theoritical critical pressure of the fluid (only required for PTMu relax).

Parameters

cell	cell to get the eos

◆ isSmoothCrossSection1d()

virtual const bool & Model::isSmoothCrossSection1d ( ) const

inlinevirtual

◆ lowMachSoundSpeed()

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

inlinevirtual

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ printInfo()

void Model::printInfo ( ) const

◆ readCompactionParameters()

virtual void Model::readCompactionParameters	(	tinyxml2::XMLElement *	,
		std::string	,
		const int &	)

inlinevirtual

Read compaction parameters.

Parameters

elementCompaction	XML element
fileName	string name of readed XML file
k	phase number

Here is the call graph for this function:

◆ readSolidParameters()

virtual void Model::readSolidParameters	(	tinyxml2::XMLElement *	,
		std::string	,
		const int &	)

inlinevirtual

Read solid parameters.

Parameters

elementSolid	XML element
fileName	string name of readed XML file
k	phase number

Here is the call graph for this function:

◆ relaxations()

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

Run all the relaxations.

Parameters

cell	cell
dt	time step
type	primitive-variable type

◆ reverseProjection()

virtual void Model::reverseProjection	(	const Coord	,
		const Coord	,
		const Coord	) const

inlinevirtual

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 in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reverseProjectionMrfFlux()

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

inlinevirtual

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ selectScalar()

virtual double Model::selectScalar	(	Phase **	,
		Mixture *	,
		Transport *	,
		Variable	,
		int	= 0 ) const

inlinevirtual

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 in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModPUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ setLowMach()

void Model::setLowMach ( const bool & lowMach )

inline

◆ setMachRefMin()

virtual void Model::setMachRefMin ( const double & machRefMin )

inlinevirtual

◆ setPhaseSlope()

virtual void Model::setPhaseSlope	(	Phase &	,
		int	)

inlinevirtual

Set the slope values for the extrapolation within the cell.

Parameters

slope	slopes for a Phase
k	phase index

Reimplemented in ModNEqDEM.

◆ setSlopeDistance()

virtual void Model::setSlopeDistance ( const double & )

inlinevirtual

Set the geometric distance over which the in-cell slopes extrapolate (cell width along the face normal).

Parameters

slopeDistance distance from the face back to the opposite face of the cell

Reimplemented in ModNEqDEM.

◆ setSmoothCrossSection1d()

virtual void Model::setSmoothCrossSection1d ( const bool & )

inlinevirtual

Reimplemented in ModEuler, ModEulerHomogeneous, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannInletInjStagState()

virtual void Model::solveRiemannInletInjStagState	(	Cell &	,
		const double &	,
		double &	,
		const double	,
		const double *	,
		const double *	,
		const double *	,
		std::vector< double > &	) const

inlinevirtual

Inlet injection using stagnation state half Riemann solver.

Parameters

cellLeft	left cell
dxLeft	left characteristic lenght
dtMax	maximum explicit time step
m0	specific mass flow rate (kg.s-1.m-2)
ak0	volume fraction array of injected fluids
rhok0	density array of injected fluids
pk0	pressure array of injected fluids
boundData	boundary dataset used for output

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannInletInjTemp()

virtual void Model::solveRiemannInletInjTemp	(	Cell &	,
		const double &	,
		double &	,
		const double	,
		const double *	,
		const double *	,
		std::vector< double > &	) const

inlinevirtual

Inlet injection using temperature half Riemann solver.

Parameters

cellLeft	left cell
dxLeft	left characteristic lenght
dtMax	maximum explicit time step
m0	specific mass flow rate (kg.s-1.m-2)
Tk0	temperature of injected fluid (same for both phases)
ak0	volume fraction of each injected phase
boundData	boundary dataset used for output

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannInletTank()

virtual void Model::solveRiemannInletTank	(	Cell &	,
		const double &	,
		double &	,
		const double *	,
		const double *	,
		const double &	,
		const double &	,
		std::vector< double > &	) const

inlinevirtual

Inlet tank half Riemann solver.

Parameters

cellLeft	left cell
dxLeft	left characteristic lenght
dtMax	maximum explicit time step
ak0	volume fraction array of fluids in tank
rhok0	density array of fluids in tank
pk0	pressure array of fluids in tank
boundData	boundary dataset used for output

Reimplemented in ModEuler, ModPTUEq, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannIntern()

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

inlinevirtual

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 in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModNEqDEM, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Here is the call graph for this function:

◆ solveRiemannInternMRF()

virtual void Model::solveRiemannInternMRF	(	Cell &	,
		Cell &	,
		const double &	,
		const double &	,
		double &	,
		const Coord &	,
		const Coord &	,
		const Coord &	,
		const Coord &	,
		const Coord &	) const

inlinevirtual

Cell to cell Riemann solver + compute fluxBuffMRF for MRF interface.

Parameters

cellLeft	left cell
cellRight	right cell
dxLeft	left characteristic lenght
dxRight	right characteristic lenght
dtMax	maximum explicit time step
omega	rotating velocity
normal	face normal
tangent	face tangent
binormal	face binormal
position	face position

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannMovingWall()

virtual void Model::solveRiemannMovingWall	(	Cell &	,
		const double &	,
		double &	,
		double	,
		std::vector< double > &	) const

inlinevirtual

Moving wall half Riemann solver.

Parameters

cellLeft	left cell
dxLeft	left characteristic lenght
dtMax	maximum explicit time step
wallVelocity	moving wall velocity (in its normal direction)
boundData	boundary dataset used for output

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannNullFlux()

virtual void Model::solveRiemannNullFlux ( ) const

inlinevirtual

No flux half Riemann solver (return null flux to use with 1D geometry with smooth varying cross section).

Reimplemented in ModEuler, ModExtendedNavierStokesKorteweg1D, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannOutletMassflow()

virtual void Model::solveRiemannOutletMassflow	(	Cell &	,
		const double &	,
		double &	,
		const double	,
		std::vector< double > &	) const

inlinevirtual

Outlet at imposed massflow half Riemann solver.

Parameters

cellLeft	left cell
dxLeft	left characteristic lenght
dtMax	maximum explicit time step
m0	specific mass flow rate (kg.s-1.m-2)
boundData	boundary dataset used for output

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannOutletPressure()

virtual void Model::solveRiemannOutletPressure	(	Cell &	,
		const double &	,
		double &	,
		const double	,
		std::vector< double > &	) const

inlinevirtual

Outlet at imposed pressure half Riemann solver.

Parameters

cellLeft	left cell
dxLeft	left characteristic lenght
dtMax	maximum explicit time step
p0	external pressure
boundData	boundary dataset used for output

Reimplemented in ModEuler, ModPTUEq, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannSymmetry()

virtual void Model::solveRiemannSymmetry	(	Cell &	cellLeft,
		const double &	dxLeft,
		double &	dtMax,
		std::vector< double > &	boundData ) const

inlinevirtual

Symmetry half Riemann solver.

Parameters

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

Here is the call graph for this function:

◆ solveRiemannTransportInletInjStagState()

virtual void Model::solveRiemannTransportInletInjStagState	(	Cell &	,
		double *	)

inlinevirtual

Inlet injection using stagnation state half Riemann solver for transport equations.

Parameters

cellLeft	left cell
valueTransports	array of transport quantities injected

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannTransportInletTank()

virtual void Model::solveRiemannTransportInletTank	(	Cell &	,
		double *	)

inlinevirtual

Inlet tank half Riemann solver for transport equations.

Parameters

cellLeft	left cell
valueTransports	array of transport quantities in tank

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannTransportIntern()

virtual void Model::solveRiemannTransportIntern	(	Cell &	,
		Cell &	)

inlinevirtual

Cell to cell Riemann solver for transport equations.

Parameters

cellLeft	left cell
cellRight	right cell

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannTransportMovingWall()

virtual void Model::solveRiemannTransportMovingWall	(	Cell &	,
		double	)

inlinevirtual

Moving wall half Riemann solver for transport equations.

Parameters

cellLeft	left cell
wallVelocity	moving wall velocity (in its normal direction)

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannTransportOutletPressure()

virtual void Model::solveRiemannTransportOutletPressure	(	Cell &	,
		double *	)

inlinevirtual

Outlet at imposed pressure half Riemann solver for transport equations.

Parameters

cellLeft	left cell
valueTransports	array of external transport quantities

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannTransportWall()

virtual void Model::solveRiemannTransportWall ( )

inlinevirtual

Wall half Riemann solver for transport equations.

Reimplemented in ModEuler, and ModUEq.

Here is the call graph for this function:

◆ solveRiemannWall()

virtual void Model::solveRiemannWall	(	Cell &	,
		const double &	,
		double &	,
		std::vector< double > &	) const

inlinevirtual

Wall half Riemann solver.

Parameters

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

Reimplemented in ModEuler, ModExtendedNavierStokesKorteweg1D, ModNEqDEM, ModPTUEq, and ModUEq.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ whoAmI()

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

inlinevirtual

Reimplemented in ModEuler, ModEulerHomogeneous, ModExtendedNavierStokesKorteweg1D, ModNEq, ModPTUEq, ModUEq, and ModUEqTotEnergy.

Member Data Documentation

◆ m_lowMach

bool Model::m_lowMach

protected

Low-Mach preconditioning (default: false).

◆ m_machRefMin

double Model::m_machRefMin

protected

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

◆ m_name

std::string Model::m_name

protected

Name of the required model.

◆ m_relaxations

std::vector<Relaxation*> Model::m_relaxations

protected

Vector of relaxation procedure.

◆ m_smoothCrossSection1d

bool Model::m_smoothCrossSection1d

protected

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

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

/home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Models/Model.h
/home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Models/Model.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Model()

◆ ~Model()

Member Function Documentation

◆ addNonConsMrfFlux()

◆ allocateCons()

◆ allocateEos()

◆ allocateMixture()

◆ allocateMixtureGradient()

◆ allocatePhase()

◆ allocatePhaseGradient()

◆ allocatePhaseSolid()

◆ allocatePhaseSolidGradient()

◆ compaction()

◆ computeCompactionPlasticity()

◆ computeCompactionPressure_dkappadalpha()

◆ computeCompactionPressure_dkappadxi()

◆ computeElasticEnergy()

◆ computeElasticEnergyAndStressTensor()

◆ computeEnergyCompaction()

◆ computeSquareLongitudinalWaveSpeed()

◆ correctionEnergy()

◆ fulfillState()

◆ fulfillStateResume()

◆ getChi()

◆ getDensityReference() [1/2]

◆ getDensityReference() [2/2]

◆ getElasticityLimit()

◆ getElasticParameterA()

◆ getLowMach()

◆ getRelaxations()

◆ getShearModulus()

◆ getSM()

◆ getVectorP() [1/2]

◆ getVectorP() [2/2]

◆ getVelocity() [1/2]

◆ getVelocity() [2/2]

◆ initializeAugmentedVariables()

◆ initializeRelaxation()

◆ isSmoothCrossSection1d()

◆ lowMachSoundSpeed()

◆ printInfo()

◆ readCompactionParameters()

◆ readSolidParameters()

◆ relaxations()

◆ reverseProjection()

◆ reverseProjectionMrfFlux()

◆ selectScalar()

◆ setLowMach()

◆ setMachRefMin()

◆ setPhaseSlope()

◆ setSlopeDistance()

◆ setSmoothCrossSection1d()

◆ solveRiemannInletInjStagState()

◆ solveRiemannInletInjTemp()

◆ solveRiemannInletTank()

◆ solveRiemannIntern()

◆ solveRiemannInternMRF()

◆ solveRiemannMovingWall()

◆ solveRiemannNullFlux()

◆ solveRiemannOutletMassflow()

◆ solveRiemannOutletPressure()

◆ solveRiemannSymmetry()

◆ solveRiemannTransportInletInjStagState()

◆ solveRiemannTransportInletTank()

◆ solveRiemannTransportIntern()

◆ solveRiemannTransportMovingWall()

◆ solveRiemannTransportOutletPressure()

◆ solveRiemannTransportWall()

◆ solveRiemannWall()

◆ whoAmI()

Member Data Documentation

◆ m_lowMach

◆ m_machRefMin

◆ m_name

◆ m_relaxations

◆ m_smoothCrossSection1d