Class HostFacility.HostCapacityReport

java.lang.Object
neqsim.process.fielddevelopment.tieback.HostFacility.HostCapacityReport
All Implemented Interfaces:
Serializable
Enclosing class:
HostFacility

public static final class HostFacility.HostCapacityReport extends Object implements Serializable
Report from host capacity assessment.
Version:
1.0
Author:
ESOL
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • hostName

      private final String hostName
    • capacityAvailable

      private final boolean capacityAvailable
    • gasCapacityAvailable

      private final boolean gasCapacityAvailable
    • oilCapacityAvailable

      private final boolean oilCapacityAvailable
    • waterCapacityAvailable

      private final boolean waterCapacityAvailable
    • liquidCapacityAvailable

      private final boolean liquidCapacityAvailable
    • processCapacityAvailable

      private final boolean processCapacityAvailable
    • processModelUsed

      private final boolean processModelUsed
    • requiredGasMSm3d

      private final double requiredGasMSm3d
    • spareGasMSm3d

      private final double spareGasMSm3d
    • requiredOilBopd

      private final double requiredOilBopd
    • spareOilBopd

      private final double spareOilBopd
    • requiredWaterM3d

      private final double requiredWaterM3d
    • spareWaterM3d

      private final double spareWaterM3d
    • requiredLiquidM3d

      private final double requiredLiquidM3d
    • spareLiquidM3d

      private final double spareLiquidM3d
    • primaryBottleneckName

      private final String primaryBottleneckName
    • primaryBottleneckUtilization

      private final double primaryBottleneckUtilization
    • activeBottleneckCount

      private final int activeBottleneckCount
    • summary

      private final String summary
  • Constructor Details

    • HostCapacityReport

      private HostCapacityReport(String hostName, boolean capacityAvailable, boolean gasCapacityAvailable, boolean oilCapacityAvailable, boolean waterCapacityAvailable, boolean liquidCapacityAvailable, boolean processCapacityAvailable, boolean processModelUsed, double requiredGasMSm3d, double spareGasMSm3d, double requiredOilBopd, double spareOilBopd, double requiredWaterM3d, double spareWaterM3d, double requiredLiquidM3d, double spareLiquidM3d, String primaryBottleneckName, double primaryBottleneckUtilization, int activeBottleneckCount, String summary)
      Creates a host capacity report.
      Parameters:
      hostName - host name
      capacityAvailable - true if all capacity checks pass
      gasCapacityAvailable - true if gas capacity passes
      oilCapacityAvailable - true if oil capacity passes
      waterCapacityAvailable - true if water capacity passes
      liquidCapacityAvailable - true if liquid capacity passes
      processCapacityAvailable - true if process model has acceptable bottleneck utilization
      processModelUsed - true if an attached process model was checked
      requiredGasMSm3d - required gas rate in MSm3/d
      spareGasMSm3d - spare gas capacity in MSm3/d
      requiredOilBopd - required oil rate in bbl/d
      spareOilBopd - spare oil capacity in bbl/d
      requiredWaterM3d - required water rate in m3/d
      spareWaterM3d - spare water capacity in m3/d
      requiredLiquidM3d - required liquid rate in m3/d
      spareLiquidM3d - spare liquid capacity in m3/d
      primaryBottleneckName - primary bottleneck equipment name
      primaryBottleneckUtilization - primary bottleneck utilization fraction
      activeBottleneckCount - number of active bottlenecks above threshold
      summary - concise text summary
  • Method Details

    • getHostName

      public String getHostName()
      Gets the host name.
      Returns:
      host name
    • isCapacityAvailable

      public boolean isCapacityAvailable()
      Checks whether all capacity checks pass.
      Returns:
      true if capacity is available
    • isGasCapacityAvailable

      public boolean isGasCapacityAvailable()
      Checks whether gas capacity passes.
      Returns:
      true if gas capacity passes
    • isOilCapacityAvailable

      public boolean isOilCapacityAvailable()
      Checks whether oil capacity passes.
      Returns:
      true if oil capacity passes
    • isWaterCapacityAvailable

      public boolean isWaterCapacityAvailable()
      Checks whether water capacity passes.
      Returns:
      true if water capacity passes
    • isLiquidCapacityAvailable

      public boolean isLiquidCapacityAvailable()
      Checks whether total liquid capacity passes.
      Returns:
      true if liquid capacity passes
    • isProcessCapacityAvailable

      public boolean isProcessCapacityAvailable()
      Checks whether process-model capacity passes.
      Returns:
      true if process-model capacity passes
    • isProcessModelUsed

      public boolean isProcessModelUsed()
      Checks whether a process model was used.
      Returns:
      true if a process model was checked
    • getRequiredGasMSm3d

      public double getRequiredGasMSm3d()
      Gets the required gas rate.
      Returns:
      required gas rate in MSm3/d
    • getSpareGasMSm3d

      public double getSpareGasMSm3d()
      Gets the spare gas capacity.
      Returns:
      spare gas capacity in MSm3/d
    • getRequiredOilBopd

      public double getRequiredOilBopd()
      Gets the required oil rate.
      Returns:
      required oil rate in bbl/d
    • getSpareOilBopd

      public double getSpareOilBopd()
      Gets the spare oil capacity.
      Returns:
      spare oil capacity in bbl/d
    • getRequiredWaterM3d

      public double getRequiredWaterM3d()
      Gets the required water rate.
      Returns:
      required water rate in m3/d
    • getSpareWaterM3d

      public double getSpareWaterM3d()
      Gets the spare water capacity.
      Returns:
      spare water capacity in m3/d
    • getRequiredLiquidM3d

      public double getRequiredLiquidM3d()
      Gets the required total liquid rate.
      Returns:
      required liquid rate in m3/d
    • getSpareLiquidM3d

      public double getSpareLiquidM3d()
      Gets the spare total liquid capacity.
      Returns:
      spare liquid capacity in m3/d
    • getPrimaryBottleneckName

      public String getPrimaryBottleneckName()
      Gets the primary bottleneck name.
      Returns:
      primary bottleneck name, or null if none was found
    • getPrimaryBottleneckUtilization

      public double getPrimaryBottleneckUtilization()
      Gets the primary bottleneck utilization.
      Returns:
      utilization as a fraction from 0 to 1
    • getActiveBottleneckCount

      public int getActiveBottleneckCount()
      Gets the active bottleneck count.
      Returns:
      number of active bottlenecks above threshold
    • getSummary

      public String getSummary()
      Gets the summary string.
      Returns:
      capacity summary