diff --git a/src/main/java/neqsim/datapresentation/jfreechart/Graph2b.java b/src/main/java/neqsim/datapresentation/jfreechart/Graph2b.java index c7c051f6f2..e4a201c16c 100644 --- a/src/main/java/neqsim/datapresentation/jfreechart/Graph2b.java +++ b/src/main/java/neqsim/datapresentation/jfreechart/Graph2b.java @@ -18,6 +18,7 @@ import org.jfree.data.xy.XYDataset; import org.jfree.data.xy.XYSeries; import org.jfree.data.xy.XYSeriesCollection; +import neqsim.util.ExcludeFromJacocoGeneratedReport; /** *

@@ -302,6 +303,7 @@ public ChartPanel getChartPanel() { * * @param args the command line arguments */ + @ExcludeFromJacocoGeneratedReport public static void main(String[] args) { new Graph2b().setVisible(true); } diff --git a/src/main/java/neqsim/process/equipment/compressor/Compressor.java b/src/main/java/neqsim/process/equipment/compressor/Compressor.java index ab6d8d19d8..9c403002b0 100644 --- a/src/main/java/neqsim/process/equipment/compressor/Compressor.java +++ b/src/main/java/neqsim/process/equipment/compressor/Compressor.java @@ -1468,10 +1468,11 @@ public double getActualCompressionRatio() { } /** + * {@inheritDoc} + * *

* Set CompressorChartType *

- * */ public void setCompressorChartType(String type) { if (type.equals("simple") || type.equals("fan law")) { diff --git a/src/main/java/neqsim/process/equipment/compressor/CompressorChart.java b/src/main/java/neqsim/process/equipment/compressor/CompressorChart.java index 2dfa7dfa68..b1e859a7e3 100644 --- a/src/main/java/neqsim/process/equipment/compressor/CompressorChart.java +++ b/src/main/java/neqsim/process/equipment/compressor/CompressorChart.java @@ -76,12 +76,6 @@ public void addCurve(double speed, double[] flow, double[] head, double[] polytr * 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. - * - * @param chartConditions An array of conditions used for the compressor chart. (Currently unused) - * @param speed An array representing the compressor speed values. - * @param flow A 2D array representing the flow rates at different speeds. - * @param head A 2D array representing the head values at different speeds. - * @param polyEff A 2D array representing the polytropic efficiency values at different speeds. */ @Override public void setCurves(double[] chartConditions, double[] speed, double[][] flow, double[][] head, diff --git a/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookup.java b/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookup.java index bcb2631601..b188b364da 100644 --- a/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookup.java +++ b/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookup.java @@ -123,6 +123,8 @@ */ /** + *

CompressorChartAlternativeMapLookup class.

+ * * @author asmund * @version $Id: $Id */ @@ -172,14 +174,10 @@ public void addCurve(double speed, double[] flow, double[] head, double[] polytr /** {@inheritDoc} */ /** + * {@inheritDoc} + * * Sets the compressor curves based on the provided chart conditions, speed, flow, head, and * polytropic efficiency values. - * - * @param chartConditions an array of chart conditions (not used in this method) - * @param speed an array of speed values for the compressor - * @param flow a 2D array of flow values corresponding to each speed - * @param head a 2D array of head values corresponding to each speed - * @param polyEff a 2D array of polytropic efficiency values corresponding to each speed */ @Override public void setCurves(double[] chartConditions, double[] speed, double[][] flow, double[][] head, @@ -208,6 +206,7 @@ public void setCurves(double[] chartConditions, double[] speed, double[][] flow, * lowest reference speed is returned. If the given speed is higher than the highest reference * speed, the highest reference speed is returned. * + * @return an ArrayList of the closest reference speeds * @param speed the speed to find the closest reference speeds for * @return an ArrayList of the closest reference speeds */ @@ -243,14 +242,12 @@ public ArrayList getClosestRefSpeeds(double speed) { /** {@inheritDoc} */ /** + * {@inheritDoc} + * * Calculates the polytropic head for a given flow and speed. * * 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. - * - * @param flow the flow rate for which the polytropic head is to be calculated - * @param speed the speed at which the polytropic head is to be calculated - * @return the calculated polytropic head */ @Override public double getPolytropicHead(double flow, double speed) { @@ -278,13 +275,11 @@ public double getPolytropicHead(double flow, double speed) { /** {@inheritDoc} */ /** + * {@inheritDoc} + * * 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. - * - * @param flow the flow rate through the compressor - * @param speed the rotational speed of the compressor - * @return the polytropic efficiency at the specified flow and speed */ @Override public double getPolytropicEfficiency(double flow, double speed) { diff --git a/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookupExtrapolate.java b/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookupExtrapolate.java index 01ab16f5d0..634b1fd629 100644 --- a/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookupExtrapolate.java +++ b/src/main/java/neqsim/process/equipment/compressor/CompressorChartAlternativeMapLookupExtrapolate.java @@ -6,6 +6,11 @@ import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; +/** + *

CompressorChartAlternativeMapLookupExtrapolate class.

+ * + * @author ASMF + */ public class CompressorChartAlternativeMapLookupExtrapolate extends CompressorChartAlternativeMapLookup { private static final long serialVersionUID = 1000; @@ -13,16 +18,14 @@ public class CompressorChartAlternativeMapLookupExtrapolate /** + * {@inheritDoc} + * * Retrieves the closest reference speeds to the given speed from the compressor chart values. The * method returns a list containing one or two speeds: - If the given speed matches a reference * speed, the list contains only that speed. - If the given speed is between two reference speeds, * the list contains both speeds. - If the given speed is less than the lowest reference speed, * the list contains the lowest reference speed. - If the given speed is greater than the highest * reference speed, the list contains the highest reference speed. - * - * @param speed the speed to find the closest reference speeds for. - * @return a list of the closest reference speeds. - * @throws IllegalStateException if no reference speeds are available in the chart values. */ @Override public ArrayList getClosestRefSpeeds(double speed) { @@ -59,12 +62,10 @@ public ArrayList getClosestRefSpeeds(double speed) { } /** + * {@inheritDoc} + * * Calculates the polytropic head for a given flow and speed by interpolating or extrapolating * between reference compressor curves. - * - * @param flow the flow rate for which the polytropic head is to be calculated - * @param speed the speed at which the compressor is operating - * @return the polytropic head corresponding to the given flow and speed */ @Override public double getPolytropicHead(double flow, double speed) { @@ -95,14 +96,10 @@ public double getPolytropicHead(double flow, double speed) { } /** + * {@inheritDoc} + * * Calculates the polytropic efficiency for a given flow and speed by interpolating or * extrapolating between reference compressor curves. - * - * @param flow the flow rate for which the polytropic efficiency is to be calculated - * @param speed the speed at which the compressor is operating - * @return the polytropic efficiency at the given flow and speed - * @throws IllegalArgumentException if no valid reference speeds are found for the given speed or - * if the curve data for a reference speed is invalid */ @Override public double getPolytropicEfficiency(double flow, double speed) { diff --git a/src/main/java/neqsim/process/equipment/compressor/CompressorChartGenerator.java b/src/main/java/neqsim/process/equipment/compressor/CompressorChartGenerator.java index da96215904..b9e72d03ff 100644 --- a/src/main/java/neqsim/process/equipment/compressor/CompressorChartGenerator.java +++ b/src/main/java/neqsim/process/equipment/compressor/CompressorChartGenerator.java @@ -2,12 +2,12 @@ /** * Compressor chart generator. - * + * * This class generates a compressor chart based on the provided compressor and the specified * generation option. - * + * * Supports generating normal curves and alternative curves. - * + * * @author Even Solbraa */ public class CompressorChartGenerator { diff --git a/src/main/java/neqsim/process/equipment/compressor/CompressorInterface.java b/src/main/java/neqsim/process/equipment/compressor/CompressorInterface.java index 103bd51e22..866bbb8399 100644 --- a/src/main/java/neqsim/process/equipment/compressor/CompressorInterface.java +++ b/src/main/java/neqsim/process/equipment/compressor/CompressorInterface.java @@ -140,6 +140,7 @@ public interface CompressorInterface extends ProcessEquipmentInterface, TwoPortI * Set CompressorChartType *

* + * @param type a {@link java.lang.String} object */ public void setCompressorChartType(String type); diff --git a/src/main/java/neqsim/process/equipment/util/Recycle.java b/src/main/java/neqsim/process/equipment/util/Recycle.java index ecaaa7d2c4..9e3fbeb660 100644 --- a/src/main/java/neqsim/process/equipment/util/Recycle.java +++ b/src/main/java/neqsim/process/equipment/util/Recycle.java @@ -476,7 +476,7 @@ public void setTemperature(double temp) { * Setter for the tolerance fields. *

* Set tolerances to tolerance input. - * + * * @param tolerance the tolerance to set */ public void setTolerance(double tolerance) { diff --git a/src/main/java/neqsim/process/processmodel/ProcessSystem.java b/src/main/java/neqsim/process/processmodel/ProcessSystem.java index c0d62ff15b..183cb34c81 100644 --- a/src/main/java/neqsim/process/processmodel/ProcessSystem.java +++ b/src/main/java/neqsim/process/processmodel/ProcessSystem.java @@ -737,7 +737,7 @@ public void setName(String name) { /** * Setter for the field runStep. - * + * * @param runStep A boolean value if run only one iteration */ public void setRunStep(boolean runStep) { @@ -746,7 +746,7 @@ public void setRunStep(boolean runStep) { /** * Getter for the field runStep. - * + * * @return A boolean value if run only one iteration */ public boolean isRunStep() { diff --git a/src/main/java/neqsim/thermo/component/attractiveeosterm/AttractiveTermInterface.java b/src/main/java/neqsim/thermo/component/attractiveeosterm/AttractiveTermInterface.java index da96f8890b..0f8ddec505 100644 --- a/src/main/java/neqsim/thermo/component/attractiveeosterm/AttractiveTermInterface.java +++ b/src/main/java/neqsim/thermo/component/attractiveeosterm/AttractiveTermInterface.java @@ -120,5 +120,10 @@ public interface AttractiveTermInterface extends Cloneable, java.io.Serializable */ public AttractiveTermInterface clone(); + /** + *

getm.

+ * + * @return a double + */ public double getm(); } diff --git a/src/main/java/neqsim/thermo/system/SystemInterface.java b/src/main/java/neqsim/thermo/system/SystemInterface.java index b2ceff1f40..165beb2869 100644 --- a/src/main/java/neqsim/thermo/system/SystemInterface.java +++ b/src/main/java/neqsim/thermo/system/SystemInterface.java @@ -2662,5 +2662,10 @@ public default void setPhysicalPropertyModel(int type) { */ public void setForceSinglePhase(String phasetypename); + /** + *

isInitialized.

+ * + * @return a boolean + */ public boolean isInitialized(); } diff --git a/src/main/java/neqsim/thermo/system/SystemThermo.java b/src/main/java/neqsim/thermo/system/SystemThermo.java index 23de161739..69b919a5e3 100644 --- a/src/main/java/neqsim/thermo/system/SystemThermo.java +++ b/src/main/java/neqsim/thermo/system/SystemThermo.java @@ -107,6 +107,11 @@ public abstract class SystemThermo implements SystemInterface { // Initialization boolean isInitialized = false; + /** + *

isInitialized.

+ * + * @return a boolean + */ public boolean isInitialized() { return isInitialized; } diff --git a/src/main/java/neqsim/thermodynamicoperations/flashops/TPgradientFlash.java b/src/main/java/neqsim/thermodynamicoperations/flashops/TPgradientFlash.java index 61f342c262..6db71251c2 100644 --- a/src/main/java/neqsim/thermodynamicoperations/flashops/TPgradientFlash.java +++ b/src/main/java/neqsim/thermodynamicoperations/flashops/TPgradientFlash.java @@ -12,6 +12,8 @@ /** * TPgradientFlash class handles thermodynamic calculations with temperature and pressure gradients. + * + * @author ASMF */ public class TPgradientFlash extends Flash { private static final long serialVersionUID = 1000; diff --git a/src/main/java/neqsim/util/ExcludeFromJacocoGeneratedReport.java b/src/main/java/neqsim/util/ExcludeFromJacocoGeneratedReport.java index afadaa282f..edccb1b00d 100644 --- a/src/main/java/neqsim/util/ExcludeFromJacocoGeneratedReport.java +++ b/src/main/java/neqsim/util/ExcludeFromJacocoGeneratedReport.java @@ -5,6 +5,11 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + *

ExcludeFromJacocoGeneratedReport class.

+ * + * @author ASMF + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface ExcludeFromJacocoGeneratedReport {