CLyapMethod Class Reference

#include <CLyapMethod.h>

Inheritance diagram for CLyapMethod:

List of all members.

Public Member Functions
	CLyapMethod (const CLyapMethod &src, const CCopasiContainer *pParent=NULL)
	~CLyapMethod ()
void	setProblem (CLyapProblem *problem)
virtual double	step (const double &deltaT)
virtual bool	calculate ()=0
virtual void	start (const CState *initialState)
virtual bool	isValidProblem (const CCopasiProblem *pProblem)
Static Public Member Functions
static bool	isValidSubType (const CCopasiMethod::SubType &subType)
static CLyapMethod *	createMethod (CCopasiMethod::SubType subType=CCopasiMethod::lyapWolf)
Static Public Attributes
static const CLyapValidSubTypes	ValidSubTypes
Protected Member Functions
	CLyapMethod (const CCopasiMethod::SubType &subType, const CCopasiContainer *pParent=NULL)
Protected Attributes
CLyapProblem *	mpProblem

---

Constructor & Destructor Documentation

CLyapMethod::CLyapMethod	(	const CCopasiMethod::SubType &	subType,
		const CCopasiContainer *	pParent = NULL
	)		[protected]

Default constructor.

Parameters:

const	CCopasiMethod::SubType & subType
const	CCopasiContainer * pParent (default: NULL)

Default constructor.

CLyapMethod::CLyapMethod	(	const CLyapMethod &	src,
		const CCopasiContainer *	pParent = NULL
	)

Copy constructor.

Parameters:

const CLyapMethod &	src
const	CCopasiContainer * pParent (default: NULL)

Copy constructor.

Parameters:

const CLyapMethod &

src

CLyapMethod::~CLyapMethod

(

)

Destructor.

---

Member Function Documentation

virtual bool CLyapMethod::calculate

(

)

[pure virtual]

Implemented in CLyapWolfMethod.

CLyapMethod * CLyapMethod::createMethod

(

CCopasiMethod::SubType

subType = CCopasiMethod::lyapWolf

)

[static]

Create a trajectory method for a special problem. Note: the returned object has to be released after use with delete a problem is also passed so that the method has a chance to choose an appropriate simulation method.

bool CLyapMethod::isValidProblem

(

const CCopasiProblem *

pProblem

)

[virtual]

Check if the method is suitable for this problem

Returns:

bool suitability of the method

Reimplemented from CCopasiMethod.

Reimplemented in CLyapWolfMethod.

bool CLyapMethod::isValidSubType

(

const CCopasiMethod::SubType &

subType

)

[static]

Checks whether the given sub type is a valid method

Parameters:

const

CCopasiMethod::SubType & subType

Returns:

bool isValidSubType

void CLyapMethod::setProblem

(

CLyapProblem *

problem

)

Set a pointer to the current state. This method is used by CLyapTask::process() The results of the simulation are passed via this CState variable

Parameters:

CState *	currentState Set a pointer to the problem. This method is used by CLyap
CLyapProblem *	problem

Set a pointer to the problem. This method is used by CLyap

Parameters:

CLyapProblem *

problem

virtual void CLyapMethod::start

(

const CState *

initialState

)

[virtual]

This instructs the method to prepare for integration starting with the initialState given.

Parameters:

const CState *

initialState

virtual double CLyapMethod::step

(

const double &

deltaT

)

[virtual]

This instructs the method to calculate a time step of deltaT starting with the current state, i.e., the result of the previous step. The new state (after deltaT) is expected in the current state. The return value is the actual timestep taken.

Parameters:

const double &

deltaT

Reimplemented in CLyapWolfMethod.

---

Member Data Documentation

CLyapProblem* CLyapMethod::mpProblem [protected]

A pointer to the current state. This is set from outside with the setState() method and never changed anywhere else. It�s used to report the results to the calling LyapTask A pointer to the trajectory problem.

const CLyapValidSubTypes CLyapMethod::ValidSubTypes [static]

A list of valid trajectory method types;

---

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

• copasi/lyap/CLyapMethod.h
• copasi/lyap/CLyapMethod.cpp