BidisperseCubeInsertionBoundary.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_BIDISPERSECUBEINSERTIONBOUNDARY_H
27 #define BOUNDARIES_BIDISPERSECUBEINSERTIONBOUNDARY_H
28 
29 #include "CubeInsertionBoundary.h"
30 #include "Particles/BaseParticle.h"
31 #include "Math/RNG.h"
32 #include "Math/Vector.h"
33 
41 {
42 public:
47 
52 
57 
61  BidisperseCubeInsertionBoundary* copy() const override;
62 
66  void set(BaseParticle* particleToCopyA, BaseParticle* particleToCopyB, double probA, int maxFailed, Vec3D posMin,
67  Vec3D posMax, Vec3D velMin, Vec3D velMax);
68 
73 
75 
79  BaseParticle* generateParticle(RNG& random) override;
80 
84  void read(std::istream& is) override;
85 
89  void write(std::ostream& os) const override;
90 
94  std::string getName() const override;
95 
96 private:
99  double probA_;
100 };
101 
102 #endif
Definition: BaseParticle.h:54
Like a CubeInsertionBoundary but the particles generated are one of two types.
Definition: BidisperseCubeInsertionBoundary.h:41
double probA_
Definition: BidisperseCubeInsertionBoundary.h:99
BaseParticle * particleToCopyB_
Definition: BidisperseCubeInsertionBoundary.h:98
BaseParticle * getParticleToCopyA() const
Get the particles that need to be copied.
Definition: BidisperseCubeInsertionBoundary.cc:75
BidisperseCubeInsertionBoundary * copy() const override
Creates a copy on the heap and returns a pointer.
Definition: BidisperseCubeInsertionBoundary.cc:56
BaseParticle * particleToCopyA_
Definition: BidisperseCubeInsertionBoundary.h:97
void read(std::istream &is) override
reads boundary properties from istream
Definition: BidisperseCubeInsertionBoundary.cc:109
~BidisperseCubeInsertionBoundary() override
Destructor: default destructor.
Definition: BidisperseCubeInsertionBoundary.cc:46
BaseParticle * generateParticle(RNG &random) override
Generates a particle with random position, radius and velocity.
Definition: BidisperseCubeInsertionBoundary.cc:88
void write(std::ostream &os) const override
writes boundary properties to ostream
Definition: BidisperseCubeInsertionBoundary.cc:120
BaseParticle * getParticleToCopyB() const
Definition: BidisperseCubeInsertionBoundary.cc:80
BidisperseCubeInsertionBoundary()
Constructor; sets everything to 0.
Definition: BidisperseCubeInsertionBoundary.cc:28
std::string getName() const override
Returns the name of the object.
Definition: BidisperseCubeInsertionBoundary.cc:130
void set(BaseParticle *particleToCopyA, BaseParticle *particleToCopyB, double probA, int maxFailed, Vec3D posMin, Vec3D posMax, Vec3D velMin, Vec3D velMax)
Sets the properties of this bidisperse cuboidal insertion boundary.
Definition: BidisperseCubeInsertionBoundary.cc:65
It's an insertion boundary which has cuboidal shape (yes, 'CuboidalInsertionBoundary' would have been...
Definition: CubeInsertionBoundary.h:42
This is a class that generates random numbers i.e. named the Random Number Generator (RNG).
Definition: RNG.h:53
Definition: Vector.h:51