Class WellFlowCapacityStrategy

java.lang.Object
neqsim.process.equipment.capacity.WellFlowCapacityStrategy
All Implemented Interfaces:
EquipmentCapacityStrategy
public class WellFlowCapacityStrategy extends Object implements EquipmentCapacityStrategy
Capacity strategy for well flow equipment.

This strategy evaluates well flow capacity based on constraints including:

  • Well production index utilization
  • Flow rate vs AOF (absolute open flow)
  • Drawdown pressure vs maximum allowable
Version:
1.0
Author:
NeqSim Development Team

  • Field Details

    • DEFAULT_MAX_PI

      public static final double DEFAULT_MAX_PI
      Default maximum well production index in Sm3/d/bar.
      See Also:

    • DEFAULT_MAX_DRAWDOWN_BAR

      public static final double DEFAULT_MAX_DRAWDOWN_BAR
      Default maximum drawdown pressure in bar.
      See Also:

    • maxPI

      private double maxPI

    • maxDrawdownBar

      private double maxDrawdownBar

  • Constructor Details

    • WellFlowCapacityStrategy

      public WellFlowCapacityStrategy()
      Default constructor.

    • WellFlowCapacityStrategy

      public WellFlowCapacityStrategy(double maxPI, double maxDrawdownBar)
      Constructor with custom constraints.
      Parameters:
      maxPI - maximum well production index
      maxDrawdownBar - maximum drawdown pressure in bar

  • Method Details

    • supports

      public boolean supports(ProcessEquipmentInterface equipment)
      Checks if this strategy supports the given equipment.
      Specified by:
      supports in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to check
      Returns:
      true if this strategy can evaluate the equipment

    • getPriority

      public int getPriority()
      Gets the priority of this strategy.

      When multiple strategies support the same equipment, the one with higher priority is used. Default priority is 0. Use positive values for more specific strategies.

      Specified by:
      getPriority in interface EquipmentCapacityStrategy
      Returns:
      the priority value (higher = more preferred)

    • getName

      public String getName()
      Gets a descriptive name for this strategy.
      Specified by:
      getName in interface EquipmentCapacityStrategy
      Returns:
      strategy name

    • getEquipmentClass

      public Class<? extends ProcessEquipmentInterface> getEquipmentClass()
      Gets the equipment class this strategy handles.
      Specified by:
      getEquipmentClass in interface EquipmentCapacityStrategy
      Returns:
      the equipment class

    • evaluateCapacity

      public double evaluateCapacity(ProcessEquipmentInterface equipment)
      Evaluates the current capacity utilization of the equipment.

      Returns a value between 0 and 1+ where:

      • 0.0 = no load
      • 1.0 = at design capacity
      • >1.0 = over capacity
      Specified by:
      evaluateCapacity in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to evaluate
      Returns:
      capacity utilization as a fraction

    • evaluateMaxCapacity

      public double evaluateMaxCapacity(ProcessEquipmentInterface equipment)
      Evaluates the maximum capacity of the equipment.

      Returns the maximum capacity in the equipment's natural units (e.g., flow rate, power, duty).

      Specified by:
      evaluateMaxCapacity in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to evaluate
      Returns:
      maximum capacity

    • getConstraints

      public Map<String, CapacityConstraint> getConstraints(ProcessEquipmentInterface equipment)
      Gets all capacity constraints for this equipment.

      Returns a map of constraint name to constraint object. The constraints include both the current value and the design/limit values.

      Specified by:
      getConstraints in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to get constraints for
      Returns:
      map of constraint name to CapacityConstraint

    • addWellFlowConstraints

      private void addWellFlowConstraints(Map<String, CapacityConstraint> constraints, WellFlow well)
      Adds constraints for well flow.
      Parameters:
      constraints - map to add constraints to
      well - the well flow equipment

    • getViolations

      public List<CapacityConstraint> getViolations(ProcessEquipmentInterface equipment)
      Gets the list of constraint violations for this equipment.

      Returns only the constraints that are currently violated (utilization > 1.0 or outside limits).

      Specified by:
      getViolations in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to check
      Returns:
      list of violated constraints

    • getBottleneckConstraint

      public CapacityConstraint getBottleneckConstraint(ProcessEquipmentInterface equipment)
      Gets the bottleneck constraint (highest utilization).
      Specified by:
      getBottleneckConstraint in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to evaluate
      Returns:
      the constraint with highest utilization, or null if none

    • isWithinHardLimits

      public boolean isWithinHardLimits(ProcessEquipmentInterface equipment)
      Checks if the equipment is operating within all hard limits.
      Specified by:
      isWithinHardLimits in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to check
      Returns:
      true if no hard limits are violated

    • isWithinSoftLimits

      public boolean isWithinSoftLimits(ProcessEquipmentInterface equipment)
      Checks if the equipment is operating within all soft limits (design values).
      Specified by:
      isWithinSoftLimits in interface EquipmentCapacityStrategy
      Parameters:
      equipment - the equipment to check
      Returns:
      true if no soft limits are violated