#include <CSteadyStateMethod.h>

Inheritance diagram for CSteadyStateMethod:

Public Types
enum	ReturnCode { notFound = 0, found, foundEquilibrium, foundNegative }
Public Member Functions
	CSteadyStateMethod (const CSteadyStateMethod &src, const CCopasiContainer *pParent=NULL)
	~CSteadyStateMethod ()
bool	elevateChildren ()
CSteadyStateMethod::ReturnCode	process (CState pState, CMatrix< C_FLOAT64 > &jacobianX, CProcessReport handler)
virtual bool	isValidProblem (const CCopasiProblem *pProblem)
virtual bool	initialize (const CSteadyStateProblem *pProblem)
void	doJacobian (CMatrix< C_FLOAT64 > &jacobian, CMatrix< C_FLOAT64 > &jacobianX)
C_FLOAT64	getStabilityResolution ()
std::string	getMethodLog () const
Static Public Member Functions
static CSteadyStateMethod *	createSteadyStateMethod (CCopasiMethod::SubType subType=CCopasiMethod::Newton)
Protected Member Functions
	CSteadyStateMethod (CCopasiMethod::SubType subType, const CCopasiContainer *pParent=NULL)
void	initializeParameter ()
virtual CSteadyStateMethod::ReturnCode	processInternal ()
virtual CSteadyStateMethod::ReturnCode	returnProcess (bool steadyStateFound)
bool	isEquilibrium (const C_FLOAT64 &resolution) const
bool	allPositive ()
void	calculateJacobianX (const C_FLOAT64 &oldMaxRate)
Protected Attributes
const CSteadyStateProblem *	mpProblem
CModel *	mpModel
CSteadyStateTask *	mpParentTask
CState *	mpSteadyState
CMatrix< C_FLOAT64 > *	mpJacobianX
CProcessReport *	mpProgressHandler
C_FLOAT64 *	mpSSResolution
C_FLOAT64 *	mpDerivationFactor
C_FLOAT64 *	mpDerivationResolution
std::ostringstream	mMethodLog

Member Enumeration Documentation

enum CSteadyStateMethod::ReturnCode

Enumerator:

notFound
found
foundEquilibrium
foundNegative

Constructor & Destructor Documentation

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

Specific constructor.

Parameters:

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

Default constructor.

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

Copy constructor.

Parameters:

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

Copy constructor.

Parameters:

const CSteadyStateMethod & src

CSteadyStateMethod::~CSteadyStateMethod ( )

Destructor.

Member Function Documentation

bool CSteadyStateMethod::allPositive ( ) [protected]

Check whether all values make physically sence, i.e., volumes and particle number are positive

Returns:: bool allPositive

void CSteadyStateMethod::calculateJacobianX ( const C_FLOAT64 & oldMaxRate ) [protected]

CSteadyStateMethod * CSteadyStateMethod::createSteadyStateMethod ( CCopasiMethod::SubType subType = CCopasiMethod::Newton ) [static]

Create a trajectory method. Note: the returned object has to be released after use with delete

CSteadyStateMethod class. This class describes the interface to all steady state methods. The various method like Newton have to be derived from this class.

Created for COPASI by Stefan Hoops 2002

void CSteadyStateMethod::doJacobian	(	CMatrix< C_FLOAT64 > &	jacobian,
		CMatrix< C_FLOAT64 > &	jacobianX
	)

calls the CModel methods to calculate the jacobians (at the steady state). This trivial method is implemented in the method because it may need to know about some method parameters

bool CSteadyStateMethod::elevateChildren ( ) [virtual]

This methods must be called to elevate subgroups to derived objects. The default implementation does nothing.

Returns:: bool success

Reimplemented from CCopasiParameterGroup.

Reimplemented in CNewtonMethod.

std::string CSteadyStateMethod::getMethodLog ( ) const

C_FLOAT64 CSteadyStateMethod::getStabilityResolution ( )

returns the resolution for stability analysis

bool CSteadyStateMethod::initialize ( const CSteadyStateProblem * pProblem ) [virtual]

Initialize the method must be called before process

Parameters:

const CSteadyStateProblem * pProblem

Returns:: bool success

Reimplemented in CNewtonMethod.

void CSteadyStateMethod::initializeParameter ( ) [protected]

initialize parameters and handle parameters of old copasi files

bool CSteadyStateMethod::isEquilibrium ( const C_FLOAT64 & resolution ) const [protected]

Check whether the steady state is chemical equilibrium

Parameters:

const C_FLOAT64 & resolution bool isEquilibrium

bool CSteadyStateMethod::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 CNewtonMethod.

CSteadyStateMethod::ReturnCode CSteadyStateMethod::process	(	CState *	pState,
		CMatrix< C_FLOAT64 > &	jacobianX,
		CProcessReport *	handler
	)

This instructs the method to calculate a the steady state starting with the initialState given. The steady state is returned in the object pointed to by steadyState.

Parameters:

CState	* steadyState
CMatrix<	C_FLOAT64 > & jacobianX
CProcessReport	* handler

Returns:: CSteadyStateMethod::ReturnCode returnCode

This instructs the method to calculate a the steady state starting with the initialState given. The steady state is returned in the object pointed to by steadyState.

Parameters:

CState	* steadyState
const	CState * initialState
C_FLOAT64	* jacobian
CEigen	* eigenValues

Returns:: CSteadyStateMethod::ReturnCode returnCode

CSteadyStateMethod::ReturnCode CSteadyStateMethod::processInternal ( ) [protected, virtual]

This instructs the method to calculate a the steady state starting with the initialState given. The steady state is returned in the object pointed to by steadyState.