Integrable Class Reference

This is the base class for systems to be integrated by an Integrator object. More...

Inheritance diagram for Integrable:

List of all members.

Public Member Functions
virtual void	diffEq (const double *const x, const double t, double *const dx)=0
	This function should calculate the differential equation.
virtual int	getDim ()=0
	This function should return the number of dimensions of the system to be integrated.
virtual double	getState (double *const x)=0
	Function to get the current state of the system before starting the integration.
virtual void	peek (const double *const, const double)
	Function that can observe the current state of the system during the integration.
virtual void	setState (const double *const x, const double t)=0
	Function to set the current state of the system after finishing the integration.

---

Detailed Description

It is responsible for calculating the differential equation through the function diffEq().

---

Member Function Documentation

virtual void diffEq	(	const double *const	x,
		const double	t,
		double *const	dx
	)		[pure virtual]

Parameters:

x	Pointer to array of length getDim() that contains the current phasespace point of the system.
t	The current value of the coordinate to be integrated.
dx	Pointer to array of length getDim() where the first derivative of the phasespace point with respect to the coordinate t is to be stored in.

Implemented in CombustionProcess.

virtual int getDim

(

)

[pure virtual]

After that function being called, the dimensionality of the system should not change anymore, since the integrator needs to rely on that number.

Implemented in CombustionProcess.

virtual double getState

(

double *const

x

)

[pure virtual]

Parameters:

x	Pointer to array of length getDim() to store current phasespace point of the system in.

Implemented in CombustionProcess.

virtual void peek	(	const double *	const,
		const double
	)		[virtual]

Parameters:

x	Pointer to array of length getDim() with the current phasespace point of the system.
t	The current time of the system.

Reimplemented in CombustionProcess.

virtual void setState	(	const double *const	x,
		const double	t
	)		[pure virtual]

Parameters:

x	Pointer to array of length getDim() with the new phasespace point of the system.
t	The new time of the system.

Implemented in CombustionProcess.