MercuryDPM  Alpha
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SpeciesHandler.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 
27 #ifndef SPECIESHANDLER_H
28 #define SPECIESHANDLER_H
29 
30 #include "BaseHandler.h"
31 class BaseSpecies;
32 //class ParticleSpecies;
34 
38 class SpeciesHandler : public BaseHandler<ParticleSpecies>
39 {
40 public:
43 
45  SpeciesHandler(const SpeciesHandler& other);
46 
49 
52 
54  virtual void addObject(ParticleSpecies* const S);
55 
57  void removeObject(unsigned const int index);
58 
60  void readObject(std::istream& is);
61 
63  ParticleSpecies* readOldObject(std::istream& is);
64 
66  unsigned int getMixedId(const unsigned int id1, const unsigned int id2) const;
67 
68  template<typename U>
69  typename std::enable_if<!std::is_pointer<typename U::MixedSpeciesType>::value,typename U::MixedSpeciesType*>::type
70  getMixedObject(const U* S, const U* T)
71  {
72  return dynamic_cast<typename U::MixedSpeciesType*>(getMixedObject(S->getIndex(),T->getIndex()));
73  }
74 
76  BaseSpecies* getMixedObject(const unsigned int id1, const unsigned int id2);
77 
79  const std::vector<BaseSpecies*>& getMixedObjects() const;
80 
82  virtual void write(std::ostream& os) const;
83 
85  std::string getName() const;
86 
88  bool useAngularDOFs();
89 
90 private:
92  std::vector<BaseSpecies*> mixedObjects_;
93 };
94 
95 #endif
96 
Container to store all ParticleSpecies.
BaseSpecies is the class from which all other species are derived.
Definition: BaseSpecies.h:44
unsigned int getMixedId(const unsigned int id1, const unsigned int id2) const
Gets the Id of the behaviour between two given species.
const std::vector< BaseSpecies * > & getMixedObjects() const
Returns a pointer to the vector of all mixed objects.
SpeciesHandler()
Default constructor, it creates an empty SpeciesHandler.
SpeciesHandler operator=(const SpeciesHandler &rhs)
Assignment operator that copies all species and the pointer to the DPMBase from the given SpeciesHand...
virtual void write(std::ostream &os) const
Write all the species and mixed species to an output stream.
void removeObject(unsigned const int index)
Remove the ParticleSpecies with given id.
~SpeciesHandler()
Destructor, it destructs the SpeciesHandler and all ParticleSpecies it contains.
virtual void addObject(ParticleSpecies *const S)
Adds a new ParticleSpecies to the SpeciesHandler.
ParticleSpecies * readOldObject(std::istream &is)
Reads ParticleSpecies into the SpeciesHandler from old-style restart data.
void readObject(std::istream &is)
Reads Species data into the SpeciesHandler from restart file.
std::vector< BaseSpecies * > mixedObjects_
The list of pointers to the mixed species.
Container to store the pointers to all objects that one creates in a simulation.
Definition: BaseHandler.h:51
std::enable_if<!std::is_pointer< typename U::MixedSpeciesType >::value, typename U::MixedSpeciesType * >::type getMixedObject(const U *S, const U *T)
std::string getName() const
Returns the name of the handler, namely the string "SpeciesHandler".
bool useAngularDOFs()
Check if angular DOF have to be used.