Chaste  Release::2018.1
VoronoiVertexMeshGenerator.hpp
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 #ifndef VORONOIVERTEXMESHGENERATOR_HPP_
37 #define VORONOIVERTEXMESHGENERATOR_HPP_
38 
39 #include <cmath>
40 #include <vector>
41 
42 #include "MutableVertexMesh.hpp"
43 #include "Toroidal2dVertexMesh.hpp"
44 #include "RandomNumberGenerator.hpp"
45 
46 #include <boost/version.hpp>
47 
48 #if BOOST_VERSION >= 105200
49 #include "boost/polygon/voronoi.hpp"
50 
58 {
59  friend class TestVoronoiVertexMeshGenerator;
60 
61 protected:
62 
64  MutableVertexMesh<2,2>* mpMesh;
65 
67  Toroidal2dVertexMesh* mpTorMesh;
68 
70  unsigned mNumElementsX;
71 
73  unsigned mNumElementsY;
74 
76  unsigned mTotalNumElements;
77 
79  unsigned mNumRelaxationSteps;
80 
82  unsigned mMaxNumElems;
83 
85  int mMaxIntX;
86 
88  int mMaxIntY;
89 
91  double mElementTargetArea;
92 
94  double mMultiplierInX;
95 
97  double mMultiplierInY;
98 
100  double mSamplingMultiplier;
101 
103  double mTol;
104 
110  unsigned mMaxExpectedNumSidesPerPolygon;
111 
121  std::vector<c_vector<double, 2> > GetInitialPointLocations();
122 
128  std::vector<c_vector<double, 2> > GetElementCentroidsFromMesh();
129 
140  void CreateVoronoiTessellation(std::vector<c_vector<double, 2> >& rSeedLocations);
141 
147  void ValidateInputAndSetMembers();
148 
158  void ValidateSeedLocations(std::vector<c_vector<double, 2> >& rSeedLocations);
159 
171  bool CheckForCongruentNodes(MutableVertexMesh<2,2>* pMesh, double width, double height);
172 
173 public:
174 
183  VoronoiVertexMeshGenerator(unsigned numElementsX,
184  unsigned numElementsY,
185  unsigned numRelaxationSteps,
186  double elementTargetArea=1.0);
187 
192  {
193  }
194 
198  virtual ~VoronoiVertexMeshGenerator();
199 
204  void GenerateVoronoiMesh();
205 
209  virtual MutableVertexMesh<2,2>* GetMesh();
210 
214  virtual MutableVertexMesh<2,2>* GetMeshAfterReMesh();
215 
219  virtual Toroidal2dVertexMesh* GetToroidalMesh();
220 
224  std::vector<double> GetPolygonDistribution();
225 
232  double GetAreaCoefficientOfVariation();
233 
239  void RefreshSeedsAndRegenerateMesh();
240 
246  void SetMaxExpectedNumSidesPerPolygon(unsigned maxExpectedNumSidesPerPolygon);
247 
251  unsigned GetMaxExpectedNumSidesPerPolygon();
252 };
253 
254 #endif // BOOST_VERSION >= 105200
255 
256 #if BOOST_VERSION < 105200
257 
263 {
264 public:
265 
270 };
271 
272 #endif // BOOST_VERSION < 105200
273 
274 #endif /*VORONOIVERTEXMESHGENERATOR_HPP_*/