GNU Octave: DAERT Class Reference

GNU Octave 4.0.0

A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages

#include "DAERT.h"

Inheritance diagram for DAERT:

Inheritance graph

Collaboration diagram for DAERT:

Collaboration graph

Public Types
typedef Matrix(*	DAEJacFunc )(const ColumnVector &x, const ColumnVector &xdot, double t, double cj)

typedef ColumnVector(*	DAERHSFunc )(const ColumnVector &x, const ColumnVector &xdot, double t, octave_idx_type &ires)

typedef ColumnVector(*	DAERTConstrFunc )(const ColumnVector &x, double t)

Public Member Functions
	DAERT (void)

	DAERT (const ColumnVector &xx, double tt, DAERTFunc &f)

	DAERT (const ColumnVector &xx, const ColumnVector &xxdot, double tt, DAERTFunc &f)

	DAERT (const DAERT &a)

virtual	~DAERT (void)

void	clear_stop_time (void)

DAERTConstrFunc	constraint_function (void) const

virtual std::string	error_message (void) const =0

virtual void	force_restart (void)

DAERHSFunc	function (void) const

void	initialize (const ColumnVector &x0, double t0)

void	initialize (const ColumnVector &xx, const ColumnVector &xxdot, double tt)

bool	integration_ok (void) const

octave_idx_type	integration_state (void) const

DAEJacFunc	jacobian_function (void) const

DAERT &	operator= (const DAERT &a)

DAERTFunc &	set_constraint_function (DAERTConstrFunc cf)

DAEFunc &	set_function (DAERHSFunc f)

DAEFunc &	set_jacobian_function (DAEJacFunc j)

void	set_stop_time (double tt)

octave_idx_type	size (void) const

ColumnVector	state (void) const

ColumnVector	state_derivative (void)

double	time (void) const

Protected Attributes
DAERTConstrFunc	constr

DAERHSFunc	fun

bool	integration_error

octave_idx_type	istate

DAEJacFunc	jac

bool	reset

bool	restart

double	stop_time

bool	stop_time_set

double	t

ColumnVector	x

ColumnVector	xdot

Detailed Description

Definition at line 30 of file DAERT.h.

Member Typedef Documentation

typedef Matrix(* DAEFunc::DAEJacFunc)(const ColumnVector &x, const ColumnVector &xdot, double t, double cj)

inherited

Definition at line 42 of file DAEFunc.h.

typedef ColumnVector(* DAEFunc::DAERHSFunc)(const ColumnVector &x, const ColumnVector &xdot, double t, octave_idx_type &ires)

inherited

Definition at line 34 of file DAEFunc.h.

typedef ColumnVector(* DAERTFunc::DAERTConstrFunc)(const ColumnVector &x, double t)

inherited

Definition at line 33 of file DAERTFunc.h.

Constructor & Destructor Documentation

DAERT::DAERT ( void )

inline

Definition at line 35 of file DAERT.h.

DAERT::DAERT	(	const ColumnVector &	xx,
		double	tt,
		DAERTFunc &	f
	)

inline

Definition at line 38 of file DAERT.h.

DAERT::DAERT	(	const ColumnVector &	xx,
		const ColumnVector &	xxdot,
		double	tt,
		DAERTFunc &	f
	)

inline

Definition at line 41 of file DAERT.h.

DAERT::DAERT ( const DAERT & a )

inline

Definition at line 45 of file DAERT.h.

virtual DAERT::~DAERT ( void )

inlinevirtual

Definition at line 59 of file DAERT.h.

Member Function Documentation

void base_diff_eqn::clear_stop_time ( void )

inlineinherited

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

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

DAERTConstrFunc DAERTFunc::constraint_function ( void ) const

inlineinherited

Definition at line 66 of file DAERTFunc.h.

Referenced by DASRT::integrate().

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

pure virtualinherited

Implemented in DASRT, DASPK, DASSL, and LSODE.

virtual void base_diff_eqn::force_restart ( void )

inlinevirtualinherited

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

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

DAERHSFunc DAEFunc::function ( void ) const

inlineinherited

Definition at line 71 of file DAEFunc.h.

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

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

inlineinherited

Definition at line 58 of file base-dae.h.

References base_diff_eqn::initialize(), and Array< T >::length().

Referenced by initialize().

void DAERT::initialize	(	const ColumnVector &	xx,
		const ColumnVector &	xxdot,
		double	tt
	)

inline

Definition at line 61 of file DAERT.h.

References base_diff_alg_eqn::initialize().

bool base_diff_eqn::integration_ok ( void ) const

inlineinherited

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

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

octave_idx_type base_diff_eqn::integration_state ( void ) const

inlineinherited

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

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

DAEJacFunc DAEFunc::jacobian_function ( void ) const

inlineinherited

Definition at line 80 of file DAEFunc.h.

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

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

inline

Definition at line 48 of file DAERT.h.

References base_diff_alg_eqn::operator=(), and DAERTFunc::operator=().

DAERTFunc& DAERTFunc::set_constraint_function ( DAERTConstrFunc cf )

inlineinherited

Definition at line 68 of file DAERTFunc.h.

Referenced by Fdasrt().

DAEFunc& DAEFunc::set_function ( DAERHSFunc f )

inlineinherited

Definition at line 73 of file DAEFunc.h.

References f.

DAEFunc& DAEFunc::set_jacobian_function ( DAEJacFunc j )

inlineinherited

Definition at line 82 of file DAEFunc.h.

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

void base_diff_eqn::set_stop_time ( double tt )

inlineinherited

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

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

octave_idx_type base_diff_eqn::size ( void ) const

inlineinherited

Definition at line 75 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().

ColumnVector base_diff_eqn::state ( void ) const

inlineinherited

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

References x.

ColumnVector base_diff_alg_eqn::state_derivative ( void )

inlineinherited

Definition at line 71 of file base-dae.h.

double base_diff_eqn::time ( void ) const

inlineinherited

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

Member Data Documentation

DAERTConstrFunc DAERTFunc::constr

protectedinherited

Definition at line 77 of file DAERTFunc.h.

Referenced by DAERTFunc::operator=().

DAERHSFunc DAEFunc::fun

protectedinherited

Definition at line 91 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

bool base_diff_eqn::integration_error

protectedinherited

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

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

octave_idx_type base_diff_eqn::istate

protectedinherited

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

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

DAEJacFunc DAEFunc::jac

protectedinherited

Definition at line 92 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

bool DAERTFunc::reset

protectedinherited

Definition at line 84 of file DAERTFunc.h.

Referenced by DASRT::integrate(), and DAERTFunc::operator=().

bool base_diff_eqn::restart

protectedinherited

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

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

double base_diff_eqn::stop_time

protectedinherited

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

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

bool base_diff_eqn::stop_time_set

protectedinherited

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

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

double base_diff_eqn::t

protectedinherited

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

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

ColumnVector base_diff_eqn::x

protectedinherited

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

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

ColumnVector base_diff_alg_eqn::xdot

protectedinherited

Definition at line 75 of file base-dae.h.

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

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

liboctave/numeric/DAERT.h