javadoc warning fix, docfix and formatting style (#1355)

Author: asmfstatoil

src/main/java/neqsim/physicalproperties/interfaceproperties/surfacetension/SurfaceTensionInterface.java

@@ -17,7 +17,7 @@
 public interface SurfaceTensionInterface {
   /**
    * <p>
-   * calcSurfaceTension. Calculates the surfacetension.
+   * Calculates the surface tension between two phases.
    * </p>
    *
    * @param interface1 Phase index 1

src/main/java/neqsim/physicalproperties/methods/commonphasephysicalproperties/viscosity/MethaneViscosityMethod.java

@@ -19,13 +19,12 @@ public MethaneViscosityMethod(PhysicalProperties phase) {
   public double calcViscosity() {
 
     // Check if there are other components than methane
-    if (phase.getPhase().getNumberOfComponents() > 1 
-      || !phase.getPhase().getComponent(0).getName().equalsIgnoreCase("methane")) {
+    if (phase.getPhase().getNumberOfComponents() > 1
+        || !phase.getPhase().getComponent(0).getName().equalsIgnoreCase("methane")) {
       throw new Error("Methane viscosity model only supports PURE METHANE.");
     }
 
-    //The following is exactly the same as LBCViscosityMethod
-
+    // The following is exactly the same as LBCViscosityMethod
     double[] a = {0.10230, 0.023364, 0.058533, -0.040758, 0.0093324};
 
     double T = phase.getPhase().getTemperature();
@@ -75,19 +74,27 @@ public double calcViscosity() {
     viscosity_LBC /= 1.0e3;
     // System.out.println("visc " + viscosity);
 
-
-    //HERE ARE THE CORRECTION TERMS:
-    double term_A = 0.0;  //Declaring the variable so that it can be changed 
+    // HERE ARE THE CORRECTION TERMS:
+    double term_A = 0.0; // Declaring the variable so that it can be changed
     if (T >= 345) {
-      term_A = 1.1 * Math.pow(T/345 - 1, 1.2);
+      term_A = 1.1 * Math.pow(T / 345 - 1, 1.2);
     } else {
-      term_A = 0.64*(T/345 - 1) * (1 - 0.4*Math.exp(-Math.pow(T-298.15, 2) / 100)/(1+Math.exp(-(P-21))));
+      term_A = 0.64 * (T / 345 - 1)
+          * (1 - 0.4 * Math.exp(-Math.pow(T - 298.15, 2) / 100) / (1 + Math.exp(-(P - 21))));
     }
 
-    double A = Math.pow(10, -6) * ( term_A + 0.27 * Math.exp(-Math.pow(T-430, 2) / 9000) * Math.exp(-Math.pow(P-21, 2) / 35)/(1+Math.exp(-(P-15))) );
-    double B = Math.pow(10, -8) * (  1.2 * Math.pow(300/T, 3) * Math.pow(P, 1.2)/(1+Math.exp(-0.6*(P-20))) + 30 * (1 - T/400) * Math.exp(-Math.pow(P-15, 2) / 20) + 13*Math.exp(-Math.pow(P-12.8, 2) / 7) );
-    double C = Math.pow(10, -8) * ( 1/(1+Math.exp((P-15)))*( 2*P * Math.exp(-Math.pow(T-375, 2) / 10000) + 8.0 * (P/4 - 1)) + 10.0 * Math.exp(-Math.pow(T-260, 2) / 300)/(1+Math.exp(0.9*(P-12))) );
-    double D = Math.pow(10, -6) * ( 0.62 * (1 - T/430) * 1/(1+Math.exp(-0.5*(P-26))) + 0.306*Math.exp(-Math.pow(T-270, 2)/50)/(1+Math.exp(-(P-25))) - (265.2/T) * Math.exp(-Math.pow(T-270, 2)/160)/(1+Math.exp(-0.5*(P-25))) );
+    double A = Math.pow(10, -6) * (term_A + 0.27 * Math.exp(-Math.pow(T - 430, 2) / 9000)
+        * Math.exp(-Math.pow(P - 21, 2) / 35) / (1 + Math.exp(-(P - 15))));
+    double B = Math.pow(10, -8)
+        * (1.2 * Math.pow(300 / T, 3) * Math.pow(P, 1.2) / (1 + Math.exp(-0.6 * (P - 20)))
+            + 30 * (1 - T / 400) * Math.exp(-Math.pow(P - 15, 2) / 20)
+            + 13 * Math.exp(-Math.pow(P - 12.8, 2) / 7));
+    double C = Math.pow(10, -8) * (1 / (1 + Math.exp((P - 15)))
+        * (2 * P * Math.exp(-Math.pow(T - 375, 2) / 10000) + 8.0 * (P / 4 - 1))
+        + 10.0 * Math.exp(-Math.pow(T - 260, 2) / 300) / (1 + Math.exp(0.9 * (P - 12))));
+    double D = Math.pow(10, -6) * (0.62 * (1 - T / 430) * 1 / (1 + Math.exp(-0.5 * (P - 26)))
+        + 0.306 * Math.exp(-Math.pow(T - 270, 2) / 50) / (1 + Math.exp(-(P - 25)))
+        - (265.2 / T) * Math.exp(-Math.pow(T - 270, 2) / 160) / (1 + Math.exp(-0.5 * (P - 25))));
 
     double eta = viscosity_LBC + A - B + C - D;
 

src/main/java/neqsim/physicalproperties/methods/commonphasephysicalproperties/viscosity/PFCTViscosityMethodMod86.java

@@ -25,7 +25,7 @@ public class PFCTViscosityMethodMod86 extends Viscosity {
   // todo: is this parameter required?
   int phaseTypeNumb = 1;
   double[] GVcoef = {-2.090975e5, 2.647269e5, -1.472818e5, 4.716740e4, -9.491872e3, 1.219979e3,
-                      -9.627993e1, 4.274152, -8.141531e-2};
+      -9.627993e1, 4.274152, -8.141531e-2};
   double visRefA = 1.696985927;
   double visRefB = -0.133372346;
   double visRefC = 1.4;
@@ -34,7 +34,7 @@ public class PFCTViscosityMethodMod86 extends Viscosity {
   double visRefG = 0.0;
 
   double[] viscRefJ = {-1.035060586e1, 1.7571599671e1, -3.0193918656e3, 1.8873011594e2,
-                        4.2903609488e-2, 1.4529023444e2, 6.1276818706e3};
+      4.2903609488e-2, 1.4529023444e2, 6.1276818706e3};
   double[] viscRefK = {-9.74602, 18.0834, -4126.66, 44.6055, 0.976544, 81.8134, 15649.9};
 
   /**
@@ -93,7 +93,8 @@ public double calcViscosity() {
     }
     PCmix = 8.0 * tempPC1 / (tempPC2 * tempPC2);
     double TCmix = tempTC1 / tempTC2;
-    double Mmix = (Mmtemp + 1.304e-4 * (Math.pow(Mwtemp / Mmtemp, 2.303) - Math.pow(Mmtemp, 2.303))) * 1e3; // phase.getPhase().getMolarMass();
+    double Mmix =
+        (Mmtemp + 1.304e-4 * (Math.pow(Mwtemp / Mmtemp, 2.303) - Math.pow(Mmtemp, 2.303))) * 1e3; // phase.getPhase().getMolarMass();
 
     referenceSystem.setTemperature(phase.getPhase().getTemperature());
     referenceSystem.setPressure(phase.getPhase().getPressure());
@@ -106,14 +107,14 @@ public double calcViscosity() {
     double alfaMix = 1.0 + 7.378e-3 * Math.pow(redDens, 1.847) * Math.pow(Mmix, 0.5173);
     double alfa0 = 1.0 + 7.378e-3 * Math.pow(redDens, 1.847)
         * Math.pow(referenceSystem.getMolarMass() * 1.0e3, 0.5173);
-    
+
     double T0 = phase.getPhase().getTemperature()
         * referenceSystem.getPhase(0).getComponent(0).getTC() / TCmix * alfa0 / alfaMix;
     double P0 = phase.getPhase().getPressure() * referenceSystem.getPhase(0).getComponent(0).getPC()
         / PCmix * alfa0 / alfaMix;
 
     double refVisosity = getRefComponentViscosity(T0, P0);
-    
+
     double viscosity = refVisosity * Math.pow(TCmix / Tc0, -1.0 / 6.0)
         * Math.pow(PCmix / Pc0, 2.0 / 3.0) * Math.pow(Mmix / M0, 0.5) * alfaMix / alfa0;
     return viscosity;
@@ -132,36 +133,31 @@ public double getRefComponentViscosity(double temp, double pres) {
     referenceSystem.setTemperature(temp);
     referenceSystem.setPressure(pres);
     referenceSystem.init(1);
-    double molDens = referenceSystem.getLowestGibbsEnergyPhase().getDensity() * 1e-3;  //[kg/L]
-    double critMolDens = 162.66e-3; //[kg/L] (Source: NIST)
+    double molDens = referenceSystem.getLowestGibbsEnergyPhase().getDensity() * 1e-3; // [kg/L]
+    double critMolDens = 162.66e-3; // [kg/L] (Source: NIST)
     double redMolDens = (molDens - critMolDens) / critMolDens;
-    
+
     double viscRefO = 0.0;
     for (int i = 0; i < GVcoef.length; i++) {
       viscRefO += GVcoef[i] * Math.pow(temp, ((i + 1) - 4) / 3.0);
     }
 
-    
-    //Calculating the reference viscosity contributions:
+    // Calculating the reference viscosity contributions:
     double temp1 = Math.pow(molDens, 0.1) * (viscRefJ[1] + viscRefJ[2] / Math.pow(temp, 3.0 / 2.0));
     double temp2 = redMolDens * Math.pow(molDens, 0.5)
         * (viscRefJ[4] + viscRefJ[5] / temp + viscRefJ[6] / Math.pow(temp, 2.0));
     double temp3 = Math.exp(temp1 + temp2);
 
-    double dTfreeze = temp - 90.69;
-    double HTAN =
-        (Math.exp(dTfreeze) - Math.exp(-dTfreeze)) / (Math.exp(dTfreeze) + Math.exp(-dTfreeze));
-    
-    //This compensates for that the HTAN function is not defined for dTfreeze > 709.0:
-    if (dTfreeze > 709.0) { 
-      double visRefE = 1.0;
-      double visRefG = 0.0;
-    } else {
-      double visRefE = (HTAN + 1.0) / 2.0;
-      double visRefG = (1.0 - HTAN) / 2.0;
-    }
+    /*
+     * double dTfreeze = temp - 90.69; double HTAN = (Math.exp(dTfreeze) - Math.exp(-dTfreeze)) /
+     * (Math.exp(dTfreeze) + Math.exp(-dTfreeze)); // This compensates for that the HTAN function is
+     * not defined for dTfreeze > 709.0: if (dTfreeze > 709.0) { double visRefE = 1.0; double
+     * visRefG = 0.0; } else { double visRefE = (HTAN + 1.0) / 2.0; double visRefG = (1.0 - HTAN) /
+     * 2.0; }
+     */
 
-    double viscRef1 = (visRefA + visRefB * Math.pow(visRefC - Math.log(temp / visRefF), 2.0)) * molDens;
+    double viscRef1 =
+        (visRefA + visRefB * Math.pow(visRefC - Math.log(temp / visRefF), 2.0)) * molDens;
     double viscRef2 = visRefE * Math.exp(viscRefJ[0] + viscRefJ[3] / temp) * (temp3 - 1.0);
 
     double temp4 = Math.pow(molDens, 0.1) * (viscRefK[1] + viscRefK[2] / Math.pow(temp, 3.0 / 2.0));

src/main/java/neqsim/process/equipment/ProcessEquipmentBaseClass.java

@@ -240,7 +240,6 @@ public void setTemperature(double temperature) {
     getFluid().setTemperature(temperature);
   }
 
-
   /** {@inheritDoc} */
   @Override
   public void setPressure(double pressure) {
@@ -355,7 +354,6 @@ public void setMinimumFlow(double minimumFlow) {
     this.minimumFlow = minimumFlow;
   }
 
-
   /**
    * <p>
    * Getter for the field <code>isActive</code>.

src/main/java/neqsim/process/equipment/adsorber/SimpleAdsorber.java

@@ -36,9 +36,11 @@ public class SimpleAdsorber extends ProcessEquipmentBaseClass {
   private double stageEfficiency = 0.25;
 
   /**
-   * {@inheritDoc}
+   * <p>
+   * Constructor for SimpleAdsorber.
+   * </p>
    *
-   * @param name a {@link java.lang.String} object
+   * @param name name of the unit operation
    */
   public SimpleAdsorber(String name) {
     super(name);

src/main/java/neqsim/process/equipment/compressor/Compressor.java

@@ -1889,13 +1889,7 @@ public double getActualCompressionRatio() {
     return actualCompressionRatio;
   }
 
-  /**
-   * {@inheritDoc}
-   *
-   * <p>
-   * Set CompressorChartType
-   * </p>
-   */
+  /** {@inheritDoc} */
   public void setCompressorChartType(String type) {
     if (type.equals("simple") || type.equals("fan law")) {
       compressorChart = new CompressorChart();
@@ -1969,5 +1963,4 @@ public boolean isLimitSpeed() {
   public void setLimitSpeed(boolean limitSpeed) {
     this.limitSpeed = limitSpeed;
   }
-
 }

src/main/java/neqsim/process/equipment/compressor/CompressorChart.java

@@ -83,13 +83,16 @@ public void addCurve(double speed, double[] flow, double[] head,
   /**
    * {@inheritDoc}
    *
+   * <p>
    * This method initializes the compressor performance curves, including speed, flow, head, and
    * polytropic efficiency.
+   * </p>
    *
    * <p>
    * The method takes chart conditions and initializes internal variables for different performance
    * parameters based on input arrays for speed, flow, head, and polytropic efficiency. It also
    * normalizes these parameters by calculating reduced values based on speed.
+   * </p>
    */
   @Override
   public void setCurves(double[] chartConditions, double[] speed, double[][] flow, double[][] head,
@@ -100,13 +103,16 @@ public void setCurves(double[] chartConditions, double[] speed, double[][] flow,
   /**
    * {@inheritDoc}
    *
+   * <p>
    * This method initializes the compressor performance curves, including speed, flow, head, and
    * polytropic efficiency.
+   * </p>
    *
    * <p>
    * The method takes chart conditions and initializes internal variables for different performance
    * parameters based on input arrays for speed, flow, head, and polytropic efficiency. It also
    * normalizes these parameters by calculating reduced values based on speed.
+   * </p>
    */
   @Override
   public void setCurves(double[] chartConditions, double[] speed, double[][] flow, double[][] head,

src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookup.java

@@ -179,25 +179,27 @@ public void addCurve(double speed, double[] flow, double[] head,
     chartSpeeds.add(speed);
   }
 
-  /** {@inheritDoc} */
   /**
    * {@inheritDoc}
    *
+   * <p>
    * Sets the compressor curves based on the provided chart conditions, speed, flow, head, and
    * polytropic efficiency values.
+   * </p>
    */
   @Override
   public void setCurves(double[] chartConditions, double[] speed, double[][] flow, double[][] head,
       double[][] polyEff) {
     setCurves(chartConditions, speed, flow, head, flow, polyEff);
   }
 
-  /** {@inheritDoc} */
   /**
    * {@inheritDoc}
    *
+   * <p>
    * Sets the compressor curves based on the provided chart conditions, speed, flow, head,
    * flowPolytrpicEfficiency and polytropic efficiency values.
+   * </p>
    */
   @Override
   public void setCurves(double[] chartConditions, double[] speed, double[][] flow, double[][] head,
@@ -256,14 +258,13 @@ public ArrayList<Double> getClosestRefSpeeds(double speed) {
     return closestRefSpeeds;
   }
 
-  /** {@inheritDoc} */
   /**
    * {@inheritDoc}
    *
-   * Calculates the polytropic head for a given flow and speed.
-   *
+   * <p>
    * This method interpolates the polytropic head values from reference speeds closest to the given
    * speed and averages them to estimate the polytropic head at the specified flow and speed.
+   * </p>
    */
   @Override
   public double getPolytropicHead(double flow, double speed) {
@@ -289,13 +290,14 @@ public double getPolytropicHead(double flow, double speed) {
     return sum / tempHeads.size();
   }
 
-  /** {@inheritDoc} */
   /**
    * {@inheritDoc}
    *
+   * <p>
    * Calculates the polytropic efficiency of the compressor for a given flow and speed. The method
    * interpolates the efficiency values from reference speed curves and averages them to estimate
    * the efficiency at the specified conditions.
+   * </p>
    */
   @Override
   public double getPolytropicEfficiency(double flow, double speed) {

src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookupExtrapolate.java

@@ -118,8 +118,10 @@ public double getPolytropicHead(double flow, double speed) {
   /**
    * {@inheritDoc}
    *
+   * <p>
    * Calculates the polytropic efficiency for a given flow and speed by interpolating or
    * extrapolating between reference compressor curves.
+   * </p>
    */
   @Override
   public double getPolytropicEfficiency(double flow, double speed) {

src/main/java/neqsim/process/equipment/distillation/Condenser.java

@@ -28,6 +28,15 @@ public class Condenser extends SimpleTray {
   private double reflux_value;
   private String reflux_unit;
 
+  /**
+   * Constructor for the Condenser class.
+   *
+   * @param name a {@link java.lang.String} object
+   */
+  public Condenser(String name) {
+    super(name);
+  }
+
   /**
    * Checks if the separation process involves liquid reflux.
    *
@@ -64,15 +73,6 @@ public void setTotalCondenser(boolean isTotalCondenser) {
     this.totalCondenser = isTotalCondenser;
   }
 
-  /**
-   * {@inheritDoc}
-   *
-   * @param name a {@link java.lang.String} object
-   */
-  public Condenser(String name) {
-    super(name);
-  }
-
   /**
    * <p>
    * Getter for the field <code>refluxRatio</code>.
@@ -129,13 +129,7 @@ public StreamInterface getProductOutStream() {
     return getGasOutStream();
   }
 
-  /**
-   * {@inheritDoc}
-   *
-   * <p>
-   * getLiquidOutStream.
-   * </p>
-   */
+  /** {@inheritDoc} */
   @Override
   public StreamInterface getLiquidOutStream() {
     if (totalCondenser || separation_with_liquid_reflux) {
@@ -145,13 +139,7 @@ public StreamInterface getLiquidOutStream() {
     }
   }
 
-  /**
-   * {@inheritDoc}
-   *
-   * <p>
-   * getLiquidOutStream.
-   * </p>
-   */
+  /** {@inheritDoc} */
   public StreamInterface getLiquidProductStream() {
     if (separation_with_liquid_reflux) {
       return mixedStreamSplitter.getSplitStream(1);
@@ -160,7 +148,6 @@ public StreamInterface getLiquidProductStream() {
     }
   }
 
-
   /** {@inheritDoc} */
   @Override
   public void run(UUID id) {