chore: fix javadoc (#1067)

* chore: fix javadoc

Author: asmfstatoil

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

@@ -121,7 +121,7 @@ public double getTemperature() {
 
   /**
    * <p>
-   * Setter for the field <code>temperature</code>.
+   * Setter for the field <code>temperature</code>. NB! Verify unit is correct.
    * </p>
    *
    * @param temperature the temperature to set
@@ -130,14 +130,8 @@ public void setTemperature(double temperature) {
     this.temperature = temperature;
   }
 
-  /**
-   * <p>
-   * Setter for the field <code>temperature</code>.
-   * </p>
-   *
-   * @param temperature the temperature to set
-   * @param temperatureUnit the unit of temperature as string
-   */
+  /** {@inheritDoc} */
+  @Override
   public void setTemperature(double temperature, String temperatureUnit) {
     this.temperature = temperature;
     this.temperatureUnit = temperatureUnit;

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

@@ -31,7 +31,6 @@ public SaturationPressure(SystemInterface tempSystem) {
    * @return a double
    */
   public double calcSaturationPressure() {
-
     if (!Double.isNaN(temperature)) {
       getThermoSystem().setTemperature(temperature, temperatureUnit);
     }

src/main/java/neqsim/dataPresentation/SampleXYDataSource.java

@@ -24,6 +24,8 @@
  * 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.
  * </p>
+ *
+ * @author Even Solbraa
  */
 public class SampleXYDataSource {
   double[][] points;

src/main/java/neqsim/fluidMechanics/flowNode/fluidBoundary/heatMassTransferCalc/finiteVolumeBoundary/fluidBoundarySolver/FluidBoundarySolver.java

@@ -41,7 +41,9 @@ public FluidBoundarySolver() {}
    * Constructor for FluidBoundarySolver.
    * </p>
    *
-   * @param boundary a {@link FluidBoundarySystemInterface} object
+   * @param boundary a
+   *        {@link neqsim.fluidMechanics.flowNode.fluidBoundary.heatMassTransferCalc.finiteVolumeBoundary.fluidBoundarySystem.FluidBoundarySystemInterface}
+   *        object
    */
   public FluidBoundarySolver(FluidBoundarySystemInterface boundary) {
     this.boundary = boundary;
@@ -67,7 +69,9 @@ public FluidBoundarySolver(FluidBoundarySystemInterface boundary) {
    * Constructor for FluidBoundarySolver.
    * </p>
    *
-   * @param boundary a {@link FluidBoundarySystemInterface} * object
+   * @param boundary a
+   *        {@link neqsim.fluidMechanics.flowNode.fluidBoundary.heatMassTransferCalc.finiteVolumeBoundary.fluidBoundarySystem.FluidBoundarySystemInterface}
+   *        * object
    * @param reactive a boolean
    */
   public FluidBoundarySolver(FluidBoundarySystemInterface boundary, boolean reactive) {

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

@@ -82,30 +82,15 @@ public void increaseTime(double dt) {
     this.time = this.time + dt;
   }
 
-  /**
-   * <p>
-   * setRunInSteps
-   * </p>
-   * 
-   * @param setRunSteps boolean set if run in steps
-   */
+  /** {@inheritDoc} */
   @Override
   public void setRunInSteps(boolean setRunSteps) {
     runInSteps = setRunSteps;
   }
 
-  /**
-   * <p>
-   * isRunInSteps.
-   * </p>
-   * 
-   * @return boolean
-   */
+  /** {@inheritDoc} */
   @Override
   public boolean isRunInSteps() {
     return runInSteps;
   }
-
-
-
 }

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

@@ -40,47 +40,47 @@ public interface SimulationInterface extends NamedInterface, Runnable, Serializa
   public void setCalculateSteadyState(boolean steady);
 
   /**
-   * Getter for property time.
+   * Getter for the field <code>time</code>.
    *
    * @return Value of property time.
    */
   public double getTime();
 
   /**
-   * Setter for property time.
+   * Setter for field <code>time</code>.
    *
    * @param value Value to set.
    */
   public void setTime(double value);
 
   /**
-   * Method to increase parameter time by a given value.
+   * Method to increase field <code>time</code> by a given value.
    *
    * @param dt Value to increase time by.
    */
   public void increaseTime(double dt);
 
   /**
    * <p>
-   * setRunInSteps
+   * setRunInSteps.
    * </p>
-   * 
-   * @param setRunSteps boolean set if run in steps
+   *
+   * @param setRunSteps boolean set true to run in steps
    */
   public void setRunInSteps(boolean setRunSteps);
 
   /**
    * <p>
    * isRunInSteps.
    * </p>
-   * 
+   *
    * @return boolean
    */
   public boolean isRunInSteps();
 
   /**
    * <p>
-   * run
+   * run.
    * </p>
    *
    * @param id UUID
@@ -89,9 +89,8 @@ public interface SimulationInterface extends NamedInterface, Runnable, Serializa
 
   /**
    * <p>
-   * run
+   * run.
    * </p>
-   *
    */
   public default void run() {
     if (isRunInSteps()) {
@@ -102,12 +101,11 @@ public default void run() {
   }
 
   /**
-   * {@inheritDoc}
-   *
    * <p>
+   * run_step
+   * </p>
    * In this method all thermodynamic and unit operations will be calculated in a steady state
    * calculation. It does not solve resycles - only calculates one step.
-   * </p>
    */
   public default void run_step() {
     run_step(UUID.randomUUID());
@@ -162,7 +160,7 @@ public default void runTransient(double dt, UUID id) {
 
   /**
    * <p>
-   * solved.
+   * Returns whether or not the module has been solved.
    * </p>
    *
    * @return a boolean
@@ -171,10 +169,10 @@ public default void runTransient(double dt, UUID id) {
 
   /**
    * <p>
-   * getReport_json
+   * getReport_json.
    * </p>
    * Return results of simulation in json format
-   * 
+   *
    * @return a String
    */
   public String getReport_json();

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

@@ -4,6 +4,13 @@
 import java.util.Map;
 import neqsim.processSimulation.processEquipment.stream.StreamInterface;
 
+/**
+ * <p>
+ * CombustionEmissionsCalculator class.
+ * </p>
+ *
+ * @author Even Solbraa
+ */
 public class CombustionEmissionsCalculator extends StreamMeasurementDeviceBaseClass {
   private static final long serialVersionUID = 1L;
 
@@ -37,6 +44,11 @@ public CombustionEmissionsCalculator(String name, StreamInterface stream) {
     super(name, "kg/hr", stream);
   }
 
+  /**
+   * <p>
+   * setComponents.
+   * </p>
+   */
   public void setComponents() {
     NATURAL_GAS_COMPOSITION.clear();
     CO2_EMISSIONS_FACTORS.clear();
@@ -71,6 +83,15 @@ public double getMeasuredValue(String unit) {
         * stream.getFluid().getFlowRate(unit);
   }
 
+  /**
+   * <p>
+   * calculateCO2Emissions.
+   * </p>
+   *
+   * @param composition a {@link java.util.Map} object
+   * @param emissionsFactors a {@link java.util.Map} object
+   * @return a double
+   */
   public static double calculateCO2Emissions(Map<String, Double> composition,
       Map<String, Double> emissionsFactors) {
     double totalEmissions = 0.0;

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

@@ -30,7 +30,6 @@ public class FlowInducedVibrationAnalyser extends MeasurementDeviceBaseClass {
   private int segment;
   private double FRMSConstant = 6.7;
 
-
   /**
    * <p>
    * Constructor for WaterDewPointAnalyser.
@@ -116,7 +115,6 @@ public double getMeasuredValue(String unit) {
     return Double.NaN;
   }
 
-
   /**
    * <p>
    * Getter for the field <code>method</code>.
@@ -151,7 +149,13 @@ public void setSegment(int segment) {
     this.segmentSet = true;
   }
 
-
+  /**
+   * <p>
+   * setFRMSConstant.
+   * </p>
+   *
+   * @param frms a double
+   */
   public void setFRMSConstant(double frms) {
     this.FRMSConstant = frms;
   }
@@ -167,7 +171,6 @@ public void setSupportArrangement(String arrangement) {
     this.supportArrangement = arrangement;
   }
 
-
   /**
    * <p>
    * Setter for the support distance <code></code>.
@@ -178,7 +181,4 @@ public void setSupportArrangement(String arrangement) {
   public void setSupportDistance(Double distance) {
     this.supportDistance = distance;
   }
-
-
-
 }

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

@@ -47,9 +47,7 @@ public void displayResult() {
     System.out.println("measured level " + separator.getLiquidLevel());
   }
 
-  /**
-   * Get level as volume fraction.
-   */
+  /** {@inheritDoc} */
   @Override
   public double getMeasuredValue(String unit) {
     if (!unit.equalsIgnoreCase("")) {

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

@@ -32,7 +32,7 @@ public default double getMeasuredValue() {
 
   /**
    * <p>
-   * getMeasuredValue.
+   * Get Measured value in specified unit.
    * </p>
    *
    * @param unit a {@link java.lang.String} object

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

@@ -74,7 +74,6 @@ public double getMeasuredValue(String unit) {
    * @param unit Unit to get value in
    * @return Measured value
    */
-
   public double getMeasuredValue(String measurement, String unit) {
     int numberOfComps = stream.getThermoSystem().getNumberOfComponents();
     double[] splitFactors = new double[numberOfComps];

src/main/java/neqsim/processSimulation/measurementDevice/simpleFlowRegime/SevereSlugAnalyser.java

@@ -627,13 +627,7 @@ public String checkFlowRegime(FluidSevereSlug fluid, Pipe pipe, SevereSlugAnalys
     return flowPattern;
   }
 
-  /**
-   * <p>
-   * getMeasuredValue.
-   * </p>
-   *
-   * @return a double
-   */
+  /** {@inheritDoc} */
   @Override
   public double getMeasuredValue(String unit) {
     if (!unit.equalsIgnoreCase("m3/sec")) {

src/main/java/neqsim/processSimulation/mechanicalDesign/MechanicalDesign.java

@@ -1083,18 +1083,46 @@ public UnitCostEstimateBaseClass getCostEstimate() {
     return costEstimate;
   }
 
+  /**
+   * <p>
+   * Setter for the field <code>defaultLiquidDensity</code>.
+   * </p>
+   *
+   * @param defaultLiqDens a double
+   */
   public void setDefaultLiquidDensity(double defaultLiqDens) {
     this.defaultLiquidDensity = defaultLiqDens;
   }
 
+  /**
+   * <p>
+   * Getter for the field <code>defaultLiquidDensity</code>.
+   * </p>
+   *
+   * @return a double
+   */
   public double getDefaultLiquidDensity() {
     return defaultLiquidDensity;
   }
 
+  /**
+   * <p>
+   * Setter for the field <code>defaultLiquidViscosity</code>.
+   * </p>
+   *
+   * @param defaultLiqVisc a double
+   */
   public void setDefaultLiquidViscosity(double defaultLiqVisc) {
     this.defaultLiquidViscosity = defaultLiqVisc;
   }
 
+  /**
+   * <p>
+   * Getter for the field <code>defaultLiquidViscosity</code>.
+   * </p>
+   *
+   * @return a double
+   */
   public double getDefaultLiquidViscosity() {
     return defaultLiquidViscosity;
   }

src/main/java/neqsim/processSimulation/mechanicalDesign/SystemMechanicalDesign.java

@@ -36,6 +36,13 @@ public SystemMechanicalDesign(ProcessSystem processSystem) {
     this.processSystem = processSystem;
   }
 
+  /**
+   * <p>
+   * getProcess.
+   * </p>
+   *
+   * @return a {@link neqsim.processSimulation.processSystem.ProcessSystem} object
+   */
   public ProcessSystem getProcess() {
     return processSystem;
   }