#include "LSODE.h"

Inheritance diagram for LSODE:

[legend]

Collaboration diagram for LSODE:

[legend]

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	fun

bool	integration_error

octave_idx_type	istate

ODEJacFunc	jac

bool	reset

bool	restart

double	stop_time

bool	stop_time_set

double	t

ColumnVector	x

Private Attributes
Array< double >	abs_tol

bool	initialized

octave_f77_int_type	iopt

octave_f77_int_type	itask

octave_f77_int_type	itol

Array< octave_f77_int_type >	iwork

octave_f77_int_type	liw

octave_f77_int_type	lrw

octave_f77_int_type	method_flag

double	rel_tol

Array< double >	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 40 of file ODEFunc.h.

◆ ODERHSFunc

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

inherited

Definition at line 39 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 374 of file LSODE.cc.

References do_integrate(), Array< T >::elem(), base_diff_eqn::integration_error, n, Array< T >::numel(), Array< T >::resize(), retval, base_diff_eqn::size(), and base_diff_eqn::x.

◆ do_integrate() [2/3]

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

virtual

Implements ODE.

Definition at line 404 of file LSODE.cc.

References base_diff_eqn::clear_stop_time(), do_integrate(), Array< T >::elem(), base_diff_eqn::force_restart(), base_diff_eqn::integration_error, n, Array< T >::numel(), Array< T >::resize(), retval, base_diff_eqn::set_stop_time(), base_diff_eqn::size(), and base_diff_eqn::x.

◆ do_integrate() [3/3]

ColumnVector LSODE::do_integrate ( double t )

virtual

Implements ODE.

Definition at line 102 of file LSODE.cc.

References abs_tol, dlsode(), F77_XFCN, Array< T >::fortran_vec(), initialized, base_diff_eqn::integration_error, iopt, base_diff_eqn::istate, itask, itol, iwork, ODEFunc::jac, ODEFunc::jacobian_function(), liw, lrw, lsode_f(), lsode_j(), method_flag, n, nn, Array< T >::numel(), rel_tol, ODEFunc::reset, Array< T >::resize(), base_diff_eqn::restart, retval, rwork, base_diff_eqn::size(), base_diff_eqn::stop_time, base_diff_eqn::stop_time_set, base_diff_eqn::t, tmp_x, user_fun, user_jac, and base_diff_eqn::x.

Referenced by do_integrate().

◆ error_message()

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

virtual

Implements base_diff_eqn.

Definition at line 310 of file LSODE.cc.

References base_diff_eqn::istate, retval, and base_diff_eqn::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 67 of file ODEFunc.h.

◆ initialize()

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

inlineinherited

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

References x.

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 76 of file ODEFunc.h.

Referenced by do_integrate().

◆ set_function()

ODEFunc& ODEFunc::set_function ( ODERHSFunc f )

inlineinherited

Definition at line 69 of file ODEFunc.h.

References f.

◆ set_jacobian_function()

ODEFunc& ODEFunc::set_jacobian_function ( ODEJacFunc j )

inlineinherited

Definition at line 78 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.

References x.

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.

References x.

◆ time()

double base_diff_eqn::time ( void ) const

inlineinherited

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

Member Data Documentation

◆ abs_tol

Array<double> LSODE::abs_tol

private

Definition at line 79 of file LSODE.h.

Referenced by do_integrate().

◆ fun

ODERHSFunc ODEFunc::fun

protectedinherited

Definition at line 87 of file ODEFunc.h.

Referenced by ODEFunc::operator=().

◆ initialized

bool LSODE::initialized

private

Definition at line 64 of file LSODE.h.

Referenced by do_integrate().

◆ integration_error

bool base_diff_eqn::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=().

◆ iopt

octave_f77_int_type LSODE::iopt

private

Definition at line 68 of file LSODE.h.

Referenced by do_integrate().

◆ istate

octave_idx_type base_diff_eqn::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=().

◆ itask

octave_f77_int_type LSODE::itask

private

Definition at line 67 of file LSODE.h.

Referenced by do_integrate().

◆ itol

octave_f77_int_type LSODE::itol

private

Definition at line 69 of file LSODE.h.

Referenced by do_integrate().

◆ iwork

Array<octave_f77_int_type> LSODE::iwork

private

Definition at line 74 of file LSODE.h.

Referenced by do_integrate().

◆ jac

ODEJacFunc ODEFunc::jac

protectedinherited

Definition at line 88 of file ODEFunc.h.

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

◆ liw

octave_f77_int_type LSODE::liw

private

Definition at line 71 of file LSODE.h.

Referenced by do_integrate().

◆ lrw

octave_f77_int_type LSODE::lrw

private

Definition at line 72 of file LSODE.h.

Referenced by do_integrate().

◆ method_flag

octave_f77_int_type LSODE::method_flag

private

Definition at line 66 of file LSODE.h.

Referenced by do_integrate().

◆ rel_tol

double LSODE::rel_tol

private

Definition at line 77 of file LSODE.h.

Referenced by do_integrate().

◆ reset

bool ODEFunc::reset

protectedinherited

Definition at line 95 of file ODEFunc.h.

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

◆ restart

bool base_diff_eqn::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=().

◆ rwork

Array<double> LSODE::rwork

private

Definition at line 75 of file LSODE.h.

Referenced by do_integrate().

◆ stop_time

double base_diff_eqn::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=().

◆ stop_time_set

bool base_diff_eqn::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=().

◆ t

double base_diff_eqn::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=().

◆ x

ColumnVector base_diff_eqn::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

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ODEJacFunc

◆ ODERHSFunc

Constructor & Destructor Documentation

◆ LSODE() [1/2]

◆ LSODE() [2/2]

◆ ~LSODE()

Member Function Documentation

◆ clear_stop_time()

◆ do_integrate() [1/3]

◆ do_integrate() [2/3]

◆ do_integrate() [3/3]

◆ error_message()

◆ force_restart()

◆ function()

◆ initialize()

◆ integrate() [1/6]

◆ integrate() [2/6]

◆ integrate() [3/6]

◆ integrate() [4/6]

◆ integrate() [5/6]

◆ integrate() [6/6]

◆ integration_ok()

◆ integration_state()

◆ jacobian_function()

◆ set_function()

◆ set_jacobian_function()

◆ set_stop_time()

◆ size()

◆ state()

◆ time()

Member Data Documentation

◆ abs_tol

◆ fun

◆ initialized

◆ integration_error

◆ iopt

◆ istate

◆ itask

◆ itol

◆ iwork

◆ jac

◆ liw

◆ lrw

◆ method_flag

◆ rel_tol

◆ reset

◆ restart

◆ rwork

◆ stop_time

◆ stop_time_set

◆ t

◆ x