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

[Matlab/Doc] Fix typos in docs for some ThermoPhase getters

Browse source 
These actually return scalars, although the docstrings
said they returned vectors
This commit is contained in:
Bryan W. Weber 2017-01-03 15:33:47 -05:00 • committed by Ray Speth
parent d655cf0eae
commit 983b2cc015
12 changed files with 16 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
interfaces/matlab/toolbox/@ThermoPhase/cp_mass.m
View file

@ -1,11 +1,11 @@
function v = cp_mass(tp)
% CP_MASS Get the mass-basis specific heats at constant pressure.
% CP_MASS Get the mass-basis specific heat at constant pressure.
% v = cp_mass(tp)
% :param tp:
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of specific heats of the species at
% Molar basis specific heat of the mixture at
% constant pressure. Units: J/kg-K
%

4
interfaces/matlab/toolbox/@ThermoPhase/cp_mole.m
View file

@ -1,11 +1,11 @@
function v = cp_mole(tp)
% CP_MOLE Get the molar-basis specific heats at constant pressure.
% CP_MOLE Get the molar-basis specific heat at constant pressure.
% v = cp_mole(tp)
% :param tp:
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of specific heats of the species at
% Molar basis specific heat of the mixture at
% constant pressure. Units: J/kmol-K
%

4
interfaces/matlab/toolbox/@ThermoPhase/cv_mass.m
View file

@ -1,11 +1,11 @@
function v = cv_mass(tp)
% CV_MASS Get the mass-basis specific heats at constant volume.
% CV_MASS Get the mass-basis specific heat at constant volume.
% v = cv_mass(tp)
% :param tp:
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of specific heats of the species at
% Mass basis specific heat of the mixture at
% constant volume. Units: J/kg-K
%

4
interfaces/matlab/toolbox/@ThermoPhase/cv_mole.m
View file

@ -1,11 +1,11 @@
function v = cv_mole(tp)
% CV_MOLE Get the molar-basis specific heats at constant volume.
% CV_MOLE Get the molar-basis specific heat at constant volume.
% v = cv_mole(tp)
% :param tp:
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of specific heats of the species at
% Molar basis specific heat of the mixture at
% constant volume. Units: J/kmol-K
%

2
interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mass.m
View file

@ -5,7 +5,7 @@ function v = enthalpy_mass(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of mass specific enthalpies of the species. Units: J/kg
% Mass specific enthalpy of the mixture. Units: J/kg
%
v = thermo_get(tp.tp_id, 9);

2
interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mole.m
View file

@ -5,7 +5,7 @@ function v = enthalpy_mole(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of molar specific enthalpies of the species. Units: J/kmol
% Molar specific enthalpy of the mixture. Units: J/kmol
%
v = thermo_get(tp.tp_id, 2);

2
interfaces/matlab/toolbox/@ThermoPhase/entropy_mass.m
View file

@ -5,7 +5,7 @@ function v = entropy_mass(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of mass specific entropies of the species. Units: J/kg-K
% Mass specific entropy of the mixture. Units: J/kg-K
%
v = thermo_get(tp.tp_id, 11);

2
interfaces/matlab/toolbox/@ThermoPhase/entropy_mole.m
View file

@ -5,7 +5,7 @@ function v = entropy_mole(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of molar specific entropies of the species. Units: J/kg
% Molar specific entropy of the mixture. Units: J/kg
%
v = thermo_get(tp.tp_id, 4);

3
interfaces/matlab/toolbox/@ThermoPhase/gibbs_mass.m
View file

@ -5,8 +5,7 @@ function v = gibbs_mass(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of mass specific Gibbs functions of the species.
% Units: J/kg
% Mass specific Gibbs function of the mixture. Units: J/kg
%
v = thermo_get(tp.tp_id, 12);

3
interfaces/matlab/toolbox/@ThermoPhase/gibbs_mole.m
View file

@ -5,8 +5,7 @@ function v = gibbs_mole(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of mole specific Gibbs functions of the species.
% Units: J/kmol
% Molar specific Gibbs function of the mixture. Units: J/kmol
%
v = thermo_get(tp.tp_id, 5);

3
interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mass.m
View file

@ -5,8 +5,7 @@ function v = intEnergy_mass(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of mass specific internal energies of the species.
% Units: J/kg
% Mass specific internal energy of the mixture. Units: J/kg
%
v = thermo_get(tp.tp_id, 10);

3
interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mole.m
View file

@ -5,8 +5,7 @@ function v = intEnergy_mole(tp)
% Instance of class :mat:func:`ThermoPhase` (or another
% object that derives from ThermoPhase)
% :return:
% Vector of mole specific internal energies of the species.
% Units: J/kmol
% Molar specific internal energy of the mixture. Units: J/kmol
%
v = thermo_get(tp.tp_id, 3);