Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractCardiacCellFactory.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36
37#ifndef ABSTRACTCARDIACCELLFACTORY_HPP_
38#define ABSTRACTCARDIACCELLFACTORY_HPP_
39
40#include <boost/shared_ptr.hpp>
41
42#include "AbstractCardiacCellInterface.hpp"
43#include "AbstractTetrahedralMesh.hpp"
44#include "AbstractIvpOdeSolver.hpp"
45#include "EulerIvpOdeSolver.hpp"
46#include "HeartGeometryInformation.hpp"
47#include "HeartRegionCodes.hpp"
48#include "ZeroStimulus.hpp"
49
65#ifdef DOXYGEN_CHASTE_ISSUE_199 // See https://github.com/Chaste/Chaste/issues/199
66template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
67#else
68template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
69#endif
71{
72private:
77
83
84protected:
86 boost::shared_ptr<ZeroStimulus> mpZeroStimulus;
88 boost::shared_ptr<AbstractIvpOdeSolver> mpSolver;
89
90public:
101
109
118 virtual void FinaliseCellCreation(std::vector< AbstractCardiacCellInterface* >* pCellsDistributed,
119 unsigned lo, unsigned hi);
120
125 virtual void FillInCellularTransmuralAreas();
126
130 virtual unsigned GetNumberOfCells();
131
137 AbstractCardiacCellFactory(boost::shared_ptr<AbstractIvpOdeSolver> pSolver = boost::shared_ptr<AbstractIvpOdeSolver>(new EulerIvpOdeSolver));
142
147
152
159
164};
165
166#endif /*ABSTRACTCARDIACCELLFACTORY_HPP_*/
virtual AbstractCardiacCellInterface * CreateCardiacCellForNode(Node< SPACE_DIM > *pNode)
virtual void SetMesh(AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > *pMesh)
AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * GetMesh()
virtual void FinaliseCellCreation(std::vector< AbstractCardiacCellInterface * > *pCellsDistributed, unsigned lo, unsigned hi)
void SetHeartGeometryInformation(HeartGeometryInformation< SPACE_DIM > *pHeartGeometryInformation)
boost::shared_ptr< AbstractIvpOdeSolver > mpSolver
HeartGeometryInformation< SPACE_DIM > * mpHeartGeometryInformation
AbstractTetrahedralMesh< ELEMENT_DIM, SPACE_DIM > * mpMesh
boost::shared_ptr< ZeroStimulus > mpZeroStimulus
virtual AbstractCardiacCellInterface * CreateCardiacCellForTissueNode(Node< SPACE_DIM > *pNode)=0
HeartGeometryInformation< SPACE_DIM > * GetHeartGeometryInformation()
Definition Node.hpp:59