#include <OdeSystemInformation.hpp>

Inheritance diagram for OdeSystemInformation< ODE_SYSTEM >:

Collaboration diagram for OdeSystemInformation< ODE_SYSTEM >:

Static Public Member Functions
static boost::shared_ptr< OdeSystemInformation< ODE_SYSTEM > >	Instance ()

Protected Member Functions
	OdeSystemInformation ()

	OdeSystemInformation (const OdeSystemInformation< ODE_SYSTEM > &)

OdeSystemInformation &	operator= (const OdeSystemInformation< ODE_SYSTEM > &)

void	Initialise ()

void	Initialise ()

void	Initialise ()

void	Initialise (void)

void	Initialise (void)

void	Initialise (void)

void	Initialise (void)

void	Initialise (void)

void	Initialise (void)

void	Initialise ()

void	Initialise ()

void	Initialise ()

Static Private Attributes
static boost::shared_ptr< OdeSystemInformation< ODE_SYSTEM > >	mpInstance

Additional Inherited Members
Public Member Functions inherited from AbstractOdeSystemInformation
	AbstractOdeSystemInformation ()

virtual	~AbstractOdeSystemInformation ()

std::string	GetSystemName () const

std::string	GetFreeVariableName () const

std::string	GetFreeVariableUnits () const

void	SetDefaultInitialConditions (const std::vector< double > &rInitialConditions)

void	SetDefaultInitialCondition (unsigned index, double initialCondition)

std::vector< double >	GetInitialConditions () const

const std::vector< std::string > &	rGetStateVariableNames () const

const std::vector< std::string > &	rGetStateVariableUnits () const

unsigned	GetStateVariableIndex (const std::string &rName) const

bool	HasStateVariable (const std::string &rName) const

std::string	GetStateVariableUnits (unsigned index) const

const std::vector< std::string > &	rGetParameterNames () const

const std::vector< std::string > &	rGetParameterUnits () const

unsigned	GetParameterIndex (const std::string &rName) const

bool	HasParameter (const std::string &rName) const

std::string	GetParameterUnits (unsigned index) const

unsigned	GetNumberOfParameters () const

unsigned	GetAnyVariableIndex (const std::string &rName) const

bool	HasAnyVariable (const std::string &rName) const

std::string	GetAnyVariableUnits (unsigned index) const

const std::vector< std::string > &	rGetDerivedQuantityNames () const

const std::vector< std::string > &	rGetDerivedQuantityUnits () const

unsigned	GetDerivedQuantityIndex (const std::string &rName) const

bool	HasDerivedQuantity (const std::string &rName) const

std::string	GetDerivedQuantityUnits (unsigned index) const

unsigned	GetNumberOfDerivedQuantities () const

unsigned	GetNumberOfAttributes () const

bool	HasAttribute (const std::string &rName) const

double	GetAttribute (const std::string &rName) const

Protected Attributes inherited from AbstractOdeSystemInformation
std::string	mSystemName

std::string	mFreeVariableName

std::string	mFreeVariableUnits

std::vector< std::string >	mVariableNames

std::vector< std::string >	mVariableUnits

std::vector< std::string >	mParameterNames

std::vector< std::string >	mParameterUnits

std::vector< std::string >	mDerivedQuantityNames

std::vector< std::string >	mDerivedQuantityUnits

std::map< std::string, double >	mAttributes

std::vector< double >	mInitialConditions

bool	mInitialised

Detailed Description

template<class ODE_SYSTEM>
class OdeSystemInformation< ODE_SYSTEM >

A concrete implementation of AbstractOdeSystemInformation, that uses templates to provide an implementation for any ODE system class.

All ODE system developers need to do is provide a specialisation of the Initialise method of this class, and set mpSystemInfo in their constructor: mpSystemInfo = OdeSystemInformation<CLASS>::Instance();

This class contains all the machinery to make it a singleton, hence providing exactly one instance per value of the template parameter.

Definition at line 55 of file OdeSystemInformation.hpp.

Constructor & Destructor Documentation

◆ OdeSystemInformation() [1/2]

template<class ODE_SYSTEM >

OdeSystemInformation< ODE_SYSTEM >::OdeSystemInformation ( )

protected

Default constructor.

Not user accessible - to obtain an instance of this class use the Instance method.

Definition at line 125 of file OdeSystemInformation.hpp.

◆ OdeSystemInformation() [2/2]

template<class ODE_SYSTEM >

OdeSystemInformation< ODE_SYSTEM >::OdeSystemInformation ( const OdeSystemInformation< ODE_SYSTEM > & )

protected

Copy constructor.

Member Function Documentation

◆ Initialise() [1/12]

void OdeSystemInformation< TysonNovak2001OdeSystem >::Initialise ( )

protectedvirtual

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 254 of file TysonNovak2001OdeSystem.cpp.

◆ Initialise() [2/12]

void OdeSystemInformation< Kerchoffs2003ContractionModel >::Initialise ( )

protectedvirtual

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 155 of file Kerchoffs2003ContractionModel.cpp.

◆ Initialise() [3/12]

void OdeSystemInformation< Nash2004ContractionModel >::Initialise ( )

protectedvirtual

Initialise the ODE system information.

This must be provided by subclasses.

Implements AbstractOdeSystemInformation.

Definition at line 42 of file Nash2004ContractionModel.cpp.

◆ Initialise() [4/12]

template<class ODE_SYSTEM >

void OdeSystemInformation< ODE_SYSTEM >::Initialise ( void )

protectedvirtual

Generic implementation of Initialise, which does nothing.

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

template<> void OdeSystemInformation<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 132 of file OdeSystemInformation.hpp.