DASPK Class Reference

#include "DASPK.h"

Inheritance diagram for DASPK:

Collaboration diagram for DASPK:

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
	DASPK (void)
	DASPK (const ColumnVector &s, double tm, DAEFunc &f)
	DASPK (const ColumnVector &s, const ColumnVector &deriv, double tm, DAEFunc &f)
	~DASPK (void)
Array< double >	absolute_tolerance (void) const
Array< octave_idx_type >	algebraic_variables (void) const
void	clear_stop_time (void)
octave_idx_type	compute_consistent_initial_condition (void) const
ColumnVector	do_integrate (double t)
Matrix	do_integrate (const ColumnVector &tout)
Matrix	do_integrate (const ColumnVector &tout, const ColumnVector &tcrit)
octave_idx_type	enforce_inequality_constraints (void) const
std::string	error_message (void) const
octave_idx_type	exclude_algebraic_variables_from_error_test (void) const
virtual void	force_restart (void)
DAERHSFunc	function (void) const
Array< octave_idx_type >	inequality_constraint_types (void) const
void	init (void)
Array< double >	initial_condition_heuristics (void) const
double	initial_step_size (void) const
void	initialize (const ColumnVector &x0, double t0)
void	initialize (const ColumnVector &x0, const ColumnVector &xdot0, double t0)
Matrix	integrate (const ColumnVector &tout, Matrix &xdot_out)
Matrix	integrate (const ColumnVector &tout, Matrix &xdot_out, const ColumnVector &tcrit)
bool	integration_ok (void) const
octave_idx_type	integration_state (void) const
DAEJacFunc	jacobian_function (void) const
octave_idx_type	maximum_order (void) const
double	maximum_step_size (void) const
octave_idx_type	print_initial_condition_info (void) const
Array< double >	relative_tolerance (void) const
void	set_absolute_tolerance (double val)
void	set_absolute_tolerance (const Array< double > &val)
void	set_algebraic_variables (int val)
void	set_algebraic_variables (const Array< octave_idx_type > &val)
void	set_compute_consistent_initial_condition (octave_idx_type val)
void	set_default_options (void)
void	set_enforce_inequality_constraints (octave_idx_type val)
void	set_exclude_algebraic_variables_from_error_test (octave_idx_type val)
DAEFunc &	set_function (DAERHSFunc f)
void	set_inequality_constraint_types (octave_idx_type val)
void	set_inequality_constraint_types (const Array< octave_idx_type > &val)
void	set_initial_condition_heuristics (const Array< double > &val)
void	set_initial_step_size (double val)
DAEFunc &	set_jacobian_function (DAEJacFunc j)
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 (double val)
void	set_relative_tolerance (const Array< double > &val)
void	set_stop_time (double tt)
void	set_use_initial_condition_heuristics (octave_idx_type val)
octave_idx_type	size (void) const
ColumnVector	state (void) const
ColumnVector	state_derivative (void)
double	time (void) const
octave_idx_type	use_initial_condition_heuristics (void) const

Protected Attributes
DAERHSFunc	fun
bool	integration_error
octave_idx_type	istate
DAEJacFunc	jac
bool	reset
bool	reset
bool	restart
double	stop_time
bool	stop_time_set
double	t
ColumnVector	x
ColumnVector	xdot

Private Attributes
Array< double >	abs_tol
Array< octave_idx_type >	info
bool	initialized
Array< octave_idx_type >	iwork
octave_idx_type	liw
octave_idx_type	lrw
Array< double >	rel_tol
Array< double >	rwork

Detailed Description

Definition at line 31 of file DASPK.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

DASPK::DASPK ( void  )

inline

Definition at line 37 of file DASPK.h.

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

inline

Definition at line 41 of file DASPK.h.

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

inline

Definition at line 45 of file DASPK.h.

DASPK::~DASPK ( void  )

inline

Definition at line 51 of file DASPK.h.

Member Function Documentation

Array<double> DASPK_options::absolute_tolerance ( void  ) const

inlineinherited

Definition at line 188 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

Array<octave_idx_type> DASPK_options::algebraic_variables ( void  ) const

inlineinherited

Definition at line 209 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

void base_diff_eqn::clear_stop_time ( void  )

inlineinherited

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

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

octave_idx_type DASPK_options::compute_consistent_initial_condition ( void  ) const

inlineinherited

Definition at line 194 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

ColumnVector DASPK::do_integrate

(

double

t

)

Definition at line 156 of file DASPK.cc.

References abs_tol, DASPK_options::absolute_tolerance(), DASPK_options::algebraic_variables(), DASPK_options::compute_consistent_initial_condition(), ddaspk(), ddaspk_f(), ddaspk_j(), ddaspk_psol(), DASPK_options::enforce_inequality_constraints(), DASPK_options::exclude_algebraic_variables_from_error_test(), F77_XFCN, Array< T >::fortran_vec(), DAEFunc::function(), DASPK_options::inequality_constraint_types(), info, DASPK_options::initial_condition_heuristics(), DASPK_options::initial_step_size(), initialized, base_diff_eqn::integration_error, base_diff_eqn::istate, iwork, DAEFunc::jacobian_function(), Array< T >::length(), liw, lrw, DASPK_options::maximum_order(), DASPK_options::maximum_step_size(), NINTbig(), DASPK_options::print_initial_condition_info(), rel_tol, DASPK_options::relative_tolerance(), DAEFunc::reset, DASPK_options::reset, Array< T >::resize(), base_diff_eqn::restart, rwork, base_diff_eqn::size(), base_diff_eqn::stop_time, base_diff_eqn::stop_time_set, base_diff_eqn::t, DASPK_options::use_initial_condition_heuristics(), user_fun, user_jac, base_diff_eqn::x, and base_diff_alg_eqn::xdot.

Referenced by integrate().

Matrix DASPK::do_integrate

(

const ColumnVector &

tout

)

Definition at line 530 of file DASPK.cc.

References integrate().

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

Definition at line 574 of file DASPK.cc.

References integrate().

octave_idx_type DASPK_options::enforce_inequality_constraints ( void  ) const

inlineinherited

Definition at line 212 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

std::string DASPK::error_message ( void  ) const

virtual

Implements base_diff_eqn.

Definition at line 685 of file DASPK.cc.

References base_diff_eqn::istate, and base_diff_eqn::t.

Referenced by Fdaspk().

octave_idx_type DASPK_options::exclude_algebraic_variables_from_error_test ( void  ) const

inlineinherited

Definition at line 206 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

virtual void base_diff_eqn::force_restart ( void  )

inlinevirtualinherited

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

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

DAERHSFunc DAEFunc::function ( void  ) const

inlineinherited

Definition at line 71 of file DAEFunc.h.

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

Array<octave_idx_type> DASPK_options::inequality_constraint_types ( void  ) const

inlineinherited

Definition at line 215 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

void DASPK_options::init ( void  )

inlineinherited

Definition at line 79 of file DASPK-opts.h.

References pow().

Array<double> DASPK_options::initial_condition_heuristics ( void  ) const

inlineinherited

Definition at line 200 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

double DASPK_options::initial_step_size ( void  ) const

inlineinherited

Definition at line 218 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

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 DAERT::initialize().

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

inlineinherited

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

References base_diff_eqn::initialize().

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

Definition at line 537 of file DASPK.cc.

References Array< T >::capacity(), do_integrate(), Array< T >::elem(), base_diff_eqn::integration_error, Matrix::resize(), base_diff_eqn::size(), base_diff_eqn::x, and base_diff_alg_eqn::xdot.

Referenced by do_integrate(), Fdaspk(), and integrate().

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

Definition at line 581 of file DASPK.cc.

References Array< T >::capacity(), base_diff_eqn::clear_stop_time(), do_integrate(), Array< T >::elem(), base_diff_eqn::force_restart(), integrate(), base_diff_eqn::integration_error, Matrix::resize(), base_diff_eqn::set_stop_time(), base_diff_eqn::size(), base_diff_eqn::x, and base_diff_alg_eqn::xdot.

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 do_integrate(), DASSL::do_integrate(), and DASRT::integrate().

octave_idx_type DASPK_options::maximum_order ( void  ) const

inlineinherited

Definition at line 221 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

double DASPK_options::maximum_step_size ( void  ) const

inlineinherited

Definition at line 224 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

octave_idx_type DASPK_options::print_initial_condition_info ( void  ) const

inlineinherited

Definition at line 203 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

Array<double> DASPK_options::relative_tolerance ( void  ) const

inlineinherited

Definition at line 191 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

void DASPK_options::set_absolute_tolerance ( double  val )

inlineinherited

Definition at line 122 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_absolute_tolerance ( const Array< double > &  val )

inlineinherited

Definition at line 129 of file DASPK-opts.h.

void DASPK_options::set_algebraic_variables ( int  val )

inlineinherited

Definition at line 157 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_algebraic_variables ( const Array< octave_idx_type > &  val )

inlineinherited

Definition at line 164 of file DASPK-opts.h.

void DASPK_options::set_compute_consistent_initial_condition ( octave_idx_type  val )

inlineinherited

Definition at line 142 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_default_options ( void  )

inlineinherited

Definition at line 120 of file DASPK-opts.h.

void DASPK_options::set_enforce_inequality_constraints ( octave_idx_type  val )

inlineinherited

Definition at line 167 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_exclude_algebraic_variables_from_error_test ( octave_idx_type  val )

inlineinherited

Definition at line 154 of file DASPK-opts.h.

Referenced by set_DASPK_options().

DAEFunc& DAEFunc::set_function ( DAERHSFunc  f )

inlineinherited

Definition at line 73 of file DAEFunc.h.

References f.

void DASPK_options::set_inequality_constraint_types ( octave_idx_type  val )

inlineinherited

Definition at line 170 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_inequality_constraint_types ( const Array< octave_idx_type > &  val )

inlineinherited

Definition at line 177 of file DASPK-opts.h.

void DASPK_options::set_initial_condition_heuristics ( const Array< double > &  val )

inlineinherited

Definition at line 148 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_initial_step_size ( double  val )

inlineinherited

Definition at line 180 of file DASPK-opts.h.

Referenced by set_DASPK_options().

DAEFunc& DAEFunc::set_jacobian_function ( DAEJacFunc  j )

inlineinherited

Definition at line 82 of file DAEFunc.h.

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

void DASPK_options::set_maximum_order ( octave_idx_type  val )

inlineinherited

Definition at line 183 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_maximum_step_size ( double  val )

inlineinherited

Definition at line 186 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_options ( const DASPK_options &  opt )

inlineinherited

Definition at line 102 of file DASPK-opts.h.

References DASPK_options::reset, DASPK_options::x_absolute_tolerance, DASPK_options::x_algebraic_variables, DASPK_options::x_compute_consistent_initial_condition, DASPK_options::x_enforce_inequality_constraints, DASPK_options::x_exclude_algebraic_variables_from_error_test, DASPK_options::x_inequality_constraint_types, DASPK_options::x_initial_condition_heuristics, DASPK_options::x_initial_step_size, DASPK_options::x_maximum_order, DASPK_options::x_maximum_step_size, DASPK_options::x_print_initial_condition_info, DASPK_options::x_relative_tolerance, and DASPK_options::x_use_initial_condition_heuristics.

Referenced by Fdaspk().

void DASPK_options::set_print_initial_condition_info ( octave_idx_type  val )

inlineinherited

Definition at line 151 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_relative_tolerance ( double  val )

inlineinherited

Definition at line 132 of file DASPK-opts.h.

Referenced by set_DASPK_options().

void DASPK_options::set_relative_tolerance ( const Array< double > &  val )

inlineinherited

Definition at line 139 of file DASPK-opts.h.

void base_diff_eqn::set_stop_time ( double  tt )

inlineinherited

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

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

void DASPK_options::set_use_initial_condition_heuristics ( octave_idx_type  val )

inlineinherited

Definition at line 145 of file DASPK-opts.h.

Referenced by set_DASPK_options().

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

octave_idx_type DASPK_options::use_initial_condition_heuristics ( void  ) const

inlineinherited

Definition at line 197 of file DASPK-opts.h.

Referenced by do_integrate(), print_DASPK_options(), and show_DASPK_options().

Member Data Documentation

Array<double> DASPK::abs_tol

private

Definition at line 78 of file DASPK.h.

Referenced by do_integrate().

DAERHSFunc DAEFunc::fun

protectedinherited

Definition at line 91 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

Array<octave_idx_type> DASPK::info

private

Definition at line 73 of file DASPK.h.

Referenced by do_integrate().

bool DASPK::initialized

private

Definition at line 68 of file DASPK.h.

Referenced by do_integrate().

bool base_diff_eqn::integration_error

protectedinherited

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

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

Array<octave_idx_type> DASPK::iwork

private

Definition at line 74 of file DASPK.h.

Referenced by do_integrate().

DAEJacFunc DAEFunc::jac

protectedinherited

Definition at line 92 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

octave_idx_type DASPK::liw

private

Definition at line 70 of file DASPK.h.

Referenced by do_integrate().

octave_idx_type DASPK::lrw

private

Definition at line 71 of file DASPK.h.

Referenced by do_integrate().

Array<double> DASPK::rel_tol

private

Definition at line 79 of file DASPK.h.

Referenced by do_integrate().

bool DAEFunc::reset

protectedinherited

Definition at line 99 of file DAEFunc.h.

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

bool DASPK_options::reset

protectedinherited

Definition at line 245 of file DASPK-opts.h.

Referenced by do_integrate(), DASPK_options::operator=(), and DASPK_options::set_options().

bool base_diff_eqn::restart

protectedinherited

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

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

Array<double> DASPK::rwork

private

Definition at line 76 of file DASPK.h.

Referenced by do_integrate().

double base_diff_eqn::stop_time

protectedinherited

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

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

---

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

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