Periodic.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Jean-luc CHARLES I2M-DuMAS/ENSAM Talence France
//                  <jean-luc.charles@ensam.eu>
//                - Damien ANDRE     SPCTS/ENS Ceramique industrielle, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jeremie GIRARDOT I2M-DuMAS/ENSAM Talence France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert    LAMIH/UVHC Valenciennes France
//                  <cedric.hubert@univ-valenciennes.fr>
//                - Ivan IORDANOFF   I2M-DuMAS-MPI/ENSAM Talence France
//                  <ivan.iordanoff@ensam.eu>
//
// Copyright (C) 2008-2016 JL. CHARLES, D. ANDRE, I. IORDANOFF, J. GIRARDOT
//
//
//x
//
//
// 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 _libDEM_Prop_Periodic_hpp_
#define _libDEM_Prop_Periodic_hpp_
 
 
#include <functional>
 
#include "GranOO3/Core/Prop.hpp"
#include "GranOO3/DEM/Element.hpp"
 
 
namespace GranOO3
{
 
 
  namespace DEM
  {
 
 
    class Periodic : public Core::Prop<Element>,
             public Core::Register<Periodic>
    {
 
      GRANOO_CLASS(DEM::Periodic, Core::Prop<Element>);
 
    public:
      Periodic();
      virtual ~Periodic();
 
      void make_master(std::function<Geom::Vector (const Geom::Vector&, bool&)> f);
      void set_master_function(std::function<Geom::Vector (const Geom::Vector&, bool&)> f);
      void set_teleport_master_function(std::function<Geom::Vector (const Geom::Vector&, bool&)> f);
      
      void make_slave(Periodic& master, std::function<Geom::Vector (const Geom::Vector&)> f, int slave_number = 0);
      void set_slave_function(std::function<Geom::Vector (const Geom::Vector&)> f);
      void set_follow_master_function(std::function<Geom::Vector (const Geom::Vector&)> f);
 
      unsigned int get_slave_number() const;
      unsigned int get_total_slave_number() const;
      
      bool is_slave() const;
      bool is_master() const;
      bool has_slave() const;
 
      void teleport_master();
      void follow_master_motion(bool follow_master_velocity);
      void follow_master_strain();
      void swap_bond(Core::SetOfBase<Element>& set, const Geom::Point& p);
 
      void remove_slave(Periodic&);
      
      Core::SetOfBase<Periodic>& slave();
      
            Periodic* get_master();
      const Periodic* get_master() const;
      void  set_master_from_element();
      
            Element* get_master_element();
      const Element* get_master_element() const;
 
      // IO
      virtual std::ostream& write_ascii (std::ostream& out) const;
      virtual std::istream& read_ascii (std::istream& in);
 
    private:
       //BOOST SERIALIZATION
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive&, const unsigned int);
 
    private:
      Core::SetOfBase<Periodic>* _slave;
      bool         _has_slave;
      bool         _is_slave;
      unsigned int _slave_number;
      bool         _is_master;
      Periodic*    _master;
      Element*     _master_element;
      std::function<Geom::Vector (const Geom::Vector&, bool&)> _function_teleport_master;
      std::function<Geom::Vector (const Geom::Vector&)>        _function_follow_master;
    };
 
 
    template<class Archive> void
    Periodic::serialize(Archive& ar, const unsigned int version) {
      ar & boost::serialization::base_object<Core::Prop<Element> >(*this);
      ar & _has_slave;
      ar & _is_slave;
      ar & _slave_number;
      ar & _is_master;
      ar & _master_element;
    }
 
  }
}
 
 
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(GranOO3::DEM::Periodic,0)
 
 
namespace GranOO3
{
  GRANOO_CLASS_DECLARE_TPL(DEM::Periodic);
}
 
// FOR IO
namespace GranOO3
{
  namespace Core
  {
    template<>
    struct Read<DEM::Periodic>
    {
      static Base* new_object(const std::string& classID, std::istream& in);
    };
  }
}
 
 
 
#endif