CellwiseOdeSystemInformation< ODE_SYSTEM > Class Template Reference

#include <CellwiseOdeSystemInformation.hpp>

Inheritance diagram for CellwiseOdeSystemInformation< ODE_SYSTEM >:

Inheritance graph
[legend]
Collaboration diagram for CellwiseOdeSystemInformation< ODE_SYSTEM >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 CellwiseOdeSystemInformation ()
template<>
void Initialise (void)
template<>
void Initialise (void)

Protected Member Functions

void Initialise (void)


Detailed Description

template<class ODE_SYSTEM>
class CellwiseOdeSystemInformation< ODE_SYSTEM >

Concrete implementation of AbstractOdeSystemInformation designed for use where some of the system information *can* vary across instances. As with OdeSystemInformation it is templated by ODE system class, to aid developers of ODE system classes - only a specialisation of the Initialise method is required.

Note: unexpected behaviour can occur if ODE system objects are copied (via copy constructor or operator=). The AbstractOdeSystem maintains a smart pointer (boost::shared_ptr) to the system information object. Hence both the original and the copy will share the same information object.

Definition at line 45 of file CellwiseOdeSystemInformation.hpp.


Constructor & Destructor Documentation

template<class ODE_SYSTEM>
CellwiseOdeSystemInformation< ODE_SYSTEM >::CellwiseOdeSystemInformation (  )  [inline]

Default constructor; calls Initialise.

Designed to be used as follows by ODE system classes in their constructors: mpSystemInfo.reset(new CellwiseOdeSystemInformation<CLASS>);

Definition at line 79 of file CellwiseOdeSystemInformation.hpp.

References CellwiseOdeSystemInformation< ODE_SYSTEM >::Initialise().


Member Function Documentation

template<class ODE_SYSTEM>
void CellwiseOdeSystemInformation< ODE_SYSTEM >::Initialise ( void   )  [inline, protected, virtual]

Generic implementation of Initialise, which does nothing.

Developers should specialise this method to their ODE system. For example,

template<> void CellwiseOdeSystemInformation<MyNewOdeSystem>::Initialise(void) { this->mVariableNames.push_back("Variable_1"); this->mVariableUnits.push_back("Units_1"); this->mInitialConditions.push_back(0.0);

this->mInitialised = true; }

Implements AbstractOdeSystemInformation.

Definition at line 85 of file CellwiseOdeSystemInformation.hpp.

Referenced by CellwiseOdeSystemInformation< ODE_SYSTEM >::CellwiseOdeSystemInformation().

template<>
void CellwiseOdeSystemInformation< IngeWntSwatCellCycleOdeSystem >::Initialise ( void   )  [inline, virtual]

template<>
void CellwiseOdeSystemInformation< WntCellCycleOdeSystem >::Initialise ( void   )  [inline, virtual]


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

Generated on Wed Mar 18 12:52:24 2009 for Chaste by  doxygen 1.5.5