Tools Class Reference

Class for tools. More...

#include <Tools.h>

Public Member Functions
	Tools (const int &numbPhases, const int &numbSolids, const int &numbTransports)
	Generic model constructor.
	~Tools ()
double	returnNonZeroValue (double a)
	Return a non-zero value of a float.

Static Public Member Functions
static void	uppercase (std::string &string)
	Modify the string of characters to uppercase it.
static void	lowercase (std::string &string)
	Modify the string of characters to lowercase it.
static void	swap (double &a, double &b)
	Swap two numbers.

Public Attributes
double *	ak
double *	Yk
double *	rhok
double *	pk
double *	ek
double *	Ek
double *	akS
double *	rhokS
double *	rhokStar
double *	pkStar
double *	ekStar
double *	EkStar
double *	vkStar
double *	YkStar
double *	Deltapk
	Pressure differences, one for each phase.
double *	zk
	Acoustic impedance of each phase.
double *	rho_cIksquare
	Density times interface sound speed square, one for each phase.
Eos **	eos
double *	Hk0
double *	Yk0
double *	compactionPk
	Compaction pressure, one for each phase.
double *	dlambda
	Plastic compaction term, one for each phase.
Tensor *	dplast
	Plastic shear term, one for each phase.
bool *	alphaNull
	Parameter to know if we consider the volume fraction as null or not.
bool *	relaxSolidPlast
	Parameter to know if we need the solid plastic relaxation.
double	physicalTime
	Current physical time.

Static Public Attributes
static double	uselessDouble

Detailed Description

Class for tools.

Constructor & Destructor Documentation

Tools()

Tools::Tools	(	const int &	numbPhases,
		const int &	numbSolids,
		const int &	numbTransports
	)

Generic model constructor.

Parameters

numbPhases	number of phases
numbSolids	number of solid phases
numberTransports	number of additional transport equations

~Tools()

Tools::~Tools

(

)

Member Function Documentation

lowercase()

void Tools::lowercase ( std::string &  string )

static

Modify the string of characters to lowercase it.

Parameters

string

string of characters

returnNonZeroValue()

double Tools::returnNonZeroValue

(

double

a

)

Return a non-zero value of a float.

Parameters

double

initial float

swap()

void Tools::swap ( double &  a, double &  b  )

static

Swap two numbers.

Parameters

double	1st number to swap
double	2nd number to swap

uppercase()

void Tools::uppercase ( std::string &  string )

static

Modify the string of characters to uppercase it.

Parameters

string

string of characters

Member Data Documentation

ak

double* Tools::ak

akS

double* Tools::akS

alphaNull

bool* Tools::alphaNull

Parameter to know if we consider the volume fraction as null or not.

compactionPk

double* Tools::compactionPk

Compaction pressure, one for each phase.

Deltapk

double* Tools::Deltapk

Pressure differences, one for each phase.

dlambda

double* Tools::dlambda

Plastic compaction term, one for each phase.

dplast

Tensor* Tools::dplast

Plastic shear term, one for each phase.

ek

double* Tools::ek

Ek

double* Tools::Ek

ekStar

double* Tools::ekStar

EkStar

double* Tools::EkStar

eos

Eos** Tools::eos

Hk0

double* Tools::Hk0

physicalTime

double Tools::physicalTime

Current physical time.

pk

double* Tools::pk

pkStar

double* Tools::pkStar

relaxSolidPlast

bool* Tools::relaxSolidPlast

Parameter to know if we need the solid plastic relaxation.

rho_cIksquare

double* Tools::rho_cIksquare

Density times interface sound speed square, one for each phase.

rhok

double* Tools::rhok

rhokS

double* Tools::rhokS

rhokStar

double* Tools::rhokStar

uselessDouble

double Tools::uselessDouble

static

vkStar

double* Tools::vkStar

Yk

double* Tools::Yk

Yk0

double* Tools::Yk0

YkStar

double* Tools::YkStar

zk

double* Tools::zk

Acoustic impedance of each phase.

---

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

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