Class ProcessModuleBaseClass

java.lang.Object

neqsim.util.NamedBaseClass

neqsim.process.SimulationBaseClass

neqsim.process.processmodel.ProcessModuleBaseClass

All Implemented Interfaces:

Serializable, Runnable, ProcessEquipmentInterface, ModuleInterface, SimulationInterface, NamedInterface

Direct Known Subclasses:

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

public abstract class ProcessModuleBaseClass
extends SimulationBaseClass
implements ModuleInterface

Abstract ProcessModuleBaseClass class.

Version:

$Id: $Id

Author:

ESOL

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isCalcDesign
protected boolean	isInitializedModule
protected boolean	isInitializedStreams
private ProcessSystem	operations
protected String	preferedThermodynamicModel
private static final long	serialVersionUID	Serialization version UID.

Fields inherited from class SimulationBaseClass

calcIdentifier, calculateSteadyState, time

Fields inherited from class NamedBaseClass

name

Constructor Summary

Constructors

Constructor	Description
ProcessModuleBaseClass(String name)	Constructor for ProcessModuleBaseClass.

Method Summary

Modifier and Type	Method	Description
abstract void	calcDesign()	calcDesign.
void	displayResult()	displayResult.
String	getConditionAnalysisMessage()	getConditionAnalysisMessage.
ControllerDeviceInterface	getController()	getController.
double	getEntropyProduction(String unit)	getEntropyProduction.
double	getExergyChange(String unit, double surroundingTemperature)	Get exergy change production of the process equipment.
double	getMassBalance()	getMassBalance in kg/sec.
double	getMassBalance(String unit)	getMassBalance.
MechanicalDesign	getMechanicalDesign()	Get a mechanicalDesign for the equipment.
ProcessSystem	getOperations()	getOperations.
String	getPreferedThermodynamicModel()	getPreferedThermodynamicModel.
double	getPressure()	Getter for the field pressure.
double	getPressure(String unit)	Getter for the field pressure converted to specified unit.
String	getReport_json()	getReport_json.
String[][]	getResultTable()	getResultTable.
String	getSpecification()	getSpecification.
double	getTemperature()	Getter for the field temperature.
double	getTemperature(String unit)	Getter for the field temperature converted to specified unit.
SystemInterface	getThermoSystem()	getThermoSystem.
Object	getUnit(String name)	getUnit.
boolean	isCalcDesign()	isCalcDesign.
String[][]	reportResults()	reportResults.
void	run_step(UUID id)	run_step
void	runConditionAnalysis(ProcessEquipmentInterface refExchanger)	runConditionAnalysis.
void	runTransient(double dt, UUID id)	runTransient
void	setController(ControllerDeviceInterface controller)	setController.
abstract void	setDesign()	setDesign.
void	setIsCalcDesign(boolean isCalcDesign)	setIsCalcDesign.
void	setPreferedThermodynamicModel(String preferedThermodynamicModel)	setPreferedThermodynamicModel.
void	setPressure(double pressure)	Setter for the field pressure.
void	setProperty(String propertyName, double value)	setProperty.
void	setProperty(String propertyName, double value, String unit)	setProperty.
void	setRegulatorOutSignal(double signal)	setRegulatorOutSignal.
void	setSpecification(String specification)	setSpecification.
void	setSpecification(String specificationName, double value)	setSpecification.
void	setTemperature(double temperature)	Setter for the field temperature.
boolean	solved()	Returns whether or not the module has been solved.
String	toJson()	Serializes the Process Equipment along with its state to a JSON string.

Methods inherited from class SimulationBaseClass

getCalculateSteadyState, getCalculationIdentifier, getTime, increaseTime, isRunInSteps, setCalculateSteadyState, setCalculationIdentifier, setRunInSteps, setTime

Methods inherited from class NamedBaseClass

getName, getTagName, setName, setTagName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ModuleInterface

addInputStream, getOutputStream, initializeModule, initializeStreams

Methods inherited from interface NamedInterface

getName, getTagName, setName, setTagName

Methods inherited from interface ProcessEquipmentInterface

equals, getCapacityDuty, getCapacityMax, getExergyChange, getFluid, getRestCapacity, hashCode, initMechanicalDesign, needRecalculation, toJson, validateSetup

Methods inherited from interface SimulationInterface

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

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization version UID.

See Also:

• Constant Field Values

preferedThermodynamicModel

protected String preferedThermodynamicModel

isInitializedModule

protected boolean isInitializedModule

isInitializedStreams

protected boolean isInitializedStreams

isCalcDesign

private boolean isCalcDesign

operations

private ProcessSystem operations

Constructor Details

ProcessModuleBaseClass

public ProcessModuleBaseClass(String name)

Constructor for ProcessModuleBaseClass.

Parameters:

name - a String object

Method Details

getPreferedThermodynamicModel

public String getPreferedThermodynamicModel()

getPreferedThermodynamicModel.

Specified by:

getPreferedThermodynamicModel in interface ModuleInterface

Returns:

a String object

setPreferedThermodynamicModel

public void setPreferedThermodynamicModel(String preferedThermodynamicModel)

setPreferedThermodynamicModel.

Specified by:

setPreferedThermodynamicModel in interface ModuleInterface

Parameters:

preferedThermodynamicModel - a String object

displayResult

public void displayResult()

displayResult.

Specified by:

displayResult in interface ProcessEquipmentInterface

setRegulatorOutSignal

public void setRegulatorOutSignal(double signal)

setRegulatorOutSignal.

Specified by:

setRegulatorOutSignal in interface ProcessEquipmentInterface

Parameters:

signal - a double

setController

public void setController(ControllerDeviceInterface controller)

setController.

Specified by:

setController in interface ProcessEquipmentInterface

Parameters:

controller - a ControllerDeviceInterface object

getController

public ControllerDeviceInterface getController()

getController.

Specified by:

getController in interface ProcessEquipmentInterface

Returns:

a ControllerDeviceInterface object

getMechanicalDesign

public MechanicalDesign getMechanicalDesign()

Get a mechanicalDesign for the equipment.

Specified by:

getMechanicalDesign in interface ProcessEquipmentInterface

Returns:

a MechanicalDesign object

calcDesign

public abstract void calcDesign()

calcDesign.

setDesign

public abstract void setDesign()

setDesign.

reportResults

public String[][] reportResults()

reportResults.

Specified by:

reportResults in interface ProcessEquipmentInterface

Returns:

an array of String objects

isCalcDesign

public boolean isCalcDesign()

isCalcDesign.

Specified by:

isCalcDesign in interface ModuleInterface

Returns:

a boolean

setIsCalcDesign

public void setIsCalcDesign(boolean isCalcDesign)

setIsCalcDesign.

Specified by:

setIsCalcDesign in interface ModuleInterface

Parameters:

isCalcDesign - a boolean

getOperations

public ProcessSystem getOperations()

getOperations.

Specified by:

getOperations in interface ModuleInterface

Returns:

a ProcessSystem object

runTransient

public void runTransient(double dt,
 UUID id)

runTransient

This method calculates thermodynamic and unit operations using difference equations if available and calculateSteadyState is true. Use setCalculateSteadyState to set the parameter. Sets calc identifier UUID.

Specified by:

runTransient in interface SimulationInterface

Parameters:

dt - Delta time [s]

id - Calculation identifier

solved

public boolean solved()

Returns whether or not the module has been solved.

Specified by:

solved in interface SimulationInterface

Returns:

a boolean

getThermoSystem

public SystemInterface getThermoSystem()

getThermoSystem.

Specified by:

getThermoSystem in interface ProcessEquipmentInterface

Returns:

a SystemInterface object

getSpecification

public String getSpecification()

getSpecification.

Specified by:

getSpecification in interface ProcessEquipmentInterface

Returns:

a String object

setSpecification

public void setSpecification(String specificationName,
 double value)

setSpecification.

Parameters:

specificationName - a String object

value - a double

setSpecification

public void setSpecification(String specification)

setSpecification.

Specified by:

setSpecification in interface ProcessEquipmentInterface

Parameters:

specification - a String object

getUnit

public Object getUnit(String name)

getUnit.

Specified by:

getUnit in interface ModuleInterface

Parameters:

name - a String object

Returns:

a Object object

setProperty

public void setProperty(String propertyName,
 double value)

setProperty.

Specified by:

setProperty in interface ModuleInterface

Parameters:

propertyName - a String object

value - a double

setProperty

public void setProperty(String propertyName,
 double value,
 String unit)

setProperty.

Parameters:

propertyName - a String object

value - a double

unit - a String object

getPressure

public double getPressure()

Getter for the field pressure.

Specified by:

getPressure in interface ProcessEquipmentInterface

Returns:

Pressure in bara

getPressure

public 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

setPressure

public void setPressure(double pressure)

Setter for the field pressure.

Specified by:

setPressure in interface ProcessEquipmentInterface

Parameters:

pressure - a double

getEntropyProduction

public double getEntropyProduction(String unit)

getEntropyProduction.

Specified by:

getEntropyProduction in interface ProcessEquipmentInterface

Parameters:

unit - a String object

Returns:

a double

getMassBalance

public double getMassBalance(String unit)

getMassBalance.

Specified by:

getMassBalance in interface ProcessEquipmentInterface

Parameters:

unit - a String object

Returns:

a double

getExergyChange

public double getExergyChange(String unit,
 double surroundingTemperature)

Get exergy change production of the process equipment.

Specified by:

getExergyChange in interface ProcessEquipmentInterface

Parameters:

unit - Supported units are J and kJ

surroundingTemperature - The surrounding temperature in Kelvin

Returns:

change in exergy in specified unit

runConditionAnalysis

public void runConditionAnalysis(ProcessEquipmentInterface refExchanger)

runConditionAnalysis.

Specified by:

runConditionAnalysis in interface ProcessEquipmentInterface

Parameters:

refExchanger - a ProcessEquipmentInterface object

getConditionAnalysisMessage

public String getConditionAnalysisMessage()

getConditionAnalysisMessage.

Specified by:

getConditionAnalysisMessage in interface ProcessEquipmentInterface

Returns:

a String object

getMassBalance

public double getMassBalance()

getMassBalance in kg/sec.

Specified by:

getMassBalance in interface ProcessEquipmentInterface

Returns:

The mass balance of the process equipment in kg/sec.

getResultTable

public String[][] getResultTable()

getResultTable.

Specified by:

getResultTable in interface ProcessEquipmentInterface

Returns:

an array of String objects

toJson

public String toJson()

Serializes the Process Equipment along with its state to a JSON string.

Specified by:

toJson in interface ProcessEquipmentInterface

Returns:

json string.

getReport_json

public String getReport_json()

getReport_json.

Return results of simulation in json format

Specified by:

getReport_json in interface ProcessEquipmentInterface

Specified by:

getReport_json in interface SimulationInterface

Returns:

a String

run_step

public void run_step(UUID id)

run_step

In this method all thermodynamic and unit operations will be calculated in a steady state calculation. Sets calc identifier UUID. It does not solve recycles - only calculates one step

Specified by:

run_step in interface SimulationInterface

Parameters:

id - Calc identifier UUID to set.

getTemperature

public double getTemperature()

Getter for the field temperature.

Specified by:

getTemperature in interface ProcessEquipmentInterface

Returns:

a double

getTemperature

public 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

setTemperature

public void setTemperature(double temperature)

Setter for the field temperature.

Specified by:

setTemperature in interface ProcessEquipmentInterface

Parameters:

temperature - Temperature in Kelvin