Class AllocationResult

java.lang.Object
neqsim.process.equipment.well.allocation.AllocationResult
All Implemented Interfaces:
Serializable
public class AllocationResult extends Object implements Serializable
Result of well production allocation.
Version:
1.0
Author:
ESOL
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • timestamp

      private final Instant timestamp

    • oilRates

      private final Map<String,Double> oilRates

    • gasRates

      private final Map<String,Double> gasRates

    • waterRates

      private final Map<String,Double> waterRates

    • uncertainties

      private final Map<String,Double> uncertainties

    • totalOilRate

      private final double totalOilRate

    • totalGasRate

      private final double totalGasRate

    • totalWaterRate

      private final double totalWaterRate

    • allocationError

      private final double allocationError

    • balanced

      private final boolean balanced

  • Constructor Details

    • AllocationResult

      public AllocationResult(Map<String,Double> oilRates, Map<String,Double> gasRates, Map<String,Double> waterRates, Map<String,Double> uncertainties, double allocationError)
      Creates an allocation result.
      Parameters:
      oilRates - oil rates by well name (Sm3/day)
      gasRates - gas rates by well name (Sm3/day)
      waterRates - water rates by well name (Sm3/day)
      uncertainties - allocation uncertainties by well
      allocationError - total allocation error

  • Method Details

    • getTimestamp

      public Instant getTimestamp()
      Gets the allocation timestamp.
      Returns:
      timestamp

    • getOilRate

      public double getOilRate(String wellName)
      Gets the oil rate for a specific well.
      Parameters:
      wellName - well name
      Returns:
      oil rate in Sm3/day

    • getGasRate

      public double getGasRate(String wellName)
      Gets the gas rate for a specific well.
      Parameters:
      wellName - well name
      Returns:
      gas rate in Sm3/day

    • getWaterRate

      public double getWaterRate(String wellName)
      Gets the water rate for a specific well.
      Parameters:
      wellName - well name
      Returns:
      water rate in Sm3/day

    • getUncertainty

      public double getUncertainty(String wellName)
      Gets the allocation uncertainty for a specific well.
      Parameters:
      wellName - well name
      Returns:
      uncertainty (0-1 scale)

    • getAllOilRates

      public Map<String,Double> getAllOilRates()
      Gets all oil rates.
      Returns:
      map of well name to oil rate

    • getAllGasRates

      public Map<String,Double> getAllGasRates()
      Gets all gas rates.
      Returns:
      map of well name to gas rate

    • getAllWaterRates

      public Map<String,Double> getAllWaterRates()
      Gets all water rates.
      Returns:
      map of well name to water rate

    • getTotalOilRate

      public double getTotalOilRate()
      Gets the total oil rate.
      Returns:
      total oil rate in Sm3/day

    • getTotalGasRate

      public double getTotalGasRate()
      Gets the total gas rate.
      Returns:
      total gas rate in Sm3/day

    • getTotalWaterRate

      public double getTotalWaterRate()
      Gets the total water rate.
      Returns:
      total water rate in Sm3/day

    • getAllocationError

      public double getAllocationError()
      Gets the allocation error (imbalance).
      Returns:
      allocation error (relative)

    • isBalanced

      public boolean isBalanced()
      Checks if the allocation is balanced.
      Returns:
      true if balanced

    • getGOR

      public double getGOR(String wellName)
      Gets the GOR for a specific well.
      Parameters:
      wellName - well name
      Returns:
      GOR (Sm3/Sm3)

    • getWaterCut

      public double getWaterCut(String wellName)
      Gets the water cut for a specific well.
      Parameters:
      wellName - well name
      Returns:
      water cut (0-1)

    • getWellNames

      public String[] getWellNames()
      Gets the well names.
      Returns:
      array of well names

    • getWellAllocation

      public Map<String,Double> getWellAllocation(String wellName)
      Gets the allocation for a single well as a map.
      Parameters:
      wellName - well name
      Returns:
      map with oil, gas, water rates

    • toString

      public String toString()
      Overrides:
      toString in class Object