Pair.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#ifndef _LibPhysic_Pair_H
#define _LibPhysic_Pair_H
 
#include "GranOO3/Core/Base.hpp"
#include "GranOO3/Core/PropClass.hpp"
 
namespace GranOO3
{
  namespace Core
  {
 
    // The most simple interaction between two particles.
    // This class is not designed to be derived.
    // This class must replace the bond class for generic interaction between particles
    template<typename type>
    class Pair : public Base,
         public PropClass< Pair<type> >,
         public Register< Pair<type> >
    {
 
      GRANOO_CLASS_T(Core::Pair, type, Base);
 
    public:
      // Connectivity management
      static void update_connectivity_map();
      static SetOfBase<Pair<type> >& get_connection_for(const type&);
      static unsigned int get_number_of_connection_for(const type& item);
 
    public:
      // Constructors and destructor
      Pair(type& p1, type& p2);
      ~Pair();
 
      type& get_item1();
      const type& get_item1() const;
      type& get_item2();
      const type& get_item2() const;
 
      type& item1();
      type& item2();
 
      // IO
      std::ostream& write_ascii (std::ostream& out) const;
      std::istream& read_ascii (std::istream& in);
      std::string info() const;
      void draw();
 
    private:
      Pair(const Pair&) = delete;
      Pair & operator=(const Pair &) = delete;
 
      //BOOST SERIALIZATION
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive&, const unsigned int);
 
    private:
      static std::map<const type*, SetOfBase<Pair<type> > > _connectivity_map;
 
    protected:
      type& item1_;
      type& item2_;
    };
 
    template<typename type> std::map<const type*, SetOfBase<Pair<type> > >
    Pair<type>::_connectivity_map = std::map<const type*, SetOfBase<Pair<type> > >();
 
    template<typename type> void
    Pair<type>::update_connectivity_map() {
      _connectivity_map.clear();
      SetOf<Pair<type> >& set = SetOf<Pair<type> >::get();
      for (auto& it: set) {
        _connectivity_map[&it->item1_].add_item(it);
        _connectivity_map[&it->item2_].add_item(it);
      }
    }
 
    template<typename type> SetOfBase<Pair<type> >&
    Pair<type>::get_connection_for(const type& item) {
      AssertMsg(_connectivity_map.size() > 0, "The connectivity map is null, you must update the connectivity map before");
      AssertMsg(_connectivity_map.count(&item) == 1, "Can't find the required item in the connectivity map, maybe you need to update it before");
      return _connectivity_map[&item];
    }
 
    template<typename type> unsigned int
    Pair<type>::get_number_of_connection_for(const type& item) {
      AssertMsg(_connectivity_map.size() > 0, "The connectivity map is null, you must update the connectivity map before");
      if (_connectivity_map.count(&item) == 0)
    return 0;
      
      return _connectivity_map[&item].size();
    }
 
    template<typename type>
    Pair<type>::Pair(type& p1, type& p2)
      : item1_(p1), item2_(p2) {
    }
 
    template<typename type>
    Pair<type>::~Pair() {
    }
 
    template<typename type> type&
    Pair<type>::get_item1() {
      return item1_;
    }
 
    template<typename type> const type&
    Pair<type>::get_item1() const {
      return item1_;
    }
 
    template<typename type> type&
    Pair<type>::get_item2() {
      return item2_;
    }
 
    template<typename type> const type&
    Pair<type>::get_item2() const {
      return item2_;
    }
 
    template<typename type> type&
    Pair<type>::item1() {
      return item1_;
    }
 
    template<typename type> type&
    Pair<type>::item2() {
      return item2_;
    }
 
    template<typename type> std::string
    Pair<type>::info() const {
      std::ostringstream os;
      os << "pair between  "
         << item1_.Core::template Register<type>::get_numeric_ID()
         << " and "
         << item2_.Core::template Register<type>::get_numeric_ID()
         << "\n";
      return os.str();
    }
 
    template<typename type>  std::ostream&
    Pair<type>::write_ascii (std::ostream& out) const {
      out << item1_.numID() << '\t' << item2_.numID();
      return out;
    }
 
    template<typename type> std::istream&
    Pair<type>::read_ascii (std::istream& in) {
      return in;
    }
 
    template<typename type> void
    Pair<type>::draw() {
 
    }
 
    template<typename type>
    template<class Archive>
    inline void
    Pair<type>::serialize(Archive & ar, const unsigned int ) {
      ar & boost::serialization::base_object<Base>(*this);
    }
 
  }
}
 
 
 
// need placement new snippet because no default constructor exist
namespace boost
{
  namespace serialization
  {
 
    template<typename type, class Archive>
    void save_construct_data(Archive & ar,
                             const GranOO3::Core::Pair<type> * t,
                             const unsigned int) {
      const type* item1 = &t->get_item1();
      const type* item2 = &t->get_item2();
      ar << item1;
      ar << item2;
    }
 
    template<typename type, class Archive>
    void load_construct_data(Archive & ar,
                             GranOO3::Core::Pair<type> * t,
                             const unsigned int) {
      type* item1 = nullptr;
      type* item2 = nullptr;
      ar >> item1;
      ar >> item2;
      ::new(t)GranOO3::Core::Pair<type>(*item1,*item2);
    }
 
  }
}
 
 
 
namespace GranOO3
{
  namespace Core
  {
 
    template<class type>
    struct Read<Pair<type> >
    {
      static Base* new_object(const std::string& classID, std::istream& in) {
        int num1, num2;
        in >> num1 >> num2;
        type& item1 = SetOf<type>::get_item_by_base_class_rank(num1);
        type& item2 = SetOf<type>::get_item_by_base_class_rank(num2);
        Pair<type>* pt = new Pair<type>(item1, item2);
        pt->read_ascii(in);
        return pt;
      }
 
    };
 
  }
}
 
 
 
 
#endif