#include <AbstractModifier.hpp>

Inheritance diagram for AbstractModifier:

Collaboration diagram for AbstractModifier:

Public Member Functions
	AbstractModifier (void)

virtual	~AbstractModifier ()

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

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

Friends
class	boost::serialization::access

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. Chaste_codegen has some experimental support for this, generating subclasses of AbstractCardiacCellWithModifiers.

Definition at line 53 of file AbstractModifier.hpp.

Constructor & Destructor Documentation

◆ AbstractModifier()

AbstractModifier::AbstractModifier ( void )

inline

Default constructor.

Definition at line 74 of file AbstractModifier.hpp.

◆ ~AbstractModifier()

virtual AbstractModifier::~AbstractModifier ( )

inlinevirtual

Default destructor.

Definition at line 81 of file AbstractModifier.hpp.

Member Function Documentation

◆ Calc()

virtual double AbstractModifier::Calc	(	double	param,
		double	time
	)

pure virtual

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

Parameters

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

Returns: the new value for the quantity which is being modified

Implemented in DummyModifier, FactorModifier, FixedModifier, and TimeModifier.

◆ serialize()

template<class Archive >

void AbstractModifier::serialize	(	Archive &	archive,
		const unsigned int	version
	)

inlineprivate

Archive the member variables.

Parameters

archive
version

Definition at line 65 of file AbstractModifier.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 57 of file AbstractModifier.hpp.

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

heart/src/odes/modifiers/AbstractModifier.hpp

Public Member Functions

Private Member Functions

Friends