SphericalParticle.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 SphericalParticle_H
27 #define SphericalParticle_H
28 
29 #include "BaseParticle.h"
30 
37 {
38 public:
39 
43  SphericalParticle() = default;
44 
50  explicit SphericalParticle(const ParticleSpecies* s) : BaseParticle(s) {}
51 
55  SphericalParticle(const SphericalParticle& p) = default;
56 
57  ~SphericalParticle() override = default;
58 
62  SphericalParticle* copy() const override {
63  return new SphericalParticle(*this);
64  }
65 
70  std::string getName() const override {
71  return "BaseParticle";
72  }
73 
74  bool isSphericalParticle() const override {return true;}
75 };
76 #endif
Definition: BaseParticle.h:54
Definition: ParticleSpecies.h:37
A spherical particle is the most simple particle used in MercuryDPM.
Definition: SphericalParticle.h:37
SphericalParticle(const ParticleSpecies *s)
Particle constructor, setting the species. This is useful to create e.g. template particles for the I...
Definition: SphericalParticle.h:50
SphericalParticle(const SphericalParticle &p)=default
Particle constructor.
bool isSphericalParticle() const override
Definition: SphericalParticle.h:74
SphericalParticle()=default
Particle constructor.
SphericalParticle * copy() const override
Particle copy method. Calls copy constructor of this class (useful for polymorphism)
Definition: SphericalParticle.h:62
~SphericalParticle() override=default
std::string getName() const override
Returns the name of the object.
Definition: SphericalParticle.h:70