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

#include "LSODE.h"

Inheritance diagram for LSODE:
ODE LSODE_options base_diff_eqn ODEFunc

Public Member Functions

 LSODE ()
 
 LSODE (const ColumnVector &s, double tm, const ODEFunc &f)
 
Matrix do_integrate (const ColumnVector &tout)
 
Matrix do_integrate (const ColumnVector &tout, const ColumnVector &tcrit)
 
ColumnVector do_integrate (double t)
 
std::string error_message () const
 
- Public Member Functions inherited from ODE
 ODE ()
 
 ODE (const ColumnVector &s, double tm, const ODEFunc &f)
 
 ODE (const ODE &a)
 
virtual ~ODE ()=default
 
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)
 
ODE & operator= (const ODE &a)
 
- Public Member Functions inherited from base_diff_eqn
 base_diff_eqn ()
 
 base_diff_eqn (const base_diff_eqn &a)
 
 base_diff_eqn (const ColumnVector &xx, double tt)
 
virtual ~base_diff_eqn ()=default
 
void clear_stop_time ()
 
virtual void force_restart ()
 
void initialize (const ColumnVector &x0, double t0)
 
bool integration_ok () const
 
octave_idx_type integration_state () const
 
base_diff_eqn & operator= (const base_diff_eqn &a)
 
void set_stop_time (double tt)
 
octave_idx_type size () const
 
ColumnVector state () const
 
double time () const
 
- Public Member Functions inherited from ODEFunc
 ODEFunc ()
 
 ODEFunc (const ODEFunc &a)
 
 ODEFunc (ODERHSFunc f)
 
 ODEFunc (ODERHSFunc f, ODEJacFunc j)
 
virtual ~ODEFunc ()=default
 
ODERHSFunc function () const
 
ODEJacFunc jacobian_function () const
 
ODEFunc & operator= (const ODEFunc &a)
 
ODEFunc & set_function (ODERHSFunc f)
 
ODEFunc & set_jacobian_function (ODEJacFunc j)
 
- Public Member Functions inherited from LSODE_options
 LSODE_options ()
 
 LSODE_options (const LSODE_options &opt)
 
 ~LSODE_options ()
 
Array< double > absolute_tolerance () const
 
void init ()
 
double initial_step_size () const
 
std::string integration_method () const
 
std::string jacobian_type () const
 
octave_idx_type lower_jacobian_subdiagonals () const
 
octave_idx_type maximum_order () const
 
double maximum_step_size () const
 
double minimum_step_size () const
 
LSODE_options & operator= (const LSODE_options &opt)
 
double relative_tolerance () const
 
void set_absolute_tolerance (const Array< double > &val)
 
void set_absolute_tolerance (double val)
 
void set_default_options ()
 
void set_initial_step_size (double val)
 
void set_integration_method (const std::string &val)
 
void set_jacobian_type (const std::string &val)
 
void set_lower_jacobian_subdiagonals (octave_idx_type val)
 
void set_maximum_order (octave_idx_type val)
 
void set_maximum_step_size (double val)
 
void set_minimum_step_size (double val)
 
void set_options (const LSODE_options &opt)
 
void set_relative_tolerance (double val)
 
void set_step_limit (octave_idx_type val)
 
void set_upper_jacobian_subdiagonals (octave_idx_type val)
 
octave_idx_type step_limit () const
 
octave_idx_type upper_jacobian_subdiagonals () const
 

Additional Inherited Members

- Public Types inherited from ODEFunc
typedef Matrix(* ODEJacFunc) (const ColumnVector &, double)
 
typedef ColumnVector(* ODERHSFunc) (const ColumnVector &, double)
 
- Protected Attributes inherited from base_diff_eqn
bool m_integration_error
 
octave_idx_type m_istate
 
bool m_restart
 
double m_stop_time
 
bool m_stop_time_set
 
double m_t
 
ColumnVector m_x
 
- Protected Attributes inherited from ODEFunc
ODERHSFunc m_fcn
 
ODEJacFunc m_jac
 
bool m_reset
 
- Protected Attributes inherited from LSODE_options
bool m_reset
 

Detailed Description

Definition at line 36 of file LSODE.h.

Constructor & Destructor Documentation

◆ LSODE() [1/2]

LSODE::LSODE ( )
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.

Member Function Documentation

◆ do_integrate() [1/3]

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

Implements ODE.

Definition at line 415 of file LSODE.cc.

References do_integrate(), Array< T, Alloc >::elem(), base_diff_eqn::m_integration_error, base_diff_eqn::m_x, n, 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 445 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, n, 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 111 of file LSODE.cc.

Referenced by do_integrate().

◆ error_message()

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

Implements base_diff_eqn.

Definition at line 351 of file LSODE.cc.

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

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