naginterfaces.library.ode.ivp_​stiff_​exp_​revcom

naginterfaces.library.ode.ivp_stiff_exp_revcom(t, tout, y, ydot, comm, rtol, atol, itol, wkjac, imon, inln, ires, irevcm, itask, itrace, io_manager=None)

ivp_stiff_exp_revcom is a reverse communication function for integrating stiff systems of explicit ordinary differential equations.

For full information please refer to the NAG Library document for d02nm

https://www.nag.com/numeric/nl/nagdoc_29.3/flhtml/d02/d02nmf.html

Parameters

tfloat

On initial entry: $t$, the value of the independent variable. The input value of $t$ is used only on the first call as the initial point of the integration.

toutfloat

On initial entry: the next value of $t$ at which a computed solution is desired. For the initial $t$, the input value of $tout$ is used to determine the direction of integration. Integration is permitted in either direction (see also $itask$).

yfloat, ndarray, shape $\left(\text{neq}\right)$, modified in place

On initial entry: the values of the dependent variables (solution). On the first call the first $\text{neq}$ elements of $y$ must contain the vector of initial values.

On final exit: the computed solution vector evaluated at $t$ (usually $t=tout$).

ydotfloat, ndarray, shape $\left(\text{neq}\right)$, modified in place

On intermediate entry: must be set to the derivatives as defined under the description of $irevcm$.

On final exit: the time derivatives $y^{\prime }$ of the vector $y$ at the last integration point.

commdict, communication object, modified in place

Communication structure.

This argument must have been initialized by prior calls to one of ivp_stiff_fulljac_setup(), ivp_stiff_bandjac_setup() or ivp_stiff_sparjac_setup() and one of ivp_stiff_dassl(), ivp_stiff_bdf() or ivp_stiff_blend().

rtolfloat, array-like, shape $(:)$

Note: the required length for this argument is determined as follows: if $itol\text{in}(1,2)$: $1$; otherwise: $\text{neq}$.

On initial entry: the relative local error tolerance.

atolfloat, array-like, shape $(:)$

Note: the required length for this argument is determined as follows: if $itol\text{in}(1,3)$: $1$; otherwise: $\text{neq}$.

On initial entry: the absolute local error tolerance.

itolint

On initial entry: a value to indicate the form of the local error test. $itol$ indicates to ivp_stiff_exp_revcom whether to interpret either or both of $rtol$ or $atol$ as a vector or a scalar. The error test to be satisfied is $\parallel e_i/w_i\parallel <1.0$, where $w_i$ is defined as follows:

$itol$	$rtol$	$atol$	$w_i$
1	scalar	scalar	$rtol\left[0\right]\times \left|y_i\right|+atol\left[0\right]$
2	scalar	vector	$rtol\left[0\right]\times \left|y_i\right|+atol[i-1]$
3	vector	scalar	$rtol[i-1]\times \left|y_i\right|+atol\left[0\right]$
4	vector	vector	$rtol[i-1]\times \left|y_i\right|+atol[i-1]$

$e_i$ is an estimate of the local error in $y_i$, computed internally, and the choice of norm to be used is defined by a previous call to an integrator setup function.

wkjacfloat, ndarray, shape $\left(\text{nwkjac}\right)$, modified in place

On intermediate entry: elements of the Jacobian as defined under the description of $irevcm$. If a numerical Jacobian was requested then $wkjac$ is used for workspace.

On intermediate exit: the Jacobian is overwritten.

imonint

On intermediate entry: may be reset to determine subsequent action in ivp_stiff_exp_revcom.

$imon=-2$

Integration is to be halted. A return will be made from ivp_stiff_exp_revcom to the calling (sub)program with $errno$ = 12.

$imon=-1$

Allow ivp_stiff_exp_revcom to continue with its own internal strategy. The integrator will try up to three restarts unless $imon\ne -1$.

$imon=0$

Return to the internal nonlinear equation solver, where the action taken is determined by the value of $inln$.

$imon=1$

Normal exit to ivp_stiff_exp_revcom to continue integration.

$imon=2$

Restart the integration at the current time point. The integrator will restart from order $1$ when this option is used. The solution $y$, provided by the $monitr$ operation (see Notes), will be used for the initial conditions.

$imon=3$

Try to continue with the same step size and order as was to be used before entering the $monitr$ operation (see Notes). $hmin$ and $hmax$ may be altered if desired.

$imon=4$

Continue the integration but using a new value of $hnext$ and possibly new values of $hmin$ and $hmax$.

inlnint

On intermediate entry: with $imon=0$ and $irevcm=9$, $inln$ specifies the action to be taken by the internal nonlinear equation solver. By setting $inln=3$ and returning to ivp_stiff_exp_revcom, the residual vector is evaluated and placed in $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[50+2\times \text{neq}+\text{i}-1]$, for $\text{i}=1,2,\dots ,\text{neq}$ and then the $monitr$ operation (see Notes) is invoked again. At present this is the only option available: $inln$ must not be set to any other value.

iresint

On intermediate entry: should be unchanged unless one of the following actions is required of ivp_stiff_exp_revcom in which case $ires$ should be set accordingly.

$ires=2$

Indicates to ivp_stiff_exp_revcom that control should be passed back immediately to the calling (sub)program with the error indicator set to $errno$ = 11.

$ires=3$

Indicates to ivp_stiff_exp_revcom that an error condition has occurred in the solution vector, its time derivative or in the value of $t$. The integrator will use a smaller time step to try to avoid this condition. If this is not possible ivp_stiff_exp_revcom returns to the calling (sub)program with the error indicator set to $errno$ = 7.

$ires=4$

Indicates to ivp_stiff_exp_revcom to stop its current operation and to enter the $monitr$ operation (see Notes) immediately.

irevcmint

On initial entry: must contain $0$.

On intermediate entry: should remain unchanged.

itaskint

On initial entry: the task to be performed by the integrator.

$itask=1$

Normal computation of output values of $y\left(t\right)$ at $t=tout$ (by overshooting and interpolating).

$itask=2$

Take one step only and return.

$itask=3$

Stop at the first internal integration point at or beyond $t=tout$ and return.

$itask=4$

Normal computation of output values of $y\left(t\right)$ at $t=tout$ but without overshooting $t=\text{tcrit}$. $\text{tcrit}$ must be specified as an option in one of the integrator setup functions before the first call to the integrator, or specified in the optional input function before a continuation call. $\text{tcrit}$ (e.g., see ivp_stiff_bdf()) may be equal to or beyond $tout$, but not before it in the direction of integration.

$itask=5$

Take one step only and return, without passing $\text{tcrit}$ (e.g., see ivp_stiff_bdf()). $\text{tcrit}$ must be specified under $itask=4$.

itraceint

On initial entry: the level of output that is printed by the integrator. $itrace$ may take the value $-1$, $0$, $1$, $2$ or $3$.

$itrace<-1$

$-1$ is assumed and similarly if $itrace>3$, $3$ is assumed.

$itrace=-1$

No output is generated.

$itrace=0$

Only warning messages are printed on the current error message unit (see FileObjManager).

$itrace>0$

Warning messages are printed as above, and on the file object associated with the advisory I/O unit (see FileObjManager) output is generated which details Jacobian entries, the nonlinear iteration and the time integration. The advisory messages are given in greater detail the larger the value of $itrace$.

io_managerFileObjManager, optional

Manager for I/O in this routine.

Returns

tfloat

On final exit: the value at which the computed solution $y$ is returned (usually at $tout$).

imonint

On intermediate exit: used to pass information between ivp_stiff_exp_revcom and the MONITR operation (see Notes). With $irevcm=9$, $imon$ contains a flag indicating under what circumstances the return from ivp_stiff_exp_revcom occurred:

$imon=-2$

Exit from ivp_stiff_exp_revcom after $ires=4$ caused an early termination (this facility could be used to locate discontinuities).

$imon=-1$

The current step failed repeatedly.

$imon=0$

Exit from ivp_stiff_exp_revcom after a call to the internal nonlinear equation solver.

$imon=1$

The current step was successful.

inlnint

On intermediate exit: contains a flag indicating the action to be taken, if any, by the internal nonlinear equation solver.

iresint

On intermediate exit: with $irevcm=1$, $2$, $3$, $4$ or $5$, $ires$ contains the value $1$.

irevcmint

On intermediate exit: indicates what action you must take before re-entering. The possible exit values of $irevcm$ are $1$, $3$, $4$, $5$, $8$, $9$ or $10$, which should be interpreted as follows:

$irevcm=1$, $3$, $4$ or $5$

Indicates that an FCN operation (see Notes) is required: $y^{\prime }=g(t,y)$ must be supplied, where $y[\text{i}-1]$ is located in $y_{\text{i}}$, for $\text{i}=1,2,\dots ,\text{neq}$.

For $irevcm=1$ or $3$, $y_{\text{i}}^{\prime }$ should be placed in location $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[50+2\times \text{neq}+\text{i}-1]$, for $\text{i}=1,2,\dots ,\text{neq}$.

For $irevcm=4$, $y_{\text{i}}^{\prime }$ should be placed in location $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[50+\text{neq}+\text{i}-1]$, for $\text{i}=1,2,\dots ,\text{neq}$.

For $irevcm=5$, $y_{\text{i}}^{\prime }$ should be placed in location $ydot[\text{i}-1]$, for $\text{i}=1,2,\dots ,\text{neq}$.

$irevcm=8$

Indicates that a JAC operation (see Notes) is required: the Jacobian matrix must be supplied.

If full matrix linear algebra is being used, the $(i,j)$th element of the Jacobian must be stored in $wkjac[(j-1)\times \text{neq}+i-1]$.

If banded matrix linear algebra is being used then the $(i,j)$th element of the Jacobian must be stored in $wkjac[(i-1)\times m_B+k-1]$, where $m_B=m_L+m_U+1$ and $k=min(m_L-i+1,0)+j$; here $m_L$ and $m_U$ are the number of subdiagonals and superdiagonals, respectively, in the band.

If sparse matrix linear algebra is being used then ivp_stiff_sparjac_enq() must be called to determine which column of the Jacobian is required and where it should be stored.

$irevcm=9$

Indicates that a MONITR operation (see Notes) can be performed.

$irevcm=10$

Indicates that the current step was not successful, due to error test failure or convergence test failure. The only information supplied to you on this return is the current value of the independent variable $t$, located in $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[18]$. No values must be changed before re-entering ivp_stiff_exp_revcom; this facility enables you to determine the number of unsuccessful steps.

On final exit: $irevcm=0$ indicated the user-specified task has been completed or an error has been encountered (see the descriptions for $itask$ and $\text{errno}$).

Raises

NagValueError

(errno $1$)

On re-entry, $imon=⟨value⟩$.

Constraint: $-2\le imon\le 4$.

(errno $1$)

Failure during internal time interpolation. $tout$ and the current time are too close.

$itask=⟨value⟩$ and $tout=⟨value⟩$ and the current time is $⟨value⟩$.

(errno $1$)

On entry, $itask=4$ or $5$ and $\text{tcrit}$ is before the current time in the direction of integration.

$itask=⟨value⟩$, $\text{tcrit}=⟨value⟩$ and the current time is $⟨value⟩$.

(errno $1$)

$itask=3$ and $tout$ is more than an integration step behind the current time.

$tout=⟨value⟩$, current time minus step size: $⟨value⟩$.

(errno $1$)

The initial stepsize, $⟨value⟩$, is too small.

(errno $1$)

Weight number $i=⟨value⟩$ used in the local error test is too small. Check the values of $rtol$ and $atol$.

$atol[i-1]$ and $y[i-1]$ may both be zero.

Weight $i=⟨value⟩$.

(errno $1$)

On entry, $itask=4$ or $5$ and $\text{tcrit}$ is before $tout$ in the direction of integration.

$itask=⟨value⟩$, $\text{tcrit}=⟨value⟩$ and $tout=⟨value⟩$.

(errno $1$)

On entry, $atol=⟨value⟩$.

Constraint: $atol\ge 0.0$.

(errno $1$)

On entry, $rtol=⟨value⟩$.

Constraint: $rtol\ge 0.0$.

(errno $1$)

Either the value of $\text{nwkjac}$ is not the same as the value supplied to the setup function or a communication array has become corrupted.

$\text{nwkjac}=⟨value⟩$, $\text{nwkjac}$ (setup) $=⟨value⟩$.

(errno $1$)

Either the value of $\text{sdysav}$ is not the same as the value supplied to the setup function or a communication array has become corrupted.

$\text{sdysav}=⟨value⟩$, $\text{sdysav}$ (setup) $=⟨value⟩$.

(errno $1$)

On entry, an illegal (negative) minimum stepsize was provided in a prior call to a setup function. $\text{hmin}=⟨value⟩$.

(errno $1$)

On entry, $tout$ is less than $t$ with respect to the direction of integration given by the sign of $\text{h0}$ in a prior call to a setup function.

$tout=⟨value⟩$, $t=⟨value⟩$ and $\text{h0}=⟨value⟩$.

(errno $1$)

On entry, an illegal (negative) maximum number of steps was provided in a prior call to a setup function. $\text{maxstp}=⟨value⟩$.

(errno $1$)

On entry, $itol=⟨value⟩$.

Constraint: $1\le itol\le 4$.

(errno $1$)

On entry, $\text{neq}=⟨value⟩$ and $\text{ldysav}=⟨value⟩$.

Constraint: $\text{neq}\le \text{ldysav}$.

(errno $1$)

On entry, $\text{neq}=⟨value⟩$.

Constraint: $\text{neq}\ge 1$.

(errno $1$)

Either the function was entered on a continuation call without a prior call of this function, or a communication array has become corrupted.

(errno $1$)

On entry, $tout$ is too close to $t$ to start integration.

$tout=⟨value⟩$ and $t=⟨value⟩$.

(errno $1$)

On entry, $itask=⟨value⟩$.

Constraint: $1\le itask\le 5$.

(errno $1$)

Either the integrator setup function has not been called prior to the first call of this function, or a communication array has become corrupted.

(errno $1$)

On entry, an illegal (negative) maximum stepsize was provided in a prior call to a setup function. $\text{hmax}=⟨value⟩$.

(errno $1$)

Either the linear algebra setup function has not been called prior to the first call of this function, or a communication array has become corrupted.

(errno $1$)

On re-entry, $inln\ne 3$ for the case $irevcm=9$ and $imon=0$.

$inln=⟨value⟩$.

(errno $1$)

On entry, $irevcm$ is invalid: $irevcm=⟨value⟩$.

(errno $1$)

On re-entry, the solution vector appears to have been overwritten.

Further integration will not be attempted.

(errno $2$)

At time $⟨value⟩$ the maximum number of allowed steps on this call was taken before reaching the next output point $tout=⟨value⟩$.

Maximum number of steps $=⟨value⟩$.

(errno $7$)

The derivative evaluation procedure set the error flag $ires=3$ repeatedly despite attempts by the integrator to avoid this.

(errno $9$)

A singular Jacobian has been encountered. You should check the problem formulation and Jacobian calculation.

(errno $10$)

Workspace error occurred when trying to form the Jacobian matrix in calculating the initial values of the solution and its time derivative.

(errno $10$)

Not enough integer store provided for sparse matrix solver.

Units of store needed: $⟨value⟩$. Amount provided: $⟨value⟩$.

(errno $10$)

Larger integer workspace required.

Provided: $⟨value⟩$; required: $⟨value⟩$.

(errno $10$)

Not enough real store provided for sparse matrix solver.

Units of store needed: $⟨value⟩$. Amount provided: $⟨value⟩$.

(errno $14$)

On entry, too much accuracy requested for precision of the machine at the start of problem. The tolerances should be checked; the requested accuracy should be reduced by a factor of at least $⟨value⟩$.

Warns

NagAlgorithmicWarning

(errno $3$)

Too much accuracy requested for precision of the machine at time $⟨value⟩$.

The tolerances should be checked; the requested accuracy should be reduced by a factor of at least $⟨value⟩$.

(errno $4$)

There were repeated error-test failures on an attempted step, before completing the requested task, but the integration was successful as far as $t$. The problem may have a singularity, or the local error requirements may be inappropriate.

(errno $5$)

There were repeated convergence-test failures on an attempted step, before completing the requested task, but the integration was successful as far as $t$. This may be caused by an inaccurate Jacobian matrix or one which is incorrectly computed.

(errno $6$)

At time $⟨value⟩$, error weight $⟨value⟩$ became zero. Check the values of $atol$, $rtol$ and $itol$ supplied.

(errno $11$)

On re-entry, $ires=2$, which signals that the integration should terminate. $ires=⟨value⟩$ at time $⟨value⟩$.

(errno $12$)

A return was forced by setting $imon=-2$, but the integration was successful as far as $t$.

(errno $13$)

The requested task has been completed, but it is estimated that a small change in $rtol$ and $atol$ is unlikely to produce any change in the computed solution. (This ONLY applies when you are NOT operating in one step mode; that is, when $itask\ne 2$ or $5$.)

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

ivp_stiff_exp_revcom is a general purpose function for integrating the initial value problem for a stiff system of explicit ordinary differential equations,

$$y^{\prime }=g(t,y)\text{.}$$

An outline of a typical calling program is

call the linear algebra setup routine

call the integrator setup routine

set $irevcm=0$

start looping

call ivp_stiff_exp_revcom

if $irevcm=8$ then

supply the Jacobian matrix

else if $irevcm=9$ then

perform monitoring tasks requested by the user

else if $irevcm=1$ or $3\le irevcm\le 5$ then

evaluate the derivative

else if $irevcm=10$ then

indicates an unsuccessful step

else

stop looping

post processing; optional linear algebra diagnostic call (sparse case only), optional integrator diagnostic call

There are three major operations that may be required of the calling function on an intermediate return ($irevcm\ne 0$) from ivp_stiff_exp_revcom; these are denoted (i), (ii) and (iii).

The following sections describe in greater detail exactly what is required of each of these operations.

1. Supply the Jacobian matrix

   You need only provide this facility if the argument $\text{jceval}=\text{'A'}$ (or $\text{jceval}=\text{'F'}$ if using sparse matrix linear algebra) in a call to the linear algebra setup function (see $\text{jceval}$ in ivp_stiff_fulljac_setup()). If the Jacobian matrix is to be evaluated numerically by the integrator, then the remainder of section (i) can be ignored.

   We must define the system of nonlinear equations which is solved internally by the integrator. The time derivative, $y^{\prime }$, has the form

   $$y^{\prime }=(y-z)/\left(hd\right)\text{,}$$

   where $h$ is the current step size and $d$ is an argument that depends on the integration method in use. The vector $y$ is the current solution and the vector $z$ depends on information from previous time steps. This means that $\frac{d}{d{y}^{\prime }}\left(\right)=\left(hd\right)\frac{d}{dy}\left(\right)$.

   The system of nonlinear equations that is solved has the form

   $$y^{\prime }-g(t,y)=0$$

   but is solved in the form

   $$r(t,y)=0\text{,}$$

   where the function $r$ is defined by

   $$r(t,y)=\left(hd\right)\left((y-z)/\left(hd\right)-g(t,y)\right)\text{.}$$

   It is the Jacobian matrix $\frac{\partial r}{\partial y}$ that you must supply as follows:

   $$\begin{array}{c}\begin{array}{ccc}& \frac{\partial r_i}{\partial y_j}=1-\left(hd\right)\frac{\partial g_i}{\partial y_j}& \text{if}i=j\text{,}\\ & & \\ & & \\ & \frac{\partial r_i}{\partial y_j}=-\left(hd\right)\frac{\partial g_i}{\partial y_j}& \text{otherwise,}\end{array}\end{array}$$

   where $t$, $h$ and $d$ are located in $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[18]$, $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[15]$ and $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[19]$ respectively and the array $y$ contains the current values of the dependent variables. Only the nonzero elements of the Jacobian need be set, since the locations where it is to be stored are preset to zero.

   In this document this operation is referred to as JAC.

2. Perform tasks requested by you

   This operation is essentially a monitoring function and additionally provides the opportunity of changing the current values of $y$, HNEXT (the step size that the integrator proposes to take on the next step), HMIN (the minimum step size to be taken on the next step), and HMAX (the maximum step size to be taken on the next step). The scaled local error at the end of a timestep may be obtained by calling ivp_stiff_errest().

   The following gives details of the location within the array $comm$[‘rwork’] of variables that may be of interest to you:

   Variable	Specification	Location
   $tcurr$	the current value of the independent variable	$comm{[}^{\prime }rwor{k}^{\prime }\left]\right[18]$
   $hlast$	last step size successfully used by the integrator	$comm{[}^{\prime }rwor{k}^{\prime }\left]\right[14]$
   $hnext$	step size that the integrator proposes to take on the next step	$comm{[}^{\prime }rwor{k}^{\prime }\left]\right[15]$
   $hmin$	minimum step size to be taken on the next step	$comm{[}^{\prime }rwor{k}^{\prime }\left]\right[16]$
   $hmax$	maximum step size to be taken on the next step	$comm{[}^{\prime }rwor{k}^{\prime }\left]\right[17]$
   $nqu$	the order of the integrator used on the last step	$comm{[}^{\prime }rwor{k}^{\prime }\left]\right[9]$

   You are advised to consult the description of $\text{monitr}$ in ivp_stiff_exp_fulljac() for details on what optional input can be made.

   If $y$ is changed, then $imon$ must be set to $2$ before return to ivp_stiff_exp_revcom. If either of the values of HMIN or HMAX are changed, then $imon$ must be set $\ge 3$ before return to ivp_stiff_exp_revcom. If HNEXT is changed, then $imon$ must be set to $4$ before return to ivp_stiff_exp_revcom.

   In addition you can force ivp_stiff_exp_revcom to evaluate the residual vector

   $$y^{\prime }-g(t,y)$$

   by setting $imon=0$ and $inln=3$ and then returning to ivp_stiff_exp_revcom; on return to this monitoring operation the residual vector will be stored in $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[50+2\times \text{neq}+\text{i}-1]$, for $\text{i}=1,2,\dots ,\text{neq}$.

   In this document this operation is referred to as MONITR.

3. Evaluate the derivative

   This operation must evaluate the derivative vector for the explicit ordinary differential equation system defined by

   $$y^{\prime }=g(t,y)\text{,}$$

   where $t$ is located in $comm{[}^{\prime }rwor{k}^{\prime }\left]\right[18]$.

   In this document this operation is referred to as FCN.