Added docstrings to Cython PureFluid class
This commit is contained in:
parent
6b34150a6c
commit
c5f649b036
2 changed files with 20 additions and 0 deletions
|
|
@ -1,25 +1,33 @@
|
|||
from . import PureFluid
|
||||
|
||||
def Water():
|
||||
"""Create a `PureFluid` object using the equation of state for water."""
|
||||
return PureFluid('liquidvapor.xml','water')
|
||||
|
||||
def Nitrogen():
|
||||
"""Create a `PureFluid` object using the equation of state for nitrogen."""
|
||||
return PureFluid('liquidvapor.xml','nitrogen')
|
||||
|
||||
def Methane():
|
||||
"""Create a `PureFluid` object using the equation of state for methane."""
|
||||
return PureFluid('liquidvapor.xml','methane')
|
||||
|
||||
def Hydrogen():
|
||||
"""Create a `PureFluid` object using the equation of state for hydrogen."""
|
||||
return PureFluid('liquidvapor.xml','hydrogen')
|
||||
|
||||
def Oxygen():
|
||||
"""Create a `PureFluid` object using the equation of state for oxygen."""
|
||||
return PureFluid('liquidvapor.xml','oxygen')
|
||||
|
||||
def Hfc134a():
|
||||
"""Create a `PureFluid` object using the equation of state for HFC-134a."""
|
||||
return PureFluid('liquidvapor.xml','hfc134a')
|
||||
|
||||
def CarbonDioxide():
|
||||
"""Create a `PureFluid` object using the equation of state for carbon dioxide."""
|
||||
return PureFluid('liquidvapor.xml','carbondioxide')
|
||||
|
||||
def Heptane():
|
||||
"""Create a `PureFluid` object using the equation of state for heptane."""
|
||||
return PureFluid('liquidvapor.xml','heptane')
|
||||
|
|
|
|||
|
|
@ -721,37 +721,49 @@ cdef class InterfacePhase(ThermoPhase):
|
|||
|
||||
|
||||
cdef class PureFluid(ThermoPhase):
|
||||
"""
|
||||
A pure substance that can be a gas, a liquid, a mixed gas-liquid fluid,
|
||||
or a fluid beyond its critical point.
|
||||
"""
|
||||
property critTemperature:
|
||||
"""Critical temperature [K]"""
|
||||
def __get__(self):
|
||||
return self.thermo.critTemperature()
|
||||
|
||||
property critPressure:
|
||||
"""Critical pressure [Pa]"""
|
||||
def __get__(self):
|
||||
return self.thermo.critPressure()
|
||||
|
||||
property critDensity:
|
||||
"""Critical density [kg/m^3 or kmol/m^3] depending on `basis`."""
|
||||
def __get__(self):
|
||||
return self.thermo.critDensity() / self._massFactor()
|
||||
|
||||
property Psat:
|
||||
"""Saturation pressure [Pa] at the current temperature"""
|
||||
def __get__(self):
|
||||
return self.thermo.satPressure(self.T)
|
||||
|
||||
property Tsat:
|
||||
"""Saturation temperature [K] at the current pressure"""
|
||||
def __get__(self):
|
||||
return self.thermo.satTemperature(self.P)
|
||||
|
||||
property X:
|
||||
"""Vapor fraction (quality)"""
|
||||
def __get__(self):
|
||||
return self.thermo.vaporFraction()
|
||||
|
||||
property TX:
|
||||
"""Get/Set the temperature and vapor fraction of a two-phase state."""
|
||||
def __get__(self):
|
||||
return self.T, self.X
|
||||
def __set__(self, values):
|
||||
self.thermo.setState_Tsat(values[0], values[1])
|
||||
|
||||
property PX:
|
||||
"""Get/Set the pressure and vapor fraction of a two-phase state."""
|
||||
def __get__(self):
|
||||
return self.P, self.X
|
||||
def __set__(self, values):
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue