doc

equinor · Oct 27, 2024 · fa03fdf · fa03fdf
1 parent 856de59
commit fa03fdf
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/src/main/java/neqsim/physicalproperties/physicalpropertysystem/PhysicalProperties.java b/src/main/java/neqsim/physicalproperties/physicalpropertysystem/PhysicalProperties.java
@@ -228,7 +228,9 @@ public double calcKinematicViscosity() {
 
   /**
    * <p>
-   * setPhases.
+   * Set phase information for all physical property calc methods, i.e., subclasses of
+   * physicalpropertymethods using setPhase(this). NB! Safe even if calc methods are null, e.g.,
+   * from constructors.
    * </p>
    */
   public void setPhases() {

diff --git a/...in/java/neqsim/physicalproperties/physicalpropertysystem/PhysicalPropertiesInterface.java b/...in/java/neqsim/physicalproperties/physicalpropertysystem/PhysicalPropertiesInterface.java
@@ -163,7 +163,7 @@ public void setMixingRule(
 
   /**
    * <p>
-   * getPhase.
+   * Getter for property <code>phase</code>.
    * </p>
    *
    * @return a {@link neqsim.thermo.phase.PhaseInterface} object
@@ -172,7 +172,8 @@ public void setMixingRule(
 
   /**
    * <p>
-   * setPhase.
+   * Setter for property <code>phase</code>. Will also set the phase for all physicalpropertymethods
+   * using setPhases. Safe to call from constructor.
    * </p>
    *
    * @param phase a {@link neqsim.thermo.phase.PhaseInterface} object