Chaste  Release::3.4
Public Member Functions | Private Member Functions | Friends | List of all members
AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM > Class Template Referenceabstract

#include <AbstractCellBasedSimulationModifier.hpp>

+ Inheritance diagram for AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >:
+ Collaboration diagram for AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions

 AbstractCellBasedSimulationModifier ()
 
virtual ~AbstractCellBasedSimulationModifier ()
 
virtual void UpdateAtEndOfTimeStep (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
 
virtual void UpdateAtEndOfOutputTimeStep (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
 
virtual void SetupSolve (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation, std::string outputDirectory)
 
virtual void UpdateAtEndOfSolve (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
 
void OutputSimulationModifierInfo (out_stream &rParamsFile)
 
virtual void OutputSimulationModifierParameters (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 ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >

An abstract modifier class (to implement setup, update and finalise methods), for use in cell-based simulations.

Definition at line 48 of file AbstractCellBasedSimulationModifier.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::AbstractCellBasedSimulationModifier ( )

Default constructor.

Definition at line 39 of file AbstractCellBasedSimulationModifier.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::~AbstractCellBasedSimulationModifier ( )
virtual

Destructor.

Definition at line 44 of file AbstractCellBasedSimulationModifier.cpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::OutputSimulationModifierInfo ( out_stream &  rParamsFile)

Output the modifier type used in the simulation to file and then call OutputSimulationModifierParameters() to output all relevant parameters.

Parameters
rParamsFilethe file stream to which the parameters are output

Definition at line 49 of file AbstractCellBasedSimulationModifier.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::OutputSimulationModifierParameters ( out_stream &  rParamsFile)
pure virtual

Output any simulation modifier parameters to file.

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

Parameters
rParamsFilethe file stream to which the parameters are output

Implemented in AbstractTargetAreaModifier< DIM >, DeltaNotchTrackingModifier< DIM >, VolumeTrackingModifier< DIM >, FarhadifarTypeModifier< DIM >, and SimpleTargetAreaModifier< DIM >.

Definition at line 58 of file AbstractCellBasedSimulationModifier.cpp.

Referenced by VolumeTrackingModifier< DIM >::OutputSimulationModifierParameters(), DeltaNotchTrackingModifier< DIM >::OutputSimulationModifierParameters(), and AbstractTargetAreaModifier< DIM >::OutputSimulationModifierParameters().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
template<class Archive >
void AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Serialize the object.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 59 of file AbstractCellBasedSimulationModifier.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
virtual void AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::SetupSolve ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation,
std::string  outputDirectory 
)
inlinevirtual

Specify what to do in the simulation before the start of the time loop.

Parameters
rCellPopulationreference to the cell population
outputDirectorythe output directory, relative to where Chaste output is stored

Definition at line 99 of file AbstractCellBasedSimulationModifier.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
virtual void AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::UpdateAtEndOfOutputTimeStep ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation)
inlinevirtual

Specify what to do in the simulation at the end of each output timestep.

Parameters
rCellPopulationreference to the cell population

Definition at line 89 of file AbstractCellBasedSimulationModifier.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
virtual void AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::UpdateAtEndOfSolve ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation)
inlinevirtual

Specify what to do in the simulation at the end of each time loop.

Parameters
rCellPopulationreference to the cell population

Definition at line 108 of file AbstractCellBasedSimulationModifier.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
virtual void AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::UpdateAtEndOfTimeStep ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation)
inlinevirtual

Specify what to do in the simulation at the end of each timestep.

Parameters
rCellPopulationreference to the cell population

Definition at line 80 of file AbstractCellBasedSimulationModifier.hpp.

Friends And Related Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 51 of file AbstractCellBasedSimulationModifier.hpp.

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