Spring.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 _libDEM_Spring_hpp_
#define _libDEM_Spring_hpp_
 
#include <string>
#include <vector>
 
#include "GranOO3/DEM/Bond.hpp"
#include "GranOO3/Core/SetOf.hpp"
#include "GranOO3/DEM/Element.hpp"
#include "GranOO3/Geom/Point.hpp"
 
namespace GranOO3
{
  namespace DEM
  {
    class Spring : public Bond,
           public Core::Register<Spring >,
           public Physic::CriticalTimeStep {
 
      GRANOO_CLASS(DEM::Spring, Bond);
 
 
    public:
      //CONSTRUCTORS & DESTRUCTORS
      Spring(Element& el1, Element& el2);
      Spring(Element& el1, Element& el2, double stiffness, double damping, double max_relative_elongation = 0);
      Spring(Element& el1, Element& el2, double stiffness, double damping, double attrac_coef, double rep_coeff, double max_relative_elongation = 0);
      virtual ~Spring();
 
      //USEFULL
      void init();
      virtual void update();
      void process();
      virtual void compute_load();
      virtual double get_linear_stiffness() const;
      virtual double get_angular_stiffness() const;
      virtual double compute_critical_time_step() const;
      virtual std::string info() const;
      
      //ACCESSORS
      GRANOO_ACCESS    (stiffness        , double      , _stiffness        );
      GRANOO_ACCESS_GET(direction        , Geom::Vector, _direction        );
      GRANOO_ACCESS_GET(elongation_energy, double      , _elongation_energy);
 
      double get_restitution_coeff() const;
      void set_restitution_coeff(double val);
 
    private:
      Spring() = delete;
      Spring(const Spring&) = delete;
      Spring & operator=(const Spring &) = delete;
 
    private:
      //Initial Parameter
      double _stiffness;
      double _attractive_coeff;
      double _repulsive_coeff;
 
      //Parameter
      Geom::Vector _direction;
 
      //Deformation energies
      double _elongation_energy;
 
      //To compute deformation energies
      Geom::Vector _F1;
      Geom::Vector _F2;
      Geom::Vector _d1;
      Geom::Vector _d2;
 
   
 
    private:
      //BOOST SERIALIZATION
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive&, const unsigned int);
    };
 
    //BOOST SERIALIZATION
 
    template<class Archive> void
    Spring::serialize(Archive & ar, const unsigned int version) {
      ar & boost::serialization::base_object<Bond>(*this);
      ar & _stiffness;
      ar & _elongation_energy;
      ar & _attractive_coeff;
      ar & _repulsive_coeff;
    }
  }
}
 
 
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(GranOO3::DEM::Spring, 0)
 
 
// need placement new snippet because no default constructor exist
namespace boost
{
  namespace serialization
  {
    template<class Archive>
    inline void save_construct_data(Archive &ar, const GranOO3::DEM::Spring *t, const unsigned int) {
 
      const GranOO3::DEM::Element* de1 = &t->get_element1();
      const GranOO3::DEM::Element* de2 = &t->get_element2();
      ar << de1;
      ar << de2;
    }
 
    template<class Archive>
    inline void load_construct_data(Archive &ar, GranOO3::DEM::Spring *t, const unsigned int) {
 
      GranOO3::DEM::Element* de1 = nullptr;
      GranOO3::DEM::Element* de2 = nullptr;
      ar >> de1;
      ar >> de2;
      ::new(t)GranOO3::DEM::Spring(*de1,*de2);
    }
  }
} // namespace ...
 
 
namespace GranOO3
{
  GRANOO_CLASS_DECLARE_TPL(DEM::Spring);
}
 
 
#endif