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 | List of all members
DAERT Class Referenceabstract

#include "DAERT.h"

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

 DAERT (const ColumnVector &xx, const ColumnVector &xxdot, double tt, DAERTFunc &f)
 
 DAERT (const ColumnVector &xx, double tt, DAERTFunc &f)
 
 DAERT (const DAERT &a)
 
 DAERT (void)
 
virtual ~DAERT (void)=default
 
void clear_stop_time (void)
 
DAERTConstrFunc constraint_function (void) const
 
virtual std::string error_message (void) const =0
 
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)
 
bool integration_ok (void) const
 
octave_idx_type integration_state (void) const
 
DAEJacFunc jacobian_function (void) const
 
DAERT & operator= (const DAERT &a)
 
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
 

Detailed Description

Definition at line 35 of file DAERT.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

◆ DAERT() [1/4]

DAERT::DAERT ( void  )
inline

Definition at line 40 of file DAERT.h.

◆ DAERT() [2/4]

DAERT::DAERT ( const ColumnVector &  xx,
double  tt,
DAERTFunc &  f 
)
inline

Definition at line 43 of file DAERT.h.

◆ DAERT() [3/4]

DAERT::DAERT ( const ColumnVector &  xx,
const ColumnVector &  xxdot,
double  tt,
DAERTFunc &  f 
)
inline

Definition at line 46 of file DAERT.h.

◆ DAERT() [4/4]

DAERT::DAERT ( const DAERT &  a)
inline

Definition at line 50 of file DAERT.h.

◆ ~DAERT()

virtual DAERT::~DAERT ( void  )
virtualdefault

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

◆ constraint_function()

DAERTConstrFunc DAERTFunc::constraint_function ( void  ) const
inlineinherited

Definition at line 71 of file DAERTFunc.h.

Referenced by DASRT::integrate().

◆ error_message()

virtual std::string base_diff_eqn::error_message ( void  ) const
pure virtualinherited

Implemented in LSODE, DASSL, DASRT, and DASPK.

◆ 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(), 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 DASRT::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 initialize().

◆ initialize() [2/2]

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

Definition at line 66 of file DAERT.h.

References base_diff_alg_eqn::initialize().

◆ 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 DASRT::integrate().

◆ operator=()

DAERT& DAERT::operator= ( const DAERT &  a)
inline

Definition at line 53 of file DAERT.h.

References base_diff_alg_eqn::operator=(), and DAERTFunc::operator=().

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

◆ m_jac

DAEJacFunc DAEFunc::m_jac
protectedinherited

Definition at line 96 of file DAEFunc.h.

Referenced by DAEFunc::operator=().

◆ m_reset

bool DAERTFunc::m_reset
protectedinherited

Definition at line 89 of file DAERTFunc.h.

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

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

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