Chaste Commit::f841a6fa79bd6f7a205054452b95ddf6d10aae23
SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <SimpleLogarithmicRepulsionForce.hpp>

+ Inheritance diagram for SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >:
+ Collaboration diagram for SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >:

Public Member Functions

 SimpleLogarithmicRepulsionForce ()
 
double GetRepulsionParameter ()
 
void SetRepulsionParameter (double repulsionParameter)
 
c_vector< double, SPACE_DIM > CalculateForceBetweenNodes (unsigned nodeAGlobalIndex, unsigned nodeBGlobalIndex, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
 
virtual void OutputForceParameters (out_stream &rParamsFile)
 
- Public Member Functions inherited from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >
 AbstractTwoBodyInteractionForce ()
 
bool GetUseCutOffLength ()
 
void SetCutOffLength (double cutOffLength)
 
double GetCutOffLength ()
 
void AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
 
virtual void WriteDataToVisualizerSetupFile (out_stream &pVizSetupFile)
 
- Public Member Functions inherited from AbstractForce< ELEMENT_DIM, SPACE_DIM >
 AbstractForce ()
 
virtual ~AbstractForce ()
 
void OutputForceInfo (out_stream &rParamsFile)
 
- Public Member Functions inherited from Identifiable
virtual ~Identifiable ()
 
std::string GetIdentifier () const
 

Protected Attributes

double mRepulsionParameter
 
- Protected Attributes inherited from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >
bool mUseCutOffLength
 
double mMechanicsCutOffLength
 

Private Member Functions

template<class Archive >
void serialize (Archive &archive, const unsigned int version)
 

Friends

class boost::serialization::access
 

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >

A class for a simple two-body repulsion force law. Designed for use in node-based simulations.

A linear repulsive force is applied between cells that overlap (i.e. whose separation is less than the sum of their radii). No attractive force is applied, and no cell-age or cell-cycle effects are included.

Definition at line 52 of file SimpleLogarithmicRepulsionForce.hpp.

Constructor & Destructor Documentation

◆ SimpleLogarithmicRepulsionForce()

Member Function Documentation

◆ CalculateForceBetweenNodes()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
c_vector< double, SPACE_DIM > SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >::CalculateForceBetweenNodes ( unsigned  nodeAGlobalIndex,
unsigned  nodeBGlobalIndex,
AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation 
)
virtual

Overridden CalculateForceBetweenNodes() method.

Returns a linear repulsive force when nodes overlap, and zero otherwise.

Parameters
nodeAGlobalIndexindex of one neighbouring node
nodeBGlobalIndexindex of the other neighbouring node
rCellPopulationthe cell population
Returns
The force exerted on Node A by Node B.

Implements AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >.

Definition at line 63 of file SimpleLogarithmicRepulsionForce.cpp.

References EXCEPTION, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::GetNode(), Node< SPACE_DIM >::GetRadius(), Node< SPACE_DIM >::rGetLocation(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetMesh().

◆ GetRepulsionParameter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
double SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >::GetRepulsionParameter ( )
Returns
mRepulsionParameter

Definition at line 50 of file SimpleLogarithmicRepulsionForce.cpp.

◆ OutputForceParameters()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters ( out_stream &  rParamsFile)
virtual

Overridden OutputForceParameters() method.

Parameters
rParamsFilethe file stream to which the parameters are output

Reimplemented from AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >.

Definition at line 98 of file SimpleLogarithmicRepulsionForce.cpp.

References AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters().

◆ serialize()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
template<class Archive >
void SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >::serialize ( Archive &  archive,
const unsigned int  version 
)
inlineprivate

Archive the object and its member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 65 of file SimpleLogarithmicRepulsionForce.hpp.

References SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >::mRepulsionParameter.

◆ SetRepulsionParameter()

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >::SetRepulsionParameter ( double  repulsionParameter)

Set mRepulsionParameter.

Parameters
repulsionParameterthe new value of mRepulsionParameter

Definition at line 56 of file SimpleLogarithmicRepulsionForce.cpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 57 of file SimpleLogarithmicRepulsionForce.hpp.

Member Data Documentation

◆ mRepulsionParameter

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
double SimpleLogarithmicRepulsionForce< ELEMENT_DIM, SPACE_DIM >::mRepulsionParameter
protected

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