copasi API  0.1
Classes | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
CLsodaMethod Class Reference

#include <CLsodaMethod.h>

Inheritance diagram for CLsodaMethod:
CTrajectoryMethod CCopasiMethod CCopasiParameterGroup CCopasiParameter CCopasiContainer CCopasiObject CTrajectoryMethodDsaLsodar

List of all members.

Classes

struct  Data

Public Member Functions

 CLsodaMethod (const CLsodaMethod &src, const CCopasiContainer *pParent=NULL)
 ~CLsodaMethod ()
virtual bool elevateChildren ()
virtual void stateChanged ()
virtual Status step (const double &deltaT)
virtual void start (const CState *initialState)
virtual void evalF (const C_FLOAT64 *t, const C_FLOAT64 *y, C_FLOAT64 *ydot)
virtual void evalR (const C_FLOAT64 *t, const C_FLOAT64 *y, const C_INT *nr, C_FLOAT64 *r)

Static Public Member Functions

static void EvalF (const C_INT *n, const C_FLOAT64 *t, const C_FLOAT64 *y, C_FLOAT64 *ydot)
static void EvalR (const C_INT *n, const C_FLOAT64 *t, const C_FLOAT64 *y, const C_INT *nr, C_FLOAT64 *r)

Protected Types

enum  RootMasking { NONE = 0, ALL, DISCRETE }

Protected Member Functions

 CLsodaMethod (const CCopasiMethod::SubType &subType=deterministic, const CCopasiContainer *pParent=NULL)
void destroyRootMask ()

Protected Attributes

bool * mpReducedModel
CState mMethodState
C_INT mLsodaStatus
CModelmpModel
bool mNoODE
RootMasking mRootMasking

Friends

CTrajectoryMethodCTrajectoryMethod::createTrajectoryMethod (CCopasiMethod::SubType subType, CTrajectoryProblem *pProblem)

Member Enumeration Documentation

enum CLsodaMethod::RootMasking [protected]
Enumerator:
NONE 
ALL 
DISCRETE 

Constructor & Destructor Documentation

CLsodaMethod::CLsodaMethod ( const CCopasiMethod::SubType subType = deterministic,
const CCopasiContainer pParent = NULL 
) [protected]

Default constructor.

Parameters:
constCCopasiMethod::SubType & subType (default: deterministic)
constCCopasiContainer * pParent (default: NULL)
CLsodaMethod::CLsodaMethod ( const CLsodaMethod src,
const CCopasiContainer pParent = NULL 
)

Copy constructor.

Parameters:
const CLsodaMethod &src
constCCopasiContainer * pParent (default: NULL)
CLsodaMethod::~CLsodaMethod ( )

Destructor.


Member Function Documentation

void CLsodaMethod::destroyRootMask ( ) [protected]

Destroy the mask which hides all roots being constant and zero.

bool CLsodaMethod::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 CTrajectoryMethodDsaLsodar.

void CLsodaMethod::EvalF ( const C_INT *  n,
const C_FLOAT64 *  t,
const C_FLOAT64 *  y,
C_FLOAT64 *  ydot 
) [static]
void CLsodaMethod::evalF ( const C_FLOAT64 *  t,
const C_FLOAT64 *  y,
C_FLOAT64 *  ydot 
) [virtual]

This evaluates the derivatives

Reimplemented in CTrajectoryMethodDsaLsodar.

void CLsodaMethod::EvalR ( const C_INT *  n,
const C_FLOAT64 *  t,
const C_FLOAT64 *  y,
const C_INT *  nr,
C_FLOAT64 *  r 
) [static]
void CLsodaMethod::evalR ( const C_FLOAT64 *  t,
const C_FLOAT64 *  y,
const C_INT *  nr,
C_FLOAT64 *  r 
) [virtual]

This evaluates the roots

Reimplemented in CTrajectoryMethodDsaLsodar.

void CLsodaMethod::start ( const CState initialState) [virtual]

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

Parameters:
const CState *initialState

Reimplemented from CTrajectoryMethod.

Reimplemented in CTrajectoryMethodDsaLsodar.

void CLsodaMethod::stateChanged ( ) [virtual]

Inform the trajectory method that the state has changed outside its control

Reimplemented from CTrajectoryMethod.

Reimplemented in CTrajectoryMethodDsaLsodar.

CTrajectoryMethod::Status CLsodaMethod::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 time step taken.

Parameters:
const double &deltaT
Returns:
Status status

Reimplemented from CTrajectoryMethod.

Reimplemented in CTrajectoryMethodDsaLsodar.


Friends And Related Function Documentation

CTrajectoryMethod* CTrajectoryMethod::createTrajectoryMethod ( CCopasiMethod::SubType  subType,
CTrajectoryProblem pProblem 
) [friend]

Reimplemented in CTrajectoryMethodDsaLsodar.


Member Data Documentation

C_INT CLsodaMethod::mLsodaStatus [protected]

LSODA state.

A pointer to the current state in complete model view.

bool CLsodaMethod::mNoODE [protected]

A Boolean value indication whether we have no ODEs

A pointer to the model

bool* CLsodaMethod::mpReducedModel [protected]

A pointer to the value of "Integrate Reduced Model"

A Boolean flag indicating whether we should try masking roots


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines