Chaste  Release::2017.1
AbstractTargetAreaModifier< DIM > Class Template Referenceabstract

#include <AbstractTargetAreaModifier.hpp>

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

Public Member Functions

 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)
 
virtual void UpdateTargetAreaOfCell (const CellPtr pCell)=0
 
virtual void OutputSimulationModifierParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractCellBasedSimulationModifier< DIM, DIM >
 AbstractCellBasedSimulationModifier ()
 
virtual ~AbstractCellBasedSimulationModifier ()
 
virtual void UpdateAtEndOfTimeStep (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0
 
virtual void UpdateAtEndOfOutputTimeStep (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
 
virtual void SetupSolve (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation, std::string outputDirectory)=0
 
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
 

Protected Attributes

double mReferenceTargetArea
 

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 AbstractTargetAreaModifier< 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.

Definition at line 48 of file AbstractTargetAreaModifier.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 39 of file AbstractTargetAreaModifier.cpp.

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

Destructor.

Definition at line 46 of file AbstractTargetAreaModifier.cpp.

Member Function Documentation

template<unsigned DIM>
double AbstractTargetAreaModifier< DIM >::GetReferenceTargetArea ( )

Get the reference target area.

Returns
the reference target area.

Definition at line 79 of file AbstractTargetAreaModifier.cpp.

References AbstractTargetAreaModifier< DIM >::mReferenceTargetArea.

template<unsigned DIM>
void AbstractTargetAreaModifier< DIM >::OutputSimulationModifierParameters ( out_stream &  rParamsFile)
virtual
template<unsigned DIM>
template<class Archive >
void AbstractTargetAreaModifier< 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 60 of file AbstractTargetAreaModifier.hpp.

References AbstractTargetAreaModifier< DIM >::mReferenceTargetArea.

template<unsigned DIM>
void AbstractTargetAreaModifier< DIM >::SetReferenceTargetArea ( double  referenceTargetArea)

Set the reference target area. The standard value is 1.0.

Parameters
referenceTargetAreathe new value of mReferenceTargetArea

Definition at line 85 of file AbstractTargetAreaModifier.cpp.

References AbstractTargetAreaModifier< DIM >::mReferenceTargetArea.

template<unsigned DIM>
void AbstractTargetAreaModifier< DIM >::SetupSolve ( AbstractCellPopulation< DIM, DIM > &  rCellPopulation,
std::string  outputDirectory 
)
virtual

Overridden SetupSolve() method.

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 57 of file AbstractTargetAreaModifier.cpp.

References AbstractTargetAreaModifier< DIM >::UpdateTargetAreas().

template<unsigned DIM>
void AbstractTargetAreaModifier< DIM >::UpdateAtEndOfTimeStep ( AbstractCellPopulation< DIM, DIM > &  rCellPopulation)
virtual

Overridden UpdateAtEndOfTimeStep() method.

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

Parameters
rCellPopulationreference to the cell population

Definition at line 51 of file AbstractTargetAreaModifier.cpp.

References AbstractTargetAreaModifier< DIM >::UpdateTargetAreas().

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

Helper method to update the target area property of an individual cell.

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

Parameters
pCellpointer to the cell

Implemented in TargetAreaLinearGrowthModifier< DIM >, and SimpleTargetAreaModifier< DIM >.

Referenced by AbstractTargetAreaModifier< DIM >::UpdateTargetAreas().

template<unsigned DIM>
void AbstractTargetAreaModifier< DIM >::UpdateTargetAreas ( AbstractCellPopulation< DIM, DIM > &  rCellPopulation)

Helper method to update the target area property of all cells in the population.

Parameters
rCellPopulationreference to the cell population

Definition at line 67 of file AbstractTargetAreaModifier.cpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetCells(), and AbstractTargetAreaModifier< DIM >::UpdateTargetAreaOfCell().

Referenced by AbstractTargetAreaModifier< DIM >::SetupSolve(), and AbstractTargetAreaModifier< DIM >::UpdateAtEndOfTimeStep().

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 51 of file AbstractTargetAreaModifier.hpp.

Member Data Documentation


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