prodml2_1::FrictionTheorySpecification Class Reference

#include <FrictionTheorySpecification.h>

Inheritance diagram for prodml2_1::FrictionTheorySpecification:

Public Member Functions
	FrictionTheorySpecification (gsoap_eml2_2::prodml21__FrictionTheory *fromGsoap)
	~FrictionTheorySpecification ()=default
unsigned int	getPrsvParameterCount () const
double	getPrsvParameterA1 (unsigned int index) const
double	getPrsvParameterA2 (unsigned int index) const
double	getPrsvParameterB1 (unsigned int index) const
double	getPrsvParameterB2 (unsigned int index) const
double	getPrsvParameterC2 (unsigned int index) const
std::string	getPrsvParameterFluidComponentReference (unsigned int index) const
void	pushBackPrsvParameter (double a1, double a2, double b1, double b2, double c2, const std::string &fluidComponentReference)
Public Member Functions inherited from prodml2_1::CompositionalViscositySpecification
	CompositionalViscositySpecification (gsoap_eml2_2::prodml21__AbstractCompositionalViscosityModel *fromGsoap)
virtual	~CompositionalViscositySpecification ()=default
gsoap_eml2_2::prodml21__ThermodynamicPhase	getThermodynamicPhase () const
void	setThermodynamicPhase (gsoap_eml2_2::prodml21__ThermodynamicPhase phase)
Public Member Functions inherited from prodml2_1::CompositionalSpecification
	CompositionalSpecification (gsoap_eml2_2::prodml21__AbstractCompositionalModel *fromGsoap)
virtual	~CompositionalSpecification ()=default
bool	hasMixingRule () const
gsoap_eml2_2::prodml21__MixingRule	getMixingRule () const
void	setMixingRule (gsoap_eml2_2::prodml21__MixingRule mixingRule)
unsigned int	getBinaryInteractionCoefficientCount () const
std::string	getBinaryInteractionCoefficientFluidComponent1Reference (unsigned int index) const
bool	hasBinaryInteractionCoefficientFluidComponent2Reference (unsigned int index) const
std::string	getBinaryInteractionCoefficientFluidComponent2Reference (unsigned int index) const
void	pushBackBinaryInteractionCoefficient (double value, const std::string &fluidComponent1Reference, const std::string &fluidComponent2Reference="")
unsigned int	getFluidComponentPropertyCount () const
void	pushBackFluidComponentProperty (const std::string &fluidComponentReference)
std::string	getFluidComponentPropertyFluidComponentReference (unsigned int index) const
Public Member Functions inherited from prodml2_1::PvtSpecification
	PvtSpecification (gsoap_eml2_2::prodml21__AbstractPvtModel *fromGsoap)
virtual	~PvtSpecification ()=default
unsigned int	getCoefficientCount () const
double	getCoefficientValue (unsigned int index) const
gsoap_eml2_2::prodml21__PvtModelParameterKind	getCoefficientKind (unsigned int index) const
bool	hasCoefficientName (unsigned int index) const
std::string	getCoefficientName (unsigned int index) const
void	pushBackCoefficient (double value, gsoap_eml2_2::prodml21__PvtModelParameterKind kind, const std::string &name="")

Additional Inherited Members
Public Attributes inherited from prodml2_1::PvtSpecification
gsoap_eml2_2::prodml21__AbstractPvtModel *	gsoapProxy

Detailed Description

A friction theory specification.

Constructor & Destructor Documentation

FrictionTheorySpecification()

prodml2_1::FrictionTheorySpecification::FrictionTheorySpecification ( gsoap_eml2_2::prodml21__FrictionTheory *  fromGsoap )

inline

Creates an instance of this class by wrapping a gsoap instance.

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~FrictionTheorySpecification()

prodml2_1::FrictionTheorySpecification::~FrictionTheorySpecification ( )

default

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

getPrsvParameterA1()

double prodml2_1::FrictionTheorySpecification::getPrsvParameterA1 ( unsigned int  index ) const

inline

Gets prsv parameter a 1

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The prsv parameter a 1.

getPrsvParameterA2()

double prodml2_1::FrictionTheorySpecification::getPrsvParameterA2 ( unsigned int  index ) const

inline

Gets prsv parameter a 2

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The prsv parameter a 2.

getPrsvParameterB1()

double prodml2_1::FrictionTheorySpecification::getPrsvParameterB1 ( unsigned int  index ) const

inline

Gets prsv parameter b 1

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The prsv parameter b 1.

getPrsvParameterB2()

double prodml2_1::FrictionTheorySpecification::getPrsvParameterB2 ( unsigned int  index ) const

inline

Gets prsv parameter b 2

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The prsv parameter b 2.

getPrsvParameterC2()

double prodml2_1::FrictionTheorySpecification::getPrsvParameterC2 ( unsigned int  index ) const

inline

Gets prsv parameter c 2

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The prsv parameter c 2.

getPrsvParameterCount()

unsigned int prodml2_1::FrictionTheorySpecification::getPrsvParameterCount ( ) const

inline

Gets prsv parameter count

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Returns

The prsv parameter count.

getPrsvParameterFluidComponentReference()

std::string prodml2_1::FrictionTheorySpecification::getPrsvParameterFluidComponentReference ( unsigned int  index ) const

inline

Gets prsv parameter fluid component reference

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The prsv parameter fluid component reference.

pushBackPrsvParameter()

void prodml2_1::FrictionTheorySpecification::pushBackPrsvParameter	(	double	a1,
		double	a2,
		double	b1,
		double	b2,
		double	c2,
		const std::string &	fluidComponentReference
	)

Pushes a back prsv parameter

Parameters

a1	The first double.
a2	The second double.
b1	The first double.
b2	The second double.
c2	The second double.
fluidComponentReference	The fluid component reference.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.0.0.0/src/prodml2_1/FrictionTheorySpecification.h