Interface ProcessEquipmentInterface

All Superinterfaces:

NamedInterface, Runnable, Serializable, SimulationInterface

All Known Subinterfaces:

AbsorberInterface, CompressorInterface, DistillationInterface, ExpanderInterface, MixerInterface, ModuleInterface, MultiStreamHeatExchangerInterface, PumpInterface, SplitterInterface, StreamInterface, TrayInterface, ValveInterface

All Known Implementing Classes:

AdiabaticPipe, AdiabaticTwoPhasePipe, Adjuster, AdsorptionDehydrationlModule, AirCooler, BatteryStorage, BlowdownValve, Calculator, CharCoalFilter, CheckValve, CO2Electrolyzer, CO2RemovalModule, ComponentSplitter, Compressor, Condenser, ControlValve, Cooler, DexpiProcessUnit, DexpiProcessUnit, DexpiStream, DexpiStream, DistillationColumn, DPCUModule, Ejector, Electrolyzer, EquilibriumStream, ESDValve, ESPPump, Expander, ExpanderOld, Filter, Flare, FlareStack, FlowRateAdjuster, FlowSetter, FuelCell, FurnaceBurner, GasScrubber, GasScrubberSimple, GasTurbine, GibbsReactor, GibbsReactorCO2, GlycolDehydrationlModule, GORfitter, Heater, HeatExchanger, HIPPSValve, Hydrocyclone, Hydrocyclone, IncompressiblePipeFlow, IronIonSaturationStream, LevelControlValve, Manifold, MEGReclaimerModule, MembraneSeparator, Mixer, MixerGasProcessingModule, MoleFractionControllerUtil, MPFMfitter, MultiStreamHeatExchanger, MultiStreamHeatExchanger2, NeqGasScrubber, NeqHeater, NeqSimUnit, NeqStream, OnePhasePipeLine, Orifice, PipeBeggsAndBrills, PipeFlowNetwork, Pipeline, PressureControlValve, PressureDrop, ProcessEquipmentBaseClass, ProcessModuleBaseClass, ProducedWaterTreatmentTrain, PropaneCoolingModule, PSDValve, Pump, Reboiler, ReBoiler, Recycle, ReservoirCVDsim, ReservoirDiffLibsim, ReservoirTPsim, RuptureDisk, SafetyReliefValve, SafetyValve, ScalePotentialCheckStream, SeparationTrainModule, SeparationTrainModuleSimple, Separator, SetPoint, Setter, SimpleAbsorber, SimpleAdsorber, SimpleFlowLine, SimpleReservoir, SimpleTEGAbsorber, SimpleTPoutPipeline, SimpleTray, SolarPanel, Splitter, StaticMixer, StaticNeqMixer, StaticPhaseMixer, SteamHeater, Stream, StreamSaturatorUtil, StreamTransition, SubseaWell, Tank, ThreePhaseSeparator, ThrottlingValve, TransientPipe, TubingPerformance, TubingPerformance, TurboExpanderCompressor, TwoFluidPipe, TwoPhasePipeLine, TwoPhaseSeparator, TwoPortEquipment, VesselDepressurization, VirtualStream, VLSolidTray, WaterCooler, WaterHammerPipe, WaterStripperColumn, WellFlow, WellFlowlineNetwork, WellFluidModule, WellSystem, WindTurbine

public interface ProcessEquipmentInterface
extends SimulationInterface

ProcessEquipmentInterface interface.

Version:

$Id: $Id

Author:

Even Solbraa

Method Summary

Modifier and Type	Method	Description
void	displayResult()	displayResult.
boolean	equals(Object o)
default double	getCapacityDuty()	getCapacityDuty.
default double	getCapacityMax()	getCapacityMax.
String	getConditionAnalysisMessage()	getConditionAnalysisMessage.
ControllerDeviceInterface	getController()	getController.
default double	getEntropyProduction(String unit)	getEntropyProduction.
default double	getExergyChange(String unit)	getExergyChange.
double	getExergyChange(String unit, double surroundingTemperature)	Get exergy change production of the process equipment.
default SystemInterface	getFluid()	getFluid.
double	getMassBalance()	getMassBalance in kg/sec.
default double	getMassBalance(String unit)	getMassBalance.
MechanicalDesign	getMechanicalDesign()	Get a mechanicalDesign for the equipment.
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.
default double	getRestCapacity()	getRestCapacity.
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.
int	hashCode()
default void	initMechanicalDesign()	Initialize a initMechanicalDesign for the equipment.
default boolean	needRecalculation()	Check if process equipment needs recalculating.
String[][]	reportResults()	reportResults.
void	runConditionAnalysis(ProcessEquipmentInterface refExchanger)	runConditionAnalysis.
void	setController(ControllerDeviceInterface controller)	setController.
void	setPressure(double pressure)	Setter for the field pressure.
void	setRegulatorOutSignal(double signal)	setRegulatorOutSignal.
void	setSpecification(String specification)	setSpecification.
void	setTemperature(double temperature)	Setter for the field temperature.
String	toJson()	Serializes the Process Equipment along with its state to a JSON string.
default String	toJson(ReportConfig cfg)	Serializes the Process Equipment with configurable level of detail.
default ValidationResult	validateSetup()	Validate the process equipment before execution.

Methods inherited from interface NamedInterface

getName, getTagName, setName, setTagName

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

reportResults

String[][] reportResults()

reportResults.

Returns:

an array of String objects

initMechanicalDesign

default void initMechanicalDesign()

Initialize a initMechanicalDesign for the equipment.

getMechanicalDesign

MechanicalDesign getMechanicalDesign()

Get a mechanicalDesign for the equipment.

Returns:

a MechanicalDesign object

needRecalculation

default boolean needRecalculation()

Check if process equipment needs recalculating.

Returns:

true or false

getSpecification

String getSpecification()

getSpecification.

Returns:

a String object

setSpecification

void setSpecification(String specification)

setSpecification.

Parameters:

specification - a String object

displayResult

void displayResult()

displayResult.

setRegulatorOutSignal

void setRegulatorOutSignal(double signal)

setRegulatorOutSignal.

Parameters:

signal - a double

setController

void setController(ControllerDeviceInterface controller)

setController.

Parameters:

controller - a ControllerDeviceInterface object

getController

ControllerDeviceInterface getController()

getController.

Returns:

a ControllerDeviceInterface object

getFluid

default SystemInterface getFluid()

getFluid.

Returns:

a SystemInterface object

getThermoSystem

SystemInterface getThermoSystem()

getThermoSystem.

Returns:

a SystemInterface object

getMassBalance

double getMassBalance()

getMassBalance in kg/sec.

Returns:

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

getPressure

double getPressure()

Getter for the field pressure.

Returns:

Pressure in bara

getPressure

double getPressure(String unit)

Getter for the field pressure converted to specified unit.

Parameters:

unit - a String object

Returns:

a double

getTemperature

double getTemperature(String unit)

Getter for the field temperature converted to specified unit.

Parameters:

unit - a String object

Returns:

a double

getTemperature

double getTemperature()

Getter for the field temperature.

Returns:

a double

setPressure

void setPressure(double pressure)

Setter for the field pressure.

Parameters:

pressure - a double

setTemperature

void setTemperature(double temperature)

Setter for the field temperature.

Parameters:

temperature - Temperature in Kelvin

runConditionAnalysis

void runConditionAnalysis(ProcessEquipmentInterface refExchanger)

runConditionAnalysis.

Parameters:

refExchanger - a ProcessEquipmentInterface object

getConditionAnalysisMessage

String getConditionAnalysisMessage()

getConditionAnalysisMessage.

Returns:

a String object

getExergyChange

double getExergyChange(String unit,
 double surroundingTemperature)

Get exergy change production of the process equipment.

Parameters:

unit - Supported units are J and kJ

surroundingTemperature - The surrounding temperature in Kelvin

Returns:

change in exergy in specified unit

getResultTable

String[][] getResultTable()

getResultTable.

Returns:

an array of String objects

equals

boolean equals(Object o)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

toJson

String toJson()

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

Returns:

json string.

toJson

default String toJson(ReportConfig cfg)

Serializes the Process Equipment with configurable level of detail.

Parameters:

cfg - report configuration

Returns:

json string

getReport_json

String getReport_json()

getReport_json.

Return results of simulation in json format

Specified by:

getReport_json in interface SimulationInterface

Returns:

a String

getEntropyProduction

default double getEntropyProduction(String unit)

getEntropyProduction.

Parameters:

unit - a String object

Returns:

a double

getMassBalance

default double getMassBalance(String unit)

getMassBalance.

Parameters:

unit - a String object

Returns:

a double

getExergyChange

default double getExergyChange(String unit)

getExergyChange.

Parameters:

unit - a String object

Returns:

a double

getCapacityDuty

default double getCapacityDuty()

getCapacityDuty.

Returns:

a double

getCapacityMax

default double getCapacityMax()

getCapacityMax.

Returns:

a double

getRestCapacity

default double getRestCapacity()

getRestCapacity.

Returns:

a double

validateSetup

default ValidationResult validateSetup()

Validate the process equipment before execution.

Checks for common setup errors:

• Equipment has a valid name
• Input streams connected
• Operating parameters in valid ranges

Returns:

validation result with errors and warnings