Class TwoPortEquipment

java.lang.Object
neqsim.util.NamedBaseClass
neqsim.process.SimulationBaseClass
neqsim.process.equipment.ProcessEquipmentBaseClass
neqsim.process.equipment.TwoPortEquipment
All Implemented Interfaces:
Serializable, Runnable, ProcessEquipmentInterface, TwoPortInterface, SimulationInterface, NamedInterface
Direct Known Subclasses:
Compressor, ExpanderOld, Filter, Flare, FlowRateAdjuster, FlowSetter, FuelCell, GasTurbine, GibbsReactor, GibbsReactorCO2, GORfitter, Heater, MoleFractionControllerUtil, MPFMfitter, NeqSimUnit, Orifice, Pipeline, Pump, ReBoiler, SimpleFlowLine, StreamSaturatorUtil, StreamTransition, SubseaWell, ThrottlingValve, TransientPipe, TubingPerformance, WellFlow
public abstract class TwoPortEquipment extends ProcessEquipmentBaseClass implements TwoPortInterface
Abstract class defining ProcessEquipment with one inlet and one outlet.
Version:
$Id: $Id
Author:
ASMF
See Also:

  • Field Details

  • Constructor Details

    • TwoPortEquipment

      public TwoPortEquipment(String name)
      Constructor for TwoPortEquipment.
      Parameters:
      name - Name of TwoPortEquipment

    • TwoPortEquipment

      public TwoPortEquipment(String name, StreamInterface stream)
      Constructor for TwoPortEquipment.
      Parameters:
      name - Name of TwoPortEquipment
      stream - Stream to set as inlet Stream. A clone of stream is set as outlet stream.

  • Method Details

    • getInletPressure

      public double getInletPressure()
      Get inlet pressure of twoport.
      Specified by:
      getInletPressure in interface TwoPortInterface
      Returns:
      inlet pressure of TwoPortEquipment in unit bara

    • getInletStream

      public StreamInterface getInletStream()
      Get inlet Stream of twoport.
      Specified by:
      getInletStream in interface TwoPortInterface
      Returns:
      inlet Stream of TwoPortEquipment

    • getInletTemperature

      public double getInletTemperature()
      Get inlet temperature of twoport.
      Specified by:
      getInletTemperature in interface TwoPortInterface
      Returns:
      inlet temperature of TwoPortEquipment in unit kelvin

    • getOutletPressure

      public double getOutletPressure()
      Get outlet pressure of twoport.
      Specified by:
      getOutletPressure in interface TwoPortInterface
      Returns:
      outlet pressure of TwoPortEquipment in unit bara

    • getOutletStream

      public StreamInterface getOutletStream()
      Get outlet Stream of twoport.
      Specified by:
      getOutletStream in interface TwoPortInterface
      Returns:
      outlet Stream of TwoPortEquipment

    • getOutletTemperature

      public double getOutletTemperature()
      Get outlet temperature of twoport.
      Specified by:
      getOutletTemperature in interface TwoPortInterface
      Returns:
      outlet temperature of TwoPortEquipment in unit kelvin

    • setInletPressure

      public void setInletPressure(double pressure)
      Set inlet pressure of twoport.
      Specified by:
      setInletPressure in interface TwoPortInterface
      Parameters:
      pressure - value to set in unit bara

    • setInletStream

      public void setInletStream(StreamInterface stream)
      Set inlet Stream of twoport.
      Specified by:
      setInletStream in interface TwoPortInterface
      Parameters:
      stream - value to set

    • setInletTemperature

      public void setInletTemperature(double temperature)
      Set inlet temperature of twoport.
      Specified by:
      setInletTemperature in interface TwoPortInterface
      Parameters:
      temperature - value to set in unit kelvin

    • setOutletPressure

      public void setOutletPressure(double pressure)
      Set outlet pressure of twoport.
      Specified by:
      setOutletPressure in interface TwoPortInterface
      Parameters:
      pressure - value to set in unit bara

    • setOutletStream

      public void setOutletStream(StreamInterface stream)
      Set outlet Stream of twoport.
      Specified by:
      setOutletStream in interface TwoPortInterface
      Parameters:
      stream - value to set

    • setOutletTemperature

      public void setOutletTemperature(double temperature)
      Set outlet temperature of twoport.
      Specified by:
      setOutletTemperature in interface TwoPortInterface
      Parameters:
      temperature - value to set in kelvin

    • getMassBalance

      public double getMassBalance(String unit)

      getMassBalance.

      Specified by:
      getMassBalance in interface ProcessEquipmentInterface
      Overrides:
      getMassBalance in class ProcessEquipmentBaseClass
      Parameters:
      unit - a String object
      Returns:
      a double

    • toJson

      public String toJson()

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

      Specified by:
      toJson in interface ProcessEquipmentInterface
      Overrides:
      toJson in class ProcessEquipmentBaseClass
      Returns:
      json string.

    • toJson

      public String toJson(ReportConfig cfg)
      Serializes the Process Equipment with configurable level of detail.
      Specified by:
      toJson in interface ProcessEquipmentInterface
      Overrides:
      toJson in class ProcessEquipmentBaseClass
      Parameters:
      cfg - report configuration
      Returns:
      json string

    • validateSetup

      public 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

      Validates the two-port equipment setup before execution. Checks that:

      • Equipment has a valid name
      • Inlet stream is connected
      • Outlet stream is initialized
      Specified by:
      validateSetup in interface ProcessEquipmentInterface
      Returns:
      validation result with errors and warnings