naginterfaces.library.ode.ivp_​adams_​diag

naginterfaces.library.ode.ivp_adams_diag(neqf, comm)[source]

ivp_adams_diag is a diagnostic function which may be called after a call to either of the integration functions ivp_adams_roots() and ivp_adams_roots_revcom().

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

https://www.nag.com/numeric/nl/nagdoc_28.6/flhtml/d02/d02qxf.html

Parameters
neqfint

The number of first-order ordinary differential equations solved by the integration function. It must be the same argument supplied to the setup function ivp_adams_setup() and the integration functions ivp_adams_roots() or ivp_adams_roots_revcom().

commdict, communication object

Communication structure.

This argument must have been initialized by prior calls to ivp_adams_setup() and one of ivp_adams_roots() or ivp_adams_roots_revcom().

Returns
ypfloat, ndarray, shape

The approximate derivative of the solution component , as supplied in on output from the integration function at the output value of . These values are obtained by the evaluation of except when the output value of the argument in the call to the integration function is and , in which case they are obtained by interpolation.

tcurrfloat

The value of the independent variable which the integrator has actually reached. will always be at least as far as the output value of the argument (from the integration function) in the direction of integration, but may be further.

hlastfloat

The last successful step size used by the integrator.

hnextfloat

The next step size which the integration function would attempt.

odlastint

The order of the method last used (successfully) by the integration function.

odnextint

The order of the method which the integration function would attempt on the next step.

nsuccint

The number of steps attempted by the integration function that have been successful since the start of the current problem.

nfailint

The number of steps attempted by the integration function that have failed since the start of the current problem.

tolfacfloat

A tolerance scale factor, , returned when the integration function exits with = 3. If and are uniformly scaled up by a factor of and ivp_adams_setup() is called, the next call to the integration function is deemed likely to succeed.

badcmpint

If the integration function returned with = 4, specifies the index of the component which forced the error exit. Otherwise is .

Raises
NagValueError
(errno )

On entry, and in ivp_adams_setup().

Constraint: in ivp_adams_setup().

(errno )

Neither of the appropriate two integrator functions has been called.

Notes

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

ivp_adams_diag permits you to extract information about the performance of ivp_adams_roots() or ivp_adams_roots_revcom(). It may only be called after a call to ivp_adams_roots() or ivp_adams_roots_revcom().