Interface SimulationInterface

All Superinterfaces:
NamedInterface, Runnable, Serializable
All Known Subinterfaces:
AbsorberInterface, CompressorInterface, DistillationInterface, ExpanderInterface, HeaterInterface, HeatExchangerInterface, MixerInterface, ModuleInterface, MultiStreamHeatExchangerInterface, PipeLineInterface, ProcessEquipmentInterface, PumpInterface, SeparatorInterface, 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, ProcessModule, ProcessModuleBaseClass, ProcessSystem, 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, SimulationBaseClass, 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 SimulationInterface extends NamedInterface, Runnable, Serializable
Interface for simulation objects.
Version:
$Id: $Id
Author:
ASMF

  • Method Details

    • getCalculationIdentifier

      UUID getCalculationIdentifier()
      Getter for property calcIdentifier.
      Returns:
      Value of calcIdentifier.

    • setCalculationIdentifier

      void setCalculationIdentifier(UUID value)
      Setter for property calcIdentifier.
      Parameters:
      value - Value to set.

    • getCalculateSteadyState

      boolean getCalculateSteadyState()
      Getter for property calculateSteadyState.
      Returns:
      Value of property calculateSteadyState

    • setCalculateSteadyState

      void setCalculateSteadyState(boolean steady)
      Setter for property calculateSteadyState.
      Parameters:
      steady - Set true to do steady state calculation when calling runTransient.

    • getTime

      double getTime()
      Getter for the field time.
      Returns:
      Value of property time.

    • setTime

      void setTime(double value)
      Setter for field time.
      Parameters:
      value - Value to set.

    • increaseTime

      void increaseTime(double dt)
      Method to increase field time by a given value.
      Parameters:
      dt - Value to increase time by.

    • setRunInSteps

      void setRunInSteps(boolean setRunSteps)

      setRunInSteps.

      Parameters:
      setRunSteps - boolean set true to run in steps

    • isRunInSteps

      boolean isRunInSteps()

      isRunInSteps.

      Returns:
      boolean

    • run

      void run(UUID id)

      In this method all thermodynamic and unit operations will be calculated in a steady state calculation.

      Parameters:
      id - UUID

    • run

      default void run()
      Specified by:
      run in interface Runnable

    • run_step

      default void run_step()

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

    • run_step

      void run_step(UUID value)

      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
      Parameters:
      value - Calc identifier UUID to set.

    • runTransient

      default void runTransient(double dt)

      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.
      Parameters:
      dt - Delta time [s]

    • runTransient

      default 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.
      Parameters:
      dt - Delta time [s]
      id - Calculation identifier

    • solved

      boolean solved()

      Returns whether or not the module has been solved.

      Returns:
      a boolean

    • getReport_json

      String getReport_json()

      getReport_json.

      Return results of simulation in json format
      Returns:
      a String