Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractImmersedBoundaryDivisionRule< SPACE_DIM > Class Template Referenceabstract

#include <AbstractImmersedBoundaryDivisionRule.hpp>

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

Public Member Functions

 AbstractImmersedBoundaryDivisionRule ()
 
virtual ~AbstractImmersedBoundaryDivisionRule ()
 
virtual c_vector< double, SPACE_DIM > CalculateCellDivisionVector (CellPtr pParentCell, ImmersedBoundaryCellPopulation< SPACE_DIM > &rCellPopulation)=0
 
void OutputCellImmersedBoundaryDivisionRuleInfo (out_stream &rParamsFile)
 
- Public Member Functions inherited from Identifiable
virtual ~Identifiable ()
 
std::string GetIdentifier () const
 

Protected Member Functions

virtual void OutputCellImmersedBoundaryDivisionRuleParameters (out_stream &rParamsFile)
 

Private Member Functions

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

Friends

class boost::serialization::access
 

Detailed Description

template<unsigned SPACE_DIM>
class AbstractImmersedBoundaryDivisionRule< SPACE_DIM >

An abstract cell division rule for use in immersed boundary simulations.

The purpose of this class is to return a vector parallel to the new boundary between the daughter cells.

Definition at line 55 of file AbstractImmersedBoundaryDivisionRule.hpp.

Constructor & Destructor Documentation

◆ AbstractImmersedBoundaryDivisionRule()

Default constructor.

Definition at line 39 of file AbstractImmersedBoundaryDivisionRule.cpp.

◆ ~AbstractImmersedBoundaryDivisionRule()

Empty destructor.

Definition at line 44 of file AbstractImmersedBoundaryDivisionRule.cpp.

Member Function Documentation

◆ CalculateCellDivisionVector()

template<unsigned SPACE_DIM>
virtual c_vector< double, SPACE_DIM > AbstractImmersedBoundaryDivisionRule< SPACE_DIM >::CalculateCellDivisionVector ( CellPtr  pParentCell,
ImmersedBoundaryCellPopulation< SPACE_DIM > &  rCellPopulation 
)
pure virtual

Return the vector that will divide the two halves of the existing cell to form the boundary between parent and daughter cell.

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

Parameters
pParentCellThe cell to divide
rCellPopulationThe immersed boundary cell population
Returns
the division vector.

Implemented in ShortAxisImmersedBoundaryDivisionRule< SPACE_DIM >.

◆ OutputCellImmersedBoundaryDivisionRuleInfo()

template<unsigned SPACE_DIM>
void AbstractImmersedBoundaryDivisionRule< SPACE_DIM >::OutputCellImmersedBoundaryDivisionRuleInfo ( out_stream &  rParamsFile)

Output the name of the concrete class and call OutputCellImmersedBoundaryDivisionRuleParameters().

Parameters
rParamsFileThe stream of the parameter file

Definition at line 49 of file AbstractImmersedBoundaryDivisionRule.cpp.

◆ OutputCellImmersedBoundaryDivisionRuleParameters()

template<unsigned SPACE_DIM>
void AbstractImmersedBoundaryDivisionRule< SPACE_DIM >::OutputCellImmersedBoundaryDivisionRuleParameters ( out_stream &  rParamsFile)
protectedvirtual

Output any parameters associated with the division rule. Currently empty since this class has no member variables. Should be overridden by any child classes that have parameters.

Parameters
rParamsFileThe stream of the parameter file

Definition at line 60 of file AbstractImmersedBoundaryDivisionRule.cpp.

◆ serialize()

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

Friends And Related Symbol Documentation

◆ boost::serialization::access

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

Definition at line 58 of file AbstractImmersedBoundaryDivisionRule.hpp.


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