Chaste  Release::2018.1
SurfaceAreaConstraintPottsUpdateRule.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 "SurfaceAreaConstraintPottsUpdateRule.hpp"
37 
38 template<unsigned DIM>
40  : AbstractPottsUpdateRule<DIM>(),
41  mDeformationEnergyParameter(0.5), // Educated guess
42  mMatureCellTargetSurfaceArea(16.0) // Defaults to a 4*4 cell size
43 {
45 }
46 
47 template<unsigned DIM>
49 {
50 }
51 
52 template<unsigned DIM>
54  unsigned targetNodeIndex,
55  PottsBasedCellPopulation<DIM>& rCellPopulation)
56 {
57  double delta_H = 0.0;
58 
59  // This method only works in 2D and 3D at present
60  assert(DIM == 2 || DIM == 3); // LCOV_EXCL_LINE
61 
62  std::set<unsigned> containing_elements = rCellPopulation.GetNode(currentNodeIndex)->rGetContainingElementIndices();
63  std::set<unsigned> new_location_containing_elements = rCellPopulation.GetNode(targetNodeIndex)->rGetContainingElementIndices();
64 
65  bool current_node_contained = !containing_elements.empty();
66  bool target_node_contained = !new_location_containing_elements.empty();
67 
68  // Every node must each be in at most one element
69  assert(new_location_containing_elements.size() < 2);
70 
71  if (!current_node_contained && !target_node_contained)
72  {
73  EXCEPTION("At least one of the current node or target node must be in an element.");
74  }
75 
76  if (current_node_contained && target_node_contained)
77  {
78  if (*(new_location_containing_elements.begin()) == *(containing_elements.begin()))
79  {
80  EXCEPTION("The current node and target node must not be in the same element.");
81  }
82  }
83 
84  // Iterate over nodes neighbouring the target node to work out the change in surface area
85  unsigned neighbours_in_same_element_as_current_node = 0;
86  unsigned neighbours_in_same_element_as_target_node = 0;
87  std::set<unsigned> target_neighbouring_node_indices = rCellPopulation.rGetMesh().GetVonNeumannNeighbouringNodeIndices(targetNodeIndex);
88  for (std::set<unsigned>::iterator iter = target_neighbouring_node_indices.begin();
89  iter != target_neighbouring_node_indices.end();
90  ++iter)
91  {
92  std::set<unsigned> neighbouring_node_containing_elements = rCellPopulation.rGetMesh().GetNode(*iter)->rGetContainingElementIndices();
93 
94  // Every node must each be in at most one element
95  assert(neighbouring_node_containing_elements.size() < 2);
96 
97  bool neighbouring_node_contained = !neighbouring_node_containing_elements.empty();
98 
99  if (neighbouring_node_contained && target_node_contained)
100  {
101  unsigned neighbour_element = (*neighbouring_node_containing_elements.begin());
102  unsigned target_element = (*new_location_containing_elements.begin());
103  if (target_element == neighbour_element)
104  {
105  neighbours_in_same_element_as_target_node++;
106  }
107  }
108  if (neighbouring_node_contained && current_node_contained)
109  {
110  unsigned neighbour_element = (*neighbouring_node_containing_elements.begin());
111  unsigned current_element = (*containing_elements.begin());
112  if (current_element == neighbour_element)
113  {
114  neighbours_in_same_element_as_current_node++;
115  }
116  }
117  }
118 
119  if (DIM == 2)
120  {
121  assert(neighbours_in_same_element_as_current_node<5);
122  assert(neighbours_in_same_element_as_target_node<5);
123 
124  double change_in_surface_area[5] = {4,2,0,-2,-4};
125 
126  if (current_node_contained) // current node is in an element
127  {
128  unsigned current_element = (*containing_elements.begin());
129  double current_surface_area = rCellPopulation.rGetMesh().GetSurfaceAreaOfElement(current_element);
130  double current_surface_area_difference = current_surface_area - mMatureCellTargetSurfaceArea;
131  double current_surface_area_difference_after_switch = current_surface_area_difference + change_in_surface_area[neighbours_in_same_element_as_current_node];
132 
133  delta_H += mDeformationEnergyParameter*(current_surface_area_difference_after_switch*current_surface_area_difference_after_switch - current_surface_area_difference*current_surface_area_difference);
134  }
135  if (target_node_contained) // target node is in an element
136  {
137  unsigned target_element = (*new_location_containing_elements.begin());
138  double target_surface_area = rCellPopulation.rGetMesh().GetSurfaceAreaOfElement(target_element);
139  double target_surface_area_difference = target_surface_area - mMatureCellTargetSurfaceArea;
140  double target_surface_area_difference_after_switch = target_surface_area_difference - change_in_surface_area[neighbours_in_same_element_as_target_node];
141 
142  delta_H += mDeformationEnergyParameter*(target_surface_area_difference_after_switch*target_surface_area_difference_after_switch - target_surface_area_difference*target_surface_area_difference);
143  }
144  }
145  else if (DIM==3)
146  {
147  assert(neighbours_in_same_element_as_current_node < 7);
148  assert(neighbours_in_same_element_as_target_node < 7);
149 
150  double change_in_surface_area[7] = {6,4,2,0,-2,-4,-6};
151 
152  if (current_node_contained) // current node is in an element
153  {
154  unsigned current_element = (*containing_elements.begin());
155  double current_surface_area = rCellPopulation.rGetMesh().GetSurfaceAreaOfElement(current_element);
156  double current_surface_area_difference = current_surface_area - mMatureCellTargetSurfaceArea;
157  double current_surface_area_difference_after_switch = current_surface_area_difference + change_in_surface_area[neighbours_in_same_element_as_current_node];
158 
159  delta_H += mDeformationEnergyParameter*(current_surface_area_difference_after_switch*current_surface_area_difference_after_switch - current_surface_area_difference*current_surface_area_difference);
160  }
161  if (target_node_contained) // target node is in an element
162  {
163  unsigned target_element = (*new_location_containing_elements.begin());
164  double target_surface_area = rCellPopulation.rGetMesh().GetSurfaceAreaOfElement(target_element);
165  double target_surface_area_difference = target_surface_area - mMatureCellTargetSurfaceArea;
166  double target_surface_area_difference_after_switch = target_surface_area_difference - change_in_surface_area[neighbours_in_same_element_as_target_node];
167 
168  delta_H += mDeformationEnergyParameter*(target_surface_area_difference_after_switch*target_surface_area_difference_after_switch - target_surface_area_difference*target_surface_area_difference);
169  }
170  }
171 
172  return delta_H;
173 }
174 
175 template<unsigned DIM>
177 {
178  return mDeformationEnergyParameter;
179 }
180 
181 template<unsigned DIM>
183 {
184  mDeformationEnergyParameter = deformationEnergyParameter;
185 }
186 
187 template<unsigned DIM>
189 {
190  return mMatureCellTargetSurfaceArea;
191 }
192 
193 template<unsigned DIM>
195 {
196  assert(matureCellTargetSurfaceArea >= 0.0);
197  mMatureCellTargetSurfaceArea = matureCellTargetSurfaceArea;
198 }
199 
200 template<unsigned DIM>
202 {
203  *rParamsFile << "\t\t\t<DeformationEnergyParameter>" << mDeformationEnergyParameter << "</DeformationEnergyParameter>\n";
204  *rParamsFile << "\t\t\t<MatureCellTargetSurfaceArea>" << mMatureCellTargetSurfaceArea << "</MatureCellTargetSurfaceArea>\n";
205 
206  // Call method on direct parent class
208 }
209 
210 // Explicit instantiation
214 
215 // Serialization for Boost >= 1.36
virtual void OutputUpdateRuleParameters(out_stream &rParamsFile)
Node< DIM > * GetNode(unsigned index)
#define EXCEPTION(message)
Definition: Exception.hpp:143
double EvaluateHamiltonianContribution(unsigned currentNodeIndex, unsigned targetNodeIndex, PottsBasedCellPopulation< DIM > &rCellPopulation)
void SetMatureCellTargetSurfaceArea(double matureCellTargetSurfaceArea)
void SetDeformationEnergyParameter(double deformationEnergyParameter)
#define EXPORT_TEMPLATE_CLASS_SAME_DIMS(CLASS)