MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HopperInsertionBoundary.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 
26 #ifndef BOUNDARIES_HOPPERINSERTIONBOUNDARY_H
27 #define BOUNDARIES_HOPPERINSERTIONBOUNDARY_H
28 
29 #include "InsertionBoundary.h"
30 
31 class BaseParticle;
32 
33 class RNG;
34 
49 {
50 public:
51 
56 
61 
65  HopperInsertionBoundary* copy() const override;
66 
70  void
71  set(BaseParticle* particleToCopy, unsigned int maxFailed, double yMin, double yMax, double radMin, double radMax,
72  double chuteAngle, double fixedParticleRadius, bool isHopperCentred_, int hopperDim, double hopperAngle,
73  double hopperLength, double hopperExitLength,
74  double hopperHeight, double lift, double fillPercent);
75 
79  void placeParticle(BaseParticle* p, RNG& random) override;
80 
84  void read(std::istream& is) override;
85 
90  void oldRead(std::istream& is);
91 
95  void write(std::ostream& os) const override;
96 
100  std::string getName() const override;
101 
102 
109  double yMin_, yMax_;
110 
114  double chuteAngle_;
115 
119  double hopperAngle_;
120 
125 
130 
135 
141 
146 
152  double fillPercent_;
153 
157  double lift_;
158 
166 
167 };
168 
169 #endif
double hopperExitLength_
The horizontal (AB-direction) width at the square exit of the hopper.
MERCURY_DEPRECATED void oldRead(std::istream &is)
deprecated version of CubeInsertionBoundary::read().
double hopperHeight_
The vertical (AC-direction) height of the hopper, measured from the top of the hopper to the start of...
double hopperLength_
The horizontal (AB-direction) width at the top of the hopper.
int hopperDim_
Either 1 or 2. If 1, the insertion boundary has vertical walls in the y extrema. This is used e...
Boundary structure for boundaries used for insertion of particles.
#define MERCURY_DEPRECATED
Definition: GeneralDefine.h:37
std::string getName() const override
Returns the name of the object.
This is a class that generates random numbers i.e. named the Random Number Generator (RNG)...
Definition: RNG.h:52
HopperInsertionBoundary()
Default constructor. Sets all properties to 0.
double hopperAngle_
Angle of the hopper as compared to the vertical plane.
void write(std::ostream &os) const override
writes boundary properties to ostream
void set(BaseParticle *particleToCopy, unsigned int maxFailed, double yMin, double yMax, double radMin, double radMax, double chuteAngle, double fixedParticleRadius, bool isHopperCentred_, int hopperDim, double hopperAngle, double hopperLength, double hopperExitLength, double hopperHeight, double lift, double fillPercent)
Sets all boundary properties at once.
double chuteAngle_
Angle of the chute as compared to the horizontal plane.
void read(std::istream &is) override
reads boundary properties from istream
Inherits from InsertionBoundary Some images are useful to better understand the structure of both the...
void placeParticle(BaseParticle *p, RNG &random) override
This places an inflow particle in the top 50% of the hopper i.e. between gamma=0.5 and gamma=1...
double yMin_
The minimum and maximum y-positions of the particle for a hopper with vertical walls in the y-directi...
double fillPercent_
Percentage of the height of the insertion boundary up to which it should be filled. The part to be filled reaches from the top of the hopper down to {fillPercent * (top - 'position A')}.
HopperInsertionBoundary * copy() const override
copy method, returns a pointer to a copy.