Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
|
#include <ExtrinsicPullModifier.hpp>
Public Member Functions | |
ExtrinsicPullModifier () | |
virtual | ~ExtrinsicPullModifier () |
virtual void | UpdateAtEndOfTimeStep (AbstractCellPopulation< DIM, DIM > &rCellPopulation) |
virtual void | SetupSolve (AbstractCellPopulation< DIM, DIM > &rCellPopulation, std::string outputDirectory) |
void | SetApplyExtrinsicPullToAllNodes (bool applyExtrinsicPullToAllNodes) |
void | SetSpeed (double speed) |
bool | GetApplyExtrinsicPullToAllNodes () |
double | GetSpeed () |
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 |
Private Member Functions | |
template<class Archive > | |
void | serialize (Archive &archive, const unsigned int version) |
Private Attributes | |
bool | mApplyExtrinsicPullToAllNodes |
double | mSpeed |
Friends | |
class | boost::serialization::access |
A modifier class which at each simulation time step applies an extrinsic pull to the right at a specified speed, optionally applying this to all nodes or else just the right-most nodes.
Definition at line 50 of file ExtrinsicPullModifier.hpp.
ExtrinsicPullModifier< DIM >::ExtrinsicPullModifier | ( | ) |
Default constructor.
Definition at line 39 of file ExtrinsicPullModifier.cpp.
|
virtual |
Destructor.
Definition at line 47 of file ExtrinsicPullModifier.cpp.
bool ExtrinsicPullModifier< DIM >::GetApplyExtrinsicPullToAllNodes | ( | ) |
Definition at line 109 of file ExtrinsicPullModifier.cpp.
double ExtrinsicPullModifier< DIM >::GetSpeed | ( | ) |
Definition at line 115 of file ExtrinsicPullModifier.cpp.
|
virtual |
Overridden OutputSimulationModifierParameters() method. Output any simulation modifier parameters to file.
rParamsFile | the file stream to which the parameters are output |
Implements AbstractCellBasedSimulationModifier< DIM, DIM >.
Definition at line 121 of file ExtrinsicPullModifier.cpp.
References AbstractCellBasedSimulationModifier< ELEMENT_DIM, SPACE_DIM >::OutputSimulationModifierParameters().
|
inlineprivate |
Boost Serialization method for archiving/checkpointing. Archives the object and its member variables.
archive | The boost archive. |
version | The current version of this class. |
Definition at line 64 of file ExtrinsicPullModifier.hpp.
References ExtrinsicPullModifier< DIM >::mApplyExtrinsicPullToAllNodes, and ExtrinsicPullModifier< DIM >::mSpeed.
void ExtrinsicPullModifier< DIM >::SetApplyExtrinsicPullToAllNodes | ( | bool | applyExtrinsicPullToAllNodes | ) |
applyExtrinsicPullToAllNodes | whether to apply the extrinsic pull to all nodes in the tissue |
Definition at line 97 of file ExtrinsicPullModifier.cpp.
void ExtrinsicPullModifier< DIM >::SetSpeed | ( | double | speed | ) |
speed | the speed of the extrinsic pull |
Definition at line 103 of file ExtrinsicPullModifier.cpp.
|
virtual |
Overridden SetupSolve() method.
Specifies what to do in the simulation before the start of the time loop.
rCellPopulation | reference to the cell population |
outputDirectory | the output directory, relative to where Chaste output is stored |
Definition at line 92 of file ExtrinsicPullModifier.cpp.
|
virtual |
Overridden UpdateAtEndOfTimeStep() method.
Specifies what to do in the simulation at the end of each time step.
rCellPopulation | reference to the cell population |
Definition at line 52 of file ExtrinsicPullModifier.cpp.
References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNumNodes(), SimulationTime::GetTimeStep(), SimulationTime::Instance(), Node< SPACE_DIM >::rGetLocation(), ChasteCuboid< SPACE_DIM >::rGetLowerCorner(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh(), Node< SPACE_DIM >::rGetModifiableLocation(), and ChasteCuboid< SPACE_DIM >::rGetUpperCorner().
|
friend |
Needed for serialization.
Definition at line 55 of file ExtrinsicPullModifier.hpp.
|
private |
Whether to apply extrinsic pull on all nodes (or just the right-most nodes).
Definition at line 74 of file ExtrinsicPullModifier.hpp.
Referenced by ExtrinsicPullModifier< DIM >::serialize().
|
private |
The speed of the extrinsic pull.
Definition at line 79 of file ExtrinsicPullModifier.hpp.
Referenced by ExtrinsicPullModifier< DIM >::serialize().