Chaste  Release::2018.1
HeartRegionCode Class Reference

#include <HeartRegionCodes.hpp>

+ Collaboration diagram for HeartRegionCode:

Static Public Member Functions

static HeartRegionType GetValidTissueId ()
 
static HeartRegionType GetValidBathId ()
 
static bool IsRegionTissue (HeartRegionType regionId)
 
static bool IsRegionBath (HeartRegionType regionId)
 

Private Member Functions

 HeartRegionCode ()
 
 HeartRegionCode (const HeartRegionCode &)
 
HeartRegionCodeoperator= (const HeartRegionCode &)
 

Detailed Description

Codes that can be used to annotate regions of a cardiac mesh.

See Node::GetRegion, Node::SetRegion, AbstractElement::GetUnsignedAttribute, AbstractElement::SetAttribute.

Note: these constants are set explicitly to be of type unsigned, so as to match the above methods. Hence why we use a class instead of an enum - you can't (until C++0x) specify the underlying type of an enum.

Definition at line 52 of file HeartRegionCodes.hpp.

Constructor & Destructor Documentation

HeartRegionCode::HeartRegionCode ( )
private

No instances of this class should be created.

HeartRegionCode::HeartRegionCode ( const HeartRegionCode )
private

No instances of this class should be created.

Member Function Documentation

HeartRegionType HeartRegionCode::GetValidTissueId ( )
static
Returns
a valid tissue identifier

Definition at line 40 of file HeartRegionCodes.cpp.

References HeartConfig::Instance(), and HeartConfig::rGetTissueIdentifiers().

Referenced by BidomainProblem< DIM >::AnalyseMeshForBath().

bool HeartRegionCode::IsRegionTissue ( HeartRegionType  regionId)
static
Returns
For a given region identifier, determines whether it is a tissue identifier
Parameters
regionIdregion identifier

Definition at line 54 of file HeartRegionCodes.cpp.

References HeartConfig::Instance().

Referenced by BidomainProblem< DIM >::AnalyseMeshForBath(), and BathCellFactory< DIM, CELLTYPE >::CreateCardiacCellForTissueNode().

HeartRegionCode& HeartRegionCode::operator= ( const HeartRegionCode )
private

No instances of this class should be created.

Returns
reference by language convention

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