Interface ModuleInterface

All Superinterfaces:

NamedInterface, ProcessEquipmentInterface, Runnable, Serializable, SimulationInterface

All Known Implementing Classes:

AdsorptionDehydrationlModule, CO2RemovalModule, DPCUModule, GlycolDehydrationlModule, MEGReclaimerModule, MixerGasProcessingModule, ProcessModuleBaseClass, PropaneCoolingModule, SeparationTrainModule, SeparationTrainModuleSimple, WellFluidModule

public interface ModuleInterface
extends ProcessEquipmentInterface

ModuleInterface interface.

Version:

$Id: $Id

Author:

ESOL

Method Summary

Modifier and Type	Method	Description
void	addInputStream(String streamName, StreamInterface stream)	addInputStream.
ProcessSystem	getOperations()	getOperations.
StreamInterface	getOutputStream(String streamName)	getOutputStream.
String	getPreferedThermodynamicModel()	getPreferedThermodynamicModel.
Object	getUnit(String name)	getUnit.
void	initializeModule()	initializeModule.
void	initializeStreams()	initializeStreams.
boolean	isCalcDesign()	isCalcDesign.
void	setIsCalcDesign(boolean isCalcDesign)	setIsCalcDesign.
void	setPreferedThermodynamicModel(String preferedThermodynamicModel)	setPreferedThermodynamicModel.
void	setProperty(String propertyName, double value)	setProperty.

Methods inherited from interface NamedInterface

getName, getTagName, setName, setTagName

Methods inherited from interface ProcessEquipmentInterface

displayResult, equals, getCapacityDuty, getCapacityMax, getConditionAnalysisMessage, getController, getEntropyProduction, getExergyChange, getExergyChange, getFluid, getMassBalance, getMassBalance, getMechanicalDesign, getPressure, getPressure, getReport_json, getRestCapacity, getResultTable, getSpecification, getTemperature, getTemperature, getThermoSystem, hashCode, 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

getOperations

ProcessSystem getOperations()

getOperations.

Returns:

a ProcessSystem object

addInputStream

void addInputStream(String streamName,
 StreamInterface stream)

addInputStream.

Parameters:

streamName - a String object

stream - a StreamInterface object

getOutputStream

StreamInterface getOutputStream(String streamName)

getOutputStream.

Parameters:

streamName - a String object

Returns:

a StreamInterface object

getPreferedThermodynamicModel

String getPreferedThermodynamicModel()

getPreferedThermodynamicModel.

Returns:

a String object

setPreferedThermodynamicModel

void setPreferedThermodynamicModel(String preferedThermodynamicModel)

setPreferedThermodynamicModel.

Parameters:

preferedThermodynamicModel - a String object

initializeStreams

void initializeStreams()

initializeStreams.

initializeModule

void initializeModule()

initializeModule.

setIsCalcDesign

void setIsCalcDesign(boolean isCalcDesign)

setIsCalcDesign.

Parameters:

isCalcDesign - a boolean

isCalcDesign

boolean isCalcDesign()

isCalcDesign.

Returns:

a boolean

getUnit

Object getUnit(String name)

getUnit.

Parameters:

name - a String object

Returns:

a Object object

setProperty

void setProperty(String propertyName,
 double value)

setProperty.

Parameters:

propertyName - a String object

value - a double