GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Types | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
DASRT Class Reference

#include "DASRT.h"

Inheritance diagram for DASRT:
Inheritance graph
[legend]
Collaboration diagram for DASRT:
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)
 
typedef ColumnVector(* DAERTConstrFunc) (const ColumnVector &x, double t)
 

Public Member Functions

 DASRT (const ColumnVector &s, const ColumnVector &deriv, double tm, DAERTFunc &f)
 
 DASRT (const ColumnVector &s, double tm, DAERTFunc &f)
 
 DASRT (void)
 
 ~DASRT (void)=default
 
void clear_stop_time (void)
 
DAERTConstrFunc constraint_function (void) const
 
std::string error_message (void) const
 
virtual void force_restart (void)
 
DAERHSFunc function (void) const
 
void initialize (const ColumnVector &x0, double t0)
 
void initialize (const ColumnVector &xx, const ColumnVector &xxdot, double tt)
 
DASRT_result integrate (const ColumnVector &tout)
 
DASRT_result integrate (const ColumnVector &tout, const ColumnVector &tcrit)
 
bool integration_ok (void) const
 
octave_idx_type integration_state (void) const
 
DAEJacFunc jacobian_function (void) const
 
DAERTFunc & set_constraint_function (DAERTConstrFunc cf)
 
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

DAERTConstrFunc m_constr
 
DAERHSFunc m_fcn
 
bool m_integration_error
 
octave_idx_type m_istate
 
DAEJacFunc m_jac
 
bool m_reset
 
bool m_restart
 
double m_stop_time
 
bool m_stop_time_set
 
double m_t
 
ColumnVector m_x
 
ColumnVector m_xdot
 

Private Member Functions

void integrate (double t)
 

Private Attributes

Array< double > m_abs_tol
 
Array< octave_f77_int_type > m_info
 
bool m_initialized
 
Array< octave_f77_int_type > m_iwork
 
Array< octave_f77_int_type > m_jroot
 
octave_f77_int_type m_liw
 
octave_f77_int_type m_lrw
 
octave_f77_int_type m_ng
 
Array< double > m_rel_tol
 
Array< double > m_rwork
 

Detailed Description

Definition at line 75 of file DASRT.h.

Member Typedef Documentation

◆ DAEJacFunc

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

Definition at line 46 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 38 of file DAEFunc.h.

◆ DAERTConstrFunc

typedef ColumnVector(* DAERTFunc::DAERTConstrFunc) (const ColumnVector &x, double t)
inherited

Definition at line 38 of file DAERTFunc.h.

Constructor & Destructor Documentation

◆ DASRT() [1/3]

DASRT::DASRT ( void  )
inline

Definition at line 81 of file DASRT.h.

◆ DASRT() [2/3]

DASRT::DASRT ( const ColumnVector &  s,
double  tm,
DAERTFunc &  f 
)
inline

Definition at line 87 of file DASRT.h.

◆ DASRT() [3/3]

DASRT::DASRT ( const ColumnVector &  s,
const ColumnVector &  deriv,
double  tm,
DAERTFunc &  f 
)
inline

Definition at line 93 of file DASRT.h.

◆ ~DASRT()

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

◆ constraint_function()

DAERTConstrFunc DAERTFunc::constraint_function ( void  ) const
inlineinherited

Definition at line 71 of file DAERTFunc.h.

Referenced by integrate().

◆ error_message()

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

Implements base_diff_eqn.

Definition at line 554 of file DASRT.cc.

References base_diff_eqn::m_istate, and base_diff_eqn::m_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(), integrate(), DASPK::integrate(), and DASSL::integrate().

◆ function()

DAERHSFunc DAEFunc::function ( void  ) const
inlineinherited

Definition at line 75 of file DAEFunc.h.

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

◆ initialize() [1/2]

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

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

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

Referenced by DAERT::initialize().

◆ initialize() [2/2]

void DAERT::initialize ( const ColumnVector &  xx,
const ColumnVector &  xxdot,
double  tt 
)
inlineinherited

Definition at line 66 of file DAERT.h.

References base_diff_alg_eqn::initialize().

◆ integrate() [1/3]

DASRT_result DASRT::integrate ( const ColumnVector &  tout)

Definition at line 376 of file DASRT.cc.

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

Referenced by DEFMETHOD(), and integrate().

◆ integrate() [2/3]

DASRT_result DASRT::integrate ( const ColumnVector &  tout,
const ColumnVector &  tcrit 
)

Definition at line 435 of file DASRT.cc.

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

◆ integrate() [3/3]

void DASRT::integrate ( double  t)
private

Definition at line 139 of file DASRT.cc.

References DAERTFunc::constraint_function(), ddasrt(), ddasrt_f(), ddasrt_g(), ddasrt_j(), Array< T, Alloc >::elem(), F77_XFCN, Array< T, Alloc >::fortran_vec(), DAEFunc::function(), DAEFunc::jacobian_function(), m_abs_tol, m_info, m_initialized, base_diff_eqn::m_integration_error, base_diff_eqn::m_istate, m_iwork, m_jroot, m_liw, m_lrw, m_ng, m_rel_tol, DAEFunc::m_reset, DAERTFunc::m_reset, base_diff_eqn::m_restart, m_rwork, base_diff_eqn::m_stop_time, base_diff_eqn::m_stop_time_set, base_diff_eqn::m_t, base_diff_eqn::m_x, base_diff_alg_eqn::m_xdot, n, nn, Array< T, Alloc >::numel(), Array< T, Alloc >::resize(), base_diff_eqn::size(), user_csub, user_fsub, and user_jsub.

◆ 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 84 of file DAEFunc.h.

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

◆ set_constraint_function()

DAERTFunc& DAERTFunc::set_constraint_function ( DAERTConstrFunc  cf)
inlineinherited

Definition at line 73 of file DAERTFunc.h.

Referenced by DEFMETHOD().

◆ set_function()

DAEFunc& DAEFunc::set_function ( DAERHSFunc  f)
inlineinherited

Definition at line 77 of file DAEFunc.h.

References f.

◆ set_jacobian_function()

DAEFunc& DAEFunc::set_jacobian_function ( DAEJacFunc  j)
inlineinherited

Definition at line 86 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(), 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.

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

◆ state()

ColumnVector base_diff_eqn::state ( void  ) const
inlineinherited

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

◆ 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

◆ m_abs_tol

Array<double> DASRT::m_abs_tol
private

Definition at line 124 of file DASRT.h.

Referenced by integrate().

◆ m_constr

DAERTConstrFunc DAERTFunc::m_constr
protectedinherited

Definition at line 82 of file DAERTFunc.h.

Referenced by DAERTFunc::operator=().

◆ m_fcn

DAERHSFunc DAEFunc::m_fcn
protectedinherited

Definition at line 95 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

◆ m_info

Array<octave_f77_int_type> DASRT::m_info
private

Definition at line 118 of file DASRT.h.

Referenced by integrate().

◆ m_initialized

bool DASRT::m_initialized
private

Definition at line 111 of file DASRT.h.

Referenced by integrate().

◆ m_integration_error

bool base_diff_eqn::m_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(), integrate(), and base_diff_eqn::operator=().

◆ m_istate

octave_idx_type base_diff_eqn::m_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(), error_message(), DASSL::error_message(), LSODE::error_message(), integrate(), and base_diff_eqn::operator=().

◆ m_iwork

Array<octave_f77_int_type> DASRT::m_iwork
private

Definition at line 119 of file DASRT.h.

Referenced by integrate().

◆ m_jac

DAEJacFunc DAEFunc::m_jac
protectedinherited

Definition at line 96 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

◆ m_jroot

Array<octave_f77_int_type> DASRT::m_jroot
private

Definition at line 120 of file DASRT.h.

Referenced by integrate().

◆ m_liw

octave_f77_int_type DASRT::m_liw
private

Definition at line 113 of file DASRT.h.

Referenced by integrate().

◆ m_lrw

octave_f77_int_type DASRT::m_lrw
private

Definition at line 114 of file DASRT.h.

Referenced by integrate().

◆ m_ng

octave_f77_int_type DASRT::m_ng
private

Definition at line 116 of file DASRT.h.

Referenced by integrate().

◆ m_rel_tol

Array<double> DASRT::m_rel_tol
private

Definition at line 125 of file DASRT.h.

Referenced by integrate().

◆ m_reset

bool DAERTFunc::m_reset
protectedinherited

Definition at line 89 of file DAERTFunc.h.

Referenced by integrate(), and DAERTFunc::operator=().

◆ m_restart

bool base_diff_eqn::m_restart
protectedinherited

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

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

◆ m_rwork

Array<double> DASRT::m_rwork
private

Definition at line 122 of file DASRT.h.

Referenced by integrate().

◆ m_stop_time

double base_diff_eqn::m_stop_time
protectedinherited

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

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

◆ m_stop_time_set

bool base_diff_eqn::m_stop_time_set
protectedinherited

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

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

◆ m_t

double base_diff_eqn::m_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(), error_message(), DASSL::error_message(), LSODE::error_message(), integrate(), and base_diff_eqn::operator=().

◆ m_x

ColumnVector base_diff_eqn::m_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(), integrate(), and base_diff_eqn::operator=().

◆ m_xdot

ColumnVector base_diff_alg_eqn::m_xdot
protectedinherited

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

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

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