AbstractModifier Class Reference

#include <AbstractModifier.hpp>

Inheritance diagram for AbstractModifier:

List of all members.

Public Member Functions

AbstractModifier (void)

virtual ~AbstractModifier ()

virtual double Calc (double param, double time)=0

Detailed Description

This family of classes are used to add simple functions into cell models to modify particular quantities on the fly. Rather than the model using the quantity directly in computing its right-hand side, it calls calc() with the current value and uses the result of that instead.

Clearly for this to work the cell model must be modified to include calls to instances of these classes. PyCml has some experimental support for this, generating subclasses of AbstractCardiacCellWithModifiers.

Definition at line 42 of file AbstractModifier.hpp.

Constructor & Destructor Documentation

AbstractModifier::AbstractModifier ( void ) [inline]

Default constructor.

Definition at line 48 of file AbstractModifier.hpp.

virtual AbstractModifier::~AbstractModifier ( ) [inline, virtual]

Default destructor.

Definition at line 55 of file AbstractModifier.hpp.

Member Function Documentation

virtual double AbstractModifier::Calc	(	double	param,
		double	time
	)			`[pure virtual]`

Pure virtual function which must be overriden in subclasses to actually perform the modification.

Parameters:

	param	the current value of the quantity which is being modified
	time	the current simulation time

Implemented in FactorModifier, TimeModifier, FixedModifier, and DummyModifier.

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

heart/src/odes/AbstractModifier.hpp


Public Member Functions
	AbstractModifier (void)
virtual	~AbstractModifier ()
virtual double	Calc (double param, double time)=0