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

#include "DAEFunc.h"

Inheritance diagram for DAEFunc:
DAE DAERTFunc DASPK DASSL DAERT DASRT

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

 DAEFunc ()
 
 DAEFunc (const DAEFunc &a)
 
 DAEFunc (DAERHSFunc f)
 
 DAEFunc (DAERHSFunc f, DAEJacFunc j)
 
virtual ~DAEFunc ()=default
 
DAERHSFunc function () const
 
DAEJacFunc jacobian_function () const
 
DAEFuncoperator= (const DAEFunc &a)
 
DAEFuncset_function (DAERHSFunc f)
 
DAEFuncset_jacobian_function (DAEJacFunc j)
 

Protected Attributes

DAERHSFunc m_fcn
 
DAEJacFunc m_jac
 
bool m_reset
 

Detailed Description

Definition at line 33 of file DAEFunc.h.

Member Typedef Documentation

◆ DAEJacFunc

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

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)

Definition at line 38 of file DAEFunc.h.

Constructor & Destructor Documentation

◆ DAEFunc() [1/4]

DAEFunc::DAEFunc ( )
inline

Definition at line 50 of file DAEFunc.h.

◆ DAEFunc() [2/4]

DAEFunc::DAEFunc ( DAERHSFunc  f)
inline

Definition at line 53 of file DAEFunc.h.

◆ DAEFunc() [3/4]

DAEFunc::DAEFunc ( DAERHSFunc  f,
DAEJacFunc  j 
)
inline

Definition at line 56 of file DAEFunc.h.

◆ DAEFunc() [4/4]

DAEFunc::DAEFunc ( const DAEFunc a)
inline

Definition at line 59 of file DAEFunc.h.

◆ ~DAEFunc()

virtual DAEFunc::~DAEFunc ( )
virtualdefault

Member Function Documentation

◆ function()

DAERHSFunc DAEFunc::function ( ) const
inline

Definition at line 75 of file DAEFunc.h.

◆ jacobian_function()

DAEJacFunc DAEFunc::jacobian_function ( ) const
inline

Definition at line 84 of file DAEFunc.h.

◆ operator=()

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

Definition at line 62 of file DAEFunc.h.

References m_fcn, m_jac, and m_reset.

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

◆ set_function()

DAEFunc& DAEFunc::set_function ( DAERHSFunc  f)
inline

Definition at line 77 of file DAEFunc.h.

References f.

◆ set_jacobian_function()

DAEFunc& DAEFunc::set_jacobian_function ( DAEJacFunc  j)
inline

Definition at line 86 of file DAEFunc.h.

Member Data Documentation

◆ m_fcn

DAERHSFunc DAEFunc::m_fcn
protected

Definition at line 95 of file DAEFunc.h.

Referenced by operator=().

◆ m_jac

DAEJacFunc DAEFunc::m_jac
protected

Definition at line 96 of file DAEFunc.h.

Referenced by operator=().

◆ m_reset

bool DAEFunc::m_reset
protected

Definition at line 103 of file DAEFunc.h.

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


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