MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FixedClusterInsertionBoundary.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 MERCURY_FIXEDCLUSTERINSERTIONBOUNDARY_H
27 #define MERCURY_FIXEDCLUSTERINSERTIONBOUNDARY_H
29 
40 
41 public:
42 
47 
52 
57 
61  FixedClusterInsertionBoundary* copy() const override;
62 
66  void set(BaseParticle *particleToCopy,
67  std::vector<Vec3D> positions, std::vector<Mdouble> radii,
68  Vec3D velMin, Vec3D velMax, Mdouble rMicroParticle);
69 
71  void setPositionsAndRadii(std::vector<Vec3D> clusterPositions, std::vector<Mdouble> clusterRadii);
72 
74  void checkBoundaryBeforeTimeStep(DPMBase* md) final;
75 
77  void placeParticle(BaseParticle* p, RNG& random) final;
78 
80  BaseParticle* generateParticle(RNG& random) final;
81 
82 private:
86  std::string getName() const override;
87 
88 
89 };
90 #endif //MERCURY_FIXEDCLUSTERINSERTIONBOUNDARY_H
The DPMBase header includes quite a few header files, defining all the handlers, which are essential...
Definition: DPMBase.h:72
double Mdouble
Definition: GeneralDefine.h:34
void placeParticle(BaseParticle *p, RNG &random) final
Places particles according to vector clusterPositions_ and sets a random velocity, if required.
FixedClusterInsertionBoundary()
Constructor: inherits from BaseClusterInsertionBoundary constructor.
void setPositionsAndRadii(std::vector< Vec3D > clusterPositions, std::vector< Mdouble > clusterRadii)
this sets positions and radii of the desired clusters.
void checkBoundaryBeforeTimeStep(DPMBase *md) final
inserts cluster: differently from RandomClusterInsertionBoundary, here no check for interaction is co...
This is a class that generates random numbers i.e. named the Random Number Generator (RNG)...
Definition: RNG.h:52
void set(BaseParticle *particleToCopy, std::vector< Vec3D > positions, std::vector< Mdouble > radii, Vec3D velMin, Vec3D velMax, Mdouble rMicroParticle)
Sets the properties of the ClusterInsertionBoundary.
BaseParticle * generateParticle(RNG &random) final
Sets cluster radii according to vector clusterRadii_.
~FixedClusterInsertionBoundary() override
Destructor: default destructor.
std::string getName() const override
Returns the name of the object.
Definition: Vector.h:49
FixedClusterInsertionBoundary * copy() const override
Creates a copy on the heap and returns a pointer.