Public Types | Public Member Functions

rock::dRock Interface Reference

import "rock.idl";

List of all members.

Public Types

enum  fO2Type {
  fo2_none, fo2_hm, fo2_nno, fo2_qfm,
  fo2_iw
}
enum  findRockLiquidusStatus { frl_success, frl_max_t, frl_min_t, frl_time }
enum  equilibrateStatus {
  equil_success, equil_quad_max, equil_lin_zero, equil_lin_max,
  equil_sat_max, equil_add_drop_max, equil_add_liquid_1, equil_add_liquid_2,
  equil_add_liquid_3, equil_rank, equil_solidus, equil_phase_rule,
  equil_time
}

Public Member Functions

void setTk (in double ltk)
 set T in Kelvins
void setPa (in double lpa)
 set P in Pascals
void setlogfo2 (in fO2Type mode, in double delta)
 set logfo2 mode and delNNO (default none)
void supressPhase (in short iphase)
 supress phase number iphase. All suppressed by default.
void enablePhase (in short iphase)
 enable phase number iphase. All supressed by default.
void setIsenthalpic (in boolean i)
 put rock in isenthalpic mode (default 0);
void setIsentropic (in boolean i)
 put rock in isentropic mode (default 0);
void setIsochoric (in boolean i)
 put rock in isochoric mode (default 0);
void setBulkCompM (in CORBA::DoubleSeq bc)
 set bulk composition in mole fraction. Values copied to internal array.
void setBulkCompW (in CORBA::DoubleSeq bc)
 set bulk composition in weight%. Values copied to internal array.
void fractionateSolids (in double scale)
 fractionate solids from the system (scale = fraction removed)
void setVolume (in double v)
 set system volume in J/Pa
void setEnthalpy (in double h)
 set system enthalpy in J
void setEntropy (in double s)
 set system entropy in J/K
double getTk ()
 returns T in Kelvins
double getPa ()
 returns P in Pascals
short getNcomp ()
 returns number of rock components
short getNLiqComp ()
 returns number of liquid components
short getNSolPhases ()
 returns number of solid phases
string getSolPhaseName (in short i)
 returns the name of a solid phase
string getSolPhaseFormula (in short i, in short j)
short getNSolComp (in short i)
 returns number of components for phase i
string getSolPhaseCompName (in short i, in short j)
string getSolPhaseCompFormula (in short i, in short j)
string getCompName (in short i)
 returns pointer to name of bulk component (oxide)
string getLiqCompName (in short i)
 returns pointer to name of liquid component
CORBA::DoubleSeq getLiqComp ()
 returns liquid composition
CORBA::DoubleSeq getLiqCompWt ()
 returns liquid composition in wt% oxides
CORBA::DoubleSeq getLiqMu ()
 returns liquid mu
CORBA::DoubleSeq getLiqActivity ()
 returns liquid activities
short getNSatSolid ()
 Returns number of saturated solid phases.
CORBA::ShortSeq getSatSolidList ()
 Returns list of indices for currently saturated solids.
short getSolComp (in short iphase, in short instance, out CORBA::DoubleSeq sx)
short getSolCompWt (in short iphase, in short instance, out CORBA::DoubleSeq sx)
short getSolMu (in short iphase, in short instance, out CORBA::DoubleSeq smu)
double getAffinity (in short iphase, out CORBA::DoubleSeq x)
short getSolVbar (in short iphase, in short instance, out CORBA::DoubleSeq svbar)
 Returns solid partial molar volumes in J/Pa. Returns 0 if not present.
double getlogfo2 ()
 get current log10fo2
double getlogfo2relative (in fO2Type mode)
 get current log10fo2 relative to buffer specified in mode
CORBA::DoubleSeq getBulkCompM ()
 get bulk composition in moles
CORBA::DoubleSeq getBulkCompW ()
 get bulk composition in grams
double getLiquidMass ()
 get liquid mass in gm
double getSolidMass ()
 get solid mass in gm
double getSolPhaseMass (in short iphase, in short instance)
 get mass in gm of phase
double getVolume ()
 returns system volume in J/Pa
double getSolidGibbsFreeEnergyTotal ()
 returns Gibbs free energy of solids in J
double getSolidEnthalpyTotal ()
 returns enthalpy of solids in J
double getSolidEntropyTotal ()
 returns entropy of solids in J/K
double getSolidHeatCapacityTotal ()
 returns heat capacity of solids in J/K
double getSolidVolumeTotal ()
 returns volume of solids in J/Pa
double getSolidGibbsFreeEnergy (in short iphase, in short instance)
 returns Gibbs free energy of solid iphase in J
double getSolidEnthalpy (in short iphase, in short instance)
 returns enthalpy of solid iphase in J
double getSolidEntropy (in short iphase, in short instance)
 returns entropy of solid iphase in J/K
double getSolidHeatCapacity (in short iphase, in short instance)
 returns heat capacity of solid iphase in J/K
double getSolidVolume (in short iphase, in short instance)
 returns volume of solid iphase in J/Pa
double getSoliddVdT (in short iphase, in short instance)
 returns dVdT of solid iphase in J/(Pa*K)
double getSoliddVdP (in short iphase, in short instance)
 returns dVdP of solid iphase in J/(Pa^2)
double getDeltaOxygen ()
 returns moles of oxygen added/removed from system
double getOxygenGibbsFreeEnergy ()
 returns Oxygen Gibbs Free Energy in J/mol
double getOxygenEnthalpy ()
 returns Oxygen enthalpy in J/mol
double getOxygenEntropy ()
 returns Oxygen entropy in J/K-mol
double getOxygenHeatCapacity ()
 returns Oxygen heat capacity in J/K-mol
double getOxygenVolume ()
 returns Oxygen volume in J/Pa-mol
double getLiquidGibbsFreeEnergy ()
 returns liquid Gibbs free energy in J
double getLiquidEnthalpy ()
 returns liquid enthalpy in J
double getLiquidEntropy ()
 returns liquid entropy in J/K
double getLiquidHeatCapacity ()
 returns liquid heat capacity in J/K
double getLiquidVolume ()
 returns liquid volume in J/Pa
double getLiquiddVdT ()
 returns liquid dVdT in J/(Pa*K)
double getLiquiddVdP ()
 returns liquid dVdP in J/Pa^2
double getLiquidViscosity ()
 returns liquid viscosity in log10 (poise)
short getPhaseNo (in string lab)
 get integer value of solid phase corresponding to label
boolean isSingleComponent (in short iphase)
 returns boolean indicating if phase iphase is single-component.
short getNumberCoexistPhase (in short iphase)
 returns number of coexisting instances of phase iphase
short findRockLiquidus ()
 find liquidus temperature for this bulk composition and sets state. returns findRockLiquidusStatus
short equilibrateRock ()
 execute equilibration on current state. returns equilibrateStatus
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
string getStatus ()
 returns a string that idicates the status/state of the object
void remove ()
 cleanup and deregister object

Detailed Description

dRock

Definition at line 35 of file rock.idl.


Member Enumeration Documentation

status returned by equilibrate method. equil_success: successful termination of equilibrate method equil_quad_max: quadratic iterations exceeded in equilibrate method equil_lin_zero: linear search truncation in equilibrate method equil_lin_max: linear search iterations exceeded in equilibrate method equil_sat_max: phase saturation loop exceeded in equilibrate method equil_add_drop_max: add/drop phase loop exceeded in equilibrate method equil_add_liquid_1: add solid: liquid exhausted (1) in equilibrate method equil_add_liquid_2: add solid: liquid exhausted (2) in equilibrate method equil_add_liquid_3: add liquid: solid exhausted in equilibrate method equil_rank: phase rule violation detected (rank) in equilibrate method equil_solidus: solidus detected in equilibrate method equil_phase_rule: phase rule violation detected (add0 in equilibrate method equil_time: time limit exceeded in equilibrate method

Definition at line 71 of file rock.idl.

status returned by findRockLiquidus method. frl_success: successful termination of find rock liquidus method frl_max_t: maximum temperature exceeded in find rock liquidus method frl_min_t: minimum temperature reached in find rock liquidus method frl_time: time limit exceeded in find rock liquidus method

Definition at line 53 of file rock.idl.

valid oxygen fugacity constraints. fo2_none: no oxygen fugacity constraint mode fo2_hm: hematite-magnetite oxygen fugacity constraint mode fo2_nno: Ni-NiO oxygen fugacity constraint mode fo2_qfm: QFM oxygen fugacity constraint mode fo2_iw: iron-wustite oxygen fugacity constraint mode

Definition at line 44 of file rock.idl.


Member Function Documentation

double rock::dRock::getAffinity ( in short  iphase,
out CORBA::DoubleSeq  x 
)

Returns affinity and composition guess for solid phase. If initial guess fails, Ghiorso's method will be used to try again.

Parameters:
iphase phase number
x estimate for mole fraction of components. Zeroed components will not be considered.
Returns:
affinity if undersaturated or zero if saturated
short rock::dRock::getSolComp ( in short  iphase,
in short  instance,
out CORBA::DoubleSeq  sx 
)

Returns solid composition in mol frac of phase components.

Parameters:
iphase phase number
instance phase instance index
sx double array to hold returned component moles.
Returns:
number of phase saturated or 0 if supressed or undersaturated.
short rock::dRock::getSolCompWt ( in short  iphase,
in short  instance,
out CORBA::DoubleSeq  sx 
)

Returns solid composition in wt% oxides.

Parameters:
iphase phase number
instance phase instance index
sx double array to hold returned wt% oxides.
Returns:
number of phase saturated or 0 if supressed or undersaturated.
short rock::dRock::getSolMu ( in short  iphase,
in short  instance,
out CORBA::DoubleSeq  smu 
)

Returns solid mu in Joules.

Parameters:
iphase phase number
instance phase instance index
smu double array to hold returned component potentials in Joules.
Returns:
number of phase saturated or 0 if supressed or undersaturated.
string rock::dRock::getSolPhaseCompFormula ( in short  i,
in short  j 
)

Returns the formula of a component in a solid phase

Parameters:
i phase index
j component index
Returns:
the name of a component in a solid phase
string rock::dRock::getSolPhaseCompName ( in short  i,
in short  j 
)

Returns the name of a component in a solid phase

Parameters:
i phase index
j component index
Returns:
the name of a component in a solid phase
string rock::dRock::getSolPhaseFormula ( in short  i,
in short  j 
)

returns the formula of a solid phase

Parameters:
i phase index
j instance index of phase

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