Class CharacterizationOptions.Builder

java.lang.Object
neqsim.thermo.characterization.CharacterizationOptions.Builder
Enclosing class:
CharacterizationOptions
public static class CharacterizationOptions.Builder extends Object
Builder for CharacterizationOptions.
Author:
ESOL

  • Field Details

    • transferBinaryInteractionParameters

      private boolean transferBinaryInteractionParameters

    • normalizeComposition

      private boolean normalizeComposition

    • namingScheme

      private CharacterizationOptions.NamingScheme namingScheme

    • generateValidationReport

      private boolean generateValidationReport

    • compositionTolerance

      private double compositionTolerance

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • transferBinaryInteractionParameters

      public CharacterizationOptions.Builder transferBinaryInteractionParameters(boolean transfer)
      Set whether to transfer binary interaction parameters from the reference fluid.

      When enabled, BIPs between pseudo-components and other components in the reference fluid will be applied to the corresponding components in the characterized fluid. This is essential for maintaining consistent phase behavior across multiple fluids in compositional simulation.

      Parameters:
      transfer - true to enable BIP transfer
      Returns:
      this builder

    • normalizeComposition

      public CharacterizationOptions.Builder normalizeComposition(boolean normalize)
      Set whether to normalize composition after characterization.

      When enabled, mole fractions will be normalized to sum to exactly 1.0 after characterization.

      Parameters:
      normalize - true to enable normalization
      Returns:
      this builder

    • namingScheme

      public CharacterizationOptions.Builder namingScheme(CharacterizationOptions.NamingScheme scheme)
      Set the naming scheme for pseudo-components.
      Parameters:
      scheme - the naming scheme to use
      Returns:
      this builder

    • generateValidationReport

      public CharacterizationOptions.Builder generateValidationReport(boolean generate)
      Set whether to generate a validation report.

      When enabled, a validation report comparing key properties before and after characterization will be generated and logged.

      Parameters:
      generate - true to generate validation report
      Returns:
      this builder

    • compositionTolerance

      public CharacterizationOptions.Builder compositionTolerance(double tolerance)
      Set the tolerance for composition operations.
      Parameters:
      tolerance - the tolerance value
      Returns:
      this builder

    • build

      public CharacterizationOptions build()
      Build the CharacterizationOptions instance.
      Returns:
      the configured options