GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
base_diff_alg_eqn Class Referenceabstract

#include "base-dae.h"

Inheritance diagram for base_diff_alg_eqn:
Collaboration diagram for base_diff_alg_eqn:

Public Member Functions

 base_diff_alg_eqn (const base_diff_alg_eqn &a)
 
 base_diff_alg_eqn (const ColumnVector &xx, const ColumnVector &xxdot, double tt)
 
 base_diff_alg_eqn (const ColumnVector &xx, double tt)
 
 base_diff_alg_eqn (void)
 
virtual ~base_diff_alg_eqn (void)=default
 
void clear_stop_time (void)
 
virtual std::string error_message (void) const =0
 
virtual void force_restart (void)
 
void initialize (const ColumnVector &x0, const ColumnVector &xdot0, double t0)
 
void initialize (const ColumnVector &x0, double t0)
 
bool integration_ok (void) const
 
octave_idx_type integration_state (void) const
 
base_diff_alg_eqnoperator= (const base_diff_alg_eqn &a)
 
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

bool m_integration_error
 
octave_idx_type m_istate
 
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 33 of file base-dae.h.

Constructor & Destructor Documentation

◆ base_diff_alg_eqn() [1/4]

base_diff_alg_eqn::base_diff_alg_eqn ( void  )
inline

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

◆ base_diff_alg_eqn() [2/4]

base_diff_alg_eqn::base_diff_alg_eqn ( const ColumnVector xx,
double  tt 
)
inline

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

◆ base_diff_alg_eqn() [3/4]

base_diff_alg_eqn::base_diff_alg_eqn ( const ColumnVector xx,
const ColumnVector xxdot,
double  tt 
)
inline

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

◆ base_diff_alg_eqn() [4/4]

base_diff_alg_eqn::base_diff_alg_eqn ( const base_diff_alg_eqn a)
inline

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

◆ ~base_diff_alg_eqn()

virtual base_diff_alg_eqn::~base_diff_alg_eqn ( void  )
virtualdefault

Member Function Documentation

◆ clear_stop_time()

void base_diff_eqn::clear_stop_time ( void  )
inlineinherited

◆ 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

◆ initialize() [1/2]

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

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 
)
inline

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

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

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

◆ operator=()

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

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

References m_xdot, and base_diff_eqn::operator=().

Referenced by DAE::operator=(), and DAERT::operator=().

◆ set_stop_time()

void base_diff_eqn::set_stop_time ( double  tt)
inlineinherited

◆ size()

octave_idx_type base_diff_eqn::size ( void  ) const
inlineinherited

◆ 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  )
inline

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_integration_error

bool base_diff_eqn::m_integration_error
protectedinherited

◆ m_istate

◆ m_restart

bool base_diff_eqn::m_restart
protectedinherited

◆ m_stop_time

double base_diff_eqn::m_stop_time
protectedinherited

◆ m_stop_time_set

bool base_diff_eqn::m_stop_time_set
protectedinherited

◆ m_t

◆ m_x

◆ m_xdot

ColumnVector base_diff_alg_eqn::m_xdot
protected

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