Chaste  Release::2018.1
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
FixedVertexBasedDivisionRule< SPACE_DIM > Class Template Reference

#include <FixedVertexBasedDivisionRule.hpp>

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

Public Member Functions

 FixedVertexBasedDivisionRule (c_vector< double, SPACE_DIM > &rDivisionVector)
 
virtual ~FixedVertexBasedDivisionRule ()
 
const c_vector< double,
SPACE_DIM > & 		rGetDivisionVector () const
 
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

c_vector< double, SPACE_DIM > mDivisionVector
 

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

A class to generate a division vector of unit length specified in the class constructor.

This helper class is used in TestVertexhBasedCellPopulation.hpp.

Definition at line 57 of file FixedVertexBasedDivisionRule.hpp.

Constructor & Destructor Documentation

template<unsigned SPACE_DIM>
FixedVertexBasedDivisionRule< SPACE_DIM >::FixedVertexBasedDivisionRule ( c_vector< double, SPACE_DIM > &  rDivisionVector)

Default constructor.

Parameters
rDivisionVectorthe specified division vector

Definition at line 39 of file FixedVertexBasedDivisionRule.cpp.

References EXCEPTION.

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

Empty destructor.

Definition at line 92 of file FixedVertexBasedDivisionRule.hpp.

Member Function Documentation

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

Overridden CalculateCellDivisionVector() method.

Parameters
pParentCellThe cell to divide
rCellPopulationThe vertex-based cell population
Returns
mDivisionVector.

Implements AbstractVertexBasedDivisionRule< SPACE_DIM >.

Definition at line 49 of file FixedVertexBasedDivisionRule.cpp.

template<unsigned SPACE_DIM>
const c_vector< double, SPACE_DIM > & FixedVertexBasedDivisionRule< SPACE_DIM >::rGetDivisionVector ( ) const
Returns
mDivisionVector.

Definition at line 57 of file FixedVertexBasedDivisionRule.cpp.

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

Member Data Documentation

template<unsigned SPACE_DIM>
c_vector<double, SPACE_DIM> FixedVertexBasedDivisionRule< SPACE_DIM >::mDivisionVector
private

The specified division vector. Initialized in the constructor.

Definition at line 65 of file FixedVertexBasedDivisionRule.hpp.

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