DASPK Class Reference

#include "DASPK.h"

Inheritance diagram for DASPK:

Public Member Functions
	DASPK ()
	DASPK (const ColumnVector &s, const ColumnVector &deriv, double tm, DAEFunc &f)
	DASPK (const ColumnVector &s, double tm, DAEFunc &f)
Matrix	do_integrate (const ColumnVector &tout)
Matrix	do_integrate (const ColumnVector &tout, const ColumnVector &tcrit)
ColumnVector	do_integrate (double t)
std::string	error_message () const
Matrix	integrate (const ColumnVector &tout, Matrix &xdot_out)
Matrix	integrate (const ColumnVector &tout, Matrix &xdot_out, const ColumnVector &tcrit)
Public Member Functions inherited from DAE
	DAE ()
	DAE (const ColumnVector &xx, const ColumnVector &xxdot, double tt, DAEFunc &f)
	DAE (const ColumnVector &xx, double tt, DAEFunc &f)
	DAE (const DAE &a)
virtual	~DAE ()=default
DAE &	operator= (const DAE &a)
Public Member Functions inherited from base_diff_alg_eqn
	base_diff_alg_eqn ()
	base_diff_alg_eqn (const base_diff_alg_eqn &a)
	base_diff_alg_eqn (const ColumnVector &xx, const ColumnVector &xxdot, double tt)
	base_diff_alg_eqn (const ColumnVector &xx, double tt)
virtual	~base_diff_alg_eqn ()=default
void	initialize (const ColumnVector &x0, const ColumnVector &xdot0, double t0)
void	initialize (const ColumnVector &x0, double t0)
base_diff_alg_eqn &	operator= (const base_diff_alg_eqn &a)
ColumnVector	state_derivative ()
Public Member Functions inherited from base_diff_eqn
	base_diff_eqn ()
	base_diff_eqn (const base_diff_eqn &a)
	base_diff_eqn (const ColumnVector &xx, double tt)
virtual	~base_diff_eqn ()=default
void	clear_stop_time ()
virtual void	force_restart ()
void	initialize (const ColumnVector &x0, double t0)
bool	integration_ok () const
octave_idx_type	integration_state () const
base_diff_eqn &	operator= (const base_diff_eqn &a)
void	set_stop_time (double tt)
octave_idx_type	size () const
ColumnVector	state () const
double	time () const
Public Member Functions inherited from DAEFunc
	DAEFunc ()
	DAEFunc (const DAEFunc &a)
	DAEFunc (DAERHSFunc f)
	DAEFunc (DAERHSFunc f, DAEJacFunc j)
virtual	~DAEFunc ()=default
DAERHSFunc	function () const
DAEJacFunc	jacobian_function () const
DAEFunc &	operator= (const DAEFunc &a)
DAEFunc &	set_function (DAERHSFunc f)
DAEFunc &	set_jacobian_function (DAEJacFunc j)
Public Member Functions inherited from DASPK_options
	DASPK_options ()
	DASPK_options (const DASPK_options &opt)
	~DASPK_options ()
Array< double >	absolute_tolerance () const
Array< octave_idx_type >	algebraic_variables () const
octave_idx_type	compute_consistent_initial_condition () const
octave_idx_type	enforce_inequality_constraints () const
octave_idx_type	exclude_algebraic_variables_from_error_test () const
Array< octave_idx_type >	inequality_constraint_types () const
void	init ()
Array< double >	initial_condition_heuristics () const
double	initial_step_size () const
octave_idx_type	maximum_order () const
double	maximum_step_size () const
DASPK_options &	operator= (const DASPK_options &opt)
octave_idx_type	print_initial_condition_info () const
Array< double >	relative_tolerance () const
void	set_absolute_tolerance (const Array< double > &val)
void	set_absolute_tolerance (double val)
void	set_algebraic_variables (const Array< octave_idx_type > &val)
void	set_algebraic_variables (int val)
void	set_compute_consistent_initial_condition (octave_idx_type val)
void	set_default_options ()
void	set_enforce_inequality_constraints (octave_idx_type val)
void	set_exclude_algebraic_variables_from_error_test (octave_idx_type val)
void	set_inequality_constraint_types (const Array< octave_idx_type > &val)
void	set_inequality_constraint_types (octave_idx_type val)
void	set_initial_condition_heuristics (const Array< double > &val)
void	set_initial_step_size (double val)
void	set_maximum_order (octave_idx_type val)
void	set_maximum_step_size (double val)
void	set_options (const DASPK_options &opt)
void	set_print_initial_condition_info (octave_idx_type val)
void	set_relative_tolerance (const Array< double > &val)
void	set_relative_tolerance (double val)
void	set_use_initial_condition_heuristics (octave_idx_type val)
octave_idx_type	use_initial_condition_heuristics () const

Additional Inherited Members
Public Types inherited from DAEFunc
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)
Protected Attributes inherited from base_diff_alg_eqn
ColumnVector	m_xdot
Protected Attributes inherited from base_diff_eqn
bool	m_integration_error
octave_idx_type	m_istate
bool	m_restart
double	m_stop_time
bool	m_stop_time_set
double	m_t
ColumnVector	m_x
Protected Attributes inherited from DAEFunc
DAERHSFunc	m_fcn
DAEJacFunc	m_jac
bool	m_reset
Protected Attributes inherited from DASPK_options
bool	m_reset

Detailed Description

Definition at line 38 of file DASPK.h.

Constructor & Destructor Documentation

DASPK() [1/3]

DASPK::DASPK ( )

inline

Definition at line 44 of file DASPK.h.

DASPK() [2/3]

DASPK::DASPK ( const ColumnVector &  s, double  tm, DAEFunc &  f  )

inline

Definition at line 48 of file DASPK.h.

DASPK() [3/3]

DASPK::DASPK ( const ColumnVector &  s, const ColumnVector &  deriv, double  tm, DAEFunc &  f  )

inline

Definition at line 53 of file DASPK.h.

Member Function Documentation

do_integrate() [1/3]

Matrix DASPK::do_integrate

(

const ColumnVector &

tout

)

Definition at line 540 of file DASPK.cc.

References integrate().

do_integrate() [2/3]

Matrix DASPK::do_integrate	(	const ColumnVector &	tout,
		const ColumnVector &	tcrit
	)

Definition at line 584 of file DASPK.cc.

References integrate().

do_integrate() [3/3]

ColumnVector DASPK::do_integrate

(

double

t

)

Definition at line 141 of file DASPK.cc.

References base_diff_eqn::m_integration_error, DAEFunc::m_reset, DASPK_options::m_reset, base_diff_eqn::m_restart, n, Array< T, Alloc >::resize(), and base_diff_eqn::size().

Referenced by integrate().

error_message()

std::string DASPK::error_message ( ) const

virtual

Implements base_diff_eqn.

Definition at line 695 of file DASPK.cc.

References base_diff_eqn::m_istate, and base_diff_eqn::m_t.

integrate() [1/2]

Matrix DASPK::integrate	(	const ColumnVector &	tout,
		Matrix &	xdot_out
	)

Definition at line 547 of file DASPK.cc.

References do_integrate(), Array< T, Alloc >::elem(), base_diff_eqn::m_integration_error, base_diff_eqn::m_x, base_diff_alg_eqn::m_xdot, n, Array< T, Alloc >::numel(), Matrix::resize(), and base_diff_eqn::size().

Referenced by do_integrate(), and integrate().

integrate() [2/2]

Matrix DASPK::integrate	(	const ColumnVector &	tout,
		Matrix &	xdot_out,
		const ColumnVector &	tcrit
	)

Definition at line 591 of file DASPK.cc.

References base_diff_eqn::clear_stop_time(), do_integrate(), Array< T, Alloc >::elem(), base_diff_eqn::force_restart(), integrate(), base_diff_eqn::m_integration_error, base_diff_eqn::m_x, base_diff_alg_eqn::m_xdot, n, Array< T, Alloc >::numel(), Matrix::resize(), base_diff_eqn::set_stop_time(), and base_diff_eqn::size().

---

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

• liboctave/numeric/DASPK.h
• liboctave/numeric/DASPK.cc