refact: mark classes abstract and simplify imports (#1151)

equinor · Oct 27, 2024 · 0eaec68 · 0eaec68
1 parent 793eea2
commit 0eaec68
Show file tree

Hide file tree

Showing 35 changed files with 139 additions and 158 deletions.
diff --git a/src/main/java/neqsim/physicalproperties/PhysicalPropertyType.java b/src/main/java/neqsim/physicalproperties/PhysicalPropertyType.java
@@ -7,12 +7,12 @@
  *
  * @author ASMF
  */
-
 public enum PhysicalPropertyType {
   MASS_DENSITY, DYNAMIC_VISCOSITY, THERMAL_CONDUCTIVITY;
 
   // We know we'll never mutate this, so we can keep
   // a local copy for fast lookup in byName
+  /** Constant <code>copyOfValues</code> */
   private static final PhysicalPropertyType[] copyOfValues = values();
 
   /**

diff --git a/...s/physicalpropertymethods/commonphasephysicalproperties/CommonPhysicalPropertyMethod.java b/...s/physicalpropertymethods/commonphasephysicalproperties/CommonPhysicalPropertyMethod.java
@@ -1,5 +1,8 @@
 package neqsim.physicalproperties.physicalpropertymethods.commonphasephysicalproperties;
 
+import neqsim.physicalproperties.physicalpropertymethods.PhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface;
+
 /**
  * <p>
  * CommonPhysicalPropertyMethod class.
@@ -8,8 +11,7 @@
  * @author Even Solbraa
  * @version $Id: $Id
  */
-public class CommonPhysicalPropertyMethod
-    extends neqsim.physicalproperties.physicalpropertymethods.PhysicalPropertyMethod {
+public abstract class CommonPhysicalPropertyMethod extends PhysicalPropertyMethod {
   private static final long serialVersionUID = 1000;
 
   protected neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface phase;
@@ -23,15 +25,13 @@ public class CommonPhysicalPropertyMethod
    *        {@link neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface}
    *        object
    */
-  public CommonPhysicalPropertyMethod(
-      neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface phase) {
+  public CommonPhysicalPropertyMethod(PhysicalPropertiesInterface phase) {
     this.phase = phase;
   }
 
   /** {@inheritDoc} */
   @Override
-  public void setPhase(
-      neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface phase) {
+  public void setPhase(PhysicalPropertiesInterface phase) {
     this.phase = phase;
   }
 }
diff --git a/...ties/physicalpropertymethods/commonphasephysicalproperties/conductivity/Conductivity.java b/...ties/physicalpropertymethods/commonphasephysicalproperties/conductivity/Conductivity.java
@@ -2,16 +2,16 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import neqsim.physicalproperties.physicalpropertymethods.commonphasephysicalproperties.CommonPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.ConductivityInterface;
 
 /**
- * Class for physical property Conductivity.
+ * Abstract class for Conductivity.
  *
  * @author Even Solbraa
  */
-abstract class Conductivity extends
-    neqsim.physicalproperties.physicalpropertymethods.commonphasephysicalproperties.CommonPhysicalPropertyMethod
-    implements
-    neqsim.physicalproperties.physicalpropertymethods.methodinterface.ConductivityInterface {
+public abstract class Conductivity extends CommonPhysicalPropertyMethod
+    implements ConductivityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Conductivity.class);
 

diff --git a/...opertymethods/commonphasephysicalproperties/conductivity/PFCTConductivityMethodMod86.java b/...opertymethods/commonphasephysicalproperties/conductivity/PFCTConductivityMethodMod86.java
@@ -6,7 +6,7 @@
 
 /**
  * <p>
- * PFCTConductivityMethodMod86 class.
+ * PFCTConductivityMethodMod86 class extending conductivity for commonphase.
  * </p>
  *
  * @author esol

diff --git a/...erties/physicalpropertymethods/commonphasephysicalproperties/diffusivity/Diffusivity.java b/...erties/physicalpropertymethods/commonphasephysicalproperties/diffusivity/Diffusivity.java
@@ -3,6 +3,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import neqsim.physicalproperties.physicalpropertymethods.commonphasephysicalproperties.CommonPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.DiffusivityInterface;
 
 /**
  * <p>
@@ -12,8 +13,7 @@
  * @author Even Solbraa
  * @version $Id: $Id
  */
-public class Diffusivity extends CommonPhysicalPropertyMethod implements
-    neqsim.physicalproperties.physicalpropertymethods.methodinterface.DiffusivityInterface {
+public class Diffusivity extends CommonPhysicalPropertyMethod implements DiffusivityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Diffusivity.class);
 

diff --git a/...properties/physicalpropertymethods/commonphasephysicalproperties/viscosity/Viscosity.java b/...properties/physicalpropertymethods/commonphasephysicalproperties/viscosity/Viscosity.java
@@ -2,16 +2,15 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import neqsim.physicalproperties.physicalpropertymethods.commonphasephysicalproperties.CommonPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.ViscosityInterface;
 
 /**
  * Abstract class for Viscosity property.
  *
  * @author Even Solbraa
  */
-abstract class Viscosity extends
-    neqsim.physicalproperties.physicalpropertymethods.commonphasephysicalproperties.CommonPhysicalPropertyMethod
-    implements
-    neqsim.physicalproperties.physicalpropertymethods.methodinterface.ViscosityInterface {
+public abstract class Viscosity extends CommonPhysicalPropertyMethod implements ViscosityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Viscosity.class);
 

diff --git a/...alproperties/physicalpropertymethods/gasphysicalproperties/GasPhysicalPropertyMethod.java b/...alproperties/physicalpropertymethods/gasphysicalproperties/GasPhysicalPropertyMethod.java
@@ -1,5 +1,8 @@
 package neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties;
 
+import neqsim.physicalproperties.physicalpropertymethods.PhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface;
+
 /**
  * <p>
  * GasPhysicalPropertyMethod class.
@@ -8,23 +11,14 @@
  * @author Even Solbraa
  * @version $Id: $Id
  */
-public class GasPhysicalPropertyMethod
-    extends neqsim.physicalproperties.physicalpropertymethods.PhysicalPropertyMethod {
+public abstract class GasPhysicalPropertyMethod extends PhysicalPropertyMethod {
   private static final long serialVersionUID = 1000;
 
   protected neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface gasPhase;
   public double[][] binaryMolecularDiameter;
   public double[][] binaryEnergyParameter;
   public double[][] binaryMolecularMass;
 
-  /**
-   * <p>
-   * Constructor for GasPhysicalPropertyMethod.
-   * </p>
-   */
-  public GasPhysicalPropertyMethod() {
-  }
-
   /**
    * <p>
    * Constructor for GasPhysicalPropertyMethod.
@@ -34,8 +28,7 @@ public GasPhysicalPropertyMethod() {
    *        {@link neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface}
    *        object
    */
-  public GasPhysicalPropertyMethod(
-      neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface gasPhase) {
+  public GasPhysicalPropertyMethod(PhysicalPropertiesInterface gasPhase) {
     this.gasPhase = gasPhase;
     binaryMolecularDiameter = new double[gasPhase.getPhase().getNumberOfComponents()][gasPhase
         .getPhase().getNumberOfComponents()];

diff --git a/...s/physicalpropertymethods/gasphysicalproperties/conductivity/ChungConductivityMethod.java b/...s/physicalpropertymethods/gasphysicalproperties/conductivity/ChungConductivityMethod.java
@@ -2,7 +2,7 @@
 
 /**
  * <p>
- * ChungConductivityMethod class.
+ * ChungConductivityMethod class extending conductivity for gases.
  * </p>
  *
  * @author Even Solbraa

diff --git a/...alproperties/physicalpropertymethods/gasphysicalproperties/conductivity/Conductivity.java b/...alproperties/physicalpropertymethods/gasphysicalproperties/conductivity/Conductivity.java
@@ -8,16 +8,16 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties.GasPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.ConductivityInterface;
 
 /**
- * Abstract class Conductivity.
+ * Abstract class Conductivity for gases.
  *
  * @author Even Solbraa
  */
-abstract class Conductivity extends
-    neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties.GasPhysicalPropertyMethod
-    implements
-    neqsim.physicalproperties.physicalpropertymethods.methodinterface.ConductivityInterface {
+public abstract class Conductivity extends GasPhysicalPropertyMethod
+    implements ConductivityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Conductivity.class);
 

diff --git a/...sim/physicalproperties/physicalpropertymethods/gasphysicalproperties/density/Density.java b/...sim/physicalproperties/physicalpropertymethods/gasphysicalproperties/density/Density.java
@@ -9,17 +9,17 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties.GasPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.DensityInterface;
 
 /**
  * <p>
- * Density class.
+ * Density class for gases.
  * </p>
  *
  * @author Even Solbraa
  * @version $Id: $Id
  */
-public class Density extends GasPhysicalPropertyMethod
-    implements neqsim.physicalproperties.physicalpropertymethods.methodinterface.DensityInterface {
+public class Density extends GasPhysicalPropertyMethod implements DensityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Density.class);
 
@@ -28,13 +28,13 @@ public class Density extends GasPhysicalPropertyMethod
    * Constructor for Density.
    * </p>
    *
-   * @param gasPhase a
+   * @param phase a
    *        {@link neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface}
    *        object
    */
   public Density(
-      neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface gasPhase) {
-    this.gasPhase = gasPhase;
+      neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface phase) {
+    super(phase);
   }
 
   /** {@inheritDoc} */

diff --git a/...icalproperties/physicalpropertymethods/gasphysicalproperties/diffusivity/Diffusivity.java b/...icalproperties/physicalpropertymethods/gasphysicalproperties/diffusivity/Diffusivity.java
@@ -2,6 +2,8 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties.GasPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.DiffusivityInterface;
 
 /**
  * <p>
@@ -11,10 +13,7 @@
  * @author Even Solbraa
  * @version $Id: $Id
  */
-public class Diffusivity extends
-    neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties.GasPhysicalPropertyMethod
-    implements
-    neqsim.physicalproperties.physicalpropertymethods.methodinterface.DiffusivityInterface {
+public class Diffusivity extends GasPhysicalPropertyMethod implements DiffusivityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Diffusivity.class);
 

diff --git a/...erties/physicalpropertymethods/gasphysicalproperties/diffusivity/WilkeLeeDiffusivity.java b/...erties/physicalpropertymethods/gasphysicalproperties/diffusivity/WilkeLeeDiffusivity.java
@@ -11,7 +11,9 @@
 public class WilkeLeeDiffusivity extends Diffusivity {
   private static final long serialVersionUID = 1000;
 
-  double[][] binaryDiffusionCoefficients, binaryLennardJonesOmega;
+  double[][] binaryDiffusionCoefficients;
+
+  double[][] binaryLennardJonesOmega;
 
   /**
    * <p>
@@ -38,8 +40,14 @@ public double calcBinaryDiffusionCoefficient(int i, int j, int method) {
     // if(method==? then)
     // remember this is the Fick's diffusion coefficients
     // to get the Maxwell-Stefan coefficient - multiply by gamma
-    double A2 = 1.06036, B2 = 0.15610, C2 = 0.19300, D2 = 0.47635, E2 = 1.03587, F2 = 1.52996,
-        G2 = 1.76474, H2 = 3.89411;
+    double A2 = 1.06036;
+    double B2 = 0.15610;
+    double C2 = 0.19300;
+    double D2 = 0.47635;
+    double E2 = 1.03587;
+    double F2 = 1.52996;
+    double G2 = 1.76474;
+    double H2 = 3.89411;
     double tempVar2 = gasPhase.getPhase().getTemperature() / binaryEnergyParameter[i][j];
     binaryLennardJonesOmega[i][j] = A2 / Math.pow(tempVar2, B2) + C2 / Math.exp(D2 * tempVar2)
         + E2 / Math.exp(F2 * tempVar2) + G2 / Math.exp(H2 * tempVar2);

diff --git a/...physicalproperties/physicalpropertymethods/gasphysicalproperties/viscosity/Viscosity.java b/...physicalproperties/physicalpropertymethods/gasphysicalproperties/viscosity/Viscosity.java
@@ -2,16 +2,15 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties.GasPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.ViscosityInterface;
 
 /**
- * * Abstract class for Viscosity property.
+ * Abstract class for Viscosity property.
  *
  * @author Even Solbraa
  */
-abstract class Viscosity extends
-    neqsim.physicalproperties.physicalpropertymethods.gasphysicalproperties.GasPhysicalPropertyMethod
-    implements
-    neqsim.physicalproperties.physicalpropertymethods.methodinterface.ViscosityInterface {
+public abstract class Viscosity extends GasPhysicalPropertyMethod implements ViscosityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Viscosity.class);
 

diff --git a/...erties/physicalpropertymethods/liquidphysicalproperties/LiquidPhysicalPropertyMethod.java b/...erties/physicalpropertymethods/liquidphysicalproperties/LiquidPhysicalPropertyMethod.java
@@ -1,5 +1,8 @@
 package neqsim.physicalproperties.physicalpropertymethods.liquidphysicalproperties;
 
+import neqsim.physicalproperties.physicalpropertymethods.PhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface;
+
 /**
  * <p>
  * LiquidPhysicalPropertyMethod class.
@@ -8,20 +11,11 @@
  * @author Even Solbraa
  * @version $Id: $Id
  */
-public class LiquidPhysicalPropertyMethod
-    extends neqsim.physicalproperties.physicalpropertymethods.PhysicalPropertyMethod {
+public abstract class LiquidPhysicalPropertyMethod extends PhysicalPropertyMethod {
   private static final long serialVersionUID = 1000;
 
   protected neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface liquidPhase;
 
-  /**
-   * <p>
-   * Constructor for LiquidPhysicalPropertyMethod.
-   * </p>
-   */
-  public LiquidPhysicalPropertyMethod() {
-  }
-
   /**
    * <p>
    * Constructor for LiquidPhysicalPropertyMethod.
@@ -31,15 +25,13 @@ public LiquidPhysicalPropertyMethod() {
    *        {@link neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface}
    *        object
    */
-  public LiquidPhysicalPropertyMethod(
-      neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface liquidPhase) {
-    this.liquidPhase = liquidPhase;
+  public LiquidPhysicalPropertyMethod(PhysicalPropertiesInterface liquidPhase) {
+    setPhase(liquidPhase);
   }
 
   /** {@inheritDoc} */
   @Override
-  public void setPhase(
-      neqsim.physicalproperties.physicalpropertysystem.PhysicalPropertiesInterface phase) {
+  public void setPhase(PhysicalPropertiesInterface phase) {
     this.liquidPhase = phase;
   }
 }
diff --git a/...roperties/physicalpropertymethods/liquidphysicalproperties/conductivity/Conductivity.java b/...roperties/physicalpropertymethods/liquidphysicalproperties/conductivity/Conductivity.java
@@ -8,19 +8,18 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import neqsim.physicalproperties.physicalpropertymethods.liquidphysicalproperties.LiquidPhysicalPropertyMethod;
+import neqsim.physicalproperties.physicalpropertymethods.methodinterface.ConductivityInterface;
 
 /**
  * <p>
- * Conductivity class.
+ * Conductivity class for liquids.
  * </p>
  *
  * @author Even Solbraa
  * @version $Id: $Id
  */
-public class Conductivity extends
-    neqsim.physicalproperties.physicalpropertymethods.liquidphysicalproperties.LiquidPhysicalPropertyMethod
-    implements
-    neqsim.physicalproperties.physicalpropertymethods.methodinterface.ConductivityInterface {
+public class Conductivity extends LiquidPhysicalPropertyMethod implements ConductivityInterface {
   private static final long serialVersionUID = 1000;
   static Logger logger = LogManager.getLogger(Conductivity.class);