NonSphericalParticle.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 NonSphericalParticle_H
27 #define NonSphericalParticle_H
28 
29 
30 #include "BaseParticle.h"
31 
37 {
38 public:
42  NonSphericalParticle() = default;
43 
48 
54 
58  ~NonSphericalParticle() override = default;
59 
63  NonSphericalParticle* copy() const override = 0;
64 
68  std::string getName() const override = 0;
69 
73  bool isSphericalParticle() const override {
74  return false;
75  }
76 
81  virtual Mdouble getKineticEnergy() const override{
83  }
84 
85  virtual Mdouble getRotationalEnergy() const override{
87  }
88 
89 };
90 
91 #endif
Definition: BaseParticle.h:54
virtual Mdouble getKineticEnergy() const
Calculates the particle's translational kinetic energy.
Definition: BaseParticle.cc:451
virtual Mdouble getRotationalEnergy() const
Calculates the particle's rotational kinetic energy.
Definition: BaseParticle.cc:460
Base class for all non-spherical particle types.
Definition: NonSphericalParticle.h:37
virtual Mdouble getKineticEnergy() const override
Definition: NonSphericalParticle.h:81
std::string getName() const override=0
NonSphericalParticle(const BaseParticle &p)
Base class copy constructor. Creates a NonSphericalParticle particle from a BaseParticle.
Definition: NonSphericalParticle.h:53
virtual Mdouble getRotationalEnergy() const override
Calculates the particle's rotational kinetic energy.
Definition: NonSphericalParticle.h:85
bool isSphericalParticle() const override
Definition: NonSphericalParticle.h:73
NonSphericalParticle()=default
NonSphericalParticle * copy() const override=0
NonSphericalParticle(const NonSphericalParticle &p)=default
~NonSphericalParticle() override=default