40 lines
1.1 KiB
Matlab
40 lines
1.1 KiB
Matlab
function t = step(r, tout)
|
|
% STEP Take one internal time step.
|
|
% t = step(r, tout)
|
|
% 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, tout)
|
|
% ,,,
|
|
% <commands to save desired variables>
|
|
% ...
|
|
% end
|
|
%
|
|
% See also: :mat:func:`advance`
|
|
%
|
|
% :param r:
|
|
% Instance of class :mat:func:`ReactorNet`
|
|
% :param tout:
|
|
% End time that the integrator should take one internal time
|
|
% step towards. This end time may not be reached, or may be
|
|
% exceeded by the internal time step.
|
|
% :return:
|
|
% Network time after the internal time step. Units: s
|
|
%
|
|
|
|
t = reactornetmethods(21, reactornet_hndl(r), tout);
|