SciPy 0.6.0 API Documentation Generated by Endo, 2007-10-17

Class SciPy.​integrate.​ode.​ode

ode  - a generic interface class to numeric integrators. It has the
  following methods:
    integrator = ode(f,jac=None)
    integrator = integrator.set_integrator(name,**params)
    integrator = integrator.set_initial_value(y0,t0=0.0)
    integrator = integrator.set_f_params(*args)
    integrator = integrator.set_jac_params(*args)
    y1 = integrator.integrate(t1,step=0,relax=0)
    flag = integrator.successful()

  Typical usage:
    r = ode(f,jac).set_integrator('vode').set_initial_value(y0,t0)
    t1 = <final t>
    dt = <step>
    while r.successful() and r.t < t1:
        r.integrate(r.t+dt)
        print r.t, r.y
  where f and jac have the following signatures:
    def f(t,y[,arg1,..]):
        return <f(t,y)>
    def jac(t,y[,arg1,..]):
        return <df/dy(t,y)>

See also:
    odeint - an integrator with a simpler interface based on lsoda from ODEPACK
    quad - for finding the area under a curve
    

Contents:
• Methods

Method summary

• __init__(self, f, jac = None)
• integrate(self, t, step = 0, relax = 0)
• set_f_params(self, *args)
• set_initial_value(self, y, t = 0.0)
• set_integrator(self, name, **integrator_params)
• set_jac_params(self, *args)
• successful(self)

Methods

• __init__(self, f, jac = None)

  Define equation y' = f(y,t) where (optional) jac = df/dy.
  User-supplied functions must have the following signatures:
  def f(t,y,...):
      return <f(t,y)>
  def jac(t,y,...):
      return <jac(t,y)>
  where ... means extra parameters that can be set with
    set_(f|jac)_params(*args)
  methods.
  

• integrate(self, t, step = 0, relax = 0)

  Find y=y(t), set y as an initial condition, and return y.

• set_f_params(self, *args)

  Set extra-parameters for user-supplied function f.

• set_initial_value(self, y, t = 0.0)

  Set initial conditions y(t) = y.

• set_integrator(self, name, **integrator_params)

  Set integrator by name.

• set_jac_params(self, *args)

  Set extra-parameters for user-supplied function jac.

• successful(self)

  Check if integration was successful.