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 | List of all members
ODE Class Referenceabstract

#include "ODE.h"

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

Public Types

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

Public Member Functions

 ODE (void)
 
 ODE (const ColumnVector &s, double tm, const ODEFunc &f)
 
 ODE (const ODE &a)
 
virtual ~ODE (void)=default
 
void clear_stop_time (void)
 
virtual ColumnVector do_integrate (double tt)=0
 
virtual Matrix do_integrate (const ColumnVector &tt)=0
 
virtual Matrix do_integrate (const ColumnVector &tt, const ColumnVector &ttcrit)=0
 
virtual std::string error_message (void) const =0
 
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
 
ODE & operator= (const ODE &a)
 
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
 

Detailed Description

Definition at line 32 of file ODE.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

◆ ODE() [1/3]

ODE::ODE ( void  )
inline

Definition at line 37 of file ODE.h.

◆ ODE() [2/3]

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

Definition at line 40 of file ODE.h.

◆ ODE() [3/3]

ODE::ODE ( const ODE &  a)
inline

Definition at line 43 of file ODE.h.

◆ ~ODE()

virtual ODE::~ODE ( void  )
virtualdefault

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 LSODE::do_integrate(), DASPK::integrate(), DASSL::integrate(), and DASRT::integrate().

◆ do_integrate() [1/3]

virtual ColumnVector ODE::do_integrate ( double  tt)
pure virtual

Implemented in LSODE.

◆ do_integrate() [2/3]

virtual Matrix ODE::do_integrate ( const ColumnVector &  tt)
pure virtual

Implemented in LSODE.

◆ do_integrate() [3/3]

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

Implemented in LSODE.

◆ error_message()

virtual std::string base_diff_eqn::error_message ( void  ) const
pure virtualinherited

Implemented in DASRT, DASPK, DASSL, and LSODE.

◆ force_restart()

virtual void base_diff_eqn::force_restart ( void  )
inlinevirtualinherited

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

Referenced by LSODE::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)
inlinevirtual

Definition at line 76 of file ODE.h.

◆ integrate() [2/6]

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

Definition at line 80 of file ODE.h.

References initialize().

◆ integrate() [3/6]

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

Definition at line 88 of file ODE.h.

◆ integrate() [4/6]

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

Definition at line 93 of file ODE.h.

References initialize().

◆ integrate() [5/6]

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

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 
)
inlinevirtual

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

◆ operator=()

ODE& ODE::operator= ( const ODE &  a)
inline

Definition at line 46 of file ODE.h.

References a, ODEFunc::operator=(), and base_diff_eqn::operator=().

◆ 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 LSODE::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 LSODE::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

◆ fun

ODERHSFunc ODEFunc::fun
protectedinherited

Definition at line 84 of file ODEFunc.h.

◆ integration_error

bool base_diff_eqn::integration_error
protectedinherited

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

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

◆ istate

octave_idx_type base_diff_eqn::istate
protectedinherited

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

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

◆ jac

ODEJacFunc ODEFunc::jac
protectedinherited

Definition at line 85 of file ODEFunc.h.

Referenced by LSODE::do_integrate().

◆ reset

bool ODEFunc::reset
protectedinherited

Definition at line 92 of file ODEFunc.h.

Referenced by LSODE::do_integrate().

◆ restart

bool base_diff_eqn::restart
protectedinherited

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

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

◆ stop_time

double base_diff_eqn::stop_time
protectedinherited

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

Referenced by LSODE::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 LSODE::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 LSODE::do_integrate(), DASSL::do_integrate(), DASPK::do_integrate(), LSODE::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 LSODE::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 file: