Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
AbstractContractionCellFactory< DIM > Class Template Referenceabstract

#include <AbstractContractionCellFactory.hpp>

+ Inheritance diagram for AbstractContractionCellFactory< DIM >:
+ Collaboration diagram for AbstractContractionCellFactory< DIM >:

Public Member Functions

virtual AbstractContractionModelCreateContractionCellForElement (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 54 of file AbstractContractionCellFactory.hpp.

Constructor & Destructor Documentation

◆ ~AbstractContractionCellFactory()

template<unsigned DIM>
virtual AbstractContractionCellFactory< DIM >::~AbstractContractionCellFactory ( )
inlinevirtual

Destructor

Definition at line 116 of file AbstractContractionCellFactory.hpp.

Member Function Documentation

◆ CreateContractionCellForElement()

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
pElementPointer 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().

◆ SetMechanicsMesh()

template<unsigned DIM>
void AbstractContractionCellFactory< DIM >::SetMechanicsMesh ( QuadraticMesh< DIM > *  pMesh)
inline

Set the mechanics mesh to be used by this cell factory.

Parameters
pMeshA quadratic (mechanics) mesh.

Definition at line 84 of file AbstractContractionCellFactory.hpp.

References AbstractContractionCellFactory< DIM >::mpMesh.

Referenced by ElectroMechanicsProblemDefinition< DIM >::SetContractionCellFactory().

Friends And Related Symbol Documentation

◆ TestElectroMechanicsProblemDefinition

template<unsigned DIM>
friend class TestElectroMechanicsProblemDefinition
friend

This class tests that the mesh is set correctly

Definition at line 58 of file AbstractContractionCellFactory.hpp.

Member Data Documentation

◆ mpMesh

template<unsigned DIM>
QuadraticMesh<DIM>* AbstractContractionCellFactory< DIM >::mpMesh
protected

The mechanics mesh

Definition at line 62 of file AbstractContractionCellFactory.hpp.

Referenced by AbstractContractionCellFactory< DIM >::SetMechanicsMesh().


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