From 0b5c97ad4f41a12b2abeb4efa07c6fe9458651a8 Mon Sep 17 00:00:00 2001 From: "Bryan W. Weber" Date: Fri, 23 Oct 2015 17:06:33 -0400 Subject: [PATCH] [Doc] Correct docs for setState_*sat in Matlab Correct the documentation to clarify that a vector must be passed in to these functions, not a single value. --- interfaces/matlab/toolbox/@ThermoPhase/setState_Psat.m | 9 +++++++-- interfaces/matlab/toolbox/@ThermoPhase/setState_Tsat.m | 8 ++++++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/interfaces/matlab/toolbox/@ThermoPhase/setState_Psat.m b/interfaces/matlab/toolbox/@ThermoPhase/setState_Psat.m index 1d4a5e256..c3afb15e8 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/setState_Psat.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/setState_Psat.m @@ -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); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/setState_Tsat.m b/interfaces/matlab/toolbox/@ThermoPhase/setState_Tsat.m index 765f4959d..fe1accaca 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/setState_Tsat.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/setState_Tsat.m @@ -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);