DAE Class Reference

#include "DAE.h"

Inheritance diagram for DAE:

Collaboration diagram for DAE:

List of all members.

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)
Public Member Functions
	DAE (void)
	DAE (const ColumnVector &xx, double tt, DAEFunc &f)
	DAE (const DAE &a)
	DAE (const ColumnVector &xx, const ColumnVector &xxdot, double tt, DAEFunc &f)
virtual	~DAE (void)
void	clear_stop_time (void)
virtual std::string	error_message (void) const =0
virtual void	force_restart (void)
DAERHSFunc	function (void) const
void	initialize (const ColumnVector &x0, const ColumnVector &xdot0, double t0)
void	initialize (const ColumnVector &x0, double t0)
bool	integration_ok (void) const
octave_idx_type	integration_state (void) const
DAEJacFunc	jacobian_function (void) const
DAE &	operator= (const DAE &a)
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
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 29 of file DAE.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.

---

Constructor & Destructor Documentation

DAE::DAE

(

void

)

[inline]

Definition at line 31 of file DAE.h.

DAE::DAE	(	const ColumnVector &	xx,
		double	tt,
		DAEFunc &	f
	)			[inline]

Definition at line 34 of file DAE.h.

DAE::DAE	(	const ColumnVector &	xx,
		const ColumnVector &	xxdot,
		double	tt,
		DAEFunc &	f
	)			[inline]

Definition at line 37 of file DAE.h.

DAE::DAE

(

const DAE &

a

)

[inline]

Definition at line 41 of file DAE.h.

virtual DAE::~DAE

(

void

)

[inline, virtual]

Definition at line 54 of file DAE.h.

---

Member Function Documentation

void base_diff_eqn::clear_stop_time

(

void

)

[inline, inherited]

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

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

virtual std::string base_diff_eqn::error_message

(

void

)

const [pure virtual, inherited]

virtual void base_diff_eqn::force_restart

(

void

)

[inline, virtual, inherited]

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

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

DAERHSFunc DAEFunc::function

(

void

)

const [inline, inherited]

Definition at line 71 of file DAEFunc.h.

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

void base_diff_alg_eqn::initialize	(	const ColumnVector &	x0,
		double	t0
	)			[inline, inherited]

Reimplemented from base_diff_eqn.

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

void base_diff_alg_eqn::initialize	(	const ColumnVector &	x0,
		const ColumnVector &	xdot0,
		double	t0
	)			[inline, inherited]

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

bool base_diff_eqn::integration_ok

(

void

)

const [inline, inherited]

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

Referenced by DEFUN_DLD().

octave_idx_type base_diff_eqn::integration_state

(

void

)

const [inline, inherited]

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

Referenced by DEFUN_DLD().

DAEJacFunc DAEFunc::jacobian_function

(

void

)

const [inline, inherited]

Definition at line 80 of file DAEFunc.h.

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

DAE& DAE::operator=

(

const DAE &

a

)

[inline]

Definition at line 44 of file DAE.h.

DAEFunc& DAEFunc::set_function

(

DAERHSFunc

f

)

[inline, inherited]

Definition at line 73 of file DAEFunc.h.

DAEFunc& DAEFunc::set_jacobian_function

(

DAEJacFunc

j

)

[inline, inherited]

Definition at line 82 of file DAEFunc.h.

Referenced by DEFUN_DLD().

void base_diff_eqn::set_stop_time

(

double

tt

)

[inline, inherited]

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

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

octave_idx_type base_diff_eqn::size

(

void

)

const [inline, inherited]

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

References x.

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

ColumnVector base_diff_eqn::state

(

void

)

const [inline, inherited]

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

References x.

ColumnVector base_diff_alg_eqn::state_derivative

(

void

)

[inline, inherited]

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

double base_diff_eqn::time

(

void

)

const [inline, inherited]

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

---

Member Data Documentation

DAERHSFunc DAEFunc::fun [protected, inherited]

Definition at line 91 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

bool base_diff_eqn::integration_error [protected, inherited]

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

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

octave_idx_type base_diff_eqn::istate [protected, inherited]

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

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

DAEJacFunc DAEFunc::jac [protected, inherited]

Definition at line 92 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

bool DAEFunc::reset [protected, inherited]

Reimplemented in DAERTFunc.

Definition at line 99 of file DAEFunc.h.

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

bool base_diff_eqn::restart [protected, inherited]

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 [protected, inherited]

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 [protected, inherited]

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 [protected, inherited]

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

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

ColumnVector base_diff_eqn::x [protected, inherited]

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

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

ColumnVector base_diff_alg_eqn::xdot [protected, inherited]

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

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

---

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

• liboctave/DAE.h