CSteadyStateTask Class Reference

#include <CSteadyStateTask.h>

Inheritance diagram for CSteadyStateTask:

List of all members.

Public Member Functions
	CSteadyStateTask (const CCopasiContainer *pParent=NULL)
	CSteadyStateTask (const CSteadyStateTask &src, const CCopasiContainer *pParent=NULL)
virtual	~CSteadyStateTask ()
virtual bool	updateMatrices ()
virtual bool	initialize (const OutputFlag &of, COutputHandler *pOutputHandler, std::ostream *pOstream)
virtual bool	process (const bool &useInitialValues)
virtual bool	restore ()
virtual void	print (std::ostream *ostream) const
void	load (CReadConfig &configBuffer)
void	setInitialState ()
const CState *	getState () const
const CMatrix< C_FLOAT64 > &	getJacobian () const
const CArrayAnnotation *	getJacobianAnnotated () const
const CMatrix< C_FLOAT64 > &	getJacobianReduced () const
const CArrayAnnotation *	getJacobianXAnnotated () const
const CEigen &	getEigenValues () const
const CEigen &	getEigenValuesReduced () const
const CSteadyStateMethod::ReturnCode &	getResult () const
Friends
std::ostream &	operator<< (std::ostream &os, const CSteadyStateTask &A)

---

Constructor & Destructor Documentation

CSteadyStateTask::CSteadyStateTask

(

const CCopasiContainer *

pParent = NULL

)

Default constructor

Parameters:

const

CCopasiContainer * pParent (default: NULL)

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

Copy constructor

Parameters:

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

CSteadyStateTask::~CSteadyStateTask

(

)

[virtual]

Destructor

---

Member Function Documentation

const CEigen & CSteadyStateTask::getEigenValues

(

)

const

Retrieves a the eigenvalues of the steady state.

Returns:

const CEigen & eigenValues

const CEigen & CSteadyStateTask::getEigenValuesReduced

(

)

const

Retrieves a the eigenvalues of the steady state.

Returns:

const CEigen & eigenValues

const CMatrix< C_FLOAT64 > & CSteadyStateTask::getJacobian

(

)

const

Retrieves a the jacobian of the steady state.

Returns:

const CMatrix< C_FLOAT64 > jacobian

const CArrayAnnotation * CSteadyStateTask::getJacobianAnnotated

(

)

const

const CMatrix< C_FLOAT64 > & CSteadyStateTask::getJacobianReduced

(

)

const

Retrieves a the jacobian of the steady state.

Returns:

const CMatrix< C_FLOAT64 > jacobian

const CArrayAnnotation * CSteadyStateTask::getJacobianXAnnotated

(

)

const

const CSteadyStateMethod::ReturnCode& CSteadyStateTask::getResult

(

)

const [inline]

Converts the eigenvalues vector to matrix

Parameters:

CEigen

&eigenvalues

Returns:

CMatrix<C_FLOAT64> &matrix

Reimplemented from CCopasiTask.

const CState * CSteadyStateTask::getState

(

)

const

Retrieves a pointer to steady state.

Returns:

CState * pSteadyState

bool CSteadyStateTask::initialize	(	const OutputFlag &	of,
		COutputHandler *	pOutputHandler,
		std::ostream *	pOstream
	)		[virtual]

Initialize the task. If an ostream is given this ostream is used instead of the target specified in the report. This allows nested tasks to share the same output device.

Parameters:

const	OutputFlag & of
COutputHandler	* pOutputHandler
std::ostream	* pOstream (default: NULL)

Returns:

bool success

Reimplemented from CCopasiTask.

void CSteadyStateTask::load

(

CReadConfig &

configBuffer

)

Loads parameters for this solver with data coming from a CReadConfig object. (CReadConfig object reads an input stream)

Parameters:

configbuffer

reference to a CReadConfig object.

void CSteadyStateTask::print

(

std::ostream *

ostream

)

const [virtual]

This is the output method for any object. The default implementation provided with CCopasiObject uses the ostream operator<< of the object to print the object.To overide this default behaviour one needs to reimplement the virtual print function.

Parameters:

std::ostream

* ostream

Reimplemented from CCopasiObject.

bool CSteadyStateTask::process

(

const bool &

useInitialValues

)

[virtual]

Process the task with or without initializing to the initial state.

Parameters:

const

bool & useInitialValues

Returns:

bool success

Reimplemented from CCopasiTask.

bool CSteadyStateTask::restore

(

)

[virtual]

Perform neccessary cleaup procedures

Reimplemented from CCopasiTask.

void CSteadyStateTask::setInitialState

(

)

Set initial state by taking the current one.

bool CSteadyStateTask::updateMatrices

(

)

[virtual]

Resizes result matrices and updates array annotations for a specific task. This is used when we need to know about the data structures of a task result without actually performing the task, e.g. when selecting objects for output. For now we assume that this functionality is also performed when initialize() is called.

Reimplemented from CCopasiTask.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const CSteadyStateTask &	A
	)		[friend]

---

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

• copasi/steadystate/CSteadyStateTask.h
• copasi/steadystate/CSteadyStateTask.cpp