Interface StreamInterface

All Superinterfaces:

NamedInterface, ProcessEquipmentInterface, Runnable, Serializable, SimulationInterface

All Known Implementing Classes:

DexpiStream, DexpiStream, EquilibriumStream, IronIonSaturationStream, NeqStream, ScalePotentialCheckStream, Stream

public interface StreamInterface
extends ProcessEquipmentInterface

StreamInterface interface.

Version:

$Id: $Id

Author:

esol

Method Summary

Modifier and Type	Method	Description
double	CCB(String unit)	Calculate and return cricondenbar.
double	CCT(String unit)	Calculate and return cricondentherm.
StreamInterface	clone()	Clone object.
StreamInterface	clone(String name)	Clone object and set a new name.
boolean	equals(Object o)
void	flashStream()	flashStream.
double	GCV()	GCV.
default double	getFlowRate(String unit)	getFlowRate.
double	getGCV(String unit, double refTVolume, double refTCombustion)	getGCV.
double	getHydrateEquilibriumTemperature()	getHydrateEquilibriumTemperature.
double	getHydrocarbonDewPoint(String temperatureUnit, double refpressure, String refPressureUnit)	Calculates the hydrocarbon dew point of the stream.
Standard_ISO6976	getISO6976(String unit, double refTVolume, double refTCombustion)	getWI.
double	getMolarRate()	getMolarRate.
double	getPressure()	Getter for the field pressure.
double	getPressure(String unit)	Getter for the field pressure converted to specified unit.
double	getRVP(double referenceTemperature, String unit, String returnUnit)	Calculates the Reid Vapor Pressure (RVP) of the stream.
double	getRVP(double referenceTemperature, String unit, String returnUnit, String rvpMethod)	Calculates the Reid Vapor Pressure (RVP) of the stream.
double	getTemperature()	Getter for the field temperature.
double	getTemperature(String unit)	Getter for the field temperature converted to specified unit.
SystemInterface	getThermoSystem()	getThermoSystem.
double	getTVP(double referenceTemperature, String unit, String returnUnit)	Calculates the True Vapor Pressure (TVP) of the stream.
double	getWI(String unit, double refTVolume, double refTCombustion)	getWI.
int	hashCode()
double	LCV()	LCV.
void	runTPflash()	runTPflash.
void	setEmptyThermoSystem(SystemInterface thermoSystem)	setEmptyThermoSystem.
void	setFlowRate(double flowrate, String unit)	setFlowRate.
void	setFluid(SystemInterface fluid)	setFluid.
void	setName(String name)	Setter for the field name.
void	setPressure(double pressure, String unit)	setPressure.
void	setTemperature(double temperature, String unit)	setTemperature.
void	setThermoSystem(SystemInterface thermoSystem)	setThermoSystem.
void	setThermoSystemFromPhase(SystemInterface thermoSystem, String phaseTypeName)	setThermoSystemFromPhase.
double	TVP(double referenceTemperature, String unit)	Calculates the True Vapor Pressure (TVP) of the stream.

Methods inherited from interface NamedInterface

getName, getTagName, setTagName

Methods inherited from interface ProcessEquipmentInterface

displayResult, getCapacityDuty, getCapacityMax, getConditionAnalysisMessage, getController, getEntropyProduction, getExergyChange, getExergyChange, getFluid, getMassBalance, getMassBalance, getMechanicalDesign, getReport_json, getRestCapacity, getResultTable, getSpecification, initMechanicalDesign, needRecalculation, reportResults, runConditionAnalysis, setController, setPressure, setRegulatorOutSignal, setSpecification, setTemperature, toJson, toJson, validateSetup

Methods inherited from interface SimulationInterface

getCalculateSteadyState, getCalculationIdentifier, getTime, increaseTime, isRunInSteps, run, run, run_step, run_step, runTransient, runTransient, setCalculateSteadyState, setCalculationIdentifier, setRunInSteps, setTime, solved

Method Details

getThermoSystem

SystemInterface getThermoSystem()

getThermoSystem.

Specified by:

getThermoSystem in interface ProcessEquipmentInterface

Returns:

a SystemInterface object

setThermoSystem

void setThermoSystem(SystemInterface thermoSystem)

setThermoSystem.

Parameters:

thermoSystem - a SystemInterface object

setFlowRate

void setFlowRate(double flowrate,
 String unit)

setFlowRate.

Parameters:

flowrate - a double

unit - a String object

getPressure

double getPressure()

Getter for the field pressure.

Specified by:

getPressure in interface ProcessEquipmentInterface

Returns:

Pressure in bara

getPressure

double getPressure(String unit)

Getter for the field pressure converted to specified unit.

Specified by:

getPressure in interface ProcessEquipmentInterface

Parameters:

unit - a String object

Returns:

a double

runTPflash

void runTPflash()

runTPflash.

getTemperature

double getTemperature(String unit)

Getter for the field temperature converted to specified unit.

Specified by:

getTemperature in interface ProcessEquipmentInterface

Parameters:

unit - a String object

Returns:

a double

getTemperature

double getTemperature()

Getter for the field temperature.

Specified by:

getTemperature in interface ProcessEquipmentInterface

Returns:

a double

setName

void setName(String name)

Setter for the field name.

Specified by:

setName in interface NamedInterface

Parameters:

name - a String object

CCT

double CCT(String unit)

Calculate and return cricondentherm.

Parameters:

unit - a String object

Returns:

Calculated cricondentherm in specified unit

CCB

double CCB(String unit)

Calculate and return cricondenbar.

Parameters:

unit - a String object

Returns:

Calculated cricondenbar in specified unit

getFlowRate

default double getFlowRate(String unit)

getFlowRate. Wrapper for SystemInterface.getFlowRate().

Parameters:

unit - Supported units are kg/sec, kg/min, kg/hr, kg/day, m3/sec, m3/min, m3/hr, Sm3/sec, Sm3/hr, Sm3/day, MSm3/day, mole/sec, mole/min, mole/hr

Returns:

flow rate in specified unit

TVP

double TVP(double referenceTemperature,
 String unit)

Calculates the True Vapor Pressure (TVP) of the stream.

Parameters:

referenceTemperature - a double

unit - a String object

Returns:

a double

getTVP

double getTVP(double referenceTemperature,
 String unit,
 String returnUnit)

Calculates the True Vapor Pressure (TVP) of the stream.

Parameters:

referenceTemperature - a double

unit - a String object

returnUnit - a String object

Returns:

a double

getRVP

double getRVP(double referenceTemperature,
 String unit,
 String returnUnit)

Calculates the Reid Vapor Pressure (RVP) of the stream.

Parameters:

referenceTemperature - a double

unit - a String object

returnUnit - a String object

Returns:

a double

getRVP

double getRVP(double referenceTemperature,
 String unit,
 String returnUnit,
 String rvpMethod)

Calculates the Reid Vapor Pressure (RVP) of the stream.

Parameters:

referenceTemperature - the reference temperature at which RVP is calculated

unit - the unit of the reference temperature

returnUnit - the unit in which the RVP should be returned

rvpMethod - the method used to calculate RVP

Returns:

the calculated RVP in the specified return unit

setFluid

void setFluid(SystemInterface fluid)

setFluid.

Parameters:

fluid - a SystemInterface object

getMolarRate

double getMolarRate()

getMolarRate.

Returns:

a double

clone

StreamInterface clone()

Clone object.

Returns:

a StreamInterface object

clone

StreamInterface clone(String name)

Clone object and set a new name.

Parameters:

name - Name of cloned object

Returns:

a StreamInterface object

flashStream

void flashStream()

flashStream.

getHydrateEquilibriumTemperature

double getHydrateEquilibriumTemperature()

getHydrateEquilibriumTemperature.

Returns:

a double

setThermoSystemFromPhase

void setThermoSystemFromPhase(SystemInterface thermoSystem,
 String phaseTypeName)

setThermoSystemFromPhase.

Parameters:

thermoSystem - a SystemInterface object

phaseTypeName - a String object

setEmptyThermoSystem

void setEmptyThermoSystem(SystemInterface thermoSystem)

setEmptyThermoSystem.

Parameters:

thermoSystem - a SystemInterface object

setPressure

void setPressure(double pressure,
 String unit)

setPressure.

Parameters:

pressure - a double

unit - a String object

setTemperature

void setTemperature(double temperature,
 String unit)

setTemperature.

Parameters:

temperature - a double

unit - a String object

GCV

double GCV()

GCV.

Returns:

a double

getGCV

double getGCV(String unit,
 double refTVolume,
 double refTCombustion)

getGCV.

Parameters:

unit - a String

refTVolume - a double in Celcius

refTCombustion - a double in Celcius

Returns:

a double

getWI

double getWI(String unit,
 double refTVolume,
 double refTCombustion)

getWI.

Parameters:

unit - a String

refTVolume - a double in Celcius

refTCombustion - a double in Celcius

Returns:

a double

getISO6976

Standard_ISO6976 getISO6976(String unit,
 double refTVolume,
 double refTCombustion)

getWI.

Parameters:

unit - a String

refTVolume - a double in Celcius

refTCombustion - a double in Celcius

Returns:

a Standard_ISO6976

LCV

double LCV()

LCV.

Returns:

a double

equals

boolean equals(Object o)

Specified by:

equals in interface ProcessEquipmentInterface

Overrides:

equals in class Object

hashCode

int hashCode()

Specified by:

hashCode in interface ProcessEquipmentInterface

Overrides:

hashCode in class Object

getHydrocarbonDewPoint

double getHydrocarbonDewPoint(String temperatureUnit,
 double refpressure,
 String refPressureUnit)

Calculates the hydrocarbon dew point of the stream.

Parameters:

temperatureUnit - the unit of the temperature to be used (e.g., "C" for Celsius, "K" for Kelvin)

refpressure - the reference pressure at which the dew point is to be calculated

refPressureUnit - the unit of the reference pressure (e.g., "bar", "Pa")

Returns:

the hydrocarbon dew point temperature in the specified temperature unit