ECOGEN 6.0
Evolutive, Compressible, Open, Genuine, Easy, N-phase
Loading...
Searching...
No Matches
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

std::vector< double > ak
std::vector< double > Yk
std::vector< double > rhok
std::vector< double > pk
std::vector< double > ek
std::vector< double > Ek
std::vector< double > akS
std::vector< double > rhokS
std::vector< double > rhokStar
std::vector< double > pkStar
std::vector< double > ekStar
std::vector< double > EkStar
std::vector< double > vkStar
std::vector< double > YkStar
std::vector< double > Deltapk
 Pressure differences, one for each phase.
std::vector< double > zk
 Acoustic impedance of each phase.
std::vector< double > rho_cIksquare
 Density times interface sound speed square, one for each phase.
std::vector< Eos * > eos
std::vector< double > Hk0
std::vector< double > Yk0
std::vector< double > compactionPk_dkappadxi
 Compaction pressure including the term d kappa_k / d xi_k, one for each phase.
std::vector< double > compactionPk_dkappadalpha
 Compaction pressure including the term d kappa_k / d alpha_k, one for each phase.
std::vector< double > dlambda
 Plastic compaction term, one for each phase.
std::vector< Tensor > dplast
 Plastic shear term, one for each phase.
std::vector< Tensor > LogCobase
 Log of the cobase.
std::vector< double > LogLambda
 Log of lambda.
std::vector< bool > alphaNull
 Parameter to know if we consider the volume fraction as null or not.
std::vector< bool > relaxSolidPlast
 Parameter to know if we need the solid plastic relaxation.
std::vector< double > ak4
std::vector< double > ak5
std::vector< double > ek4
std::vector< double > ek5
std::vector< Tensor > LogCobase4
 Log of the cobase.
std::vector< Tensor > LogCobase5
 Log of the cobase.
std::vector< double > LogLambda4
 Log of lambda.
std::vector< double > LogLambda5
 Log of lambda.
std::vector< Tensor > dLogCobaseDt1
std::vector< Tensor > dLogCobaseDt2
std::vector< Tensor > dLogCobaseDt3
std::vector< Tensor > dLogCobaseDt4
std::vector< Tensor > dLogCobaseDt5
std::vector< Tensor > dLogCobaseDt6
std::vector< double > dLogLambdaDt1
std::vector< double > dLogLambdaDt2
std::vector< double > dLogLambdaDt3
std::vector< double > dLogLambdaDt4
std::vector< double > dLogLambdaDt5
std::vector< double > dLogLambdaDt6
std::vector< double > dakDt1
std::vector< double > dakDt2
std::vector< double > dakDt3
std::vector< double > dakDt4
std::vector< double > dakDt5
std::vector< double > dakDt6
std::vector< double > dekDt1
std::vector< double > dekDt2
std::vector< double > dekDt3
std::vector< double > dekDt4
std::vector< double > dekDt5
std::vector< double > dekDt6
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
numbPhasesnumber of phases
numbSolidsnumber of solid phases
numberTransportsnumber 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
stringstring of characters
Here is the caller graph for this function:

◆ returnNonZeroValue()

double Tools::returnNonZeroValue ( double a)

Return a non-zero value of a float.

Parameters
doubleinitial float
Here is the call graph for this function:

◆ swap()

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

Swap two numbers.

Parameters
double1st number to swap
double2nd number to swap

◆ uppercase()

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

Modify the string of characters to uppercase it.

Parameters
stringstring of characters
Here is the caller graph for this function:

Member Data Documentation

◆ ak

std::vector<double> Tools::ak

◆ ak4

std::vector<double> Tools::ak4

◆ ak5

std::vector<double> Tools::ak5

◆ akS

std::vector<double> Tools::akS

◆ alphaNull

std::vector<bool> Tools::alphaNull

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

◆ compactionPk_dkappadalpha

std::vector<double> Tools::compactionPk_dkappadalpha

Compaction pressure including the term d kappa_k / d alpha_k, one for each phase.

◆ compactionPk_dkappadxi

std::vector<double> Tools::compactionPk_dkappadxi

Compaction pressure including the term d kappa_k / d xi_k, one for each phase.

◆ dakDt1

std::vector<double> Tools::dakDt1

◆ dakDt2

std::vector<double> Tools::dakDt2

◆ dakDt3

std::vector<double> Tools::dakDt3

◆ dakDt4

std::vector<double> Tools::dakDt4

◆ dakDt5

std::vector<double> Tools::dakDt5

◆ dakDt6

std::vector<double> Tools::dakDt6

◆ dekDt1

std::vector<double> Tools::dekDt1

◆ dekDt2

std::vector<double> Tools::dekDt2

◆ dekDt3

std::vector<double> Tools::dekDt3

◆ dekDt4

std::vector<double> Tools::dekDt4

◆ dekDt5

std::vector<double> Tools::dekDt5

◆ dekDt6

std::vector<double> Tools::dekDt6

◆ Deltapk

std::vector<double> Tools::Deltapk

Pressure differences, one for each phase.

◆ dlambda

std::vector<double> Tools::dlambda

Plastic compaction term, one for each phase.

◆ dLogCobaseDt1

std::vector<Tensor> Tools::dLogCobaseDt1

◆ dLogCobaseDt2

std::vector<Tensor> Tools::dLogCobaseDt2

◆ dLogCobaseDt3

std::vector<Tensor> Tools::dLogCobaseDt3

◆ dLogCobaseDt4

std::vector<Tensor> Tools::dLogCobaseDt4

◆ dLogCobaseDt5

std::vector<Tensor> Tools::dLogCobaseDt5

◆ dLogCobaseDt6

std::vector<Tensor> Tools::dLogCobaseDt6

◆ dLogLambdaDt1

std::vector<double> Tools::dLogLambdaDt1

◆ dLogLambdaDt2

std::vector<double> Tools::dLogLambdaDt2

◆ dLogLambdaDt3

std::vector<double> Tools::dLogLambdaDt3

◆ dLogLambdaDt4

std::vector<double> Tools::dLogLambdaDt4

◆ dLogLambdaDt5

std::vector<double> Tools::dLogLambdaDt5

◆ dLogLambdaDt6

std::vector<double> Tools::dLogLambdaDt6

◆ dplast

std::vector<Tensor> Tools::dplast

Plastic shear term, one for each phase.

◆ Ek

std::vector<double> Tools::Ek

◆ ek

std::vector<double> Tools::ek

◆ ek4

std::vector<double> Tools::ek4

◆ ek5

std::vector<double> Tools::ek5

◆ EkStar

std::vector<double> Tools::EkStar

◆ ekStar

std::vector<double> Tools::ekStar

◆ eos

std::vector<Eos*> Tools::eos

◆ Hk0

std::vector<double> Tools::Hk0

◆ LogCobase

std::vector<Tensor> Tools::LogCobase

Log of the cobase.

◆ LogCobase4

std::vector<Tensor> Tools::LogCobase4

Log of the cobase.

◆ LogCobase5

std::vector<Tensor> Tools::LogCobase5

Log of the cobase.

◆ LogLambda

std::vector<double> Tools::LogLambda

Log of lambda.

◆ LogLambda4

std::vector<double> Tools::LogLambda4

Log of lambda.

◆ LogLambda5

std::vector<double> Tools::LogLambda5

Log of lambda.

◆ physicalTime

double Tools::physicalTime

Current physical time.

◆ pk

std::vector<double> Tools::pk

◆ pkStar

std::vector<double> Tools::pkStar

◆ relaxSolidPlast

std::vector<bool> Tools::relaxSolidPlast

Parameter to know if we need the solid plastic relaxation.

◆ rho_cIksquare

std::vector<double> Tools::rho_cIksquare

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

◆ rhok

std::vector<double> Tools::rhok

◆ rhokS

std::vector<double> Tools::rhokS

◆ rhokStar

std::vector<double> Tools::rhokStar

◆ uselessDouble

double Tools::uselessDouble
static

◆ vkStar

std::vector<double> Tools::vkStar

◆ Yk

std::vector<double> Tools::Yk

◆ Yk0

std::vector<double> Tools::Yk0

◆ YkStar

std::vector<double> Tools::YkStar

◆ zk

std::vector<double> Tools::zk

Acoustic impedance of each phase.

The documentation for this class was generated from the following files:
  • /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Tools.h
  • /home/runner/work/ECOGEN/ECOGEN/doc_sources/src/Tools.cpp