docfix: specify that reference pressure is in bara (#827)

equinor · Oct 4, 2023 · 9587f09 · 9587f09
1 parent ede9c66
commit 9587f09
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 10 deletions.
diff --git a/...ava/neqsim/processSimulation/measurementDevice/HydrateEquilibriumTemperatureAnalyser.java b/...ava/neqsim/processSimulation/measurementDevice/HydrateEquilibriumTemperatureAnalyser.java
@@ -82,7 +82,7 @@ public double getMeasuredValue(String unit) {
    * Getter for the field <code>referencePressure</code>.
    * </p>
    *
-   * @return a double
+   * @return Reference pressure in bara
    */
   public double getReferencePressure() {
     return referencePressure;
@@ -93,7 +93,7 @@ public double getReferencePressure() {
    * Setter for the field <code>referencePressure</code>.
    * </p>
    *
-   * @param referencePressure a double
+   * @param referencePressure Reference pressure to set in in bara
    */
   public void setReferencePressure(double referencePressure) {
     this.referencePressure = referencePressure;

diff --git a/src/main/java/neqsim/processSimulation/measurementDevice/WaterDewPointAnalyser.java b/src/main/java/neqsim/processSimulation/measurementDevice/WaterDewPointAnalyser.java
@@ -99,7 +99,7 @@ public double getMeasuredValue(String unit) {
    * Getter for the field <code>referencePressure</code>.
    * </p>
    *
-   * @return a double
+   * @return Reference pressure in bara
    */
   public double getReferencePressure() {
     return referencePressure;
@@ -110,7 +110,7 @@ public double getReferencePressure() {
    * Setter for the field <code>referencePressure</code>.
    * </p>
    *
-   * @param referencePressure a double
+   * @param referencePressure Reference pressure to set in in bara
    */
   public void setReferencePressure(double referencePressure) {
     this.referencePressure = referencePressure;

diff --git a/src/main/java/neqsim/standards/Standard.java b/src/main/java/neqsim/standards/Standard.java
@@ -199,11 +199,15 @@ public void setReferenceState(String referenceState) {
     this.referenceState = referenceState;
   }
 
-  public void setReferencePressure(double referencePressure) {
-    this.referencePressure = referencePressure;
+  /** {@inheritDoc} */
+  @Override
+  public double getReferencePressure() {
+    return referencePressure;
   }
 
-  public double getReferencePressure(){
-    return referencePressure;
+  /** {@inheritDoc} */
+  @Override
+  public void setReferencePressure(double referencePressure) {
+    this.referencePressure = referencePressure;
   }
 }
diff --git a/src/main/java/neqsim/standards/StandardInterface.java b/src/main/java/neqsim/standards/StandardInterface.java
@@ -165,5 +165,21 @@ public interface StandardInterface {
    */
   public void setResultTable(String[][] resultTable);
 
+  /**
+   * <p>
+   * Getter for the field <code>referencePressure</code>.
+   * </p>
+   *
+   * @return Reference pressure in bara
+   */
+  public double getReferencePressure();
+
+  /**
+   * <p>
+   * Setter for the field <code>referencePressure</code>.
+   * </p>
+   *
+   * @param referencePressure Reference pressure to set in in bara
+   */
   public void setReferencePressure(double referencePressure);
 }
diff --git a/src/main/java/neqsim/standards/salesContract/ContractSpecification.java b/src/main/java/neqsim/standards/salesContract/ContractSpecification.java
@@ -202,7 +202,7 @@ public void setReferenceTemperatureMeasurement(double referenceTemperature) {
    * Getter for the field <code>referencePressure</code>.
    * </p>
    *
-   * @return a double
+   * @return Reference pressure in bara
    */
   public double getReferencePressure() {
     return referencePressure;
@@ -213,7 +213,7 @@ public double getReferencePressure() {
    * Setter for the field <code>referencePressure</code>.
    * </p>
    *
-   * @param referencePressure a double
+   * @param referencePressure Reference pressure to set in in bara
    */
   public void setReferencePressure(double referencePressure) {
     this.referencePressure = referencePressure;