Add a note about the state setters to PureFluidPhase

Cantera · Jan 22, 2016 · 9714be4 · 9714be4
1 parent 37e488a
commit 9714be4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/thermo/PureFluidPhase.cpp b/src/thermo/PureFluidPhase.cpp
@@ -284,6 +284,11 @@ doublereal PureFluidPhase::satTemperature(doublereal p) const
     return m_sub->Tsat(p);
 }
 
+/* The next several functions set the state. They run the Substance::Set
+ * function, followed by setting the state of the ThermoPhase object
+ * to the newly computed temperature and density of the Substance.
+ */
+
 void PureFluidPhase::setState_HP(double h, double p, double tol)
 {
     Set(tpx::PropertyPair::HP, h, p);