Main Page | Namespace List | Alphabetical List | Class List | File List | Class Members | Related Pages

phases::dPhase Interface Reference

import "phases.idl";

List of all members.

Public Types

enum  errorType {
  INVALID, BOUNDS, STATE, CALCULATION,
  UNKTYPE
}
enum  errorSeverity { WARNING, SERIOUS, FATAL, UNKSEV }

Public Member Functions

void setState (in PhaseState ss) raises (PhaseError)
 single call set of phase state. Members can be set independently

void setTk (in double tk) raises (PhaseError)
 set temperature in Kelvins

void setPa (in double pa) raises (PhaseError)
 set pressure in Pascal

void setMoles (in double m) raises (PhaseError)
 set total number of moles

void setMass (in double w) raises (PhaseError)
 set total weight in grams

void setComps (in CORBA::DoubleSeq c) raises (PhaseError)
 set component moles

void setGenericWts (in CORBA::DoubleSeq c) raises (PhaseError)
 set generic component (1-2 element) grams

string getName ()
 get phase name

string getCompName (in short i)
 get component name for component i

CORBA::StringSeq getCompNames ()
 get list of component names

CORBA::StringSeq getCompFormulas ()
 get list of component formulas

CORBA::StringSeq getGenericCompFormulas ()
 get list of relevant generic (1-2 element) component formulas

string getFormula ()
 get chemical formula for phase

double getMW ()
 get molecular weight (gm/mol)

unsigned short getNcomp ()
 get number of components

unsigned short getGenericNcomp ()
 get number of generic (1-2 element) components

PhaseState getState ()
 get state structure for phase

double getTk ()
 get temperature in Kelvins

double getPa ()
 get pressure in Pascal

double getMoles ()
 get total moles

double getMass ()
 get weight in grams

CORBA::DoubleSeq getComps ()
 get component moles

CORBA::DoubleSeq getGenericWts ()
 get generic component (1-2 element) grams

double getG ()
 get Gibbs free energy in Joules

double getH ()
 get enthalpy in Joules

double getS ()
 get entropy in Joules/Kelvin

double getCp ()
 get constant-pressure heat capacity in Joules/Kelvin

double getV ()
 get volume in cubic meters

CORBA::DoubleSeq getMu ()
 get component potentials in Joules/mole

void update () raises (PhaseError)
long long getLastAccessTime ()
 get time of last object access (seconds from local reference)

unsigned short isActive ()
 returns 1 if there are still active references to object

void remove ()
 deactivate and remove dSolution object


Detailed Description

dPhase

Definition at line 46 of file phases.idl.


Member Enumeration Documentation

enum phases::dPhase::errorSeverity
 

valid error severities WARNING: Phase remains in usable state. Retry with valid data. SERIOUS: Phase may not be in usable state. Future calcs suspect. FATAL: All hell has broken loose. Start over.

Definition at line 61 of file phases.idl.

enum phases::dPhase::errorType
 

valid error types. INVALID: input data not valid BOUNDS: input data out of bounds for this phase STATE: Phase is in invalid state for requested calculation CALCULATION: internal calculation error

Definition at line 54 of file phases.idl.


Member Function Documentation

void phases::dPhase::update  )  raises (PhaseError)
 

update internal state. For most phases this is not used at all. It is present for synchronization of calculations in many-phase client implementations. Single-direction call does not block client. If you need to ask, you probably don't need it.


The documentation for this interface was generated from the following file:
Generated on Mon Jul 7 21:43:50 2008 for dPhases by doxygen 1.3.4