research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Correct docs for setState_*sat in Matlab

Browse source 
Correct the documentation to clarify that a vector must be passed in to
these functions, not a single value.
This commit is contained in:
Bryan W. Weber 2015-10-23 17:06:33 -04:00
parent 5aabfe9704
commit 0b5c97ad4f
2 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
interfaces/matlab/toolbox/@ThermoPhase/setState_Psat.m
View file

@ -1,10 +1,15 @@
function setState_Psat(tp, px)
% SETSTATE_PSAT Set the fluid to a saturated state at a given pressure.
% SETSTATE_PSAT Set the fluid state using the given pressure and quality.
% setState_Psat(tp,px)
% The fluid state will be set to a saturated liquid-vapor state using the
% input pressure and vapor fraction (quality) as the independent,
% intensive variables.
% :param tp:
% Instance of class :mat:func:`ThermoPhase` (or another
% class derived from ThermoPhase)
% :param px:
% Pressure. Units: Pa
% Vector of length 2 containing the desired values for the pressure (Pa)
% and the vapor fraction
%
thermo_set(tp.tp_id, 24, px);

8
interfaces/matlab/toolbox/@ThermoPhase/setState_Tsat.m
View file

@ -1,11 +1,15 @@
function setState_Tsat(tp, tx)
% SETSTATE_TSAT Set the fluid to a saturated state at a given temperature.
% SETSTATE_TSAT Set the fluid state using the given temperature and quality.
% setState_Tsat(tp,tx)
% The fluid state will be set to a saturated liquid-vapor state using the
% input temperature and vapor fraction (quality) as the independent,
% intensive variables.
% :param tp:
% Instance of class :mat:func:`ThermoPhase` (or another
% class derived from ThermoPhase)
% :param tx:
% Temperature. Units: K
% Vector of length 2 containing the desired values for the temperature (K)
% and the vapor fraction (quality)
%
thermo_set(tp.tp_id, 25, tx);