#include "DAE.h"

Inheritance diagram for DAE:

[legend]

Collaboration diagram for DAE:

[legend]

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 (const ColumnVector &xx, const ColumnVector &xxdot, double tt, DAEFunc &f)

	DAE (const ColumnVector &xx, double tt, DAEFunc &f)

	DAE (const DAE &a)

	DAE (void)

virtual	~DAE (void)=default

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 34 of file DAE.h.

Member Typedef Documentation

◆ DAEJacFunc

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

inherited

Definition at line 47 of file DAEFunc.h.

◆ DAERHSFunc

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

inherited

Definition at line 39 of file DAEFunc.h.

Constructor & Destructor Documentation

◆ DAE() [1/4]

DAE::DAE ( void )

inline

Definition at line 40 of file DAE.h.

◆ DAE() [2/4]

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

inline

Definition at line 43 of file DAE.h.

◆ DAE() [3/4]

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

inline

Definition at line 46 of file DAE.h.

◆ DAE() [4/4]

DAE::DAE ( const DAE & a )

inline

Definition at line 50 of file DAE.h.

◆ ~DAE()

virtual DAE::~DAE ( void )

virtualdefault

Member Function Documentation

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

◆ function()

DAERHSFunc DAEFunc::function ( void ) const

inlineinherited

Definition at line 76 of file DAEFunc.h.

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

◆ initialize() [1/2]

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

inlineinherited

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

References base_diff_eqn::initialize().

◆ initialize() [2/2]

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

inlineinherited

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

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

Referenced by DAERT::initialize().

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

◆ jacobian_function()

DAEJacFunc DAEFunc::jacobian_function ( void ) const

inlineinherited

Definition at line 85 of file DAEFunc.h.

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

◆ operator=()

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

inline

Definition at line 53 of file DAE.h.

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

◆ set_function()

DAEFunc& DAEFunc::set_function ( DAERHSFunc f )

inlineinherited

Definition at line 78 of file DAEFunc.h.

References f.

◆ set_jacobian_function()

DAEFunc& DAEFunc::set_jacobian_function ( DAEJacFunc j )

inlineinherited

Definition at line 87 of file DAEFunc.h.

Referenced by DEFMETHOD().

◆ 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.

References x.

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.

References x.

◆ state_derivative()

ColumnVector base_diff_alg_eqn::state_derivative ( void )

inlineinherited

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

◆ time()

double base_diff_eqn::time ( void ) const

inlineinherited

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

Member Data Documentation

◆ fun

DAERHSFunc DAEFunc::fun

protectedinherited

Definition at line 96 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

◆ integration_error

bool base_diff_eqn::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=().

◆ istate

octave_idx_type base_diff_eqn::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=().

◆ jac

DAEJacFunc DAEFunc::jac

protectedinherited

Definition at line 97 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

◆ reset

bool DAEFunc::reset

protectedinherited

Definition at line 104 of file DAEFunc.h.

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

◆ restart

bool base_diff_eqn::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=().

◆ stop_time

double base_diff_eqn::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=().

◆ stop_time_set

bool base_diff_eqn::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=().

◆ t

double base_diff_eqn::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=().

◆ x

ColumnVector base_diff_eqn::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=().

◆ xdot

ColumnVector base_diff_alg_eqn::xdot

protectedinherited

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

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

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

liboctave/numeric/DAE.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DAEJacFunc

◆ DAERHSFunc

Constructor & Destructor Documentation

◆ DAE() [1/4]

◆ DAE() [2/4]

◆ DAE() [3/4]

◆ DAE() [4/4]

◆ ~DAE()

Member Function Documentation

◆ clear_stop_time()

◆ error_message()

◆ force_restart()

◆ function()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ integration_ok()

◆ integration_state()

◆ jacobian_function()

◆ operator=()

◆ set_function()

◆ set_jacobian_function()

◆ set_stop_time()

◆ size()

◆ state()

◆ state_derivative()

◆ time()

Member Data Documentation

◆ fun

◆ integration_error

◆ istate

◆ jac

◆ reset

◆ restart

◆ stop_time

◆ stop_time_set

◆ t

◆ x

◆ xdot