Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
|
#include <RandomCaSwitchingUpdateRule.hpp>
Public Member Functions | |
RandomCaSwitchingUpdateRule () | |
~RandomCaSwitchingUpdateRule () | |
double | EvaluateSwitchingProbability (unsigned currentNodeIndex, unsigned neighbourNodeIndex, CaBasedCellPopulation< DIM > &rCellPopulation, double dt, double deltaX) |
double | GetSwitchingParameter () |
void | SetSwitchingParameter (double switchingParameter) |
void | OutputUpdateRuleParameters (out_stream &rParamsFile) |
Public Member Functions inherited from AbstractCaSwitchingUpdateRule< DIM > | |
AbstractCaSwitchingUpdateRule () | |
virtual | ~AbstractCaSwitchingUpdateRule () |
Public Member Functions inherited from AbstractUpdateRule< DIM > | |
AbstractUpdateRule () | |
virtual | ~AbstractUpdateRule () |
void | OutputUpdateRuleInfo (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 | |
double | mSwitchingParameter |
Friends | |
class | TestCaUpdateRules |
class | boost::serialization::access |
A random switching update rule for use in cell-based simulations using the cellular CA model.
The probability of performing a switch is
P* delta_t
Where P is the mSwitchingParameter. delta_t is the timestep.
Definition at line 57 of file RandomCaSwitchingUpdateRule.hpp.
RandomCaSwitchingUpdateRule< DIM >::RandomCaSwitchingUpdateRule | ( | ) |
Constructor.
Definition at line 39 of file RandomCaSwitchingUpdateRule.cpp.
RandomCaSwitchingUpdateRule< DIM >::~RandomCaSwitchingUpdateRule | ( | ) |
Destructor.
Definition at line 46 of file RandomCaSwitchingUpdateRule.cpp.
|
virtual |
Calculate the probability of a given switch. Here this is hust
mSwitchingParameter * dt
currentNodeIndex | The index of the current node/lattice site |
neighbourNodeIndex | The index of the neighbour node/lattice site |
rCellPopulation | The cell population |
dt | is the time interval |
deltaX | defines the size of the lattice site |
Implements AbstractCaSwitchingUpdateRule< DIM >.
Definition at line 51 of file RandomCaSwitchingUpdateRule.cpp.
double RandomCaSwitchingUpdateRule< DIM >::GetSwitchingParameter | ( | ) |
Definition at line 61 of file RandomCaSwitchingUpdateRule.cpp.
|
virtual |
Overridden OutputUpdateRuleParameters() method.
rParamsFile | the file stream to which the parameters are output |
Reimplemented from AbstractCaSwitchingUpdateRule< DIM >.
Definition at line 73 of file RandomCaSwitchingUpdateRule.cpp.
References AbstractCaSwitchingUpdateRule< DIM >::OutputUpdateRuleParameters().
|
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 79 of file RandomCaSwitchingUpdateRule.hpp.
References RandomCaSwitchingUpdateRule< DIM >::mSwitchingParameter.
void RandomCaSwitchingUpdateRule< DIM >::SetSwitchingParameter | ( | double | switchingParameter | ) |
Set mSwitchingParameter.
switchingParameter | the new value of mSwitchingParameter |
Definition at line 67 of file RandomCaSwitchingUpdateRule.cpp.
|
friend |
Definition at line 70 of file RandomCaSwitchingUpdateRule.hpp.
|
friend |
Definition at line 59 of file RandomCaSwitchingUpdateRule.hpp.
|
private |
Switching parameter for update rule. Set to the default value 0.5 in the constructor.
Definition at line 68 of file RandomCaSwitchingUpdateRule.hpp.
Referenced by RandomCaSwitchingUpdateRule< DIM >::serialize().