GNU Octave  4.0.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
DASSL Class Reference

#include "DASSL.h"

Inheritance diagram for DASSL:
Inheritance graph
[legend]
Collaboration diagram for DASSL:
Collaboration graph
[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

 DASSL (void)
 
 DASSL (const ColumnVector &s, double tm, DAEFunc &f)
 
 DASSL (const ColumnVector &s, const ColumnVector &deriv, double tm, DAEFunc &f)
 
 ~DASSL (void)
 
Array< doubleabsolute_tolerance (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_nonnegativity_constraints (void) const
 
std::string error_message (void) const
 
virtual void force_restart (void)
 
DAERHSFunc function (void) const
 
void init (void)
 
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
 
Array< doublerelative_tolerance (void) const
 
void set_absolute_tolerance (double val)
 
void set_absolute_tolerance (const Array< double > &val)
 
void set_compute_consistent_initial_condition (octave_idx_type val)
 
void set_default_options (void)
 
void set_enforce_nonnegativity_constraints (octave_idx_type val)
 
DAEFuncset_function (DAERHSFunc f)
 
void set_initial_step_size (double val)
 
DAEFuncset_jacobian_function (DAEJacFunc j)
 
void set_maximum_order (octave_idx_type val)
 
void set_maximum_step_size (double val)
 
void set_options (const DASSL_options &opt)
 
void set_relative_tolerance (double val)
 
void set_relative_tolerance (const Array< double > &val)
 
void set_step_limit (octave_idx_type val)
 
void set_stop_time (double tt)
 
octave_idx_type size (void) const
 
ColumnVector state (void) const
 
ColumnVector state_derivative (void)
 
octave_idx_type step_limit (void) const
 
double time (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< doubleabs_tol
 
Array< octave_idx_typeinfo
 
bool initialized
 
Array< octave_idx_typeiwork
 
octave_idx_type liw
 
octave_idx_type lrw
 
Array< doublerel_tol
 
Array< doublerwork
 

Detailed Description

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

DASSL::DASSL ( void  )
inline

Definition at line 37 of file DASSL.h.

DASSL::DASSL ( const ColumnVector s,
double  tm,
DAEFunc f 
)
inline

Definition at line 41 of file DASSL.h.

DASSL::DASSL ( const ColumnVector s,
const ColumnVector deriv,
double  tm,
DAEFunc f 
)
inline

Definition at line 45 of file DASSL.h.

DASSL::~DASSL ( void  )
inline

Definition at line 51 of file DASSL.h.

Member Function Documentation

Array<double> DASSL_options::absolute_tolerance ( void  ) const
inlineinherited

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

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_options().

void base_diff_eqn::clear_stop_time ( void  )
inlineinherited

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

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

octave_idx_type DASSL_options::compute_consistent_initial_condition ( void  ) const
inlineinherited

Definition at line 135 of file DASSL-opts.h.

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_options().

ColumnVector DASSL::do_integrate ( double  t)
Matrix DASSL::do_integrate ( const ColumnVector tout)

Definition at line 345 of file DASSL.cc.

References integrate().

Matrix DASSL::do_integrate ( const ColumnVector tout,
const ColumnVector tcrit 
)

Definition at line 389 of file DASSL.cc.

References integrate().

octave_idx_type DASSL_options::enforce_nonnegativity_constraints ( void  ) const
inlineinherited

Definition at line 138 of file DASSL-opts.h.

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_options().

std::string DASSL::error_message ( void  ) const
virtual

Implements base_diff_eqn.

Definition at line 500 of file DASSL.cc.

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

Referenced by Fdassl().

virtual void base_diff_eqn::force_restart ( void  )
inlinevirtualinherited

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

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

DAERHSFunc DAEFunc::function ( void  ) const
inlineinherited

Definition at line 71 of file DAEFunc.h.

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

void DASSL_options::init ( void  )
inlineinherited

Definition at line 64 of file DASSL-opts.h.

double DASSL_options::initial_step_size ( void  ) const
inlineinherited

Definition at line 141 of file DASSL-opts.h.

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_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 DASSL::integrate ( const ColumnVector tout,
Matrix xdot_out 
)
Matrix DASSL::integrate ( const ColumnVector tout,
Matrix xdot_out,
const ColumnVector tcrit 
)
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 DASPK::do_integrate(), do_integrate(), and DASRT::integrate().

octave_idx_type DASSL_options::maximum_order ( void  ) const
inlineinherited

Definition at line 144 of file DASSL-opts.h.

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_options().

double DASSL_options::maximum_step_size ( void  ) const
inlineinherited

Definition at line 147 of file DASSL-opts.h.

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_options().

Array<double> DASSL_options::relative_tolerance ( void  ) const
inlineinherited

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

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_options().

void DASSL_options::set_absolute_tolerance ( double  val)
inlineinherited

Definition at line 92 of file DASSL-opts.h.

Referenced by set_DASSL_options().

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

Definition at line 99 of file DASSL-opts.h.

void DASSL_options::set_compute_consistent_initial_condition ( octave_idx_type  val)
inlineinherited

Definition at line 112 of file DASSL-opts.h.

Referenced by set_DASSL_options().

void DASSL_options::set_default_options ( void  )
inlineinherited

Definition at line 90 of file DASSL-opts.h.

void DASSL_options::set_enforce_nonnegativity_constraints ( octave_idx_type  val)
inlineinherited

Definition at line 115 of file DASSL-opts.h.

Referenced by set_DASSL_options().

DAEFunc& DAEFunc::set_function ( DAERHSFunc  f)
inlineinherited

Definition at line 73 of file DAEFunc.h.

References f.

void DASSL_options::set_initial_step_size ( double  val)
inlineinherited

Definition at line 118 of file DASSL-opts.h.

Referenced by set_DASSL_options().

DAEFunc& DAEFunc::set_jacobian_function ( DAEJacFunc  j)
inlineinherited

Definition at line 82 of file DAEFunc.h.

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

void DASSL_options::set_maximum_order ( octave_idx_type  val)
inlineinherited

Definition at line 121 of file DASSL-opts.h.

Referenced by set_DASSL_options().

void DASSL_options::set_maximum_step_size ( double  val)
inlineinherited

Definition at line 124 of file DASSL-opts.h.

Referenced by set_DASSL_options().

void DASSL_options::set_options ( const DASSL_options opt)
inlineinherited
void DASSL_options::set_relative_tolerance ( double  val)
inlineinherited

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

Referenced by set_DASSL_options().

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

Definition at line 109 of file DASSL-opts.h.

void DASSL_options::set_step_limit ( octave_idx_type  val)
inlineinherited

Definition at line 127 of file DASSL-opts.h.

Referenced by set_DASSL_options().

void base_diff_eqn::set_stop_time ( double  tt)
inlineinherited

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

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

octave_idx_type base_diff_eqn::size ( void  ) const
inlineinherited
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.

octave_idx_type DASSL_options::step_limit ( void  ) const
inlineinherited

Definition at line 150 of file DASSL-opts.h.

Referenced by do_integrate(), print_DASSL_options(), and show_DASSL_options().

double base_diff_eqn::time ( void  ) const
inlineinherited

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

Member Data Documentation

Array<double> DASSL::abs_tol
private

Definition at line 78 of file DASSL.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> DASSL::info
private

Definition at line 73 of file DASSL.h.

Referenced by do_integrate().

bool DASSL::initialized
private

Definition at line 68 of file DASSL.h.

Referenced by do_integrate().

bool base_diff_eqn::integration_error
protectedinherited
octave_idx_type base_diff_eqn::istate
protectedinherited
Array<octave_idx_type> DASSL::iwork
private

Definition at line 74 of file DASSL.h.

Referenced by do_integrate().

DAEJacFunc DAEFunc::jac
protectedinherited

Definition at line 92 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

octave_idx_type DASSL::liw
private

Definition at line 70 of file DASSL.h.

Referenced by do_integrate().

octave_idx_type DASSL::lrw
private

Definition at line 71 of file DASSL.h.

Referenced by do_integrate().

Array<double> DASSL::rel_tol
private

Definition at line 79 of file DASSL.h.

Referenced by do_integrate().

bool DAEFunc::reset
protectedinherited

Definition at line 99 of file DAEFunc.h.

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

bool DASSL_options::reset
protectedinherited
bool base_diff_eqn::restart
protectedinherited
Array<double> DASSL::rwork
private

Definition at line 76 of file DASSL.h.

Referenced by do_integrate().

double base_diff_eqn::stop_time
protectedinherited
bool base_diff_eqn::stop_time_set
protectedinherited
double base_diff_eqn::t
protectedinherited
ColumnVector base_diff_eqn::x
protectedinherited
ColumnVector base_diff_alg_eqn::xdot
protectedinherited

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