Chaste Release::3.1
CellwiseOdeSystemInformation< ODE_SYSTEM > Class Template Reference

#include <CellwiseOdeSystemInformation.hpp>

Inheritance diagram for CellwiseOdeSystemInformation< ODE_SYSTEM >:
Collaboration diagram for CellwiseOdeSystemInformation< ODE_SYSTEM >:

List of all members.

Public Member Functions

 CellwiseOdeSystemInformation ()

Protected Member Functions

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

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 53 of file CellwiseOdeSystemInformation.hpp.


Constructor & Destructor Documentation

template<class ODE_SYSTEM >
CellwiseOdeSystemInformation< ODE_SYSTEM >::CellwiseOdeSystemInformation ( )

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 87 of file CellwiseOdeSystemInformation.hpp.

References CellwiseOdeSystemInformation< ODE_SYSTEM >::Initialise().


Member Function Documentation

template<class ODE_SYSTEM >
void CellwiseOdeSystemInformation< ODE_SYSTEM >::Initialise ( void  ) [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() { 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 93 of file CellwiseOdeSystemInformation.hpp.

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

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

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 305 of file WntCellCycleOdeSystem.cpp.

References NAN.

template<>
void CellwiseOdeSystemInformation< VanLeeuwen2009WntSwatCellCycleOdeSystem >::Initialise ( ) [protected, virtual]

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 389 of file VanLeeuwen2009WntSwatCellCycleOdeSystem.cpp.

References NAN.

template<>
void CellwiseOdeSystemInformation< Mirams2010WntOdeSystem >::Initialise ( ) [protected, virtual]

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 156 of file Mirams2010WntOdeSystem.cpp.

template<>
void CellwiseOdeSystemInformation< DeltaNotchOdeSystem >::Initialise ( ) [protected, virtual]

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 81 of file DeltaNotchOdeSystem.cpp.

template<>
void CellwiseOdeSystemInformation< Alarcon2004OxygenBasedCellCycleOdeSystem >::Initialise ( ) [protected, virtual]

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 164 of file Alarcon2004OxygenBasedCellCycleOdeSystem.cpp.

References NAN.


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