added more field units (#985)

* added more field units

* more updates to units

* more field units

* add possibility to see available units

* fix test for units

* update text

* update

Author: EvenSol

src/main/java/neqsim/Units.java

@@ -8,13 +8,13 @@
 
 import java.util.ArrayList;
 import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import neqsim.physicalProperties.PhysicalPropertyHandler;
 import neqsim.thermo.ThermodynamicConstantsInterface;
 import neqsim.thermo.ThermodynamicModelSettings;
 import neqsim.thermo.component.ComponentInterface;
 import neqsim.thermo.system.SystemInterface;
 import neqsim.util.exception.InvalidInputException;
-import org.apache.logging.log4j.Logger;
 
 /**
  * Phase class.
@@ -122,7 +122,8 @@ public void addComponent(String name, double moles, int compNumber) {
     }
 
     if (this.hasComponent(name)) {
-      // shall use addMoles/addMolesChemreac to adding/subtracting moles for component.
+      // shall use addMoles/addMolesChemreac to adding/subtracting moles for
+      // component.
       throw new RuntimeException(new InvalidInputException(this, "addComponent", "name",
           "component with same name already exists in phase. Use addMoles or addMolesChemreac."));
     }
@@ -616,6 +617,9 @@ public double getMolarVolume(String unit) {
       case "litre/mol":
         conversionFactor = 1000.0;
         break;
+      case "ft3/lbmole":
+        conversionFactor = 16018.463373960138;
+        break;
       default:
         throw new RuntimeException("unit not supported " + unit);
     }
@@ -1000,6 +1004,9 @@ public double getCp(String unit) {
       case "kJ/kgK":
         conversionFactor = 1.0 / getNumberOfMolesInPhase() / getMolarMass() / 1000.0;
         break;
+      case "btu/lbmole-F":
+        conversionFactor = 1.0 / getNumberOfMolesInPhase() / getMolarMass() / 1000.0 * 0.2388;
+        break;
       default:
         break;
     }
@@ -1030,6 +1037,9 @@ public double getCv(String unit) {
       case "kJ/kgK":
         conversionFactor = 1.0 / getNumberOfMolesInPhase() / getMolarMass() / 1000.0;
         break;
+      case "btu/lbmole-F":
+        conversionFactor = 1.0 / getNumberOfMolesInPhase() / getMolarMass() / 1000.0 * 0.2388;
+        break;
       default:
         break;
     }
@@ -1165,6 +1175,9 @@ public double getEntropy(String unit) {
       case "kJ/kgK":
         conversionFactor = 1.0 / getNumberOfMolesInPhase() / getMolarMass() / 1000.0;
         break;
+      case "btu/lb-F":
+        conversionFactor = 1.0 / getNumberOfMolesInPhase() / getMolarMass() / 1000.0 * 0.2388;
+        break;
       default:
         throw new RuntimeException("unit not supported " + unit);
     }
@@ -1226,6 +1239,9 @@ public double getThermalConductivity(String unit) {
       case "W/cmK":
         conversionFactor = 0.01;
         break;
+      case "Btu/hr-ft-F":
+        conversionFactor = 0.5781759824;
+        break;
       default:
         throw new RuntimeException("unit not supported " + unit);
     }
@@ -1559,6 +1575,27 @@ public final double getMolarMass() {
     return tempVar;
   }
 
+  /** {@inheritDoc} */
+  @Override
+  public double getMolarMass(String unit) {
+    double refMolarMass = getMolarMass();
+    double conversionFactor = 1.0;
+    switch (unit) {
+      case "kg/mol":
+        conversionFactor = 1.0;
+        break;
+      case "gr/mol":
+        conversionFactor = 1000.0;
+        break;
+      case "lbm/lbmol":
+        conversionFactor = 1000.0;
+        break;
+      default:
+        throw new RuntimeException("unit not supported " + unit);
+    }
+    return refMolarMass * conversionFactor;
+  }
+
   /** {@inheritDoc} */
   @Override
   public double getJouleThomsonCoefficient(String unit) {
@@ -1571,6 +1608,12 @@ public double getJouleThomsonCoefficient(String unit) {
       case "C/bar":
         conversionFactor = 1.0;
         break;
+      case "K/Pa":
+        conversionFactor = 1.0e-5;
+        break;
+      case "F/psi":
+        conversionFactor = 1.8 * 1.0 / 14.503773773;
+        break;
       default:
         throw new RuntimeException("unit not supported " + unit);
     }
@@ -2093,6 +2136,27 @@ public double getSoundSpeed() {
     throw new UnsupportedOperationException("Unimplemented method 'getSoundSpeed'");
   }
 
+  /** {@inheritDoc} */
+  @Override
+  public double getSoundSpeed(String unit) {
+    double refVel = getSoundSpeed();
+    double conversionFactor = 1.0;
+    switch (unit) {
+      case "m/s":
+        conversionFactor = 1.0;
+        break;
+      case "km/hr":
+        conversionFactor = 3.6;
+        break;
+      case "ft/sec":
+        conversionFactor = 3.280839895;
+        break;
+      default:
+        break;
+    }
+    return refVel * conversionFactor;
+  }
+
   /** {@inheritDoc} */
   @Override
   public ComponentInterface getComponentWithIndex(int index) {

src/main/java/neqsim/thermo/phase/Phase.java

@@ -336,7 +336,6 @@ public void init(double totalNumberOfMoles, int numberOfComponents, int initType
    */
   public ComponentInterface[] getcomponentArray();
 
-
   /**
    * Get normalized names of components in phase.
    *
@@ -1390,6 +1389,14 @@ public default void addMolesChemReac(int component, double dn) {
    */
   public double getMolarMass();
 
+  /**
+   * method to get molar mass of a fluid phase.
+   *
+   * @param unit Supported units are kg/mol, gr/mol
+   * @return molar mass in specified unit
+   */
+  public double getMolarMass(String unit);
+
   /**
    * <p>
    * getInternalEnergy.
@@ -1973,4 +1980,13 @@ public default boolean hasComponent(String name) {
    * @return speed of sound in m/s
    */
   public double getSoundSpeed();
+
+  /**
+   * method to get the speed of sound of a system. The sound speed is implemented based on a molar
+   * average over the phases
+   *
+   * @param unit Supported units are m/s, km/h
+   * @return speed of sound in m/s
+   */
+  public double getSoundSpeed(String unit);
 }