Chaste Release::3.1
NodeBasedCellPopulationWithBuskeUpdate< DIM > Class Template Reference

#include <NodeBasedCellPopulationWithBuskeUpdate.hpp>

Inheritance diagram for NodeBasedCellPopulationWithBuskeUpdate< DIM >:
Collaboration diagram for NodeBasedCellPopulationWithBuskeUpdate< DIM >:

List of all members.

Public Member Functions

 NodeBasedCellPopulationWithBuskeUpdate (NodesOnlyMesh< DIM > &rMesh, std::vector< CellPtr > &rCells, const std::vector< unsigned > locationIndices=std::vector< unsigned >(), bool deleteMesh=false)
 NodeBasedCellPopulationWithBuskeUpdate (NodesOnlyMesh< DIM > &rMesh)
virtual void UpdateNodeLocations (const std::vector< c_vector< double, DIM > > &rNodeForces, double dt)
void OutputCellPopulationParameters (out_stream &rParamsFile)

Private Member Functions

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

Friends

class TestNodeBasedCellPopulationWithBuskeUpdate
class boost::serialization::access

Detailed Description

template<unsigned DIM>
class NodeBasedCellPopulationWithBuskeUpdate< DIM >

A NodeBasedCellPopulationWithBuskeUpdate is a CellPopulation consisting of only nodes in space with associated cells. There are no elements and no mesh. The cell positions are updated according to Buske et al (2011) (doi:10.1371/journal.pcbi.1001045).

Definition at line 50 of file NodeBasedCellPopulationWithBuskeUpdate.hpp.


Constructor & Destructor Documentation

template<unsigned DIM>
NodeBasedCellPopulationWithBuskeUpdate< DIM >::NodeBasedCellPopulationWithBuskeUpdate ( NodesOnlyMesh< DIM > &  rMesh,
std::vector< CellPtr > &  rCells,
const std::vector< unsigned locationIndices = std::vector<unsigned>(),
bool  deleteMesh = false 
)

Default constructor.

Note that the cell population will take responsibility for freeing the memory used by the nodes.

Parameters:
rMesha mutable nodes-only mesh
rCellsa vector of cells
locationIndicesan optional vector of location indices that correspond to real cells
deleteMeshwhether to delete nodes-only mesh in destructor

Definition at line 41 of file NodeBasedCellPopulationWithBuskeUpdate.cpp.

Constructor for use by the de-serializer.

Parameters:
rMesha mutable nodes-only mesh

Definition at line 50 of file NodeBasedCellPopulationWithBuskeUpdate.cpp.


Member Function Documentation

template<unsigned DIM>
void NodeBasedCellPopulationWithBuskeUpdate< DIM >::OutputCellPopulationParameters ( out_stream &  rParamsFile) [virtual]

Outputs CellPopulation 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

Reimplemented from NodeBasedCellPopulation< DIM >.

Definition at line 187 of file NodeBasedCellPopulationWithBuskeUpdate.cpp.

References NodeBasedCellPopulation< DIM >::OutputCellPopulationParameters().

template<unsigned DIM>
template<class Archive >
void NodeBasedCellPopulationWithBuskeUpdate< DIM >::serialize ( Archive &  archive,
const unsigned int  version 
) [inline, private]

Serialize the object and its member variables.

Note that serialization of the nodes is handled by load/save_construct_data, so we don't actually have to do anything here except delegate to the base class.

Parameters:
archivethe archive
versionthe current version of this class

Reimplemented from NodeBasedCellPopulation< DIM >.

Definition at line 68 of file NodeBasedCellPopulationWithBuskeUpdate.hpp.

template<unsigned DIM>
void NodeBasedCellPopulationWithBuskeUpdate< DIM >::UpdateNodeLocations ( const std::vector< c_vector< double, DIM > > &  rNodeForces,
double  dt 
) [virtual]

Overridden UpdateNodeLocations() method. To use the update from Buske et al (2011) (doi:10.1371/journal.pcbi.1001045).

Parameters:
rNodeForcesa vector containing the force on each node in the cell population
dtthe time step

Definition at line 57 of file NodeBasedCellPopulationWithBuskeUpdate.cpp.

References PetscMatTools::AddToElement(), PetscTools::CreateAndSetVec(), PetscTools::Destroy(), PetscMatTools::Finalise(), OdeLinearSystemSolver::rGetForceVector(), OdeLinearSystemSolver::rGetLhsMatrix(), PetscVecTools::SetElement(), OdeLinearSystemSolver::SetInitialConditionVector(), and OdeLinearSystemSolver::SolveOneTimeStep().


Friends And Related Function Documentation

template<unsigned DIM>
friend class boost::serialization::access [friend]

Needed for serialization.

Reimplemented from NodeBasedCellPopulation< DIM >.

Definition at line 57 of file NodeBasedCellPopulationWithBuskeUpdate.hpp.


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