Chaste  Release::3.4
SimpleTargetAreaModifier< DIM > Class Template Reference

#include <SimpleTargetAreaModifier.hpp>

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

Public Member Functions

 SimpleTargetAreaModifier ()
 
virtual ~SimpleTargetAreaModifier ()
 
virtual void UpdateTargetAreaOfCell (const CellPtr pCell)
 
void OutputSimulationModifierParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractTargetAreaModifier< DIM >
 AbstractTargetAreaModifier ()
 
virtual ~AbstractTargetAreaModifier ()
 
virtual void UpdateAtEndOfTimeStep (AbstractCellPopulation< DIM, DIM > &rCellPopulation)
 
virtual void SetupSolve (AbstractCellPopulation< DIM, DIM > &rCellPopulation, std::string outputDirectory)
 
double GetReferenceTargetArea ()
 
void SetReferenceTargetArea (double referenceTargetArea)
 
void UpdateTargetAreas (AbstractCellPopulation< DIM, DIM > &rCellPopulation)
 
- Public Member Functions inherited from AbstractCellBasedSimulationModifier< DIM, DIM >
 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)
 
- 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
 

Additional Inherited Members

- Protected Attributes inherited from AbstractTargetAreaModifier< DIM >
double mReferenceTargetArea
 

Detailed Description

template<unsigned DIM>
class SimpleTargetAreaModifier< DIM >

A modifier class in which the target area property of each cell is updated. It is used to implement growth in vertex-based simulations.

Todo:
Improve class documentation by describing precisely how the target area depends on the cell's status

Definition at line 51 of file SimpleTargetAreaModifier.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 39 of file SimpleTargetAreaModifier.cpp.

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

Destructor.

Definition at line 45 of file SimpleTargetAreaModifier.cpp.

Member Function Documentation

template<unsigned DIM>
void SimpleTargetAreaModifier< DIM >::OutputSimulationModifierParameters ( out_stream &  rParamsFile)
virtual

Overridden OutputSimulationModifierParameters() method. Output any simulation modifier parameters to file.

Parameters
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractTargetAreaModifier< DIM >.

Definition at line 111 of file SimpleTargetAreaModifier.cpp.

References AbstractTargetAreaModifier< DIM >::OutputSimulationModifierParameters().

template<unsigned DIM>
template<class Archive >
void SimpleTargetAreaModifier< 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 63 of file SimpleTargetAreaModifier.hpp.

template<unsigned DIM>
void SimpleTargetAreaModifier< DIM >::UpdateTargetAreaOfCell ( const CellPtr  pCell)
virtual

Overridden UpdateTargetAreaOfCell() method.

Parameters
pCellpointer to the cell

At division, daughter cells inherit the cell data array from the mother cell. Here, we assign the target area that we want daughter cells to have to cells that we know to divide in this time step.

Todo:
This is a little hack that we might want to clean up in the future.

Implements AbstractTargetAreaModifier< DIM >.

Definition at line 50 of file SimpleTargetAreaModifier.cpp.

References SimulationTime::GetTime(), and SimulationTime::Instance().

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 54 of file SimpleTargetAreaModifier.hpp.


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