ODES Class Reference

#include "ODES.h"

Inheritance diagram for ODES:

Collaboration diagram for ODES:

Public Types
typedef ColumnVector(*	ODES_bsub) (const ColumnVector &x, double, const ColumnVector &theta, int column)
typedef ColumnVector(*	ODES_fsub) (const ColumnVector &x, double, const ColumnVector &theta)
typedef Matrix(*	ODES_jsub) (const ColumnVector &x, double, const ColumnVector &theta)

Public Member Functions
	ODES (const ColumnVector &s, const ColumnVector &xtheta, double tm, ODESFunc &f)
	ODES (const ColumnVector &s, double tm, ODESFunc &f)
	ODES (const ODES &a)
	ODES (void)
	~ODES (void)=default
ODES_bsub	bsub_function (void) const
void	clear_stop_time (void)
virtual std::string	error_message (void) const =0
virtual void	force_restart (void)
ODES_fsub	fsub_function (void) const
OCTAVE_API void	initialize (const ColumnVector &x, double t)
OCTAVE_API void	initialize (const ColumnVector &x, double t, const ColumnVector &theta)
bool	integration_ok (void) const
octave_idx_type	integration_state (void) const
ODES_jsub	jsub_function (void) const
ODES &	operator= (const ODES &a)
ColumnVector	parameter_vector (void)
ODESFunc &	set_bsub_function (ODES_bsub b)
ODESFunc &	set_fsub_function (ODES_fsub f)
ODESFunc &	set_jsub_function (ODES_jsub j)
void	set_stop_time (double tt)
octave_idx_type	size (void) const
ColumnVector	state (void) const
double	time (void) const

Protected Attributes
ODES_bsub	m_bsub
ODES_fsub	m_fsub
bool	m_integration_error
octave_idx_type	m_istate
ODES_jsub	m_jsub
bool	m_restart
double	m_stop_time
bool	m_stop_time_set
double	m_t
ColumnVector	m_theta
ColumnVector	m_x
ColumnVector	m_xdot

Detailed Description

Definition at line 34 of file ODES.h.

Member Typedef Documentation

ODES_bsub

typedef ColumnVector(* ODESFunc::ODES_bsub) (const ColumnVector &x, double, const ColumnVector &theta, int column)

inherited

Definition at line 49 of file ODESFunc.h.

ODES_fsub

typedef ColumnVector(* ODESFunc::ODES_fsub) (const ColumnVector &x, double, const ColumnVector &theta)

inherited

Definition at line 46 of file ODESFunc.h.

ODES_jsub

typedef Matrix(* ODESFunc::ODES_jsub) (const ColumnVector &x, double, const ColumnVector &theta)

inherited

Definition at line 52 of file ODESFunc.h.

Constructor & Destructor Documentation

ODES() [1/4]

ODES::ODES ( void  )

inline

Definition at line 39 of file ODES.h.

ODES() [2/4]

ODES::ODES ( const ColumnVector &  s, double  tm, ODESFunc &  f  )

inline

Definition at line 42 of file ODES.h.

ODES() [3/4]

ODES::ODES ( const ColumnVector &  s, const ColumnVector &  xtheta, double  tm, ODESFunc &  f  )

inline

Definition at line 46 of file ODES.h.

ODES() [4/4]

ODES::ODES ( const ODES &  a )

inline

Definition at line 51 of file ODES.h.

~ODES()

ODES::~ODES ( void  )

default

Member Function Documentation

bsub_function()

ODES_bsub ODESFunc::bsub_function ( void  ) const

inlineinherited

Definition at line 91 of file ODESFunc.h.

clear_stop_time()

void base_diff_eqn::clear_stop_time ( void  )

inlineinherited

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

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

error_message()

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

pure virtualinherited

Implemented in LSODE, DASSL, DASRT, and DASPK.

force_restart()

virtual void base_diff_eqn::force_restart ( void  )

inlinevirtualinherited

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

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

fsub_function()

ODES_fsub ODESFunc::fsub_function ( void  ) const

inlineinherited

Definition at line 83 of file ODESFunc.h.

initialize() [1/2]

void ODES::initialize	(	const ColumnVector &	x,
		double	t
	)

Definition at line 33 of file ODES.cc.

References ColumnVector, base_diff_eqn::initialize(), m_xdot, and Array< T, Alloc >::numel().

initialize() [2/2]

void ODES::initialize	(	const ColumnVector &	x,
		double	t,
		const ColumnVector &	theta
	)

Definition at line 40 of file ODES.cc.

References ColumnVector, base_diff_eqn::initialize(), m_theta, m_xdot, and Array< T, Alloc >::numel().

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

jsub_function()

ODES_jsub ODESFunc::jsub_function ( void  ) const

inlineinherited

Definition at line 99 of file ODESFunc.h.

operator=()

ODES& ODES::operator= ( const ODES &  a )

inline

Definition at line 55 of file ODES.h.

References m_theta, m_xdot, base_diff_eqn::operator=(), and ODESFunc::operator=().

parameter_vector()

ColumnVector ODES::parameter_vector ( void  )

inline

Definition at line 70 of file ODES.h.

set_bsub_function()

ODESFunc& ODESFunc::set_bsub_function ( ODES_bsub  b )

inlineinherited

Definition at line 93 of file ODESFunc.h.

set_fsub_function()

ODESFunc& ODESFunc::set_fsub_function ( ODES_fsub  f )

inlineinherited

Definition at line 85 of file ODESFunc.h.

References f.

set_jsub_function()

ODESFunc& ODESFunc::set_jsub_function ( ODES_jsub  j )

inlineinherited

Definition at line 101 of file ODESFunc.h.

set_stop_time()

void base_diff_eqn::set_stop_time ( double  tt )

inlineinherited

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

Referenced by LSODE::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(), LSODE::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_bsub

ODES_bsub ODESFunc::m_bsub

protectedinherited

Definition at line 110 of file ODESFunc.h.

Referenced by ODESFunc::operator=().

m_fsub

ODES_fsub ODESFunc::m_fsub

protectedinherited

Definition at line 109 of file ODESFunc.h.

Referenced by ODESFunc::operator=().

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

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

m_jsub

ODES_jsub ODESFunc::m_jsub

protectedinherited

Definition at line 111 of file ODESFunc.h.

Referenced by ODESFunc::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(), LSODE::do_integrate(), DASRT::integrate(), and base_diff_eqn::operator=().

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

m_theta

ColumnVector ODES::m_theta

protected

Definition at line 83 of file ODES.h.

Referenced by initialize(), and 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(), LSODE::do_integrate(), DASPK::integrate(), DASSL::integrate(), DASRT::integrate(), and base_diff_eqn::operator=().

m_xdot

ColumnVector ODES::m_xdot

protected

Definition at line 80 of file ODES.h.

Referenced by initialize(), and operator=().

---

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

• liboctave/numeric/ODES.h
• liboctave/numeric/ODES.cc