Class ProcessOptimizationEngine.OptimizationResult

java.lang.Object
neqsim.process.util.optimizer.ProcessOptimizationEngine.OptimizationResult
All Implemented Interfaces:
Serializable
Enclosing class:
ProcessOptimizationEngine
public static class ProcessOptimizationEngine.OptimizationResult extends Object implements Serializable
Result of an optimization run.
Version:
2.0
Author:
NeqSim Development Team
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • objective

      private String objective

    • optimalValue

      private double optimalValue

    • converged

      private boolean converged

    • errorMessage

      private String errorMessage

    • bottleneck

      private String bottleneck

    • constraintViolations

      private List<String> constraintViolations

    • sensitivity

      private ProcessOptimizationEngine.SensitivityResult sensitivity

    • inletPressure

      private double inletPressure

    • outletPressure

      private double outletPressure

  • Constructor Details

    • OptimizationResult

      public OptimizationResult()

  • Method Details

    • getObjective

      public String getObjective()

    • setObjective

      public void setObjective(String objective)

    • getOptimalValue

      public double getOptimalValue()

    • setOptimalValue

      public void setOptimalValue(double optimalValue)

    • isConverged

      public boolean isConverged()

    • setConverged

      public void setConverged(boolean converged)

    • getErrorMessage

      public String getErrorMessage()

    • setErrorMessage

      public void setErrorMessage(String errorMessage)

    • getBottleneck

      public String getBottleneck()

    • setBottleneck

      public void setBottleneck(String bottleneck)

    • getConstraintViolations

      public List<String> getConstraintViolations()

    • setConstraintViolations

      public void setConstraintViolations(List<String> violations)

    • getSensitivity

      public ProcessOptimizationEngine.SensitivityResult getSensitivity()
      Gets the sensitivity analysis result.

      The sensitivity result is automatically generated when optimization completes, providing information about constraint margins, flow gradients, and bottleneck equipment.

      Returns:
      the sensitivity result, or null if not available

    • setSensitivity

      public void setSensitivity(ProcessOptimizationEngine.SensitivityResult sensitivity)
      Sets the sensitivity analysis result.
      Parameters:
      sensitivity - the sensitivity result

    • getInletPressure

      public double getInletPressure()
      Gets the inlet pressure used in optimization.
      Returns:
      inlet pressure in bara

    • setInletPressure

      public void setInletPressure(double inletPressure)
      Sets the inlet pressure.
      Parameters:
      inletPressure - inlet pressure in bara

    • getOutletPressure

      public double getOutletPressure()
      Gets the outlet pressure used in optimization.
      Returns:
      outlet pressure in bara

    • setOutletPressure

      public void setOutletPressure(double outletPressure)
      Sets the outlet pressure.
      Parameters:
      outletPressure - outlet pressure in bara

    • isNearCapacity

      public boolean isNearCapacity()
      Checks if the system is near capacity at the optimal flow rate.

      Convenience method that delegates to the sensitivity result.

      Returns:
      true if utilization exceeds 95%

    • getAvailableMargin

      public double getAvailableMargin()
      Gets the available margin before hitting capacity.

      Convenience method that delegates to the sensitivity result.

      Returns:
      margin as a fraction (0.05 = 5% headroom), or 1.0 if sensitivity not available