cantera/interfaces/matlab/toolbox/@ReactorNet/step.m
Ray Speth 8d4e9bff6e [Reactor] Make argument to ReactorNet.step optional and deprecated
The value of this argument has almost no effect on the integrator, and
frequently confuses users since the ReactorNet can end up at a time either
greater or less than the specified time. By removing this argument, the
distinction betwen step() and advance(t) becomes much more clear.
2015-06-11 14:03:20 -04:00

39 lines
1,000 B
Matlab

function t = step(r, tout)
% STEP Take one internal time step.
% t = step(r)
% The integrator used to integrate the ODEs (CVODE) takes
% variable-size steps, chosen so that a specified error
% tolerance is maintained. At times when the solution is rapidly
% changing, the time step becomes smaller to resolve the
% solution.
%
% Method :mat:func:`step` takes one internal time step and returns
% the network time after taking that step. This
% can be useful when it is desired to resolve a rapidly-changing
% solution.
%
% This method can be used as follows:
%
% .. code-block:: matlab
%
% t = 0.0
% tout = 0.1
% while t < tout
% t = step(r)
% ,,,
% <commands to save desired variables>
% ...
% end
%
% See also: :mat:func:`advance`
%
% :param r:
% Instance of class :mat:func:`ReactorNet`
% :return:
% Network time after the internal time step. Units: s
%
if nargin == 1
tout = -999;
end
t = reactornetmethods(21, reactornet_hndl(r), tout);