ClusterGenerator.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 ClusterGenerator_H
27 #define ClusterGenerator_H
28 
29 #endif //ClusterGenerator_H
30 
31 #include "BaseCluster.h"
32 
39 {
40 public:
41 
47 
52 
56  void create();
57 
58 
60 
62 
63  //InteractionHandler* interactionHandler;
64 
65 
66 
67 private:
68 
69  /*
70  * ----------------------------------------------------
71  * VARIABLES
72  * ----------------------------------------------------
73  */
74 
75  // Position
77 
78  // TIME
81 
82  //Particles
87 
88  //Cluster
90  unsigned int idCluster_;
93 
94  // Central force
97 
98  // Data analysis
101 
102  // Energy
105 
106  // File
125 
126  // Restart self test
129 
130 
131 
132 };
Definition: BaseCluster.h:51
This class allows the user to create clusters of particles. All particles will be of LinearPlasticVis...
Definition: ClusterGenerator.h:39
Vec3D position_
Definition: ClusterGenerator.h:76
~ClusterGenerator()
Default destructor.
Definition: ClusterGenerator.cc:124
bool isVtkOutputOn_
bool used to define whether or not vtk output must be created.
Definition: ClusterGenerator.h:116
Mdouble energyRatioTolerance_
Energy ratio threshold under wich the simulation can be considered static.
Definition: ClusterGenerator.h:104
bool isRestartOutputOn_
bool used to define whether or not restart output must be created.
Definition: ClusterGenerator.h:120
Mdouble velocityDampingModulus_
Value of damping modulus for velocity.
Definition: ClusterGenerator.h:96
BaseCluster clusterProperties
Definition: ClusterGenerator.h:59
unsigned int idCluster_
Total number of particles.
Definition: ClusterGenerator.h:90
int internalStructureGridLength_
Number of points used for creating internal structure's grid.
Definition: ClusterGenerator.h:100
void create()
runs the simulation that creates the cluster.
Definition: ClusterGenerator.cc:132
bool isCdatOutputOn_
bool used to define whether or not cluster data output must be created.
Definition: ClusterGenerator.h:108
Mdouble clusterSizeSafetyFactor_
safety factor for the initial size of the cluster: this must be greater than 1.
Definition: ClusterGenerator.h:92
bool isIntStrucOutputOn_
bool used to define whether or not cluster internal structure output must be created.
Definition: ClusterGenerator.h:114
bool isOverlOutputOn_
bool used to define whether or not overlap data output must be created.
Definition: ClusterGenerator.h:110
bool restartSelfTest_
bool used to define whether or not the restart self test is being computed.
Definition: ClusterGenerator.h:128
ParticleHandler fakeParticleHandler
Definition: ClusterGenerator.h:61
bool isAmatOutputOn_
bool used to define whether or not adjacency matrix output must be created.
Definition: ClusterGenerator.h:112
bool isDataOutputOn_
bool used to define whether or not data output must be created.
Definition: ClusterGenerator.h:118
Mdouble collisionTimeOverTimeStep_
Ratio between collision time and time step: should be at least 50.
Definition: ClusterGenerator.h:80
ClusterGenerator()
This constructor initializes all variables to default values. After initialization all values are pas...
Definition: ClusterGenerator.cc:36
int nParticles_
Total number of particles.
Definition: ClusterGenerator.h:86
bool isFStatOutputOn_
bool used to define whether or not fStat output must be created.
Definition: ClusterGenerator.h:122
bool isEneOutputOn_
bool used to define whether or not eneOutput output must be created.
Definition: ClusterGenerator.h:124
Mdouble sizeDispersityParticle_
Size dispersity of particles: must be between 0 and 1.
Definition: ClusterGenerator.h:84
Container to store all BaseParticle.
Definition: ParticleHandler.h:48
Definition: Vector.h:51