cantera/interfaces/matlab/toolbox/IdealGasReactor.m
Ingmar Schoegl d263566670 [Reactor] Deprecating magic numbers.
* add deprecation warning for int ReactorBase::type() (to be changed after Cantera 2.5)
 * introduce temporary std::string ReactorBase::typeStr() (to be renamed after Cantera 2.5)
 * deprecate all functions using the old call and introduce associated temporary functions
2019-08-01 15:37:48 -04:00

25 lines
757 B
Matlab

function r = IdealGasReactor(contents)
% IDEALGASREACTOR Create a reactor with an ideal gas.
% r = IdealGasReactor(contents)
% An IdealGasReactor is an instance of class Reactor where the governing
% equations are specialized for the ideal gas equation of state (and do not
% work correctly with other thermodynamic models). Examples:
%
% .. code-block:: matlab
%
% r1 = IdealGasReactor % an empty reactor
% r2 = IdealGasReactor(gas) % a reactor containing a gas
%
% See also: :mat:func:`Reactor`
%
% :param contents:
% Cantera :mat:func:`Solution` to be set as the contents of the
% reactor
% :return:
% Instance of class :mat:func:`Reactor`
%
if nargin == 0
contents = 0;
end
r = Reactor(contents, 'IdealGasReactor');