GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
ODES Class Reference

#include "ODES.h"

Inheritance diagram for ODES:
base_diff_eqn ODESFunc

Public Member Functions

 ODES ()
 
 ODES (const ColumnVector &s, const ColumnVector &xtheta, double tm, ODESFunc &f)
 
 ODES (const ColumnVector &s, double tm, ODESFunc &f)
 
 ODES (const ODES &a)
 
 ~ODES ()=default
 
void initialize (const ColumnVector &x, double t)
 
void initialize (const ColumnVector &x, double t, const ColumnVector &theta)
 
ODESoperator= (const ODES &a)
 
ColumnVector parameter_vector ()
 
- Public Member Functions inherited from base_diff_eqn
 base_diff_eqn ()
 
 base_diff_eqn (const base_diff_eqn &a)
 
 base_diff_eqn (const ColumnVector &xx, double tt)
 
virtual ~base_diff_eqn ()=default
 
void clear_stop_time ()
 
virtual std::string error_message () const =0
 
virtual void force_restart ()
 
void initialize (const ColumnVector &x0, double t0)
 
bool integration_ok () const
 
octave_idx_type integration_state () const
 
base_diff_eqnoperator= (const base_diff_eqn &a)
 
void set_stop_time (double tt)
 
octave_idx_type size () const
 
ColumnVector state () const
 
double time () const
 
- Public Member Functions inherited from ODESFunc
 ODESFunc ()
 
 ODESFunc (const ODESFunc &a)
 
 ODESFunc (ODES_fsub f)
 
 ODESFunc (ODES_fsub f, ODES_bsub b)
 
 ODESFunc (ODES_fsub f, ODES_bsub b, ODES_jsub j)
 
virtual ~ODESFunc ()=default
 
ODES_bsub bsub_function () const
 
ODES_fsub fsub_function () const
 
ODES_jsub jsub_function () const
 
ODESFuncoperator= (const ODESFunc &a)
 
ODESFuncset_bsub_function (ODES_bsub b)
 
ODESFuncset_fsub_function (ODES_fsub f)
 
ODESFuncset_jsub_function (ODES_jsub j)
 

Protected Attributes

ColumnVector m_theta
 
ColumnVector m_xdot
 
- Protected Attributes inherited from base_diff_eqn
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
 
- Protected Attributes inherited from ODESFunc
ODES_bsub m_bsub
 
ODES_fsub m_fsub
 
ODES_jsub m_jsub
 

Additional Inherited Members

- Public Types inherited from ODESFunc
typedef ColumnVector(* ODES_bsub) (const ColumnVector &x, double, const ColumnVector &theta, int column)
 
typedef ColumnVector(* ODES_fsub) (const ColumnVector &x, double, const ColumnVector &theta)
 
typedef Matrix(* ODES_jsub) (const ColumnVector &x, double, const ColumnVector &theta)
 

Detailed Description

Definition at line 34 of file ODES.h.

Constructor & Destructor Documentation

◆ ODES() [1/4]

ODES::ODES ( )
inline

Definition at line 39 of file ODES.h.

◆ ODES() [2/4]

ODES::ODES ( const ColumnVector s,
double  tm,
ODESFunc f 
)
inline

Definition at line 42 of file ODES.h.

◆ ODES() [3/4]

ODES::ODES ( const ColumnVector s,
const ColumnVector xtheta,
double  tm,
ODESFunc f 
)
inline

Definition at line 46 of file ODES.h.

◆ ODES() [4/4]

ODES::ODES ( const ODES a)
inline

Definition at line 51 of file ODES.h.

◆ ~ODES()

ODES::~ODES ( )
default

Member Function Documentation

◆ initialize() [1/2]

void ODES::initialize ( const ColumnVector x,
double  t 
)

Definition at line 33 of file ODES.cc.

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

◆ initialize() [2/2]

void ODES::initialize ( const ColumnVector x,
double  t,
const ColumnVector theta 
)

Definition at line 40 of file ODES.cc.

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

◆ operator=()

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

Definition at line 55 of file ODES.h.

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

◆ parameter_vector()

ColumnVector ODES::parameter_vector ( )
inline

Definition at line 70 of file ODES.h.

Member Data Documentation

◆ m_theta

ColumnVector ODES::m_theta
protected

Definition at line 83 of file ODES.h.

Referenced by initialize(), and operator=().

◆ m_xdot

ColumnVector ODES::m_xdot
protected

Definition at line 80 of file ODES.h.

Referenced by initialize(), and operator=().


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