Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractOnLatticeCellPopulation.cpp
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#include "AbstractOnLatticeCellPopulation.hpp"
37
38template<unsigned DIM>
40 std::vector<CellPtr>& rCells,
41 const std::vector<unsigned> locationIndices,
42 bool deleteMesh)
43 : AbstractCellPopulation<DIM>(rMesh, rCells, locationIndices),
44 mDeleteMesh(deleteMesh),
45 mUpdateNodesInRandomOrder(true),
46 mIterateRandomlyOverUpdateRuleCollection(false)
47{
48 std::list<CellPtr>::iterator it = this->mCells.begin();
49 for (unsigned i=0; it != this->mCells.end(); ++it, ++i)
50 {
51 unsigned index = locationIndices.empty() ? i : locationIndices[i]; // assume that the ordering matches
53 }
54}
55
56template<unsigned DIM>
58 : AbstractCellPopulation<DIM>(rMesh),
59 mDeleteMesh(true),
60 mUpdateNodesInRandomOrder(true),
61 mIterateRandomlyOverUpdateRuleCollection(false)
62{
63}
64
65template<unsigned DIM>
69
70template<unsigned DIM>
72{
73 return mUpdateNodesInRandomOrder;
74}
75
76template<unsigned DIM>
78{
79 mUpdateNodesInRandomOrder = updateNodesInRandomOrder;
80}
81
82template<unsigned DIM>
84{
85 mIterateRandomlyOverUpdateRuleCollection = iterateRandomly;
86}
87
88template<unsigned DIM>
90{
91 return mIterateRandomlyOverUpdateRuleCollection;
92}
93
94template<unsigned DIM>
96{
97 EXCEPTION("SetNode() cannot be called on a subclass of AbstractOnLatticeCellPopulation.");
98}
99
100template<unsigned DIM>
102{
103 EXCEPTION("Cannot call GetNeighbouringNodeIndices() on a subclass of AbstractOnLatticeCellPopulation, need to go through the PottsMesh instead");
104 std::set<unsigned> neighbouring_node_indices;
105 return neighbouring_node_indices;
106}
107
108template<unsigned DIM>
110{
111 *rParamsFile << "\t\t<UpdateNodesInRandomOrder>" << mUpdateNodesInRandomOrder << "</UpdateNodesInRandomOrder>\n";
112 *rParamsFile << "\t\t<IterateRandomlyOverUpdateRuleCollection>" << mIterateRandomlyOverUpdateRuleCollection << "</IterateRandomlyOverUpdateRuleCollection>\n";
113
114 // Call method on direct parent class
116}
117
118template<unsigned DIM>
123
124template<unsigned DIM>
125const std::vector<boost::shared_ptr<AbstractUpdateRule<DIM> > > AbstractOnLatticeCellPopulation<DIM>::GetUpdateRuleCollection() const
126{
127 return mUpdateRuleCollection;
128}
129
130template<unsigned DIM>
132{
133 mUpdateRuleCollection.clear();
134}
135
136// Explicit instantiation
#define EXCEPTION(message)
virtual void AddCellUsingLocationIndex(unsigned index, CellPtr pCell)
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)=0
void SetUpdateNodesInRandomOrder(bool updateNodesInRandomOrder)
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)
AbstractOnLatticeCellPopulation(AbstractMesh< DIM, DIM > &rMesh)
void SetNode(unsigned index, ChastePoint< DIM > &rNewLocation)
virtual const std::vector< boost::shared_ptr< AbstractUpdateRule< DIM > > > GetUpdateRuleCollection() const
std::set< unsigned > GetNeighbouringNodeIndices(unsigned index)
void SetIterateRandomlyOverUpdateRuleCollection(bool iterateRandomly)