Class Characterise

java.lang.Object
neqsim.thermo.characterization.Characterise
All Implemented Interfaces:
Serializable, Cloneable
public class Characterise extends Object implements Serializable, Cloneable

Characterise class.

Version:
$Id: $Id
Author:
esol
See Also:

  • Field Details

  • Constructor Details

    • Characterise

      public Characterise()

      Constructor for Characterise.

    • Characterise

      public Characterise(SystemInterface system)

      Constructor for Characterise.

      Parameters:
      system - a SystemInterface object

  • Method Details

    • setThermoSystem

      public void setThermoSystem(SystemInterface system)

      setThermoSystem.

      Parameters:
      system - a SystemInterface object

    • clone

      public Characterise clone()
      Overrides:
      clone in class Object

    • getTBPModel

      public TBPModelInterface getTBPModel()

      getTBPModel.

      Returns:
      a TBPModelInterface object

    • setTBPModel

      public void setTBPModel(String name)

      setTBPModel.

      Parameters:
      name - a String object

    • setLumpingModel

      public void setLumpingModel(String name)

      Setter for the field lumpingModel.

      Parameters:
      name - a String object

    • setPlusFractionModel

      public void setPlusFractionModel(String name)

      Setter for the field plusFractionModel.

      Parameters:
      name - a String object

    • getPlusFractionModel

      public PlusFractionModelInterface getPlusFractionModel()

      Getter for the field plusFractionModel.

      Returns:
      a PlusFractionModelInterface object

    • setGammaShapeParameter

      public Characterise setGammaShapeParameter(double alpha)
      Set the gamma distribution shape parameter (alpha) for Whitson Gamma Model. Only applies when using "Whitson Gamma Model" as the plus fraction model.

      Typical values:

      • Gas condensates: 0.5 - 1.0
      • Black oils: 1.0 - 2.0
      • Heavy oils: 2.0 - 4.0
      Parameters:
      alpha - shape parameter value
      Returns:
      this Characterise instance for method chaining

    • setGammaMinMW

      public Characterise setGammaMinMW(double eta)
      Set the minimum molecular weight (eta) for Whitson Gamma Model. Only applies when using "Whitson Gamma Model" as the plus fraction model.
      Parameters:
      eta - minimum molecular weight in g/mol (typically 84-90 for C7+)
      Returns:
      this Characterise instance for method chaining

    • setAutoEstimateGammaAlpha

      public Characterise setAutoEstimateGammaAlpha(boolean autoEstimate)
      Enable automatic estimation of the gamma shape parameter (alpha) based on fluid properties. Only applies when using "Whitson Gamma Model" as the plus fraction model.
      Parameters:
      autoEstimate - true to enable auto-estimation
      Returns:
      this Characterise instance for method chaining

    • setGammaDensityModel

      public Characterise setGammaDensityModel(String densityModel)
      Set the density model for Whitson Gamma Model characterization. Only applies when using "Whitson Gamma Model" as the plus fraction model.
      Parameters:
      densityModel - "UOP" for Watson K-factor (default) or "Soreide" for Søreide (1989) correlation
      Returns:
      this Characterise instance for method chaining

    • getLumpingModel

      public LumpingModelInterface getLumpingModel()

      Getter for the field lumpingModel.

      Returns:
      a LumpingModelInterface object

    • characterisePlusFraction

      public void characterisePlusFraction()

      characterisePlusFraction.

    • characterizeToReference

      public SystemInterface characterizeToReference(SystemInterface referenceFluid)
      Characterize this fluid to match the pseudo-component structure of a reference fluid.

      This method redistributes this fluid's pseudo-components to match the reference fluid's pseudo-component boundaries, enabling consistent compositional modeling across multiple fluid samples.

      Example: 

      SystemInterface referenceFluid = ...;  // Fluid with "master" PC structure
SystemInterface myFluid = ...;         // Fluid to be matched

SystemInterface matched = myFluid.getCharacterization()
    .characterizeToReference(referenceFluid);
      Parameters:
      referenceFluid - the fluid defining the target pseudo-component structure
      Returns:
      a new fluid with pseudo-components matching the reference

    • characterizeToReference

      public SystemInterface characterizeToReference(SystemInterface referenceFluid, CharacterizationOptions options)
      Characterize this fluid to match the pseudo-component structure of a reference fluid with options.

      This method allows specifying options for BIP transfer, normalization, and validation.

      Example: 

      CharacterizationOptions options = CharacterizationOptions.builder()
    .transferBinaryInteractionParameters(true).normalizeComposition(true).build();

SystemInterface matched =
    myFluid.getCharacterization().characterizeToReference(referenceFluid, options);
      Parameters:
      referenceFluid - the fluid defining the target pseudo-component structure
      options - characterization options
      Returns:
      a new fluid with pseudo-components matching the reference

    • transferBipsFrom

      public Characterise transferBipsFrom(SystemInterface referenceFluid)
      Transfer binary interaction parameters from a reference fluid to this fluid.

      This copies BIPs between components that exist in both fluids. For pseudo-components, it matches by position.

      Parameters:
      referenceFluid - the fluid containing BIPs to copy
      Returns:
      this Characterise instance for method chaining