prodml2_1::CompositionalSpecification Class Reference

#include <CompositionalSpecification.h>

Inheritance diagram for prodml2_1::CompositionalSpecification:

Public Member Functions
	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 compositional specification.

Constructor & Destructor Documentation

CompositionalSpecification()

prodml2_1::CompositionalSpecification::CompositionalSpecification ( gsoap_eml2_2::prodml21__AbstractCompositionalModel *  fromGsoap )

inline

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

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~CompositionalSpecification()

virtual prodml2_1::CompositionalSpecification::~CompositionalSpecification ( )

virtualdefault

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

Member Function Documentation

getBinaryInteractionCoefficientCount()

unsigned int prodml2_1::CompositionalSpecification::getBinaryInteractionCoefficientCount ( ) const

inline

Gets binary interaction coefficient count

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Returns

The binary interaction coefficient count.

getBinaryInteractionCoefficientFluidComponent1Reference()

std::string prodml2_1::CompositionalSpecification::getBinaryInteractionCoefficientFluidComponent1Reference ( unsigned int  index ) const

inline

Gets binary interaction coefficient fluid component 1 reference

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The binary interaction coefficient fluid component 1 reference.

getBinaryInteractionCoefficientFluidComponent2Reference()

std::string prodml2_1::CompositionalSpecification::getBinaryInteractionCoefficientFluidComponent2Reference ( unsigned int  index ) const

inline

Gets binary interaction coefficient fluid component 2 reference

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

The binary interaction coefficient fluid component 2 reference.

getFluidComponentPropertyCount()

unsigned int prodml2_1::CompositionalSpecification::getFluidComponentPropertyCount ( ) const

inline

Gets fluid component property count

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Returns

The fluid component property count.

getFluidComponentPropertyFluidComponentReference()

std::string prodml2_1::CompositionalSpecification::getFluidComponentPropertyFluidComponentReference ( unsigned int  index ) const

inline

Gets fluid component property 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 fluid component property fluid component reference.

getMixingRule()

gsoap_eml2_2::prodml21__MixingRule prodml2_1::CompositionalSpecification::getMixingRule ( ) const

inline

Gets mixing rule

Exceptions

std::invalid_argument

Thrown when an invalid argument error condition occurs.

Returns

The mixing rule.

hasBinaryInteractionCoefficientFluidComponent2Reference()

bool prodml2_1::CompositionalSpecification::hasBinaryInteractionCoefficientFluidComponent2Reference ( unsigned int  index ) const

inline

Query if 'index' has binary interaction coefficient fluid component 2 reference

Exceptions

std::out_of_range

Thrown when an out of range error condition occurs.

Parameters

index

Zero-based index of the.

Returns

True if binary interaction coefficient fluid component 2 reference, false if not.

hasMixingRule()

bool prodml2_1::CompositionalSpecification::hasMixingRule ( ) const

inline

Query if this object has mixing rule

Returns

True if mixing rule, false if not.

pushBackBinaryInteractionCoefficient()

void prodml2_1::CompositionalSpecification::pushBackBinaryInteractionCoefficient	(	double	value,
		const std::string &	fluidComponent1Reference,
		const std::string &	fluidComponent2Reference = ""
	)

Pushes a back binary interaction coefficient

Parameters

value	The value.
fluidComponent1Reference	The fluid component 1 reference.
fluidComponent2Reference	(Optional) The fluid component 2 reference.

pushBackFluidComponentProperty()

void prodml2_1::CompositionalSpecification::pushBackFluidComponentProperty

(

const std::string &

fluidComponentReference

)

Pushes a back fluid component property

Parameters

fluidComponentReference

The fluid component reference.

setMixingRule()

void prodml2_1::CompositionalSpecification::setMixingRule

(

gsoap_eml2_2::prodml21__MixingRule

mixingRule

)

Sets mixing rule

Parameters

mixingRule

The mixing rule.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.3.0.0/src/prodml2_1/CompositionalSpecification.h