FakeBathCell Class Reference

#include <FakeBathCell.hpp>

Collaboration diagram for FakeBathCell:

Public Member Functions
	FakeBathCell (boost::shared_ptr< AbstractIvpOdeSolver > pSolver, boost::shared_ptr< AbstractStimulusFunction > pIntracellularStimulus)
	~FakeBathCell ()
void	EvaluateYDerivatives (double time, const std::vector< double > &rY, std::vector< double > &rDY)
double	GetIIonic (const std::vector< double > *pStateVariables=NULL)
void	ComputeExceptVoltage (double tStart, double tEnd)
double	GetIntracellularCalciumConcentration ()
Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
Friends
class	boost::serialization::access

Detailed Description

This class represents a fake cell for use within the bath of a bidomain simulation.

Note:: Note that only a portion of the normal functionality of a cardiac cell is actually redefined in this class. If further calls to cardiac cells are later added to the simulation process, additional overrides may need to be added here.

Definition at line 52 of file FakeBathCell.hpp.

Constructor & Destructor Documentation

FakeBathCell::FakeBathCell	(	boost::shared_ptr< AbstractIvpOdeSolver >	pSolver,
		boost::shared_ptr< AbstractStimulusFunction >	pIntracellularStimulus
	)

Constructor uses the same signature as normal cells, for convenience.

Parameters:

	pSolver	unused
	pIntracellularStimulus	unused

Definition at line 39 of file FakeBathCell.cpp.

References AbstractCardiacCell::Init(), and AbstractUntemplatedParameterisedSystem::mpSystemInfo.

FakeBathCell::~FakeBathCell ( )

Destructor; does nothing.

Definition at line 47 of file FakeBathCell.cpp.

Member Function Documentation

void FakeBathCell::ComputeExceptVoltage	(	double	tStart,
		double	tEnd
	)			`[virtual]`

There isn't really a cell here, so we override this method to do nothing.

Parameters:

	tStart	unused
	tEnd	unused

Reimplemented from AbstractCardiacCell.

Definition at line 62 of file FakeBathCell.cpp.

void FakeBathCell::EvaluateYDerivatives	(	double	time,
		const std::vector< double > &	rY,
		std::vector< double > &	rDY
	)			`[virtual]`

This method is pure in a base class, so we need it, but we never use it. It has an empty body.

Parameters:

	time	unused
	rY	unused
	rDY	unused

Implements AbstractOdeSystem.

Definition at line 52 of file FakeBathCell.cpp.

References NEVER_REACHED.

double FakeBathCell::GetIIonic ( const std::vector< double > * pStateVariables = NULL ) [virtual]

Fake cells have no transmembrane currents, so this method always returns 0.

Parameters:

pStateVariables

unused

Returns:: zero

Implements AbstractCardiacCellInterface.

Definition at line 57 of file FakeBathCell.cpp.

double FakeBathCell::GetIntracellularCalciumConcentration ( ) [virtual]

There is really no calcium here, so we override this method to return a dummy value (0) Implementing this with a dummy implementation is needed by mechanics

Returns:: always zero

Reimplemented from AbstractCardiacCellInterface.

Definition at line 66 of file FakeBathCell.cpp.

template<class Archive >

void FakeBathCell::serialize	(	Archive &	archive,
		const unsigned int	version
	)			`[inline, private]`

Archive this cell. Just calls the base class version.

Parameters:

	archive
	version

Reimplemented from AbstractCardiacCell.

Definition at line 64 of file FakeBathCell.hpp.

References AbstractUntemplatedParameterisedSystem::mNumberOfStateVariables.

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from AbstractCardiacCell.

Definition at line 56 of file FakeBathCell.hpp.

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

heart/src/odes/ionicmodels/FakeBathCell.hpp
heart/src/odes/ionicmodels/FakeBathCell.cpp

FakeBathCell Class Reference

Public Member Functions

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation