ChuteInsertionBoundary.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2023, 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_CHUTEINSERTIONBOUNDARY_H
27 #define BOUNDARIES_CHUTEINSERTIONBOUNDARY_H
28 
29 #include "InsertionBoundary.h"
30 #include "Math/Vector.h"
31 
32 class BaseParticle;
33 
34 class RNG;
35 
41 {
42 public:
43 
48 
51 
55  ChuteInsertionBoundary* copy() const override;
56 
60  void set(std::vector<BaseParticle*> particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double
61  fixedParticleRadius, double inflowVelocity, double inflowVelocityVariance);
62 
66  void
67  set(BaseParticle* particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double fixedParticleRadius,
68  double inflowVelocity, double inflowVelocityVariance);
69 
70  void placeParticle(BaseParticle* p, RNG& random) override;
71 
75  void read(std::istream& is) override;
76 
80  void write(std::ostream& os) const override;
81 
85  std::string getName() const override;
86 
87 private:
88 
93 
101 
102 };
103 
104 #endif
Definition: BaseParticle.h:54
Used for modeling chute inflow. Inherits from InsertionBoundary.
Definition: ChuteInsertionBoundary.h:41
double inflowVelocityVariance_
Definition: ChuteInsertionBoundary.h:100
double fixedParticleRadius_
radius of the fixed bottom particles, mean particle velocity in X-direction, and allowed maximum rand...
Definition: ChuteInsertionBoundary.h:100
void placeParticle(BaseParticle *p, RNG &random) override
Definition: ChuteInsertionBoundary.cc:148
std::string getName() const override
Returns the name of the object.
Definition: ChuteInsertionBoundary.cc:210
Vec3D posMax_
Definition: ChuteInsertionBoundary.h:92
void write(std::ostream &os) const override
writes boundary properties to ostream
Definition: ChuteInsertionBoundary.cc:196
ChuteInsertionBoundary()
Default constructor.
Definition: ChuteInsertionBoundary.cc:35
void read(std::istream &is) override
reads boundary properties from istream
Definition: ChuteInsertionBoundary.cc:181
Vec3D posMin_
The two extremal corners of the cuboidal insertion boundary.
Definition: ChuteInsertionBoundary.h:92
double inflowVelocity_
Definition: ChuteInsertionBoundary.h:100
ChuteInsertionBoundary * copy() const override
Copy method; creates a copy on the heap.
Definition: ChuteInsertionBoundary.cc:61
void set(std::vector< BaseParticle * > particleToCopy, unsigned int maxFailed, Vec3D posMin, Vec3D posMax, double fixedParticleRadius, double inflowVelocity, double inflowVelocityVariance)
Sets all boundary properties at once.
Definition: ChuteInsertionBoundary.cc:89
Boundary structure for boundaries used for insertion of particles.
Definition: InsertionBoundary.h:50
This is a class that generates random numbers i.e. named the Random Number Generator (RNG).
Definition: RNG.h:53
Definition: Vector.h:51