refact: clean up setBeta/getBeta functions and docfix (#671)

* refact: cleanup various setBeta stuff
equinor · May 22, 2023 · d638646 · d638646
1 parent db50378
commit d638646
Show file tree

Hide file tree

Showing 14 changed files with 151 additions and 171 deletions.
diff --git a/src/main/java/neqsim/dataPresentation/SampleXYDataSource.java b/src/main/java/neqsim/dataPresentation/SampleXYDataSource.java
@@ -19,12 +19,11 @@
 
 /**
  * A dummy data source for an XY plot.
- * <P>
+ *
+ * <p>
  * Note that the aim of this class is to create a self-contained data source for demo purposes - it
  * is NOT intended to show how you should go about writing your own data sources.
- *
- * @author asmund
- * @version $Id: $Id
+ * </p>
  */
 public class SampleXYDataSource {
   double[][] points;

diff --git a/src/main/java/neqsim/dataPresentation/userInterface.java b/src/main/java/neqsim/dataPresentation/userInterface.java
diff --git a/src/main/java/neqsim/thermo/component/Component.java b/src/main/java/neqsim/thermo/component/Component.java
@@ -145,7 +145,7 @@ abstract class Component implements ComponentInterface {
   private double triplePointTemperature = 1000.0;
   double meltingPointTemperature = 110.0;
   private double idealGasEnthalpyOfFormation = 0.0;
-  double idealGasGibsEnergyOfFormation = 0.0;
+  double idealGasGibbsEnergyOfFormation = 0.0;
 
   double idealGasAbsoluteEntropy = 0.0;
 
@@ -363,7 +363,7 @@ public void createComponent(String component_name, double moles, double molesInP
 
         setIdealGasEnthalpyOfFormation(
             Double.parseDouble(dataSet.getString("EnthalpyOfFormation")));
-        idealGasGibsEnergyOfFormation = gibbsEnergyOfFormation;
+        idealGasGibbsEnergyOfFormation = gibbsEnergyOfFormation;
         idealGasAbsoluteEntropy = Double.parseDouble(dataSet.getString("AbsoluteEntropy"));
 
         for (int i = 0; i < 5; i++) {
@@ -656,8 +656,8 @@ public final double getIdealGasEnthalpyOfFormation() {
 
   /** {@inheritDoc} */
   @Override
-  public final double getIdealGasGibsEnergyOfFormation() {
-    return idealGasGibsEnergyOfFormation;
+  public final double getIdealGasGibbsEnergyOfFormation() {
+    return idealGasGibbsEnergyOfFormation;
   }
 
   /** {@inheritDoc} */

diff --git a/src/main/java/neqsim/thermo/component/ComponentInterface.java b/src/main/java/neqsim/thermo/component/ComponentInterface.java
@@ -685,8 +685,21 @@ public default double getTripplePointDensity() {
    * </p>
    *
    * @return a double
+   * @deprecated Replaced by {@link getIdealGasGibbsEnergyOfFormation}
    */
-  public double getIdealGasGibsEnergyOfFormation();
+  @Deprecated
+  public default double getIdealGasGibsEnergyOfFormation() {
+    return getIdealGasGibbsEnergyOfFormation();
+  }
+
+  /**
+   * <p>
+   * getIdealGasGibsEnergyOfFormation.
+   * </p>
+   *
+   * @return a double
+   */
+  public double getIdealGasGibbsEnergyOfFormation();
 
   /**
    * <p>

diff --git a/src/main/java/neqsim/thermo/phase/Phase.java b/src/main/java/neqsim/thermo/phase/Phase.java
@@ -1612,12 +1612,6 @@ public final double getPhaseFraction() {
     return getBeta();
   }
 
-  /** {@inheritDoc} */
-  @Override
-  public final double getBeta() {
-    return this.beta;
-  }
-
   /** {@inheritDoc} */
   @Override
   public double getdPdrho() {
@@ -1922,8 +1916,20 @@ public double[] groupTBPfractions() {
 
   /** {@inheritDoc} */
   @Override
-  public final void setBeta(double beta) {
-    this.beta = beta;
+  public final double getBeta() {
+    return this.beta;
+  }
+
+  /** {@inheritDoc} */
+  @Override
+  public final void setBeta(double b) {
+    if (b < 0) {
+      b = neqsim.thermo.ThermodynamicModelSettings.phaseFractionMinimumLimit;
+    }
+    if (b > 1) {
+      b = 1.0 - neqsim.thermo.ThermodynamicModelSettings.phaseFractionMinimumLimit;
+    }
+    this.beta = b;
   }
 
   /** {@inheritDoc} */

diff --git a/src/main/java/neqsim/thermo/phase/PhaseInterface.java b/src/main/java/neqsim/thermo/phase/PhaseInterface.java
@@ -590,16 +590,6 @@ public default double getExessGibbsEnergySymetric() {
    */
   public double getSresTP();
 
-  /**
-   * <p>
-   * Setter for property <code>beta</code>. Beta is the mole fraction of a phase of all the moles of
-   * a system.
-   * </p>
-   *
-   * @param b Beta value to set.
-   */
-  public void setBeta(double b);
-
   /**
    * <p>
    * setProperties. Transfer properties from another phase object.
@@ -629,13 +619,24 @@ public default double getExessGibbsEnergySymetric() {
 
   /**
    * <p>
-   * getBeta.
+   * Getter for property <code>beta</code>. Beta is the mole fraction of a phase of all the moles of
+   * a system.
    * </p>
    *
-   * @return a double
+   * @return Beta value
    */
   public double getBeta();
 
+  /**
+   * <p>
+   * Setter for property <code>beta</code>. Beta is the mole fraction of a phase of all the moles of
+   * a system.
+   * </p>
+   *
+   * @param b Beta value to set.
+   */
+  public void setBeta(double b);
+
   /**
    * <p>
    * getWtFrac.