Class TankCapacityStrategy

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

This strategy evaluates tank capacity based on multiple constraints including:

  • Liquid level (fill level and overflow risk)
  • Volume utilization
  • Vapor space requirements
Version:
1.0
Author:
NeqSim Development Team

  • Field Details

    • DEFAULT_MAX_LIQUID_LEVEL

      public static final double DEFAULT_MAX_LIQUID_LEVEL
      Default maximum liquid level fraction.
      See Also:

    • DEFAULT_MIN_LIQUID_LEVEL

      public static final double DEFAULT_MIN_LIQUID_LEVEL
      Default minimum liquid level fraction.
      See Also:

    • maxLiquidLevel

      private double maxLiquidLevel

    • minLiquidLevel

      private double minLiquidLevel

  • Constructor Details

    • TankCapacityStrategy

      public TankCapacityStrategy()
      Default constructor.

    • TankCapacityStrategy

      public TankCapacityStrategy(double maxLiquidLevel, double minLiquidLevel)
      Constructor with custom constraints.
      Parameters:
      maxLiquidLevel - maximum liquid level fraction (0-1)
      minLiquidLevel - minimum liquid level fraction (0-1)

  • 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

    • evaluateBasicCapacity

      private double evaluateBasicCapacity(Tank tank)
      Evaluates basic capacity when tank doesn't have constraint interface.
      Parameters:
      tank - the tank to evaluate
      Returns:
      utilization factor (0-1+)

    • 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

    • 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

    • setMaxLiquidLevel

      public void setMaxLiquidLevel(double maxLiquidLevel)
      Sets the maximum liquid level.
      Parameters:
      maxLiquidLevel - maximum liquid level fraction

    • getMaxLiquidLevel

      public double getMaxLiquidLevel()
      Gets the maximum liquid level.
      Returns:
      maximum liquid level fraction

    • setMinLiquidLevel

      public void setMinLiquidLevel(double minLiquidLevel)
      Sets the minimum liquid level.
      Parameters:
      minLiquidLevel - minimum liquid level fraction

    • getMinLiquidLevel

      public double getMinLiquidLevel()
      Gets the minimum liquid level.
      Returns:
      minimum liquid level fraction