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 (const ColumnVector &s, const ColumnVector &deriv, double tm, DAEFunc &f)
	DASPK (const ColumnVector &s, double tm, DAEFunc &f)
	DASPK (void)
	~DASPK (void)=default
void	clear_stop_time (void)
Matrix	do_integrate (const ColumnVector &tout)
Matrix	do_integrate (const ColumnVector &tout, const ColumnVector &tcrit)
ColumnVector	do_integrate (double t)
std::string	error_message (void) const
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)
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
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

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

Detailed Description

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

DASPK() [1/3]

DASPK::DASPK ( void  )

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 52 of file DASPK.h.

~DASPK()

DASPK::~DASPK ( void  )

default

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

do_integrate() [1/3]

Matrix DASPK::do_integrate

(

const ColumnVector &

tout

)

Definition at line 539 of file DASPK.cc.

References integrate().

do_integrate() [2/3]

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

Definition at line 583 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 abs_tol, current_liboctave_error_handler, ddaspk(), ddaspk_f(), ddaspk_j(), ddaspk_psol(), F77_XFCN, Array< T >::fortran_vec(), DAEFunc::function(), info, initialized, base_diff_eqn::integration_error, base_diff_eqn::istate, iwork, DAEFunc::jacobian_function(), liw, lrw, n, octave::math::nint_big(), nn, Array< T >::numel(), rel_tol, DAEFunc::reset, Array< T >::resize(), base_diff_eqn::restart, retval, rwork, base_diff_eqn::size(), base_diff_eqn::stop_time, base_diff_eqn::stop_time_set, base_diff_eqn::t, user_fun, user_jac, base_diff_eqn::x, and base_diff_alg_eqn::xdot.

Referenced by integrate().

error_message()

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

virtual

Implements base_diff_eqn.

Definition at line 694 of file DASPK.cc.

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

Referenced by DEFMETHOD().

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

function()

DAERHSFunc DAEFunc::function ( void  ) const

inlineinherited

Definition at line 76 of file DAEFunc.h.

Referenced by 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().

integrate() [1/2]

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

Definition at line 546 of file DASPK.cc.

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

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

integrate() [2/2]

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

Definition at line 590 of file DASPK.cc.

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

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

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(), 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 do_integrate(), DASSL::do_integrate(), LSODE::do_integrate(), 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

abs_tol

Array<double> DASPK::abs_tol

private

Definition at line 85 of file DASPK.h.

Referenced by do_integrate().

fun

DAERHSFunc DAEFunc::fun

protectedinherited

Definition at line 96 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

info

Array<octave_f77_int_type> DASPK::info

private

Definition at line 80 of file DASPK.h.

Referenced by do_integrate().

initialized

bool DASPK::initialized

private

Definition at line 75 of file DASPK.h.

Referenced by do_integrate().

integration_error

bool base_diff_eqn::integration_error

protectedinherited

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

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

iwork

Array<octave_f77_int_type> DASPK::iwork

private

Definition at line 81 of file DASPK.h.

Referenced by do_integrate().

jac

DAEJacFunc DAEFunc::jac

protectedinherited

Definition at line 97 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

liw

octave_f77_int_type DASPK::liw

private

Definition at line 77 of file DASPK.h.

Referenced by do_integrate().

lrw

octave_f77_int_type DASPK::lrw

private

Definition at line 78 of file DASPK.h.

Referenced by do_integrate().

rel_tol

Array<double> DASPK::rel_tol

private

Definition at line 86 of file DASPK.h.

Referenced by do_integrate().

reset

bool DAEFunc::reset

protectedinherited

Definition at line 104 of file DAEFunc.h.

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

rwork

Array<double> DASPK::rwork

private

Definition at line 83 of file DASPK.h.

Referenced by do_integrate().

stop_time

double base_diff_eqn::stop_time

protectedinherited

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

Referenced by 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 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 do_integrate(), DASSL::do_integrate(), LSODE::do_integrate(), 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 do_integrate(), DASSL::do_integrate(), LSODE::do_integrate(), 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 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