HeartRegionCode Class Reference

#include <HeartRegionCodes.hpp>

List of all members.

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 &)
HeartRegionCode &	operator= (const HeartRegionCode &)

---

Detailed Description

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

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

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 45 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]

Convenience method that returns a valid tissue identifier

Definition at line 33 of file HeartRegionCodes.cpp.

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

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

HeartRegionType HeartRegionCode::GetValidBathId

(

)

[static]

Convenience method that returns a valid bath identifier

Definition at line 40 of file HeartRegionCodes.cpp.

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

Referenced by BidomainProblem< DIM >::AnalyseMeshForBath(), and SetCircularTissueIn2dMesh().

bool HeartRegionCode::IsRegionTissue

(

HeartRegionType

regionId

)

[static]

For a given region identifier, determines whether it is a tissue identifier

Parameters:

regionId

region identifier

Definition at line 47 of file HeartRegionCodes.cpp.

References HeartConfig::Instance().

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

bool HeartRegionCode::IsRegionBath

(

HeartRegionType

regionId

)

[static]

For a given region identifier, determines whether it is a bath identifier

Parameters:

regionId

region identifier

Definition at line 52 of file HeartRegionCodes.cpp.

References HeartConfig::Instance().

Referenced by BidomainProblem< DIM >::AnalyseMeshForBath(), BidomainWithBathAssembler< ELEMENT_DIM, SPACE_DIM >::ComputeMatrixTerm(), BidomainMassMatrixAssembler< DIM >::ComputeMatrixTerm(), AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >::CreateCardiacCellForNode(), BidomainProblem< DIM >::CreateInitialCondition(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::FinaliseForBath(), HeartConfig::GetBathConductivity(), AbstractBidomainSolver< ELEMENT_DIM, SPACE_DIM >::InitialiseForSolve(), and MatrixBasedBidomainSolver< ELEMENT_DIM, SPACE_DIM >::SetupLinearSystem().

HeartRegionCode& HeartRegionCode::operator=

(

const HeartRegionCode &

)

[private]

No instances of this class should be created.

---

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

• heart/src/problem/HeartRegionCodes.hpp
• heart/src/problem/HeartRegionCodes.cpp