MyODE Class Reference

Abstract class to define by user specified (system of) ODE. More...

#include <MyODE.h>

Public Member Functions
	MyODE ()
	Default Constructor.
	MyODE (const Mesh &mesh)
	Constructor using mesh instance.
virtual	~MyODE ()
	Destructor.
virtual real_t	Function (real_t t, const real_t &y)
	Virtual member function to define function defining ODE in case of a single ODE.
virtual real_t	Function (real_t t, const Vect< real_t > &y, int i=1)
	Virtual member function to define function defining ODE.
virtual real_t	Jacobian (real_t t, const real_t &y)
	Virtual member function to define derivative of function in case of a single ODE.
virtual real_t	Jacobian (real_t t, const Vect< real_t > &y, int i=1, int j=1)
	Virtual member function to define partial derivatives of function.

Detailed Description

Abstract class to define by user specified (system of) ODE.

The user has to implement a class that inherits from the present one where the virtual functions are implemented.

Author

Rachid Touzani

Copyright

GNU Lesser Public License

Constructor & Destructor Documentation

MyODE()

MyODE

(

const Mesh &

mesh

)

Constructor using mesh instance.

Parameters

mesh	Reference to Mesh instance

Member Function Documentation

Function() [1/2]

virtual real_t Function ( real_t t, const real_t & y )

virtual

Virtual member function to define function defining ODE in case of a single ODE.

Parameters

[in]	t	Time at which the ode function is evaluated
[in]	y	Unknown

Returns

Value of function

Function() [2/2]

virtual real_t Function ( real_t t, const Vect< real_t > & y, int i = 1 )

virtual

Virtual member function to define function defining ODE.

Parameters

[in]	t	Time at which the ode function is evaluated
[in]	y	Vector of unknowns
[in]	i	component of function to define [Default: 1].

Returns

Value of function

Warning

The component must not be larger than vector size

Jacobian() [1/2]

virtual real_t Jacobian ( real_t t, const real_t & y )

virtual

Virtual member function to define derivative of function in case of a single ODE.

Parameters

[in]	t	Time at which the derivative function is evaluated
[in]	y	Unknown

Returns

Value of derivative

Jacobian() [2/2]

virtual real_t Jacobian ( real_t t, const Vect< real_t > & y, int i = 1, int j = 1 )

virtual

Virtual member function to define partial derivatives of function.

Parameters

[in]	t	Time at which the jacobian function is evaluated
[in]	y	Vector of unknowns
[in]	i	Function component [Default: 1]
[in]	j	Index of partial derivative [Default: 1]

Returns

Value of partial derivative