CNewtonMethod Class Reference

#include <CNewtonMethod.h>

Inheritance diagram for CNewtonMethod:

List of all members.

Public Member Functions
	CNewtonMethod (const CNewtonMethod &src, const CCopasiContainer *pParent=NULL)
	~CNewtonMethod ()
virtual bool	elevateChildren ()
virtual void	load (CReadConfig &configBuffer, CReadConfig::Mode mode=CReadConfig::SEARCH)
virtual CSteadyStateMethod::ReturnCode	processInternal ()
bool	isSteadyState (C_FLOAT64 value)
C_FLOAT64	targetFunction (const CVector< C_FLOAT64 > &particleFluxes)
virtual bool	isValidProblem (const CCopasiProblem *pProblem)
virtual bool	initialize (const CSteadyStateProblem *pProblem)
Friends
CSteadyStateMethod *	CSteadyStateMethod::createSteadyStateMethod (CCopasiMethod::SubType subType)

---

Constructor & Destructor Documentation

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

Copy constructor.

Parameters:

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

CNewtonMethod::~CNewtonMethod

(

)

Destructor.

---

Member Function Documentation

bool CNewtonMethod::elevateChildren

(

)

[virtual]

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

Returns:

bool success

Reimplemented from CSteadyStateMethod.

bool CNewtonMethod::initialize

(

const CSteadyStateProblem *

pProblem

)

[virtual]

Initialize the method must be called before process

Parameters:

const

CSteadyStateProblem * pProblem

Returns:

bool success

Reimplemented from CSteadyStateMethod.

bool CNewtonMethod::isSteadyState

(

C_FLOAT64

value

)

bool CNewtonMethod::isValidProblem

(

const CCopasiProblem *

pProblem

)

[virtual]

Check if the method is suitable for this problem

Returns:

bool suitability of the method

Reimplemented from CSteadyStateMethod.

virtual void CNewtonMethod::load	(	CReadConfig &	configBuffer,
		CReadConfig::Mode	mode = CReadConfig::SEARCH
	)		[virtual]

Load a list of parameters

Parameters:

CReadConfig &	configBuffer
CReadConfig::Mode	mode Default(CReadConfig::SEARCH)

Reimplemented from CCopasiMethod.

CSteadyStateMethod::ReturnCode CNewtonMethod::processInternal

(

)

[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.

Parameters:

CState	& steadyState
const	CState & initialState

Returns:

CSteadyStateMethod::ReturnCode returnCode

Reimplemented from CSteadyStateMethod.

C_FLOAT64 CNewtonMethod::targetFunction

(

const CVector< C_FLOAT64 > &

particleFluxes

)

This is the function that is supposed to be near zero if a steady state is detected.

Parameters:

const

CVector< C_FLOAT64 > & particleFluxes

---

Friends And Related Function Documentation

CSteadyStateMethod* CSteadyStateMethod::createSteadyStateMethod

(

CCopasiMethod::SubType

subType

)

[friend]

---

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

• copasi/steadystate/CNewtonMethod.h
• copasi/steadystate/CNewtonMethod.cpp