Chaste  Release::2018.1
Public Member Functions | Private Member Functions | Friends | List of all members
AbstractForce< ELEMENT_DIM, SPACE_DIM > Class Template Referenceabstract

#include <AbstractForce.hpp>

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

Public Member Functions

 AbstractForce ()
 
virtual ~AbstractForce ()
 
virtual void AddForceContribution (AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)=0
 
void OutputForceInfo (out_stream &rParamsFile)
 
virtual void OutputForceParameters (out_stream &rParamsFile)=0
 
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)
 

Friends

class boost::serialization::access
 

Detailed Description

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

An abstract force class, for use in cell-based simulations.

Definition at line 48 of file AbstractForce.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractForce< ELEMENT_DIM, SPACE_DIM >::AbstractForce ( )

Default constructor.

Definition at line 39 of file AbstractForce.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
AbstractForce< ELEMENT_DIM, SPACE_DIM >::~AbstractForce ( )
virtual

Destructor.

Definition at line 44 of file AbstractForce.cpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
virtual void AbstractForce< ELEMENT_DIM, SPACE_DIM >::AddForceContribution ( AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM > &  rCellPopulation)
pure virtual

Calculates the force on each node.

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

Parameters
rCellPopulationreference to the cell population

Implemented in AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >, AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >, and PopulationTestingForce< ELEMENT_DIM, SPACE_DIM >.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void AbstractForce< ELEMENT_DIM, SPACE_DIM >::OutputForceInfo ( out_stream &  rParamsFile)

Outputs force used in the simulation to file and then calls OutputForceParameters to output all relevant parameters.

Parameters
rParamsFilethe file stream to which the parameters are output

Definition at line 49 of file AbstractForce.cpp.

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

Outputs force parameters to file.

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

Parameters
rParamsFilethe file stream to which the parameters are output

Implemented in LinearSpringWithVariableSpringConstantsForce< DIM >, GeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >, GeneralisedLinearSpringForce< DIM >, GeneralisedLinearSpringForce< 2 >, NagaiHondaForce< DIM >, CryptProjectionForce, FarhadifarForce< DIM >, PopulationTestingForce< ELEMENT_DIM, SPACE_DIM >, NagaiHondaDifferentialAdhesionForce< DIM >, DiffusionForce< DIM >, DifferentialAdhesionGeneralisedLinearSpringForce< ELEMENT_DIM, SPACE_DIM >, WelikyOsterForce< DIM >, AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >, AbstractTwoBodyInteractionForce< DIM >, AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >, BuskeElasticForce< DIM >, BuskeAdhesiveForce< DIM >, BuskeCompressionForce< DIM >, VertexCryptBoundaryForce< DIM >, ChemotacticForce< DIM >, and RepulsionForce< DIM >.

Definition at line 59 of file AbstractForce.cpp.

Referenced by ChemotacticForce< DIM >::OutputForceParameters(), VertexCryptBoundaryForce< DIM >::OutputForceParameters(), BuskeCompressionForce< DIM >::OutputForceParameters(), AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >::OutputForceParameters(), WelikyOsterForce< DIM >::OutputForceParameters(), DiffusionForce< DIM >::OutputForceParameters(), FarhadifarForce< DIM >::OutputForceParameters(), and NagaiHondaForce< DIM >::OutputForceParameters().

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

Serialize the object.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 59 of file AbstractForce.hpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void AbstractForce< ELEMENT_DIM, SPACE_DIM >::WriteDataToVisualizerSetupFile ( out_stream &  pVizSetupFile)
virtual

Write any data necessary to a visualization setup file. Used by AbstractCellBasedSimulation::WriteVisualizerSetupFile().

Parameters
pVizSetupFilea visualization setup file

Reimplemented in AbstractTwoBodyInteractionForce< ELEMENT_DIM, SPACE_DIM >, AbstractTwoBodyInteractionForce< DIM >, and AbstractTwoBodyInteractionForce< ELEMENT_DIM, ELEMENT_DIM >.

Definition at line 65 of file AbstractForce.cpp.

Friends And Related Function Documentation

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

Needed for serialization.

Definition at line 51 of file AbstractForce.hpp.

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