Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
Public Member Functions | Private Member Functions | Friends | List of all members
RandomDirectionVertexBasedDivisionRule< SPACE_DIM > Class Template Reference

#include <RandomDirectionVertexBasedDivisionRule.hpp>

+ Inheritance diagram for RandomDirectionVertexBasedDivisionRule< SPACE_DIM >:
+ Collaboration diagram for RandomDirectionVertexBasedDivisionRule< SPACE_DIM >:

Public Member Functions

 RandomDirectionVertexBasedDivisionRule ()
 
virtual ~RandomDirectionVertexBasedDivisionRule ()
 
virtual c_vector< double, SPACE_DIM > CalculateCellDivisionVector (CellPtr pParentCell, VertexBasedCellPopulation< SPACE_DIM > &rCellPopulation)
 
- Public Member Functions inherited from AbstractVertexBasedDivisionRule< SPACE_DIM >
 AbstractVertexBasedDivisionRule ()
 
virtual ~AbstractVertexBasedDivisionRule ()
 
void OutputCellVertexBasedDivisionRuleInfo (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)
 

Friends

class boost::serialization::access
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractVertexBasedDivisionRule< SPACE_DIM >
virtual void OutputCellVertexBasedDivisionRuleParameters (out_stream &rParamsFile)
 

Detailed Description

template<unsigned SPACE_DIM>
class RandomDirectionVertexBasedDivisionRule< SPACE_DIM >

A class to generate a division vector of unit length that points in a uniformly random direction.

Definition at line 52 of file RandomDirectionVertexBasedDivisionRule.hpp.

Constructor & Destructor Documentation

◆ RandomDirectionVertexBasedDivisionRule()

template<unsigned SPACE_DIM>
RandomDirectionVertexBasedDivisionRule< SPACE_DIM >::RandomDirectionVertexBasedDivisionRule ( )
inline

Default constructor.

Definition at line 72 of file RandomDirectionVertexBasedDivisionRule.hpp.

◆ ~RandomDirectionVertexBasedDivisionRule()

template<unsigned SPACE_DIM>
virtual RandomDirectionVertexBasedDivisionRule< SPACE_DIM >::~RandomDirectionVertexBasedDivisionRule ( )
inlinevirtual

Empty destructor.

Definition at line 79 of file RandomDirectionVertexBasedDivisionRule.hpp.

Member Function Documentation

◆ CalculateCellDivisionVector()

template<unsigned SPACE_DIM>
c_vector< double, SPACE_DIM > RandomDirectionVertexBasedDivisionRule< SPACE_DIM >::CalculateCellDivisionVector ( CellPtr  pParentCell,
VertexBasedCellPopulation< SPACE_DIM > &  rCellPopulation 
)
virtual

Overridden CalculateCellDivisionVector() method.

Return a unit vector in a random direction, i.e the arguments are redundant for this division rule.

Parameters
pParentCellThe cell to divide
rCellPopulationThe vertex-based cell population
Returns
the division vector.

Implements AbstractVertexBasedDivisionRule< SPACE_DIM >.

Definition at line 39 of file RandomDirectionVertexBasedDivisionRule.cpp.

References RandomNumberGenerator::Instance(), and RandomNumberGenerator::ranf().

◆ serialize()

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

Serialize the object and its member variables.

Parameters
archivethe archive
versionthe current version of this class

Definition at line 63 of file RandomDirectionVertexBasedDivisionRule.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<unsigned SPACE_DIM>
friend class boost::serialization::access
friend

Definition at line 55 of file RandomDirectionVertexBasedDivisionRule.hpp.

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