[Python] Document ThermoPhase DP, DPX, and DPY properties

Cantera · Jul 3, 2015 · ce21b08 · ce21b08
1 parent 07f2562
commit ce21b08
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/interfaces/cython/cantera/thermo.pyx b/interfaces/cython/cantera/thermo.pyx
@@ -887,6 +887,7 @@ cdef class ThermoPhase(_SolutionBase):
                                     V / self._mass_factor())
 
     property DP:
+        """Get/Set density [kg/m^3] and pressure [Pa]."""
         def __get__(self):
             return self.density, self.P
         def __set__(self, values):
@@ -896,6 +897,7 @@ cdef class ThermoPhase(_SolutionBase):
             self.thermo.setState_RP(D*self._mass_factor(), P)
 
     property DPX:
+        """Get/Set density [kg/m^3], pressure [Pa], and mole fractions."""
         def __get__(self):
             return self.density, self.P, self.X
         def __set__(self, values):
@@ -906,6 +908,7 @@ cdef class ThermoPhase(_SolutionBase):
             self.thermo.setState_RP(D*self._mass_factor(), P)
 
     property DPY:
+        """Get/Set density [kg/m^3], pressure [Pa], and mass fractions."""
         def __get__(self):
             return self.density, self.P, self.Y
         def __set__(self, values):