HeartRegionCode Class Reference

#include <HeartRegionCodes.hpp>

Collaboration diagram for HeartRegionCode:
Collaboration graph
[legend]

List of all members.

Static Public Attributes

static const HeartRegionType TISSUE = 0u
static const HeartRegionType BATH = 1u
static const HeartRegionType LEFT_VENTRICLE_WALL = 2u
static const HeartRegionType RIGHT_VENTRICLE_WALL = 3u
static const HeartRegionType LEFT_SEPTUM = 4u
static const HeartRegionType RIGHT_SEPTUM = 5u
static const HeartRegionType LEFT_VENTRICLE_SURFACE = 6u
static const HeartRegionType RIGHT_VENTRICLE_SURFACE = 7u
static const HeartRegionType UNKNOWN = 8u

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 43 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

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

No instances of this class should be created.

Member Data Documentation

const HeartRegionType HeartRegionCode::BATH = 1u [static]

Bath

Definition at line 49 of file HeartRegionCodes.hpp.

Referenced by BidomainProblem< DIM >::AnalyseMeshForBath(), BidomainWithBathRhsMatrixAssembler< DIM >::ComputeMatrixTerm(), BidomainWithBathAssembler< ELEMENT_DIM, SPACE_DIM >::ComputeMatrixTerm(), BidomainWithBathAssembler< ELEMENT_DIM, SPACE_DIM >::ComputeVectorTerm(), BidomainWithBathMatrixBasedAssembler< ELEMENT_DIM, SPACE_DIM >::ConstructVectorForMatrixBasedRhsAssembly(), AbstractCardiacCellFactory< ELEMENT_DIM, SPACE_DIM >::CreateCardiacCellForNode(), BidomainProblem< DIM >::CreateInitialCondition(), BidomainWithBathAssembler< ELEMENT_DIM, SPACE_DIM >::FinaliseLinearSystem(), and SetCircularTissueIn2dMesh().

const HeartRegionType HeartRegionCode::LEFT_SEPTUM = 4u [static]

Left portion of the septum

Definition at line 55 of file HeartRegionCodes.hpp.

Referenced by StreeterFibreGenerator< SPACE_DIM >::GenerateOrthotropicFibreOrientation(), HeartGeometryInformation< SPACE_DIM >::GetDistanceToEndo(), StreeterFibreGenerator< SPACE_DIM >::GetFibreMaxAngle(), and HeartGeometryInformation< SPACE_DIM >::GetHeartRegion().

const HeartRegionType HeartRegionCode::LEFT_VENTRICLE_SURFACE = 6u [static]

Endocardial surface of the left ventricle

Definition at line 59 of file HeartRegionCodes.hpp.

Referenced by StreeterFibreGenerator< SPACE_DIM >::GenerateOrthotropicFibreOrientation(), HeartGeometryInformation< SPACE_DIM >::GetDistanceToEndo(), and StreeterFibreGenerator< SPACE_DIM >::GetFibreMaxAngle().

const HeartRegionType HeartRegionCode::LEFT_VENTRICLE_WALL = 2u [static]

Left ventricular wall

Definition at line 51 of file HeartRegionCodes.hpp.

Referenced by StreeterFibreGenerator< SPACE_DIM >::GenerateOrthotropicFibreOrientation(), HeartGeometryInformation< SPACE_DIM >::GetDistanceToEndo(), StreeterFibreGenerator< SPACE_DIM >::GetFibreMaxAngle(), and HeartGeometryInformation< SPACE_DIM >::GetHeartRegion().

const HeartRegionType HeartRegionCode::RIGHT_SEPTUM = 5u [static]

Right portion of the septum

Definition at line 57 of file HeartRegionCodes.hpp.

Referenced by StreeterFibreGenerator< SPACE_DIM >::GenerateOrthotropicFibreOrientation(), HeartGeometryInformation< SPACE_DIM >::GetDistanceToEndo(), StreeterFibreGenerator< SPACE_DIM >::GetFibreMaxAngle(), and HeartGeometryInformation< SPACE_DIM >::GetHeartRegion().

const HeartRegionType HeartRegionCode::RIGHT_VENTRICLE_SURFACE = 7u [static]

Endocardial surface of the right ventricle

Definition at line 61 of file HeartRegionCodes.hpp.

Referenced by StreeterFibreGenerator< SPACE_DIM >::GenerateOrthotropicFibreOrientation(), HeartGeometryInformation< SPACE_DIM >::GetDistanceToEndo(), and StreeterFibreGenerator< SPACE_DIM >::GetFibreMaxAngle().

const HeartRegionType HeartRegionCode::RIGHT_VENTRICLE_WALL = 3u [static]

Right ventricular wall

Definition at line 53 of file HeartRegionCodes.hpp.

Referenced by StreeterFibreGenerator< SPACE_DIM >::GenerateOrthotropicFibreOrientation(), HeartGeometryInformation< SPACE_DIM >::GetDistanceToEndo(), StreeterFibreGenerator< SPACE_DIM >::GetFibreMaxAngle(), and HeartGeometryInformation< SPACE_DIM >::GetHeartRegion().

const HeartRegionType HeartRegionCode::TISSUE = 0u [static]

This value is also the default region if none is specified (see Node.cpp and AbstractElement.cpp).

Definition at line 47 of file HeartRegionCodes.hpp.

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

const HeartRegionType HeartRegionCode::UNKNOWN = 8u [static]

Unknown node type (should never occur...)

Definition at line 63 of file HeartRegionCodes.hpp.

Referenced by StreeterFibreGenerator< SPACE_DIM >::GenerateOrthotropicFibreOrientation(), HeartGeometryInformation< SPACE_DIM >::GetDistanceToEndo(), StreeterFibreGenerator< SPACE_DIM >::GetFibreMaxAngle(), and HeartGeometryInformation< SPACE_DIM >::GetHeartRegion().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2