Chaste Release::3.1
Public Member Functions | Protected Member Functions
BoundaryElement< ELEMENT_DIM, SPACE_DIM > Class Template Reference

#include <BoundaryElement.hpp>

Inheritance diagram for BoundaryElement< ELEMENT_DIM, SPACE_DIM >:
Collaboration diagram for BoundaryElement< ELEMENT_DIM, SPACE_DIM >:

List of all members.

Public Member Functions

 BoundaryElement (unsigned index, const std::vector< Node< SPACE_DIM > * > &rNodes)
 BoundaryElement (unsigned index, Node< SPACE_DIM > *pNode)
void RegisterWithNodes ()
void ResetIndex (unsigned index)
void MarkAsDeleted ()
void UpdateNode (const unsigned &rIndex, Node< SPACE_DIM > *pNode)

Protected Member Functions

 BoundaryElement ()

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
class BoundaryElement< ELEMENT_DIM, SPACE_DIM >

Concrete boundary element class which inherits from AbstractTetrahedralElement.

A 'face' in Chaste is shorthand for BoundaryElement<2,3> i.e. a 2D boundary surface element on the edge of a 3D mesh.

Definition at line 52 of file BoundaryElement.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
BoundaryElement< ELEMENT_DIM, SPACE_DIM >::BoundaryElement ( ) [protected]

(Protected) constructor that does take in nodes. Only available to subclasses. Calling code should use one of the other constructors.

Definition at line 46 of file BoundaryElement.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
BoundaryElement< ELEMENT_DIM, SPACE_DIM >::BoundaryElement ( unsigned  index,
const std::vector< Node< SPACE_DIM > * > &  rNodes 
)

Constructor which takes in a vector of nodes.

Parameters:
indexthe index of the element in the mesh
rNodesthe nodes owned by the element

Definition at line 53 of file BoundaryElement.cpp.

References BoundaryElement< ELEMENT_DIM, SPACE_DIM >::RegisterWithNodes().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
BoundaryElement< ELEMENT_DIM, SPACE_DIM >::BoundaryElement ( unsigned  index,
Node< SPACE_DIM > *  pNode 
)

Create a new boundary element from a Node.

The element has ELEMENT_DIM=0 and SPACE_DIM identical to that of the node from which it is constructed.

Parameters:
indexthe index of the element in the mesh
pNodea pointer to the node

Definition at line 60 of file BoundaryElement.cpp.

References AbstractElement< ELEMENT_DIM, SPACE_DIM >::mNodes, and BoundaryElement< ELEMENT_DIM, SPACE_DIM >::RegisterWithNodes().

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void BoundaryElement< ELEMENT_DIM, SPACE_DIM >::MarkAsDeleted ( ) [virtual]

Mark the element as having been removed from the mesh. Also notify nodes in the element that it has been removed.

Implements AbstractElement< ELEMENT_DIM, SPACE_DIM >.

Definition at line 91 of file BoundaryElement.cpp.

Referenced by Cylindrical2dMesh::ReconstructCylindricalMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void BoundaryElement< ELEMENT_DIM, SPACE_DIM >::RegisterWithNodes ( ) [virtual]

Inform all nodes forming this element that they are in this element.

Implements AbstractElement< ELEMENT_DIM, SPACE_DIM >.

Definition at line 71 of file BoundaryElement.cpp.

Referenced by BoundaryElement< ELEMENT_DIM, SPACE_DIM >::BoundaryElement(), AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM >::ConstructFromMesh(), and Cylindrical2dMesh::ReMesh().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void BoundaryElement< ELEMENT_DIM, SPACE_DIM >::ResetIndex ( unsigned  index)

Reset the index of this boundary element in the mesh.

Parameters:
indexthe new index of the boundary element

Definition at line 80 of file BoundaryElement.cpp.

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
void BoundaryElement< ELEMENT_DIM, SPACE_DIM >::UpdateNode ( const unsigned &  rIndex,
Node< SPACE_DIM > *  pNode 
) [virtual]

Update node at the given index.

Parameters:
rIndexis an local index to which node to change
pNodeis a pointer to the replacement node

Implements AbstractElement< ELEMENT_DIM, SPACE_DIM >.

Definition at line 103 of file BoundaryElement.cpp.

References Node< SPACE_DIM >::AddBoundaryElement().

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