refact: standardize exception logging (#1147)

* refact: standardize exception logging (remove stack trace) * refact: standardize use of neqsim exceptions * test: silence tests
equinor · Oct 26, 2024 · a32566a · a32566a
1 parent 45e6476
commit a32566a
Show file tree

Hide file tree

Showing 68 changed files with 631 additions and 703 deletions.
diff --git a/...oundary/heatmasstransfercalc/nonequilibriumfluidboundary/NonEquilibriumFluidBoundary.java b/...oundary/heatmasstransfercalc/nonequilibriumfluidboundary/NonEquilibriumFluidBoundary.java
@@ -1,12 +1,9 @@
 package neqsim.fluidmechanics.flownode.fluidboundary.heatmasstransfercalc.nonequilibriumfluidboundary;
 
+import Jama.Matrix;
 import neqsim.fluidmechanics.flownode.FlowNodeInterface;
 import neqsim.thermo.system.SystemInterface;
 
-import Jama.Matrix;
-
-
-
 /**
  * <p>
  * Abstract NonEquilibriumFluidBoundary class.

diff --git a/...luidboundary/filmmodelboundary/reactivefilmmodel/enhancementfactor/EnhancementFactor.java b/...luidboundary/filmmodelboundary/reactivefilmmodel/enhancementfactor/EnhancementFactor.java
@@ -116,7 +116,6 @@ public void setOnesVec(int phase) {
     }
   }
 
-
   /**
    * Getter for property hattaNumber.
    *

diff --git a/src/main/java/neqsim/processsimulation/measurementdevice/MultiPhaseMeter.java b/src/main/java/neqsim/processsimulation/measurementdevice/MultiPhaseMeter.java
@@ -126,7 +126,7 @@ public double getMeasuredValue(String measurement, String unit) {
       try {
         thermoOps.TPflash();
       } catch (Exception ex) {
-        logger.error(ex.getMessage(), ex);
+        logger.error(ex.getMessage());
         return Double.NaN;
       }
       // tempFluid.display();
@@ -148,7 +148,7 @@ public double getMeasuredValue(String measurement, String unit) {
       try {
         thermoOps.TPflash();
       } catch (Exception ex) {
-        logger.error(ex.getMessage(), ex);
+        logger.error(ex.getMessage());
         return Double.NaN;
       }
       // tempFluid.display();
@@ -166,7 +166,7 @@ public double getMeasuredValue(String measurement, String unit) {
       try {
         thermoOps.TPflash();
       } catch (Exception ex) {
-        logger.error(ex.getMessage(), ex);
+        logger.error(ex.getMessage());
         return Double.NaN;
       }
       // tempFluid.display();
@@ -184,7 +184,7 @@ public double getMeasuredValue(String measurement, String unit) {
       try {
         thermoOps.TPflash();
       } catch (Exception ex) {
-        logger.error(ex.getMessage(), ex);
+        logger.error(ex.getMessage());
         return Double.NaN;
       }
       // tempFluid.display();
@@ -203,7 +203,7 @@ public double getMeasuredValue(String measurement, String unit) {
       try {
         thermoOps.TPflash();
       } catch (Exception ex) {
-        logger.error(ex.getStackTrace());
+        logger.error(ex.getMessage());
         return Double.NaN;
       }
       tempFluid.initPhysicalProperties();
@@ -237,7 +237,7 @@ public double getMeasuredValue(String measurement, String unit) {
       try {
         thermoOps.TPflash();
       } catch (Exception ex) {
-        logger.error(ex.getStackTrace());
+        logger.error(ex.getMessage());
         return Double.NaN;
       }
       if (!tempFluid.hasPhaseType("gas")) {

diff --git a/src/main/java/neqsim/processsimulation/mechanicaldesign/valve/ValveMechanicalDesign.java b/src/main/java/neqsim/processsimulation/mechanicaldesign/valve/ValveMechanicalDesign.java
@@ -33,9 +33,8 @@ public class ValveMechanicalDesign extends MechanicalDesign {
    * Constructor for ValveMechanicalDesign.
    * </p>
    *
-   * @param equipment a
-   *                  {@link neqsim.processsimulation.processequipment.ProcessEquipmentInterface}
-   *                  object
+   * @param equipment a {@link neqsim.processsimulation.processequipment.ProcessEquipmentInterface}
+   *        object
    */
   public ValveMechanicalDesign(ProcessEquipmentInterface equipment) {
     super(equipment);
@@ -50,7 +49,8 @@ public void readDesignSpecifications() {
     if (getDesignStandard().containsKey("valve design codes")) {
       System.out.println("valve code standard: "
           + getDesignStandard().get("valve design codes").getStandardName());
-      valveCvMax = ((ValveDesignStandard) getDesignStandard().get("valve design codes")).getValveCvMax();
+      valveCvMax =
+          ((ValveDesignStandard) getDesignStandard().get("valve design codes")).getValveCvMax();
     } else {
       System.out.println("no valve code standard specified......using default");
     }
@@ -78,7 +78,7 @@ public void displayResults() {
     Container dialogContentPane = dialog.getContentPane();
     dialogContentPane.setLayout(new BorderLayout());
 
-    String[] names = { "Name", "Value", "Unit" };
+    String[] names = {"Name", "Value", "Unit"};
 
     String[][] table = new String[16][3]; // createTable(getProcessEquipment().getName());
 

diff --git a/...im/processsimulation/processequipment/compressor/CompressorChartAlternativeMapLookup.java b/...im/processsimulation/processequipment/compressor/CompressorChartAlternativeMapLookup.java
@@ -191,10 +191,8 @@ public CompressorCurve getCurveAtRefSpeed(double refSpeed) {
       }
     }
     String msg = "Does not match any speed in the chart.";
-    neqsim.util.exception.InvalidInputException ex =
-        new neqsim.util.exception.InvalidInputException(this, "getCurveAtRefSpeed", "refSpeed",
-            msg);
-    throw new RuntimeException(ex);
+    throw new RuntimeException(new neqsim.util.exception.InvalidInputException(this,
+        "getCurveAtRefSpeed", "refSpeed", msg));
   }
 
   /**

diff --git a/src/main/java/neqsim/processsimulation/processequipment/pipeline/Fittings.java b/src/main/java/neqsim/processsimulation/processequipment/pipeline/Fittings.java
@@ -89,7 +89,7 @@ public Fitting(String name) {
         LtoD = (Double.parseDouble(dataSet.getString("LtoD")));
         System.out.printf("LtoD " + LtoD);
       } catch (Exception ex) {
-        logger.error("error in comp", ex);
+        logger.error("error in fittings");
       }
     }
 

diff --git a/src/main/java/neqsim/processsimulation/processequipment/stream/Stream.java b/src/main/java/neqsim/processsimulation/processequipment/stream/Stream.java
@@ -567,13 +567,14 @@ public String[][] reportResults() {
    * @return a {@link java.lang.Object} object
    */
   public Object getProperty(String propertyName, String unit, String phase, String component) {
+    throw new RuntimeException(
+        new neqsim.util.exception.NotImplementedException(this, "getProperty"));
     // getFluid().getProperties.containsKey(propertyName)) {
     // if(properties.containsKey(propertyName)) {
     // }
     // else
 
-    // todo: throw not implemented error
-    return null;
+    // return null;
   }
 
   /** {@inheritDoc} */

diff --git a/src/main/java/neqsim/processsimulation/processequipment/stream/StreamInterface.java b/src/main/java/neqsim/processsimulation/processequipment/stream/StreamInterface.java
@@ -191,7 +191,6 @@ public default double getFlowRate(String unit) {
    */
   public StreamInterface clone(String name);
 
-
   /**
    * <p>
    * flashStream.

diff --git a/src/main/java/neqsim/processsimulation/processequipment/valve/ThrottlingValve.java b/src/main/java/neqsim/processsimulation/processequipment/valve/ThrottlingValve.java
@@ -508,8 +508,8 @@ public void run(UUID id) {
     try {
       inStream.getThermoSystem().setTotalNumberOfMoles(molarFlow);
       inStream.getThermoSystem().init(3);
-    } catch (Exception e) {
-      logger.error(e.getMessage());
+    } catch (Exception ex) {
+      logger.error(ex.getMessage());
     }
     // inletStream.run(id);
 
@@ -572,15 +572,15 @@ public void runTransient(double dt, UUID id) {
       inStream.getThermoSystem().setTotalNumberOfMoles(molarFlow);
       inStream.getThermoSystem().init(1);
       inStream.run(id);
-    } catch (Exception e) {
-      logger.error(e.getMessage());
+    } catch (Exception ex) {
+      logger.error(ex.getMessage());
     }
     try {
       outStream.getThermoSystem().setTotalNumberOfMoles(molarFlow);
       outStream.getThermoSystem().init(1);
       outStream.run(id);
-    } catch (Exception e) {
-      logger.error(e.getMessage());
+    } catch (Exception ex) {
+      logger.error(ex.getMessage());
     }
     setCalculationIdentifier(id);
   }

diff --git a/src/main/java/neqsim/processsimulation/processsystem/ProcessSystem.java b/src/main/java/neqsim/processsimulation/processsystem/ProcessSystem.java
@@ -664,7 +664,6 @@ public static ProcessSystem open(String filePath) {
       return (ProcessSystem) objectinputstream.readObject();
       // logger.info("process file open ok: " + filePath);
     } catch (Exception ex) {
-      // logger.error(ex.toString());
       logger.error(ex.getMessage(), ex);
     }
     return null;

diff --git a/src/main/java/neqsim/processsimulation/util/monitor/StreamResponse.java b/src/main/java/neqsim/processsimulation/util/monitor/StreamResponse.java
@@ -208,8 +208,8 @@ public StreamResponse(StreamInterface inputStream) {
                   Double.toString(
                       inputStream.getTVP(37.8, "C", neqsim.util.unit.Units.getSymbol("pressure"))),
                   neqsim.util.unit.Units.getSymbol("pressure")));
-        } catch (Exception e) {
-          logger.error(e.getMessage());
+        } catch (Exception ex) {
+          logger.error(ex.getMessage());
         }
         try {
           newdata.put("RVP",
@@ -220,8 +220,8 @@ public StreamResponse(StreamInterface inputStream) {
           newdata.put("relative density", new Value(
               Double.toString(inputStream.getFluid().getPhase(name).getDensity("kg/m3") / 1000.0),
               "-"));
-        } catch (Exception e) {
-          logger.error(e.getMessage());
+        } catch (Exception ex) {
+          logger.error(ex.getMessage());
         }
       } else if (name.equals("gas")) {
         Standard_ISO6976 standard = inputStream.getISO6976("volume", 15.0, 15.0);

diff --git a/src/main/java/neqsim/processsimulation/util/report/Report.java b/src/main/java/neqsim/processsimulation/util/report/Report.java
@@ -30,7 +30,9 @@ public class Report {
   SystemInterface fluid = null;
 
   /**
-   * <p>Constructor for Report.</p>
+   * <p>
+   * Constructor for Report.
+   * </p>
    *
    * @param process a {@link neqsim.processsimulation.processsystem.ProcessSystem} object
    */
@@ -39,7 +41,9 @@ public Report(ProcessSystem process) {
   }
 
   /**
-   * <p>Constructor for Report.</p>
+   * <p>
+   * Constructor for Report.
+   * </p>
    *
    * @param fluid a {@link neqsim.thermo.system.SystemInterface} object
    */
@@ -48,16 +52,21 @@ public Report(SystemInterface fluid) {
   }
 
   /**
-   * <p>Constructor for Report.</p>
+   * <p>
+   * Constructor for Report.
+   * </p>
    *
-   * @param processEquipmentBaseClass a {@link neqsim.processsimulation.processequipment.ProcessEquipmentBaseClass} object
+   * @param processEquipmentBaseClass a
+   *        {@link neqsim.processsimulation.processequipment.ProcessEquipmentBaseClass} object
    */
   public Report(ProcessEquipmentBaseClass processEquipmentBaseClass) {
     processEquipment = processEquipmentBaseClass;
   }
 
   /**
-   * <p>Constructor for Report.</p>
+   * <p>
+   * Constructor for Report.
+   * </p>
    *
    * @param processModule a {@link neqsim.processsimulation.processsystem.ProcessModule} object
    */
@@ -66,16 +75,21 @@ public Report(ProcessModule processModule) {
   }
 
   /**
-   * <p>Constructor for Report.</p>
+   * <p>
+   * Constructor for Report.
+   * </p>
    *
-   * @param processModuleBaseClass a {@link neqsim.processsimulation.processsystem.ProcessModuleBaseClass} object
+   * @param processModuleBaseClass a
+   *        {@link neqsim.processsimulation.processsystem.ProcessModuleBaseClass} object
    */
   public Report(ProcessModuleBaseClass processModuleBaseClass) {
     // TODO Auto-generated constructor stub
   }
 
   /**
-   * <p>generateJsonReport.</p>
+   * <p>
+   * generateJsonReport.
+   * </p>
    *
    * @return a {@link java.lang.String} object
    */
@@ -101,16 +115,23 @@ public String generateJsonReport() {
     for (Map.Entry<String, String> entry : json_reports.entrySet()) {
       // Parse each value as a separate JSON object using the static parseString method
       try {
-        JsonObject nestedJsonObject = JsonParser.parseString(entry.getValue()).getAsJsonObject();
+        String s = entry.getValue();
+        if (s == null) {
+          // Not necessary to log that an entry is null
+          continue;
+        }
+        JsonObject nestedJsonObject = JsonParser.parseString(s).getAsJsonObject();
+
         // Update the final JsonObject with the parsed JSON object
         finalJsonObject.add(entry.getKey(), nestedJsonObject);
-      } catch (Exception e) {
-        logger.error(e.getMessage());
+      } catch (Exception ex) {
+        logger.error(ex.getMessage());
       }
     }
 
     // Convert the final JsonObject to a JSON string with pretty printing
-    Gson prettyGson = new GsonBuilder().serializeSpecialFloatingPointValues().setPrettyPrinting().create();
+    Gson prettyGson =
+        new GsonBuilder().serializeSpecialFloatingPointValues().setPrettyPrinting().create();
     return prettyGson.toJson(finalJsonObject);
   }
 }
diff --git a/src/main/java/neqsim/standards/gasquality/Standard_ISO15403.java b/src/main/java/neqsim/standards/gasquality/Standard_ISO15403.java
@@ -54,10 +54,8 @@ public double getValue(String returnParameter) {
     } else if (returnParameter.equals("NM")) {
       return NM;
     } else {
-      neqsim.util.exception.InvalidInputException ex =
-          new neqsim.util.exception.InvalidInputException(this, "getValue", "returnParameter",
-              "parameter not supported");
-      throw new RuntimeException(ex);
+      throw new RuntimeException(new neqsim.util.exception.InvalidInputException(this, "getValue",
+          "returnParameter", "parameter not supported"));
     }
   }
 

diff --git a/src/main/java/neqsim/standards/gasquality/Standard_ISO6976_2016.java b/src/main/java/neqsim/standards/gasquality/Standard_ISO6976_2016.java
@@ -126,7 +126,7 @@ public Standard_ISO6976_2016(SystemInterface thermoSystem) {
             M[i] = this.thermoSystem.getPhase(0).getComponent(i).getMolarMass();
             dataSet.next();
           } catch (Exception er) {
-            logger.error(er.toString());
+            logger.error(er.getMessage());
           }
           componentsNotDefinedByStandard
               .add("this.thermoSystem.getPhase(0).getComponent(i).getComponentName()");

diff --git a/src/main/java/neqsim/standards/salescontract/BaseContract.java b/src/main/java/neqsim/standards/salescontract/BaseContract.java
@@ -72,7 +72,7 @@ public BaseContract(SystemInterface system) {
    * @param country a {@link java.lang.String} object
    */
   public BaseContract(SystemInterface system, String terminal, String country) {
-    int numb = 0;
+    // int numb = 0;
     this.setContractName(contractName);
     try (
         neqsim.util.database.NeqSimContractDataBase database =
@@ -81,7 +81,7 @@ public BaseContract(SystemInterface system, String terminal, String country) {
             database.getResultSet("SELECT * FROM gascontractspecifications WHERE TERMINAL='"
                 + terminal + "'" + " AND COUNTRY='" + country + "'")) {
       while (dataSet.next()) {
-        numb++;
+        // numb++;
         StandardInterface method = getMethod(system, dataSet.getString("METHOD"));
         double referencePressure = Double.parseDouble(dataSet.getString("ReferencePbar"));
         method.setReferencePressure(referencePressure);
@@ -90,12 +90,12 @@ public BaseContract(SystemInterface system, String terminal, String country) {
             dataSet.getString("TERMINAL"), Double.parseDouble(dataSet.getString("MINVALUE")),
             Double.parseDouble(dataSet.getString("MAXVALUE")), dataSet.getString("UNIT"),
             Double.parseDouble(dataSet.getString("ReferenceTdegC")),
-            Double.parseDouble(dataSet.getString("ReferenceTdegC")), referencePressure, ""));// dataSet.getString("Comments"));
+            Double.parseDouble(dataSet.getString("ReferenceTdegC")), referencePressure, "")); // dataSet.getString("Comments"));
         // System.out.println(dataSet.getString("Comments"));
         // System.out.println("specification added..." + numb);
       }
     } catch (Exception ex) {
-      logger.error("error in comp", ex);
+      logger.error("error in comp");
     } finally {
       specificationsNumber = spesifications.size();
     }

diff --git a/src/main/java/neqsim/thermo/atomelement/Element.java b/src/main/java/neqsim/thermo/atomelement/Element.java
@@ -89,10 +89,8 @@ public String[] getElementNames() {
    */
   public double getNumberOfElements(String elementName) {
     if (nameArray == null) {
-      neqsim.util.exception.InvalidInputException ex =
-          new neqsim.util.exception.InvalidInputException(this, "getNumberOfElements", elementName,
-              "component not in element database..");
-      throw new RuntimeException(ex);
+      throw new RuntimeException(new neqsim.util.exception.InvalidInputException(this,
+          "getNumberOfElements", elementName, "component not in element database.."));
     }
     for (int i = 0; i < nameArray.length; i++) {
       if (nameArray[i].equals(elementName)) {