cantera/interfaces/matlab/toolbox/ConstPressureReactor.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

26 lines
848 B
Matlab

function r = ConstPressureReactor(contents)
% CONSTPRESSUREREACTOR Create a constant pressure reactor object.
% r = ConstPressureReactor(contents)
% A :mat:func:`ConstPressureReactor` is an instance of class
% :mat:func:`Reactor` where the pressure is held constant. The volume
% is not a state variable, but instead takes on whatever value is
% consistent with holding the pressure constant. Examples:
%
% .. code-block:: matlab
%
% r1 = ConstPressureReactor % an empty reactor
% r2 = ConstPressureReactor(contents) % a reactor containing contents
%
% 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, 'ConstPressureReactor');