Chaste  Release::3.4
Public Member Functions | Private Member Functions | Friends | List of all members
AbstractPottsUpdateRule< DIM > Class Template Referenceabstract

#include <AbstractPottsUpdateRule.hpp>

+ Inheritance diagram for AbstractPottsUpdateRule< DIM >:
+ Collaboration diagram for AbstractPottsUpdateRule< DIM >:

Public Member Functions

 AbstractPottsUpdateRule ()
 
virtual ~AbstractPottsUpdateRule ()
 
virtual double EvaluateHamiltonianContribution (unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)=0
 
void OutputUpdateRuleInfo (out_stream &rParamsFile)
 
virtual void OutputUpdateRuleParameters (out_stream &rParamsFile)=0
 
- Public Member Functions inherited from Identifiable
virtual ~Identifiable ()
 
std::string GetIdentifier () const
 

Private Member Functions

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

Friends

class boost::serialization::access
 

Detailed Description

template<unsigned DIM>
class AbstractPottsUpdateRule< DIM >

An abstract Potts update rule class, for use in cell-based simulations using the cellular Potts model.

Definition at line 50 of file PottsBasedCellPopulation.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>
AbstractPottsUpdateRule< DIM >::AbstractPottsUpdateRule ( )

Default constructor.

Definition at line 39 of file AbstractPottsUpdateRule.cpp.

template<unsigned DIM>
AbstractPottsUpdateRule< DIM >::~AbstractPottsUpdateRule ( )
virtual

Destructor.

Definition at line 44 of file AbstractPottsUpdateRule.cpp.

Member Function Documentation

template<unsigned DIM>
virtual double AbstractPottsUpdateRule< DIM >::EvaluateHamiltonianContribution ( unsigned  currentNodeIndex,
unsigned  targetNodeIndex,
PottsBasedCellPopulation< DIM > &  rCellPopulation 
)
pure virtual

Calculate the contribution to the Hamiltonian.

Parameters
currentNodeIndexThe index of the current node/lattice site
targetNodeIndexThe index of the target node/lattice site
rCellPopulationThe cell population
Returns
The difference in the Hamiltonian with the configuration of the target node having the same spin as the current node with the current configuration. i.e H_1-H_0

Implemented in SurfaceAreaConstraintPottsUpdateRule< DIM >, VolumeConstraintPottsUpdateRule< DIM >, AdhesionPottsUpdateRule< DIM >, and ChemotaxisPottsUpdateRule< DIM >.

template<unsigned DIM>
void AbstractPottsUpdateRule< DIM >::OutputUpdateRuleInfo ( out_stream &  rParamsFile)

Output update rule to file. Call OutputUpdateRuleParameters() to output all member variables to file.

Parameters
rParamsFilea file stream

Definition at line 49 of file AbstractPottsUpdateRule.cpp.

template<unsigned DIM>
void AbstractPottsUpdateRule< DIM >::OutputUpdateRuleParameters ( out_stream &  rParamsFile)
pure virtual

Output update rule parameters to file.

As this method is pure virtual, it must be overridden in subclasses.

Parameters
rParamsFilea file stream

Implemented in DifferentialAdhesionPottsUpdateRule< DIM >, AdhesionPottsUpdateRule< DIM >, SurfaceAreaConstraintPottsUpdateRule< DIM >, VolumeConstraintPottsUpdateRule< DIM >, and ChemotaxisPottsUpdateRule< DIM >.

Definition at line 59 of file AbstractPottsUpdateRule.cpp.

Referenced by ChemotaxisPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), VolumeConstraintPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), SurfaceAreaConstraintPottsUpdateRule< DIM >::OutputUpdateRuleParameters(), and AdhesionPottsUpdateRule< DIM >::OutputUpdateRuleParameters().

template<unsigned DIM>
template<class Archive >
void AbstractPottsUpdateRule< DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.

Parameters
archiveThe boost archive.
versionThe current version of this class.

Definition at line 64 of file AbstractPottsUpdateRule.hpp.

Friends And Related Function Documentation

template<unsigned DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 55 of file AbstractPottsUpdateRule.hpp.

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