Chaste  Release::3.4
AbstractOnLatticeCellPopulation.cpp
1 /*
2 
3 Copyright (c) 2005-2016, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, 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 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #include "AbstractOnLatticeCellPopulation.hpp"
37 
38 template<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 
56 template<unsigned DIM>
58  : AbstractCellPopulation<DIM>(rMesh),
59  mDeleteMesh(true),
60  mUpdateNodesInRandomOrder(true),
61  mIterateRandomlyOverUpdateRuleCollection(false)
62 {
63 }
64 
65 template<unsigned DIM>
67 {
68 }
69 
70 template<unsigned DIM>
72 {
73  return mUpdateNodesInRandomOrder;
74 }
75 
76 template<unsigned DIM>
78 {
79  mUpdateNodesInRandomOrder = updateNodesInRandomOrder;
80 }
81 
82 template<unsigned DIM>
84 {
85  mIterateRandomlyOverUpdateRuleCollection = iterateRandomly;
86 }
87 
88 template<unsigned DIM>
90 {
91  return mIterateRandomlyOverUpdateRuleCollection;
92 }
93 
94 template<unsigned DIM>
95 void AbstractOnLatticeCellPopulation<DIM>::SetNode(unsigned nodeIndex, ChastePoint<DIM>& rNewLocation)
96 {
97  EXCEPTION("SetNode() cannot be called on a subclass of AbstractOnLatticeCellPopulation.");
98 }
99 
100 template<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 
108 template<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 
119 // Explicit instantiation
121 
void SetUpdateNodesInRandomOrder(bool updateNodesInRandomOrder)
void SetIterateRandomlyOverUpdateRuleCollection(bool iterateRandomly)
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)=0
#define EXCEPTION(message)
Definition: Exception.hpp:143
std::set< unsigned > GetNeighbouringNodeIndices(unsigned index)
void SetNode(unsigned index, ChastePoint< DIM > &rNewLocation)
virtual void OutputCellPopulationParameters(out_stream &rParamsFile)
AbstractOnLatticeCellPopulation(AbstractMesh< DIM, DIM > &rMesh)
virtual void AddCellUsingLocationIndex(unsigned index, CellPtr pCell)