From 11db445caf1d07ea62ad2b6f960829ad587d85b9 Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Sat, 14 May 2016 16:43:35 -0400 Subject: [PATCH] [Thermo/Doc] Explain why Phase::setMolecularWeight exists --- include/cantera/thermo/Phase.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/include/cantera/thermo/Phase.h b/include/cantera/thermo/Phase.h index 441878d1a..46bcb7030 100644 --- a/include/cantera/thermo/Phase.h +++ b/include/cantera/thermo/Phase.h @@ -752,7 +752,11 @@ protected: */ mutable ValueCache m_cache; - //! Set the molecular weight of a single species to a given value + //! Set the molecular weight of a single species to a given value. + //! + //! Used by phases where the equation of state is defined for a specific + //! value of the molecular weight which may not exactly correspond to the + //! value computed from the chemical formula. //! @param k id of the species //! @param mw Molecular Weight (kg kmol-1) void setMolecularWeight(const int k, const double mw) {