Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
VonMisesVertexBasedDivisionRule< SPACE_DIM > Class Template Reference

#include <VonMisesVertexBasedDivisionRule.hpp>

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

Public Member Functions

 VonMisesVertexBasedDivisionRule ()
 
virtual ~VonMisesVertexBasedDivisionRule ()
 
double GetMeanParameter ()
 
double GetConcentrationParameter ()
 
void SetMeanParameter (double meanParameter)
 
void SetConcentrationParameter (double concentrationParameter)
 
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)
 

Private Attributes

double mMeanParameter
 
double mConcentrationParameter
 

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 VonMisesVertexBasedDivisionRule< SPACE_DIM >

A class to generate a division vector of unit length that points in a direction randomly sampled from a von Mises distribution parameterised by mu (mean parameter) and kappa (concentration parameter).

Definition at line 54 of file VonMisesVertexBasedDivisionRule.hpp.

Constructor & Destructor Documentation

◆ VonMisesVertexBasedDivisionRule()

Default constructor.

Definition at line 40 of file VonMisesVertexBasedDivisionRule.cpp.

◆ ~VonMisesVertexBasedDivisionRule()

Empty destructor.

Definition at line 48 of file VonMisesVertexBasedDivisionRule.cpp.

Member Function Documentation

◆ CalculateCellDivisionVector()

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

Overridden CalculateCellDivisionVector() method.

Return a unit vector that points in a direction randomly sampled from a von Mises distribution, 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 78 of file VonMisesVertexBasedDivisionRule.cpp.

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

◆ GetConcentrationParameter()

template<unsigned DIM>
double VonMisesVertexBasedDivisionRule< DIM >::GetConcentrationParameter ( )
Returns
mConcentrationParameter

Definition at line 59 of file VonMisesVertexBasedDivisionRule.cpp.

◆ GetMeanParameter()

template<unsigned DIM>
double VonMisesVertexBasedDivisionRule< DIM >::GetMeanParameter ( )
Returns
mMeanParameter

Definition at line 53 of file VonMisesVertexBasedDivisionRule.cpp.

◆ serialize()

template<unsigned SPACE_DIM>
template<class Archive >
void VonMisesVertexBasedDivisionRule< 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 72 of file VonMisesVertexBasedDivisionRule.hpp.

References VonMisesVertexBasedDivisionRule< SPACE_DIM >::mConcentrationParameter, and VonMisesVertexBasedDivisionRule< SPACE_DIM >::mMeanParameter.

◆ SetConcentrationParameter()

template<unsigned DIM>
void VonMisesVertexBasedDivisionRule< DIM >::SetConcentrationParameter ( double  concentrationParameter)

Set mConcentrationParameter.

Parameters
concentrationParameterthe new value of mConcentrationParameter

Definition at line 71 of file VonMisesVertexBasedDivisionRule.cpp.

◆ SetMeanParameter()

template<unsigned DIM>
void VonMisesVertexBasedDivisionRule< DIM >::SetMeanParameter ( double  meanParameter)

Set mMeanParameter.

Parameters
meanParameterthe new value of mMeanParameter

Definition at line 65 of file VonMisesVertexBasedDivisionRule.cpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Definition at line 64 of file VonMisesVertexBasedDivisionRule.hpp.

Member Data Documentation

◆ mConcentrationParameter

template<unsigned SPACE_DIM>
double VonMisesVertexBasedDivisionRule< SPACE_DIM >::mConcentrationParameter
private

Concentration parameter. Must be positive. Initialised to 1 in the constructor.

Definition at line 62 of file VonMisesVertexBasedDivisionRule.hpp.

Referenced by VonMisesVertexBasedDivisionRule< SPACE_DIM >::serialize().

◆ mMeanParameter

template<unsigned SPACE_DIM>
double VonMisesVertexBasedDivisionRule< SPACE_DIM >::mMeanParameter
private

Mean parameter. Initialised to 0 in the constructor.

Definition at line 59 of file VonMisesVertexBasedDivisionRule.hpp.

Referenced by VonMisesVertexBasedDivisionRule< SPACE_DIM >::serialize().


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