GNU Octave  4.4.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
LSODE Class Reference

#include "LSODE.h"

Inheritance diagram for LSODE:
Inheritance graph
[legend]
Collaboration diagram for LSODE:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

 LSODE (void)
 
 LSODE (const ColumnVector &s, double tm, const ODEFunc &f)
 
 ~LSODE (void)=default
 
void clear_stop_time (void)
 
ColumnVector do_integrate (double t)
 
Matrix do_integrate (const ColumnVector &tout)
 
Matrix do_integrate (const ColumnVector &tout, const ColumnVector &tcrit)
 
std::string error_message (void) const
 
virtual void force_restart (void)
 
ODERHSFunc function (void) const
 
void initialize (const ColumnVector &x0, double t0)
 
virtual ColumnVector integrate (double tt)
 
virtual ColumnVector integrate (const ColumnVector &x0, double t0, double tt)
 
virtual Matrix integrate (const ColumnVector &tt)
 
virtual Matrix integrate (const ColumnVector &x0, double t0, const ColumnVector &tt)
 
virtual Matrix integrate (const ColumnVector &tt, const ColumnVector &ttcrit)
 
virtual Matrix integrate (const ColumnVector &x0, double t0, const ColumnVector &tt, const ColumnVector &ttcrit)
 
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 33 of file LSODE.h.

Member Typedef Documentation

◆ ODEJacFunc

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

Definition at line 37 of file ODEFunc.h.

◆ ODERHSFunc

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

Definition at line 36 of file ODEFunc.h.

Constructor & Destructor Documentation

◆ LSODE() [1/2]

LSODE::LSODE ( void  )
inline

Definition at line 39 of file LSODE.h.

◆ LSODE() [2/2]

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

Definition at line 44 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 89 of file base-de.h.

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

◆ do_integrate() [1/3]

ColumnVector LSODE::do_integrate ( double  t)
virtual

Implements ODE.

Definition at line 106 of file LSODE.cc.

References abs_tol, DLSODE(), F77_XFCN, Array< T >::fortran_vec(), i, 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, 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().

◆ do_integrate() [2/3]

Matrix LSODE::do_integrate ( const ColumnVector &  tout)
virtual

Implements ODE.

Definition at line 377 of file LSODE.cc.

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

◆ do_integrate() [3/3]

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

Implements ODE.

Definition at line 407 of file LSODE.cc.

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

◆ error_message()

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

Implements base_diff_eqn.

Definition at line 313 of file LSODE.cc.

References base_diff_eqn::istate, retval, string, and base_diff_eqn::t.

◆ force_restart()

virtual void base_diff_eqn::force_restart ( void  )
inlinevirtualinherited

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

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

◆ function()

ODERHSFunc ODEFunc::function ( void  ) const
inlineinherited

Definition at line 64 of file ODEFunc.h.

◆ initialize()

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

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

References t, and x.

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

◆ integrate() [1/6]

virtual ColumnVector ODE::integrate ( double  tt)
inlinevirtualinherited

Definition at line 76 of file ODE.h.

◆ integrate() [2/6]

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

Definition at line 80 of file ODE.h.

References initialize().

◆ integrate() [3/6]

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

Definition at line 88 of file ODE.h.

◆ integrate() [4/6]

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

Definition at line 93 of file ODE.h.

References initialize().

◆ integrate() [5/6]

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

Definition at line 102 of file ODE.h.

◆ integrate() [6/6]

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

Definition at line 108 of file ODE.h.

References initialize().

◆ integration_ok()

bool base_diff_eqn::integration_ok ( void  ) const
inlineinherited

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

Referenced by Fdaspk(), Fdasrt(), and Fdassl().

◆ integration_state()

octave_idx_type base_diff_eqn::integration_state ( void  ) const
inlineinherited

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

Referenced by Fdaspk(), Fdasrt(), and Fdassl().

◆ jacobian_function()

ODEJacFunc ODEFunc::jacobian_function ( void  ) const
inlineinherited

Definition at line 73 of file ODEFunc.h.

Referenced by do_integrate().

◆ set_function()

ODEFunc& ODEFunc::set_function ( ODERHSFunc  f)
inlineinherited

Definition at line 66 of file ODEFunc.h.

References f.

◆ set_jacobian_function()

ODEFunc& ODEFunc::set_jacobian_function ( ODEJacFunc  j)
inlineinherited

Definition at line 75 of file ODEFunc.h.

Referenced by Flsode().

◆ set_stop_time()

void base_diff_eqn::set_stop_time ( double  tt)
inlineinherited

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

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

◆ size()

octave_idx_type base_diff_eqn::size ( void  ) const
inlineinherited

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

References x.

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

◆ state()

ColumnVector base_diff_eqn::state ( void  ) const
inlineinherited

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

References x.

◆ time()

double base_diff_eqn::time ( void  ) const
inlineinherited

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

References t.

Member Data Documentation

◆ abs_tol

Array<double> LSODE::abs_tol
private

Definition at line 76 of file LSODE.h.

Referenced by do_integrate().

◆ fun

ODERHSFunc ODEFunc::fun
protectedinherited

Definition at line 84 of file ODEFunc.h.

◆ initialized

bool LSODE::initialized
private

Definition at line 61 of file LSODE.h.

Referenced by do_integrate().

◆ integration_error

bool base_diff_eqn::integration_error
protectedinherited

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

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

◆ iopt

octave_f77_int_type LSODE::iopt
private

Definition at line 65 of file LSODE.h.

Referenced by do_integrate().

◆ istate

octave_idx_type base_diff_eqn::istate
protectedinherited

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

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

◆ itask

octave_f77_int_type LSODE::itask
private

Definition at line 64 of file LSODE.h.

Referenced by do_integrate().

◆ itol

octave_f77_int_type LSODE::itol
private

Definition at line 66 of file LSODE.h.

Referenced by do_integrate().

◆ iwork

Array<octave_f77_int_type> LSODE::iwork
private

Definition at line 71 of file LSODE.h.

Referenced by do_integrate().

◆ jac

ODEJacFunc ODEFunc::jac
protectedinherited

Definition at line 85 of file ODEFunc.h.

Referenced by do_integrate().

◆ liw

octave_f77_int_type LSODE::liw
private

Definition at line 68 of file LSODE.h.

Referenced by do_integrate().

◆ lrw

octave_f77_int_type LSODE::lrw
private

Definition at line 69 of file LSODE.h.

Referenced by do_integrate().

◆ method_flag

octave_f77_int_type LSODE::method_flag
private

Definition at line 63 of file LSODE.h.

Referenced by do_integrate().

◆ rel_tol

double LSODE::rel_tol
private

Definition at line 74 of file LSODE.h.

Referenced by do_integrate().

◆ reset

bool ODEFunc::reset
protectedinherited

Definition at line 92 of file ODEFunc.h.

Referenced by do_integrate().

◆ restart

bool base_diff_eqn::restart
protectedinherited

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

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

◆ rwork

Array<double> LSODE::rwork
private

Definition at line 72 of file LSODE.h.

Referenced by do_integrate().

◆ stop_time

double base_diff_eqn::stop_time
protectedinherited

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

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

◆ stop_time_set

bool base_diff_eqn::stop_time_set
protectedinherited

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

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

◆ t

double base_diff_eqn::t
protectedinherited

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

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

◆ x

ColumnVector base_diff_eqn::x
protectedinherited

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

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

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