Public Member Functions | List of all members
PhaseInterface Class Referenceabstract

pure abstract interface to phase type and id stuff More...

#include <PhaseInterface.h>

Inheritance diagram for PhaseInterface:
Inheritance graph
[legend]

Public Member Functions

virtual void setptype (PhaseType pt)=0
 Set the phase type to pt (Vapor, Liquid, Solid) More...
 
virtual PhaseType ptype (void) const =0
 Returns the phase type. More...
 
virtual void setpid (PhaseIndex pi, int ordinal=0)=0
 Set the PhaseIndex pi plus ordinal. More...
 
virtual PhaseIndex pid (void) const =0
 Returns the phase index. More...
 
virtual MassBalanceMode representation (void) const =0
 return default flow base More...
 
virtual Value & totalflow (void)=0
 return total flow in the default flow base More...
 
virtual Value & flow (int i)=0
 return flow for component i in the default flow base More...
 
virtual const Value & flow (int i) const =0
 return flow for component i in the default flow base More...
 
virtual Value & frac (int i)=0
 return fraction for component i in the default flow base More...
 
virtual std::vector< Quantity > & fracs (void)=0
 return reference to the fractions for all components in the default flow base More...
 
- Public Member Functions inherited from Diagnostic
 Diagnostic (void)
 
void setVerbosity (int verbosity)
 sets the verbosity level for this instance More...
 
int verbosity (void) const
 

Additional Inherited Members

- Protected Attributes inherited from Diagnostic
int verbosityInstance
 

Detailed Description

pure abstract interface to phase type and id stuff

#include <libpf/phases/PhaseInterface.h>

Remarks
Warning
Thread safe:
Extendable:
Platform dependencies:

Member Function Documentation

virtual Value& PhaseInterface::flow ( int  i)
pure virtual

return flow for component i in the default flow base

Implemented in PhaseMN, and PhaseM.

virtual const Value& PhaseInterface::flow ( int  i) const
pure virtual

return flow for component i in the default flow base

Implemented in PhaseMN, and PhaseM.

virtual Value& PhaseInterface::frac ( int  i)
pure virtual

return fraction for component i in the default flow base

Implemented in PhaseMN, and PhaseM.

virtual std::vector<Quantity>& PhaseInterface::fracs ( void  )
pure virtual

return reference to the fractions for all components in the default flow base

Implemented in PhaseMN, and PhaseM.

virtual PhaseIndex PhaseInterface::pid ( void  ) const
pure virtual

Returns the phase index.

Implemented in PhaseM.

virtual PhaseType PhaseInterface::ptype ( void  ) const
pure virtual

Returns the phase type.

Implemented in PhaseM.

virtual MassBalanceMode PhaseInterface::representation ( void  ) const
pure virtual

return default flow base

Implemented in PhaseMN, and PhaseM.

virtual void PhaseInterface::setpid ( PhaseIndex  pi,
int  ordinal = 0 
)
pure virtual

Set the PhaseIndex pi plus ordinal.

Implemented in PhaseM.

virtual void PhaseInterface::setptype ( PhaseType  pt)
pure virtual

Set the phase type to pt (Vapor, Liquid, Solid)

Implemented in PhaseM.

virtual Value& PhaseInterface::totalflow ( void  )
pure virtual

return total flow in the default flow base

Implemented in PhaseMN, and PhaseM.

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