MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ParticleSpecies.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2014, 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 ParticleSpecies_H
27 #define ParticleSpecies_H
28 #include "BaseSpecies.h"
29 #include "Math/ExtendedMath.h"
31 //class SpeciesHandler;
32 class BaseInteractable;
33 class BaseInteraction;
34 
35 //Note the getVelocity can for some Species be dependent on which point on the Species is meant.
36 class ParticleSpecies : public virtual BaseSpecies
37 {
38 public:
40 
43 
46 
48  virtual ~ParticleSpecies();
49 
54  virtual ParticleSpecies* copy() const=0;
55 
60  virtual BaseSpecies* copyMixed() const=0;
61 
63  void read(std::istream& is);
64 
66  void write(std::ostream& os) const;
67 
69  std::string getBaseName() const;
70 
73  void setDensity(Mdouble density);
74 
77  Mdouble getMassFromRadius(const Mdouble radius) const;
78 
79  Mdouble getVolumeFromRadius(const Mdouble radius) const;
80 
82  Mdouble getDensity() const;
83 
87  void computeMass(BaseParticle* p) const;
88 
89 private:
94 };
95 #endif
BaseSpecies is the class from which all other species are derived.
Definition: BaseSpecies.h:44
double Mdouble
void computeMass(BaseParticle *p) const
Compute Particle mass function, which required a reference to the Species vector. It computes the Par...
Stores information about interactions between two interactable objects; often particles but could be ...
std::string getBaseName() const
Used in Species::getName to obtain a unique name for each Species.
Mdouble getVolumeFromRadius(const Mdouble radius) const
virtual BaseSpecies * copyMixed() const =0
Creates a new MixedSpecies with the same force properties as the Species from which it is called...
Mdouble getMassFromRadius(const Mdouble radius) const
void setDensity(Mdouble density)
Allows density_ to be changed.
void write(std::ostream &os) const
Writes the species properties to an output stream.
ParticleSpecies()
The default constructor.
void read(std::istream &is)
Reads the species properties from an input stream.
Mdouble density_
The mass density.
Defines the basic properties that a interactable object can have.
Mdouble getDensity() const
Allows density_ to be accessed.
BaseInteraction InteractionType
virtual ~ParticleSpecies()
The default destructor.
virtual ParticleSpecies * copy() const =0
Creates a deep copy of the object from which it is called.