Chaste  Release::2018.1
IsolatedLabelledCellKiller.cpp
1 /*
2 
3 Copyright (c) 2005-2018, 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 "IsolatedLabelledCellKiller.hpp"
37 #include "VertexBasedCellPopulation.hpp"
38 #include "CellLabel.hpp"
39 
40 template<unsigned DIM>
42  : AbstractCellKiller<DIM>(pCellPopulation)
43 {
44  if (dynamic_cast<VertexBasedCellPopulation<DIM>*>(pCellPopulation) == nullptr)
45  {
46  EXCEPTION("IsolatedLabelledCellKiller only works with a VertexBasedCellPopulation.");
47  }
48 }
49 
50 template<unsigned DIM>
52 {
53  MutableVertexMesh<DIM, DIM>& vertex_mesh = static_cast<VertexBasedCellPopulation<DIM>*>(this->mpCellPopulation)->rGetMesh();
54 
55  unsigned num_labelled_cells = this->mpCellPopulation->GetCellPropertyRegistry()->template Get<CellLabel>()->GetCellCount();
56 
57  // If there is more than one labelled cell...
58  if (num_labelled_cells > 1)
59  {
60  // Iterate over cell population
61  for (typename AbstractCellPopulation<DIM>::Iterator cell_iter = this->mpCellPopulation->Begin();
62  cell_iter != this->mpCellPopulation->End();
63  ++cell_iter)
64  {
65  // Only consider cells with the CellLabel property
66  if (cell_iter->template HasCellProperty<CellLabel>())
67  {
68  // Get the element index corresponding to this cell
69  unsigned elem_index = this->mpCellPopulation->GetLocationIndexUsingCell(*cell_iter);
70 
71  // Get the set of neighbouring element indices
72  std::set<unsigned> neighbouring_elem_indices = vertex_mesh.GetNeighbouringElementIndices(elem_index);
73 
74  // Check if any of the corresponding cells have the CellLabel property...
75  unsigned num_labelled_neighbours = 0;
76  for (std::set<unsigned>::iterator elem_iter = neighbouring_elem_indices.begin();
77  elem_iter != neighbouring_elem_indices.end();
78  ++elem_iter)
79  {
80  if (this->mpCellPopulation->GetCellUsingLocationIndex(*elem_iter)->template HasCellProperty<CellLabel>())
81  {
82  num_labelled_neighbours++;
83  }
84  }
85 
86  // ...and if none do, then kill this cell
87  if (num_labelled_neighbours == 0)
88  {
89  cell_iter->Kill();
90  }
91  }
92  }
93  }
94 }
95 
96 template<unsigned DIM>
98 {
99  // There are no member variables, so just call method on direct parent class
101 }
102 
103 // Explicit instantiation
104 template class IsolatedLabelledCellKiller<1>;
105 template class IsolatedLabelledCellKiller<2>;
106 template class IsolatedLabelledCellKiller<3>;
107 
108 // Serialization for Boost >= 1.36
#define EXCEPTION(message)
Definition: Exception.hpp:143
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)
virtual void OutputCellKillerParameters(out_stream &rParamsFile)=0
std::set< unsigned > GetNeighbouringElementIndices(unsigned elementIndex)
Definition: VertexMesh.cpp:783
IsolatedLabelledCellKiller(AbstractCellPopulation< DIM > *pCellPopulation)
void OutputCellKillerParameters(out_stream &rParamsFile)