Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractOnLatticeCellPopulation.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 ABSTRACTONLATTICECELLPOPULATION_HPP_
37#define ABSTRACTONLATTICECELLPOPULATION_HPP_
38
39#include "AbstractCellPopulation.hpp"
40#include "AbstractUpdateRule.hpp"
41
45template<unsigned DIM>
47{
48private:
49
58 template<class Archive>
59 void serialize(Archive & archive, const unsigned int version)
60 {
61 archive & boost::serialization::base_object<AbstractCellPopulation<DIM> >(*this);
62 archive & mUpdateRuleCollection;
65 }
66
67protected:
68
73 std::vector<boost::shared_ptr<AbstractUpdateRule<DIM> > > mUpdateRuleCollection;
74
80
86
92
99
100public:
101
112 std::vector<CellPtr>& rCells,
113 const std::vector<unsigned> locationIndices=std::vector<unsigned>(),
114 bool deleteMesh=false);
115
120
129 virtual void UpdateCellLocations(double dt)=0;
130
137
143 void SetUpdateNodesInRandomOrder(bool updateNodesInRandomOrder);
144
150 void SetIterateRandomlyOverUpdateRuleCollection(bool iterateRandomly);
151
156
166 void SetNode(unsigned index, ChastePoint<DIM>& rNewLocation);
167
177 std::set<unsigned> GetNeighbouringNodeIndices(unsigned index);
178
184 virtual void OutputCellPopulationParameters(out_stream& rParamsFile);
185
196 virtual double GetDefaultTimeStep();
197
206 virtual void AddUpdateRule(boost::shared_ptr<AbstractUpdateRule<DIM> > pUpdateRule)=0;
207
211 virtual void RemoveAllUpdateRules();
212
218 virtual const std::vector<boost::shared_ptr<AbstractUpdateRule<DIM> > > GetUpdateRuleCollection() const;
219};
220
221#endif /*ABSTRACTONLATTICECELLPOPULATION_HPP_*/
void SetUpdateNodesInRandomOrder(bool updateNodesInRandomOrder)
std::vector< boost::shared_ptr< AbstractUpdateRule< DIM > > > mUpdateRuleCollection
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)
void SetNode(unsigned index, ChastePoint< DIM > &rNewLocation)
void serialize(Archive &archive, const unsigned int version)
virtual const std::vector< boost::shared_ptr< AbstractUpdateRule< DIM > > > GetUpdateRuleCollection() const
friend class boost::serialization::access
std::set< unsigned > GetNeighbouringNodeIndices(unsigned index)
void SetIterateRandomlyOverUpdateRuleCollection(bool iterateRandomly)
virtual void UpdateCellLocations(double dt)=0
virtual void AddUpdateRule(boost::shared_ptr< AbstractUpdateRule< DIM > > pUpdateRule)=0