Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
VoronoiVertexMeshGenerator.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, 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
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF 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 <boost/shared_ptr.hpp>
43#include "MutableVertexMesh.hpp"
44#include "Toroidal2dVertexMesh.hpp"
45#include "RandomNumberGenerator.hpp"
46
47#include <boost/version.hpp>
48
49#if BOOST_VERSION >= 105200
50#include "boost/polygon/voronoi.hpp"
51
59{
60 friend class TestVoronoiVertexMeshGenerator;
61
62protected:
63
65 boost::shared_ptr<MutableVertexMesh<2,2> > mpMesh;
66
68 boost::shared_ptr<Toroidal2dVertexMesh > mpTorMesh;
69
71 unsigned mNumElementsX;
72
74 unsigned mNumElementsY;
75
77 unsigned mTotalNumElements;
78
80 unsigned mNumRelaxationSteps;
81
83 unsigned mMaxNumElems;
84
86 int mMaxIntX;
87
89 int mMaxIntY;
90
92 double mElementTargetArea;
93
95 double mMultiplierInX;
96
98 double mMultiplierInY;
99
101 double mSamplingMultiplier;
102
104 double mTol;
105
111 unsigned mMaxExpectedNumSidesPerPolygon;
112
122 std::vector<c_vector<double, 2> > GetInitialPointLocations();
123
129 std::vector<c_vector<double, 2> > GetElementCentroidsFromMesh();
130
141 void CreateVoronoiTessellation(std::vector<c_vector<double, 2> >& rSeedLocations);
142
148 void ValidateInputAndSetMembers();
149
159 void ValidateSeedLocations(std::vector<c_vector<double, 2> >& rSeedLocations);
160
172 bool CheckForCongruentNodes(MutableVertexMesh<2,2>* pMesh, double width, double height);
173
174public:
175
184 VoronoiVertexMeshGenerator(unsigned numElementsX,
185 unsigned numElementsY,
186 unsigned numRelaxationSteps,
187 double elementTargetArea=1.0);
188
193 {
194 }
195
199 virtual ~VoronoiVertexMeshGenerator() = default;
200
205 void GenerateVoronoiMesh();
206
210 virtual boost::shared_ptr<MutableVertexMesh<2,2> > GetMesh();
211
215 virtual boost::shared_ptr<MutableVertexMesh<2,2> > GetMeshAfterReMesh();
216
220 virtual boost::shared_ptr<Toroidal2dVertexMesh> GetToroidalMesh();
221
225 std::vector<double> GetPolygonDistribution();
226
233 double GetAreaCoefficientOfVariation();
234
240 void RefreshSeedsAndRegenerateMesh();
241
247 void SetMaxExpectedNumSidesPerPolygon(unsigned maxExpectedNumSidesPerPolygon);
248
252 unsigned GetMaxExpectedNumSidesPerPolygon();
253};
254
255#endif // BOOST_VERSION >= 105200
256
257#if BOOST_VERSION < 105200
258
264{
265public:
266
271};
272
273#endif // BOOST_VERSION < 105200
274
275#endif /*VORONOIVERTEXMESHGENERATOR_HPP_*/