Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
AbstractOffLatticeCellPopulation.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#ifndef ABSTRACTOFFLATTICECELLPOPULATION_HPP_
37#define ABSTRACTOFFLATTICECELLPOPULATION_HPP_
38
39#include "AbstractCellPopulation.hpp"
40
48#ifdef DOXYGEN_CHASTE_ISSUE_199 // See https://github.com/Chaste/Chaste/issues/199
49template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
50#else
51template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
52#endif
53class AbstractOffLatticeCellPopulation : public AbstractCellPopulation<ELEMENT_DIM,SPACE_DIM>
54{
55private:
56
65 template<class Archive>
66 void serialize(Archive & archive, const unsigned int version)
67 {
68 archive & boost::serialization::base_object<AbstractCellPopulation<ELEMENT_DIM, SPACE_DIM> >(*this);
69 archive & mDampingConstantNormal;
70 archive & mDampingConstantMutant;
72 }
73
74protected:
82
87
94
101
102public:
103
112 std::vector<CellPtr>& rCells,
113 const std::vector<unsigned> locationIndices=std::vector<unsigned>());
114
124 virtual unsigned AddNode(Node<SPACE_DIM>* pNewNode)=0;
125
135 virtual void SetNode(unsigned nodeIndex, ChastePoint<SPACE_DIM>& rNewLocation)=0;
136
149 virtual void UpdateNodeLocations(double dt);
150
163 virtual void CheckForStepSizeException(unsigned nodeIndex, c_vector<double,SPACE_DIM>& rDisplacement, double dt)=0;
164
174 virtual double GetDampingConstant(unsigned nodeIndex)=0;
175
181 void SetDampingConstantNormal(double dampingConstantNormal);
182
188 void SetDampingConstantMutant(double dampingConstantMutant);
189
195 void SetAbsoluteMovementThreshold(double absoluteMovementThreshold);
196
201
206
211
217 virtual void OutputCellPopulationParameters(out_stream& rParamsFile);
218};
219
220#endif /*ABSTRACTOFFLATTICECELLPOPULATION_HPP_*/
void SetDampingConstantMutant(double dampingConstantMutant)
virtual unsigned AddNode(Node< SPACE_DIM > *pNewNode)=0
virtual void CheckForStepSizeException(unsigned nodeIndex, c_vector< double, SPACE_DIM > &rDisplacement, double dt)=0
virtual void SetNode(unsigned nodeIndex, ChastePoint< SPACE_DIM > &rNewLocation)=0
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)
virtual double GetDampingConstant(unsigned nodeIndex)=0
void serialize(Archive &archive, const unsigned int version)
void SetAbsoluteMovementThreshold(double absoluteMovementThreshold)
void SetDampingConstantNormal(double dampingConstantNormal)
Definition Node.hpp:59