Chaste  Build::
MappableGridGenerator.hpp
1 /*
2 
3 Copyright (c) 2005-2016, 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 MAPPABLEGRIDGENERATOR_HPP_
37 #define MAPPABLEGRIDGENERATOR_HPP_
38 
39 #include "SmartPointers.hpp"
40 #include "Part.hpp"
41 
47 {
51  units::quantity<unit::length> mReferenceLength;
52 
53 public:
58 
63 
71  boost::shared_ptr<Part<3> > GeneratePlane(unsigned numX, unsigned numY, bool withEndCaps = true);
72 
84  boost::shared_ptr<Part<3> > GenerateCylinder(double cylinderRadius,
85  double cylinderThickness,
86  double cylinderHeight,
87  unsigned numX,
88  unsigned numY,
89  double cylinderAngle = 2.0 * M_PI);
90 
102  boost::shared_ptr<Part<3> > GenerateHemisphere(double sphereRadius,
103  double sphereThickness,
104  unsigned numX,
105  unsigned numY,
106  double sphereAzimuthAngle = 2.0 * M_PI,
107  double spherePolarAngle = 0.5 * M_PI);
108 };
109 
110 #endif /*MAPPABLEGRIDGENERATOR_HPP_*/
boost::shared_ptr< Part< 3 > > GenerateCylinder(double cylinderRadius, double cylinderThickness, double cylinderHeight, unsigned numX, unsigned numY, double cylinderAngle=2.0 *M_PI)
boost::shared_ptr< Part< 3 > > GenerateHemisphere(double sphereRadius, double sphereThickness, unsigned numX, unsigned numY, double sphereAzimuthAngle=2.0 *M_PI, double spherePolarAngle=0.5 *M_PI)
boost::shared_ptr< Part< 3 > > GeneratePlane(unsigned numX, unsigned numY, bool withEndCaps=true)
units::quantity< unit::length > mReferenceLength