LSODE Class Reference

#include "LSODE.h"

Inheritance diagram for LSODE:

Collaboration diagram for LSODE:

Public Types
typedef Matrix(*	ODEJacFunc) (const ColumnVector &, double)
typedef ColumnVector(*	ODERHSFunc) (const ColumnVector &, double)

Public Member Functions
	LSODE (const ColumnVector &s, double tm, const ODEFunc &f)
	LSODE (void)
	~LSODE (void)=default
void	clear_stop_time (void)
Matrix	do_integrate (const ColumnVector &tout)
Matrix	do_integrate (const ColumnVector &tout, const ColumnVector &tcrit)
ColumnVector	do_integrate (double t)
std::string	error_message (void) const
virtual void	force_restart (void)
ODERHSFunc	function (void) const
void	initialize (const ColumnVector &x0, double t0)
virtual Matrix	integrate (const ColumnVector &tt)
virtual Matrix	integrate (const ColumnVector &tt, const ColumnVector &ttcrit)
virtual Matrix	integrate (const ColumnVector &x0, double t0, const ColumnVector &tt)
virtual Matrix	integrate (const ColumnVector &x0, double t0, const ColumnVector &tt, const ColumnVector &ttcrit)
virtual ColumnVector	integrate (const ColumnVector &x0, double t0, double tt)
virtual ColumnVector	integrate (double tt)
bool	integration_ok (void) const
octave_idx_type	integration_state (void) const
ODEJacFunc	jacobian_function (void) const
ODEFunc &	set_function (ODERHSFunc f)
ODEFunc &	set_jacobian_function (ODEJacFunc j)
void	set_stop_time (double tt)
octave_idx_type	size (void) const
ColumnVector	state (void) const
double	time (void) const

Protected Attributes
ODERHSFunc	m_fun
bool	m_integration_error
octave_idx_type	m_istate
ODEJacFunc	m_jac
bool	m_reset
bool	m_restart
double	m_stop_time
bool	m_stop_time_set
double	m_t
ColumnVector	m_x

Private Attributes
Array< double >	m_abs_tol
bool	m_initialized
octave_f77_int_type	m_iopt
octave_f77_int_type	m_itask
octave_f77_int_type	m_itol
Array< octave_f77_int_type >	m_iwork
octave_f77_int_type	m_liw
octave_f77_int_type	m_lrw
octave_f77_int_type	m_method_flag
double	m_rel_tol
Array< double >	m_rwork

Detailed Description

Definition at line 36 of file LSODE.h.

Member Typedef Documentation

ODEJacFunc

typedef Matrix(* ODEFunc::ODEJacFunc) (const ColumnVector &, double)

inherited

Definition at line 39 of file ODEFunc.h.

ODERHSFunc

typedef ColumnVector(* ODEFunc::ODERHSFunc) (const ColumnVector &, double)

inherited

Definition at line 38 of file ODEFunc.h.

Constructor & Destructor Documentation

LSODE() [1/2]

LSODE::LSODE ( void  )

inline

Definition at line 42 of file LSODE.h.

LSODE() [2/2]

LSODE::LSODE ( const ColumnVector &  s, double  tm, const ODEFunc &  f  )

inline

Definition at line 47 of file LSODE.h.

~LSODE()

LSODE::~LSODE ( void  )

default

Member Function Documentation

clear_stop_time()

void base_diff_eqn::clear_stop_time ( void  )

inlineinherited

Definition at line 92 of file base-de.h.

Referenced by do_integrate(), DASRT::integrate(), DASPK::integrate(), and DASSL::integrate().

do_integrate() [1/3]

Matrix LSODE::do_integrate ( const ColumnVector &  tout )

virtual

Implements ODE.

Definition at line 375 of file LSODE.cc.

References do_integrate(), Array< T, Alloc >::elem(), base_diff_eqn::m_integration_error, base_diff_eqn::m_x, Array< T, Alloc >::numel(), Matrix::resize(), and base_diff_eqn::size().

do_integrate() [2/3]

Matrix LSODE::do_integrate ( const ColumnVector &  tout, const ColumnVector &  tcrit  )

virtual

Implements ODE.

Definition at line 405 of file LSODE.cc.

References base_diff_eqn::clear_stop_time(), do_integrate(), Array< T, Alloc >::elem(), base_diff_eqn::force_restart(), base_diff_eqn::m_integration_error, base_diff_eqn::m_x, Array< T, Alloc >::numel(), Matrix::resize(), base_diff_eqn::set_stop_time(), and base_diff_eqn::size().

do_integrate() [3/3]

ColumnVector LSODE::do_integrate ( double  t )

virtual

Implements ODE.

Definition at line 102 of file LSODE.cc.

References dlsode(), F77_XFCN, Array< T, Alloc >::fortran_vec(), ODEFunc::function(), ODEFunc::jacobian_function(), lsode_f(), lsode_j(), m_abs_tol, m_initialized, base_diff_eqn::m_integration_error, m_iopt, base_diff_eqn::m_istate, m_itask, m_itol, m_iwork, ODEFunc::m_jac, m_liw, m_lrw, m_method_flag, m_rel_tol, ODEFunc::m_reset, base_diff_eqn::m_restart, m_rwork, base_diff_eqn::m_stop_time, base_diff_eqn::m_stop_time_set, base_diff_eqn::m_t, base_diff_eqn::m_x, nn, Array< T, Alloc >::numel(), Array< T, Alloc >::resize(), base_diff_eqn::size(), tmp_x, user_fun, and user_jac.

Referenced by do_integrate().

error_message()

std::string LSODE::error_message ( void  ) const

virtual

Implements base_diff_eqn.

Definition at line 311 of file LSODE.cc.

References base_diff_eqn::m_istate, and base_diff_eqn::m_t.

Referenced by DEFMETHOD().

force_restart()

virtual void base_diff_eqn::force_restart ( void  )

inlinevirtualinherited

Definition at line 98 of file base-de.h.

Referenced by do_integrate(), DASRT::integrate(), DASPK::integrate(), and DASSL::integrate().

function()

ODERHSFunc ODEFunc::function ( void  ) const

inlineinherited

Definition at line 66 of file ODEFunc.h.

Referenced by do_integrate().

initialize()

void base_diff_eqn::initialize ( const ColumnVector &  x0, double  t0  )

inlineinherited

Definition at line 70 of file base-de.h.

Referenced by ODES::initialize(), and base_diff_alg_eqn::initialize().

integrate() [1/6]

virtual Matrix ODE::integrate ( const ColumnVector &  tt )

inlinevirtualinherited

Definition at line 91 of file ODE.h.

integrate() [2/6]

virtual Matrix ODE::integrate ( const ColumnVector &  tt, const ColumnVector &  ttcrit  )

inlinevirtualinherited

Definition at line 105 of file ODE.h.

integrate() [3/6]

virtual Matrix ODE::integrate ( const ColumnVector &  x0, double  t0, const ColumnVector &  tt  )

inlinevirtualinherited

Definition at line 96 of file ODE.h.

References initialize().

integrate() [4/6]

virtual Matrix ODE::integrate ( const ColumnVector &  x0, double  t0, const ColumnVector &  tt, const ColumnVector &  ttcrit  )

inlinevirtualinherited

Definition at line 111 of file ODE.h.

References initialize().

integrate() [5/6]

virtual ColumnVector ODE::integrate ( const ColumnVector &  x0, double  t0, double  tt  )

inlinevirtualinherited

Definition at line 83 of file ODE.h.

References initialize().

integrate() [6/6]

virtual ColumnVector ODE::integrate ( double  tt )

inlinevirtualinherited

Definition at line 79 of file ODE.h.

Referenced by DEFMETHOD().

integration_ok()

bool base_diff_eqn::integration_ok ( void  ) const

inlineinherited

Definition at line 100 of file base-de.h.

Referenced by DEFMETHOD().

integration_state()

octave_idx_type base_diff_eqn::integration_state ( void  ) const

inlineinherited

Definition at line 102 of file base-de.h.

Referenced by DEFMETHOD().

jacobian_function()

ODEJacFunc ODEFunc::jacobian_function ( void  ) const

inlineinherited

Definition at line 75 of file ODEFunc.h.

Referenced by do_integrate().

set_function()

ODEFunc & ODEFunc::set_function ( ODERHSFunc  f )

inlineinherited

Definition at line 68 of file ODEFunc.h.

References f.

set_jacobian_function()

ODEFunc & ODEFunc::set_jacobian_function ( ODEJacFunc  j )

inlineinherited

Definition at line 77 of file ODEFunc.h.

Referenced by DEFMETHOD().

set_stop_time()

void base_diff_eqn::set_stop_time ( double  tt )

inlineinherited

Definition at line 85 of file base-de.h.

Referenced by do_integrate(), DASRT::integrate(), DASPK::integrate(), and DASSL::integrate().

size()

octave_idx_type base_diff_eqn::size ( void  ) const

inlineinherited

Definition at line 79 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASPK::integrate(), DASSL::integrate(), and DASRT::integrate().

state()

ColumnVector base_diff_eqn::state ( void  ) const

inlineinherited

Definition at line 81 of file base-de.h.

time()

double base_diff_eqn::time ( void  ) const

inlineinherited

Definition at line 83 of file base-de.h.

Member Data Documentation

m_abs_tol

Array<double> LSODE::m_abs_tol

private

Definition at line 79 of file LSODE.h.

Referenced by do_integrate().

m_fun

ODERHSFunc ODEFunc::m_fun

protectedinherited

Definition at line 86 of file ODEFunc.h.

Referenced by ODEFunc::operator=().

m_initialized

bool LSODE::m_initialized

private

Definition at line 64 of file LSODE.h.

Referenced by do_integrate().

m_integration_error

bool base_diff_eqn::m_integration_error

protectedinherited

Definition at line 118 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASPK::integrate(), DASSL::integrate(), DASRT::integrate(), and base_diff_eqn::operator=().

m_iopt

octave_f77_int_type LSODE::m_iopt

private

Definition at line 68 of file LSODE.h.

Referenced by do_integrate().

m_istate

octave_idx_type base_diff_eqn::m_istate

protectedinherited

Definition at line 120 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASPK::error_message(), DASRT::error_message(), DASSL::error_message(), error_message(), DASRT::integrate(), and base_diff_eqn::operator=().

m_itask

octave_f77_int_type LSODE::m_itask

private

Definition at line 67 of file LSODE.h.

Referenced by do_integrate().

m_itol

octave_f77_int_type LSODE::m_itol

private

Definition at line 69 of file LSODE.h.

Referenced by do_integrate().

m_iwork

Array<octave_f77_int_type> LSODE::m_iwork

private

Definition at line 74 of file LSODE.h.

Referenced by do_integrate().

m_jac

ODEJacFunc ODEFunc::m_jac

protectedinherited

Definition at line 87 of file ODEFunc.h.

Referenced by do_integrate(), and ODEFunc::operator=().

m_liw

octave_f77_int_type LSODE::m_liw

private

Definition at line 71 of file LSODE.h.

Referenced by do_integrate().

m_lrw

octave_f77_int_type LSODE::m_lrw

private

Definition at line 72 of file LSODE.h.

Referenced by do_integrate().

m_method_flag

octave_f77_int_type LSODE::m_method_flag

private

Definition at line 66 of file LSODE.h.

Referenced by do_integrate().

m_rel_tol

double LSODE::m_rel_tol

private

Definition at line 77 of file LSODE.h.

Referenced by do_integrate().

m_reset

bool ODEFunc::m_reset

protectedinherited

Definition at line 94 of file ODEFunc.h.

Referenced by do_integrate(), and ODEFunc::operator=().

m_restart

bool base_diff_eqn::m_restart

protectedinherited

Definition at line 116 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASRT::integrate(), and base_diff_eqn::operator=().

m_rwork

Array<double> LSODE::m_rwork

private

Definition at line 75 of file LSODE.h.

Referenced by do_integrate().

m_stop_time

double base_diff_eqn::m_stop_time

protectedinherited

Definition at line 112 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASRT::integrate(), and base_diff_eqn::operator=().

m_stop_time_set

bool base_diff_eqn::m_stop_time_set

protectedinherited

Definition at line 114 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASRT::integrate(), and base_diff_eqn::operator=().

m_t

double base_diff_eqn::m_t

protectedinherited

Definition at line 110 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASPK::error_message(), DASRT::error_message(), DASSL::error_message(), error_message(), DASRT::integrate(), and base_diff_eqn::operator=().

m_x

ColumnVector base_diff_eqn::m_x

protectedinherited

Definition at line 108 of file base-de.h.

Referenced by DASPK::do_integrate(), DASSL::do_integrate(), do_integrate(), DASPK::integrate(), DASSL::integrate(), DASRT::integrate(), and base_diff_eqn::operator=().

---

The documentation for this class was generated from the following files:

• liboctave/numeric/LSODE.h
• liboctave/numeric/LSODE.cc