chore: clean up workflows

src/main/java/neqsim/PVTsimulation/simulation/BasePVTsimulation.java

@@ -169,6 +169,8 @@ public double getZsaturation() {
   }
 
   /**
+   * <p>Getter for the field <code>saturationTemperature</code>.</p>
+   *
    * @return the saturationTemperature
    */
   public double getSaturationTemperature() {

src/main/java/neqsim/api/ioc/CalculationResult.java

@@ -3,15 +3,26 @@
 import java.util.Arrays;
 
 /**
+ * <p>CalculationResult class.</p>
  *
  * @author jo.lyshoel
+ * @version $Id: $Id
  */
 public class CalculationResult {
   public Double[][] fluidProperties;
   public String[] calculationError;
 
+  /**
+   * <p>Constructor for CalculationResult.</p>
+   */
   public CalculationResult() {}
 
+  /**
+   * <p>Constructor for CalculationResult.</p>
+   *
+   * @param fluidProperties an array of {@link java.lang.Double} objects
+   * @param calculationError an array of {@link java.lang.String} objects
+   */
   public CalculationResult(Double[][] fluidProperties, String[] calculationError) {
     this.fluidProperties = fluidProperties;
     this.calculationError = calculationError;

src/main/java/neqsim/chemicalReactions/chemicalReaction/ChemicalReactionFactory.java

@@ -21,6 +21,9 @@
 public class ChemicalReactionFactory {
   static Logger logger = LogManager.getLogger(ChemicalReactionFactory.class);
 
+  /**
+   * <p>Constructor for ChemicalReactionFactory.</p>
+   */
   public ChemicalReactionFactory() {}
 
   /**

src/main/java/neqsim/fluidMechanics/flowNode/FlowNodeInterface.java

@@ -727,7 +727,7 @@ default public void display() {
 
   /**
    * Specify wall friction factor for phase 0. Set to null to reset.
-   * 
+   *
    * @param frictionFactor Friction factor to use for phase 0 or null to reset.
    */
   default public void setWallFrictionFactor(double frictionFactor) {
@@ -736,7 +736,7 @@ default public void setWallFrictionFactor(double frictionFactor) {
 
   /**
    * Specify wall friction factor for a given phase. Set to null to reset.
-   * 
+   *
    * @param phase Index to phase to set wall friction factor for.
    * @param frictionFactor Friction factor to use for a given phase or null to reset.
    */

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/InterphaseTransportCoefficientBaseClass.java

@@ -12,6 +12,9 @@
  */
 public class InterphaseTransportCoefficientBaseClass
     implements InterphaseTransportCoefficientInterface {
+  /**
+   * <p>Constructor for InterphaseTransportCoefficientBaseClass.</p>
+   */
   public InterphaseTransportCoefficientBaseClass() {}
 
   /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseOnePhase/InterphaseOnePhase.java

@@ -12,6 +12,9 @@
  * @version $Id: $Id
  */
 public class InterphaseOnePhase extends InterphaseTransportCoefficientBaseClass {
+    /**
+     * <p>Constructor for InterphaseOnePhase.</p>
+     */
     public InterphaseOnePhase() {}
 
     /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseOnePhase/interphasePipeFlow/InterphasePipeFlow.java

@@ -12,6 +12,9 @@
  * @version $Id: $Id
  */
 public class InterphasePipeFlow extends InterphaseOnePhase {
+    /**
+     * <p>Constructor for InterphasePipeFlow.</p>
+     */
     public InterphasePipeFlow() {}
 
     /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/InterphaseTwoPhase.java

@@ -12,6 +12,9 @@
  * @version $Id: $Id
  */
 public class InterphaseTwoPhase extends InterphaseTransportCoefficientBaseClass {
+    /**
+     * <p>Constructor for InterphaseTwoPhase.</p>
+     */
     public InterphaseTwoPhase() {}
 
     /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/interphasePipeFlow/InterphaseAnnularFlow.java

@@ -13,6 +13,9 @@
 public class InterphaseAnnularFlow extends InterphaseStratifiedFlow {
     private static final long serialVersionUID = 1000;
 
+    /**
+     * <p>Constructor for InterphaseAnnularFlow.</p>
+     */
     public InterphaseAnnularFlow() {}
 
     /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/interphasePipeFlow/InterphaseDropletFlow.java

@@ -14,6 +14,9 @@ public class InterphaseDropletFlow extends InterphaseTwoPhasePipeFlow
     implements neqsim.thermo.ThermodynamicConstantsInterface {
   private static final long serialVersionUID = 1000;
 
+  /**
+   * <p>Constructor for InterphaseDropletFlow.</p>
+   */
   public InterphaseDropletFlow() {}
 
   /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/interphasePipeFlow/InterphaseStratifiedFlow.java

@@ -14,6 +14,9 @@ public class InterphaseStratifiedFlow extends InterphaseTwoPhasePipeFlow
     implements neqsim.thermo.ThermodynamicConstantsInterface {
   private static final long serialVersionUID = 1000;
 
+  /**
+   * <p>Constructor for InterphaseStratifiedFlow.</p>
+   */
   public InterphaseStratifiedFlow() {}
 
   /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/interphasePipeFlow/InterphaseTwoPhasePipeFlow.java

@@ -12,6 +12,9 @@
  * @version $Id: $Id
  */
 public class InterphaseTwoPhasePipeFlow extends InterphaseTwoPhase {
+    /**
+     * <p>Constructor for InterphaseTwoPhasePipeFlow.</p>
+     */
     public InterphaseTwoPhasePipeFlow() {}
 
     /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/interphaseReactorFlow/InterphasePackedBed.java

@@ -14,6 +14,9 @@ public class InterphasePackedBed extends InterphaseReactorFlow
         implements neqsim.thermo.ThermodynamicConstantsInterface {
     private static final long serialVersionUID = 1000;
 
+    /**
+     * <p>Constructor for InterphasePackedBed.</p>
+     */
     public InterphasePackedBed() {}
 
     /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/interphaseReactorFlow/InterphaseReactorFlow.java

@@ -12,6 +12,9 @@
  * @version $Id: $Id
  */
 public class InterphaseReactorFlow extends InterphaseTwoPhase {
+    /**
+     * <p>Constructor for InterphaseReactorFlow.</p>
+     */
     public InterphaseReactorFlow() {}
 
     /**

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/interphaseTransportCoefficient/interphaseTwoPhase/stirredCell/InterphaseStirredCellFlow.java

@@ -14,6 +14,9 @@
 public class InterphaseStirredCellFlow extends InterphaseStratifiedFlow {
     private static final long serialVersionUID = 1000;
 
+    /**
+     * <p>Constructor for InterphaseStirredCellFlow.</p>
+     */
     public InterphaseStirredCellFlow() {}
 
     /**

src/main/java/neqsim/physicalProperties/physicalPropertySystem/PhysicalProperties.java

@@ -350,13 +350,11 @@ public double getKinematicViscosity() {
   }
 
   /**
+   * {@inheritDoc}
+   *
    * <p>
    * getDiffusionCoefficient.
    * </p>
-   *
-   * @param i a int
-   * @param j a int
-   * @return a double
    */
   public double getDiffusionCoefficient(int i, int j) {
     return diffusivityCalc.getMaxwellStefanBinaryDiffusionCoefficient(i, j);

src/main/java/neqsim/processSimulation/SimulationBaseClass.java

@@ -5,6 +5,9 @@
 
 /**
  * Base class for process simulation objects.
+ *
+ * @author ASMF
+ * @version $Id: $Id
  */
 public abstract class SimulationBaseClass extends NamedBaseClass implements SimulationInterface {
   private static final long serialVersionUID = 1L;
@@ -16,11 +19,20 @@ public abstract class SimulationBaseClass extends NamedBaseClass implements Simu
   protected boolean calculateSteadyState = true;
   protected double time = 0;
 
+  /**
+   * <p>Constructor for SimulationBaseClass.</p>
+   *
+   * @param name a {@link java.lang.String} object
+   */
   public SimulationBaseClass(String name) {
     super(name);
   }
 
-  /** {@inheritDoc} */
+  /**
+   * {@inheritDoc}
+   *
+   * @return a {@link java.util.UUID} object
+   */
   public UUID getCalculationIdentifier() {
     return calcIdentifier;
   }
@@ -46,7 +58,11 @@ public void setCalculateSteadyState(boolean steady) {
     this.calculateSteadyState = steady;
   }
 
-  /** {@inheritDoc} */
+  /**
+   * {@inheritDoc}
+   *
+   * @return a double
+   */
   public double getTime() {
     return this.time;
   }

src/main/java/neqsim/processSimulation/SimulationInterface.java

@@ -5,6 +5,9 @@
 
 /**
  * Interface for simulation objects.
+ *
+ * @author ASMF
+ * @version $Id: $Id
  */
 public interface SimulationInterface extends NamedInterface, Runnable {
   /**
@@ -57,6 +60,8 @@ public interface SimulationInterface extends NamedInterface, Runnable {
   public void increaseTime(double dt);
 
   /**
+   * {@inheritDoc}
+   *
    * <p>
    * run
    * </p>

src/main/java/neqsim/processSimulation/controllerDevice/ControllerDeviceBaseClass.java

@@ -40,6 +40,9 @@ public class ControllerDeviceBaseClass extends NamedBaseClass implements Control
   private double TintValue = 0.0;
   private double Tderiv = 300.0;
 
+  /**
+   * <p>Constructor for ControllerDeviceBaseClass.</p>
+   */
   public ControllerDeviceBaseClass() {
     super("controller");
   }

src/main/java/neqsim/processSimulation/costEstimation/CostEstimateBaseClass.java

@@ -34,7 +34,8 @@ public CostEstimateBaseClass(ProcessSystem process) {
   }
 
   /**
-   * 
+   * <p>Constructor for CostEstimateBaseClass.</p>
+   *
    * @param process input process
    * @param costFactor cost factor
    */

src/main/java/neqsim/processSimulation/costEstimation/valve/ValveCostEstimate.java

@@ -21,7 +21,7 @@ public ValveCostEstimate(ValveMechanicalDesign mechanicalEquipment) {
         super(mechanicalEquipment);
     }
 
-	/** {@inheritDoc} */
+    /** {@inheritDoc} */
     @Override
     public double getTotaltCost() {
         ValveMechanicalDesign valveMecDesign = (ValveMechanicalDesign) mechanicalEquipment;

src/main/java/neqsim/processSimulation/measurementDevice/MeasurementDeviceBaseClass.java

@@ -63,6 +63,9 @@ public void setIsOnlineSignal(boolean isOnlineSignal, String plantName, String t
     private String conditionAnalysisMessage = "";
     private double conditionAnalysisMaxDeviation = 0.0;
 
+    /**
+     * <p>Constructor for MeasurementDeviceBaseClass.</p>
+     */
     public MeasurementDeviceBaseClass() {
         super("default");
     }

src/main/java/neqsim/processSimulation/measurementDevice/MultiPhaseMeter.java

@@ -23,6 +23,9 @@ public class MultiPhaseMeter extends MeasurementDeviceBaseClass {
   double pressure = 10.0, temperature = 298.15;
   String unitT, unitP;
 
+  /**
+   * <p>Constructor for MultiPhaseMeter.</p>
+   */
   public MultiPhaseMeter() {
     name = "Multi Phase Meter";
   }

src/main/java/neqsim/processSimulation/measurementDevice/TemperatureTransmitter.java

@@ -20,6 +20,9 @@ public class TemperatureTransmitter extends MeasurementDeviceBaseClass {
     private static final long serialVersionUID = 1000;
     protected StreamInterface stream = null;
 
+    /**
+     * <p>Constructor for TemperatureTransmitter.</p>
+     */
     public TemperatureTransmitter() {
         name = "Temperature Transmitter";
         unit = "K";

src/main/java/neqsim/processSimulation/measurementDevice/WellAllocator.java

@@ -7,31 +7,61 @@
 import neqsim.thermo.system.SystemInterface;
 import neqsim.thermo.system.SystemSrkEos;
 
+/**
+ * <p>WellAllocator class.</p>
+ *
+ * @author ASMF
+ * @version $Id: $Id
+ */
 public class WellAllocator extends MeasurementDeviceBaseClass {
 
   private static final long serialVersionUID = 1L;
   protected StreamInterface wellStream = null;
   protected StreamInterface exportGasStream = null;
   protected StreamInterface exportOilStream = null;
 
+  /**
+   * <p>Constructor for WellAllocator.</p>
+   */
   public WellAllocator() {
     name = "Well Allocator";
   }
 
+  /**
+   * <p>Constructor for WellAllocator.</p>
+   *
+   * @param stream a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface} object
+   */
   public WellAllocator(StreamInterface stream) {
     name = "Well Allocator";
     this.wellStream = stream;
   }
 
+  /**
+   * <p>Constructor for WellAllocator.</p>
+   *
+   * @param streamname a {@link java.lang.String} object
+   * @param stream a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface} object
+   */
   public WellAllocator(String streamname, StreamInterface stream) {
     this(stream);
     name = streamname;
   }
 
+  /**
+   * <p>Setter for the field <code>exportGasStream</code>.</p>
+   *
+   * @param stream a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface} object
+   */
   public void setExportGasStream(StreamInterface stream) {
     this.exportGasStream = stream;
   }
 
+  /**
+   * <p>Setter for the field <code>exportOilStream</code>.</p>
+   *
+   * @param stream a {@link neqsim.processSimulation.processEquipment.stream.StreamInterface} object
+   */
   public void setExportOilStream(StreamInterface stream) {
     this.exportOilStream = stream;
   }
@@ -70,6 +100,11 @@ public double getMeasuredValue(String measurement) {
     return 0.0;
   }
 
+  /**
+   * <p>main.</p>
+   *
+   * @param args an array of {@link java.lang.String} objects
+   */
   public static void main(String[] args) {
     SystemInterface testFluid = new SystemSrkEos(338.15, 50.0);
     testFluid.addComponent("nitrogen", 1.205);