Class LumpingResult

java.lang.Object
neqsim.thermo.characterization.LumpingResult
All Implemented Interfaces:
Serializable
public class LumpingResult extends Object implements Serializable
Result class containing lumping quality metrics and configuration details.

This class provides feedback on the lumping operation, including:

  • Number of components before and after lumping
  • Property preservation errors (MW, density)
  • Configuration details applied
  • Any warnings generated during lumping
Version:
1.0
Author:
ESOL
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version UID.
      See Also:

    • modelName

      private final String modelName

    • originalComponentCount

      private final int originalComponentCount

    • lumpedComponentCount

      private final int lumpedComponentCount

    • originalAverageMW

      private final double originalAverageMW

    • lumpedAverageMW

      private final double lumpedAverageMW

    • originalAverageDensity

      private final double originalAverageDensity

    • lumpedAverageDensity

      private final double lumpedAverageDensity

    • warnings

      private final List<String> warnings

    • lumpedComponentNames

      private final List<String> lumpedComponentNames

    • carbonNumberBoundaries

      private final int[] carbonNumberBoundaries

  • Constructor Details

    • LumpingResult

      private LumpingResult(LumpingResult.Builder builder)
      Constructor for LumpingResult.
      Parameters:
      builder - the builder containing all result data

  • Method Details

    • getModelName

      public String getModelName()
      Get the lumping model name used.
      Returns:
      the model name

    • getOriginalComponentCount

      public int getOriginalComponentCount()
      Get the number of heavy components before lumping.
      Returns:
      original component count

    • getLumpedComponentCount

      public int getLumpedComponentCount()
      Get the number of pseudo-components after lumping.
      Returns:
      lumped component count

    • getMWError

      public double getMWError()
      Get the relative error in average molecular weight after lumping.

      Error is calculated as: |lumpedMW - originalMW| / originalMW

      Returns:
      relative MW error (0.0 = perfect match, 0.01 = 1% error)

    • getDensityError

      public double getDensityError()
      Get the relative error in average density after lumping.

      Error is calculated as: |lumpedDensity - originalDensity| / originalDensity

      Returns:
      relative density error (0.0 = perfect match, 0.01 = 1% error)

    • getOriginalAverageMW

      public double getOriginalAverageMW()
      Get the original mass-weighted average molecular weight.
      Returns:
      original average MW in kg/mol

    • getLumpedAverageMW

      public double getLumpedAverageMW()
      Get the lumped mass-weighted average molecular weight.
      Returns:
      lumped average MW in kg/mol

    • getOriginalAverageDensity

      public double getOriginalAverageDensity()
      Get the original mass-weighted average density.
      Returns:
      original average density in kg/m3

    • getLumpedAverageDensity

      public double getLumpedAverageDensity()
      Get the lumped mass-weighted average density.
      Returns:
      lumped average density in kg/m3

    • getWarnings

      public List<String> getWarnings()
      Get any warnings generated during lumping.
      Returns:
      list of warning messages

    • hasWarnings

      public boolean hasWarnings()
      Check if lumping generated any warnings.
      Returns:
      true if there are warnings

    • getLumpedComponentNames

      public List<String> getLumpedComponentNames()
      Get the names of the lumped components created.
      Returns:
      list of component names

    • getCarbonNumberBoundaries

      public int[] getCarbonNumberBoundaries()
      Get the carbon number boundaries used for lumping.
      Returns:
      array of carbon number boundaries, or null if auto-calculated

    • toMap

      public Map<String,Object> toMap()
      Get a summary map of all metrics for easy inspection.
      Returns:
      map of metric names to values

    • toString

      public String toString()
      Overrides:
      toString in class Object