Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
|
#include <VertexCryptBoundaryForce.hpp>
Public Member Functions | |
VertexCryptBoundaryForce (double forceStrength=1.0) | |
~VertexCryptBoundaryForce () | |
void | AddForceContribution (AbstractCellPopulation< DIM > &rCellPopulation) |
double | GetForceStrength () const |
void | OutputForceParameters (out_stream &rParamsFile) |
Public Member Functions inherited from AbstractForce< DIM > | |
AbstractForce () | |
virtual | ~AbstractForce () |
virtual void | AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0 |
void | OutputForceInfo (out_stream &rParamsFile) |
virtual void | WriteDataToVisualizerSetupFile (out_stream &pVizSetupFile) |
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 | mForceStrength |
Friends | |
class | TestVertexCryptBoundaryForce |
class | boost::serialization::access |
A boundary force class for use in vertex-based crypt simulations to prevent cells moving below the bottom of the crypt (y=0).
The boundary force is taken to be zero for y>0, and proportional to y^2 for y<0 (hence is continuously differentiable at y=0). The constant of proportionality is given by the parameter mForceStrength, whose value is set in the constructor.
Definition at line 55 of file VertexCryptBoundaryForce.hpp.
VertexCryptBoundaryForce< DIM >::VertexCryptBoundaryForce | ( | double | forceStrength = 1.0 | ) |
Constructor.
forceStrength | the force strength |
Definition at line 40 of file VertexCryptBoundaryForce.cpp.
References VertexCryptBoundaryForce< DIM >::mForceStrength.
VertexCryptBoundaryForce< DIM >::~VertexCryptBoundaryForce | ( | ) |
Destructor.
Definition at line 49 of file VertexCryptBoundaryForce.cpp.
void VertexCryptBoundaryForce< DIM >::AddForceContribution | ( | AbstractCellPopulation< DIM > & | rCellPopulation | ) |
Overridden AddForceContribution() method.
Calculates the boundary force on each node in the vertex-based cell population.
rCellPopulation | reference to the cell population |
Definition at line 54 of file VertexCryptBoundaryForce.cpp.
References EXCEPTION, AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorBegin(), AbstractMesh< ELEMENT_DIM, SPACE_DIM >::GetNodeIteratorEnd(), and VertexBasedCellPopulation< DIM >::rGetMesh().
double VertexCryptBoundaryForce< DIM >::GetForceStrength | ( | ) | const |
Definition at line 84 of file VertexCryptBoundaryForce.cpp.
|
virtual |
Overridden OutputForceParameters() method.
rParamsFile | the file stream to which the parameters are output |
Implements AbstractForce< DIM >.
Definition at line 90 of file VertexCryptBoundaryForce.cpp.
References AbstractForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters().
|
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 73 of file VertexCryptBoundaryForce.hpp.
References VertexCryptBoundaryForce< DIM >::mForceStrength.
|
friend |
Definition at line 64 of file VertexCryptBoundaryForce.hpp.
|
friend |
Definition at line 57 of file VertexCryptBoundaryForce.hpp.
|
private |
Parameter determining the strength of the force acting on nodes below y=0.
Definition at line 62 of file VertexCryptBoundaryForce.hpp.
Referenced by VertexCryptBoundaryForce< DIM >::VertexCryptBoundaryForce(), and VertexCryptBoundaryForce< DIM >::serialize().