Fix documentation of ThermoPhase::setToEquilState

speth · speth · commit f5f12caa8ef0 · 2020-07-09T20:39:36.000-04:00
The values passed into this function are the nondimensional (species) chemical
potentials, not the element potentials. The method ChemEquil::setToEquilState
already handles calculation of the chemical potentials from the element
potentials.
diff --git a/include/cantera/thermo/ThermoPhase.h b/include/cantera/thermo/ThermoPhase.h
@@ -1457,10 +1457,10 @@ class ThermoPhase : public Phase
      * temperature is unchanged.  Any phase (ideal or not) that
      * implements this method can be equilibrated by ChemEquil.
      *
-     * @param lambda_RT Input vector of dimensionless element potentials
-     *                  The length is equal to nElements().
+     * @param mu_RT Input vector of dimensionless chemical potentials
+     *                  The length is equal to nSpecies().
      */
-    virtual void setToEquilState(const doublereal* lambda_RT) {
+    virtual void setToEquilState(const doublereal* mu_RT) {
         throw NotImplementedError("ThermoPhase::setToEquilState");
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1457,10 +1457,10 @@ class ThermoPhase : public Phase`
`1457`	`1457`	`* temperature is unchanged. Any phase (ideal or not) that`
`1458`	`1458`	`* implements this method can be equilibrated by ChemEquil.`
`1459`	`1459`	`*`
`1460`		`- * @param lambda_RT Input vector of dimensionless element potentials`
`1461`		`- * The length is equal to nElements().`
	`1460`	`+ * @param mu_RT Input vector of dimensionless chemical potentials`
	`1461`	`+ * The length is equal to nSpecies().`
`1462`	`1462`	`*/`
`1463`		`- virtual void setToEquilState(const doublereal* lambda_RT) {`
	`1463`	`+ virtual void setToEquilState(const doublereal* mu_RT) {`
`1464`	`1464`	`throw NotImplementedError("ThermoPhase::setToEquilState");`
`1465`	`1465`	`}`
`1466`	`1466`