AbstractContractionCellFactory< DIM > Class Template Reference

#include <AbstractContractionCellFactory.hpp>

Inherited by LabelBasedContractionCellFactory< DIM >.

Collaboration diagram for AbstractContractionCellFactory< DIM >:

Public Member Functions
virtual AbstractContractionModel *	CreateContractionCellForElement (Element< DIM, DIM > *pElement)=0
void	SetMechanicsMesh (QuadraticMesh< DIM > *pMesh)
virtual	~AbstractContractionCellFactory ()
Protected Attributes
QuadraticMesh< DIM > *	mpMesh
Friends
class	TestElectroMechanicsProblemDefinition

Detailed Description

template<unsigned DIM>
class AbstractContractionCellFactory< DIM >

A factory to ease creating contraction cell models for use in a electro-mechanics simulations.

The user should implement their own concrete class, in particular implementing CreateContractionCellForElement(Element*), which should return the contraction model corresponding to a given element. The user should also implement GetNumberOfCells() if this isn't equal to the number of nodes. FinaliseCellCreation() can be used to (eg) add stimuli to certain cells after they have been created.

DIM is the dimension of the quadratic mesh (element dimension == space dimension for mechanics at present).

Definition at line 57 of file AbstractContractionCellFactory.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>

virtual AbstractContractionCellFactory< DIM >::~AbstractContractionCellFactory ( ) [inline, virtual]

Destructor

Definition at line 119 of file AbstractContractionCellFactory.hpp.

Member Function Documentation

template<unsigned DIM>

virtual AbstractContractionModel* AbstractContractionCellFactory< DIM >::CreateContractionCellForElement ( Element< DIM, DIM > * pElement ) [pure virtual]

Returns:: a newly created contraction model for the given quadrature point.

Note that there is no vector of all the quadrature points of the mesh; the quad point index is the index that would be obtained by looping over elements and then looping over quad points.

Parameters:

pElement

Pointer to element. It is assumed that all the quad points in a given element will be assigned the same kind of contraction cell.

Implemented in LabelBasedContractionCellFactory< DIM >.

Referenced by AbstractCardiacMechanicsSolver< ELASTICITY_SOLVER, DIM >::Initialise().

template<unsigned DIM>

void AbstractContractionCellFactory< DIM >::SetMechanicsMesh ( QuadraticMesh< DIM > * pMesh ) [inline]