Chaste  Release::2017.1
RandomDirectionCentreBasedDivisionRule.cpp
1 /*
2 
3 Copyright (c) 2005-2017, 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 "RandomDirectionCentreBasedDivisionRule.hpp"
37 #include "RandomNumberGenerator.hpp"
38 
39 template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>
40 std::pair<c_vector<double, SPACE_DIM>, c_vector<double, SPACE_DIM> > RandomDirectionCentreBasedDivisionRule<ELEMENT_DIM, SPACE_DIM>::CalculateCellDivisionVector(
41  CellPtr pParentCell,
43 {
44  // Get separation parameter
45  double separation = rCellPopulation.GetMeinekeDivisionSeparation();
46 
47  // Make a random direction vector of the required length
48  c_vector<double, SPACE_DIM> random_vector;
49 
50  /*
51  * Pick a random direction and move the parent cell backwards by 0.5*separation
52  * in that direction and return the position of the daughter cell 0.5*separation
53  * forwards in that direction.
54  */
55  switch (SPACE_DIM)
56  {
57  case 1:
58  {
59  double random_direction = -1.0 + 2.0*(RandomNumberGenerator::Instance()->ranf() < 0.5);
60 
61  random_vector(0) = 0.5*separation*random_direction;
62  break;
63  }
64  case 2:
65  {
66  double random_angle = 2.0*M_PI*RandomNumberGenerator::Instance()->ranf();
67 
68  random_vector(0) = 0.5*separation*cos(random_angle);
69  random_vector(1) = 0.5*separation*sin(random_angle);
70  break;
71  }
72  case 3:
73  {
74  /*
75  * Note that to pick a random point on the surface of a sphere, it is incorrect
76  * to select spherical coordinates from uniform distributions on [0, 2*pi) and
77  * [0, pi) respectively, since points picked in this way will be 'bunched' near
78  * the poles. See #2230.
79  */
80  double u = RandomNumberGenerator::Instance()->ranf();
81  double v = RandomNumberGenerator::Instance()->ranf();
82 
83  double random_azimuth_angle = 2*M_PI*u;
84  double random_zenith_angle = std::acos(2*v - 1);
85 
86  random_vector(0) = 0.5*separation*cos(random_azimuth_angle)*sin(random_zenith_angle);
87  random_vector(1) = 0.5*separation*sin(random_azimuth_angle)*sin(random_zenith_angle);
88  random_vector(2) = 0.5*separation*cos(random_zenith_angle);
89  break;
90  }
91  default:
92  // This can't happen
94  }
95 
96  c_vector<double, SPACE_DIM> parent_position = rCellPopulation.GetLocationOfCellCentre(pParentCell) - random_vector;
97  c_vector<double, SPACE_DIM> daughter_position = parent_position + random_vector;
98 
99  std::pair<c_vector<double, SPACE_DIM>, c_vector<double, SPACE_DIM> > positions(parent_position, daughter_position);
100 
101  return positions;
102 }
103 
104 // Explicit instantiation
111 
112 // Serialization for Boost >= 1.36
#define NEVER_REACHED
Definition: Exception.hpp:206
virtual std::pair< c_vector< double, SPACE_DIM >, c_vector< double, SPACE_DIM > > CalculateCellDivisionVector(CellPtr pParentCell, AbstractCentreBasedCellPopulation< ELEMENT_DIM, SPACE_DIM > &rCellPopulation)
static RandomNumberGenerator * Instance()
#define EXPORT_TEMPLATE_CLASS_ALL_DIMS(CLASS)
c_vector< double, SPACE_DIM > GetLocationOfCellCentre(CellPtr pCell)