Class SimulationBaseClass

java.lang.Object
neqsim.util.NamedBaseClass
neqsim.process.SimulationBaseClass
All Implemented Interfaces:
Serializable, Runnable, SimulationInterface, NamedInterface
Direct Known Subclasses:
ProcessEquipmentBaseClass, ProcessModule, ProcessModuleBaseClass, ProcessSystem
public abstract class SimulationBaseClass extends NamedBaseClass implements SimulationInterface
Base class for process simulation objects.
Version:
$Id: $Id
Author:
ASMF
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version UID.
      See Also:

    • calcIdentifier

      protected UUID calcIdentifier
      Unique identifier of which solve/run call was last called successfully.

    • calculateSteadyState

      protected boolean calculateSteadyState

    • time

      protected double time

    • runInSteps

      private boolean runInSteps

  • Constructor Details

    • SimulationBaseClass

      public SimulationBaseClass(String name)

      Constructor for SimulationBaseClass.

      Parameters:
      name - a String object

  • Method Details

    • getCalculationIdentifier

      public UUID getCalculationIdentifier()
      Getter for property calcIdentifier.
      Specified by:
      getCalculationIdentifier in interface SimulationInterface
      Returns:
      Value of calcIdentifier.

    • setCalculationIdentifier

      public void setCalculationIdentifier(UUID value)
      Setter for property calcIdentifier.
      Specified by:
      setCalculationIdentifier in interface SimulationInterface
      Parameters:
      value - Value to set.

    • getCalculateSteadyState

      public boolean getCalculateSteadyState()
      Getter for property calculateSteadyState.
      Specified by:
      getCalculateSteadyState in interface SimulationInterface
      Returns:
      Value of property calculateSteadyState

    • setCalculateSteadyState

      public void setCalculateSteadyState(boolean steady)
      Setter for property calculateSteadyState.
      Specified by:
      setCalculateSteadyState in interface SimulationInterface
      Parameters:
      steady - Set true to do steady state calculation when calling runTransient.

    • getTime

      public double getTime()
      Getter for the field time.
      Specified by:
      getTime in interface SimulationInterface
      Returns:
      Value of property time.

    • setTime

      public void setTime(double value)
      Setter for field time.
      Specified by:
      setTime in interface SimulationInterface
      Parameters:
      value - Value to set.

    • increaseTime

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

    • setRunInSteps

      public void setRunInSteps(boolean setRunSteps)

      setRunInSteps.

      Specified by:
      setRunInSteps in interface SimulationInterface
      Parameters:
      setRunSteps - boolean set true to run in steps

    • isRunInSteps

      public boolean isRunInSteps()

      isRunInSteps.

      Specified by:
      isRunInSteps in interface SimulationInterface
      Returns:
      boolean