Cylinder.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 _GranOO_LibShape_Cylinder_hh_
#define _GranOO_LibShape_Cylinder_hh_
 
#include <iostream>
#include <string>
 
#include <vtkUnstructuredGrid.h>
 
#include "GranOO3/Geom/Point.hpp"
#include "GranOO3/Shape/Volume.hpp"
#include "GranOO3/Shape/Sphere.hpp"
 
#include "GranOO3/Core/String.hpp"
#include "GranOO3/Core/ObjectFactory.hpp"
 
 
namespace GranOO3
{
  namespace Shape
  {
 
 
    class Cylinder : public Volume,
             public Core::ObjectFactoryInterface< Base, Cylinder>
    {
 
      GRANOO_OBJECT_FACTORY(Cylinder);
 
    private:
      enum ContactRegion {XMIN   = 1 << 0, RADIUS = 1 << 1, XMAX   = 1 << 2};
 
    public:
      static std::string class_ID() {return std::string("Cylinder");}
      static std::string desc();
      static void draw_gl(double radius, double length, double xshift=0., bool draw_end_disk = true);
      
    public:
      //CONSTRUCTORS & DESTRUCTORS
      Cylinder(double radius = 0., double length = 0., const Geom::Frame& frame = Geom::Frame::global);
      Cylinder(const Cylinder &);
      Cylinder(const Cylinder &, const Geom::Frame& frame);
      Cylinder(const Geom::Frame& frame);
      virtual ~Cylinder();
 
      //CLONING
      void make_equal_to(const Cylinder&);
 
      //IO
      void read_xml_element(const TiXmlElement* el);
      virtual std::ostream& write_ascii (std::ostream& out) const;
      virtual std::istream& read_ascii (std::istream& in);
      virtual void to_vtk(vtkUnstructuredGrid* data);
 
      std::string info() const;
 
      //BOUNDING SHAPE
      void update_bounding_box();
      void update_bounding_sphere();
      double get_greatest_dimension() const;
      AABB aabb() const;
 
      //CONTACT DETECTION
      Interference locate(const Geom::Point&) const;
      Interference locate(const Geom::Point&, double radius) const;
      void set_contact_regions(const std::string &regions);
 
      //CONTACT DETECTION v2
      GRANOO_DECLARE_SHAPE_COLLISION();
      bool collide_inside(const Geom::Point& p1, double radius, Collision::Data& info) const;
      bool collide_outside(const Geom::Point& p1, double radius, Collision::Data& info) const;
 
      //USEFULL
      double get_volume() const;
      void compute_inertia_tensor(double density, Geom::Tensor &) const;
      Geom::Point farthest_point_along(const Geom::Vector&) const;
      void draw_gl() const;
      void scale(double);
 
 
      //ACCESSORS
      GRANOO_ACCESS_SHAPE_DIM(radius, double, _radius);
      GRANOO_ACCESS_SHAPE_DIM(length, double, _length);
 
      std::ostream& to_povray (std::ostream& out, const Core::Color&) const;
 
    private:
      Cylinder & operator=(const Cylinder &); // copy constructor forbidden
 
      //SERIALIZATION
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive&, const unsigned int);
 
    private:
      double _radius;
      double _length;
      ContactRegion _cRegion;
    };
 
    inline
    Cylinder::Cylinder(double radius, double length, const Geom::Frame& frame)
      : Volume(frame),
      _radius(radius),
      _length(length),
      _cRegion(ContactRegion(XMIN | RADIUS | XMAX)) {
      set_face_ID("xMin", "xMax", "radius");
      SafeModeAssert(_radius>=0, "bad input value");
      SafeModeAssert(_length>=0, "bad input value");
    }
 
    inline
    Cylinder::Cylinder(const Cylinder &s)
      : Cylinder(s._radius, s._length, s._frame) {
    }
 
    inline
    Cylinder::Cylinder(const Cylinder& s, const Geom::Frame& frame)
      : Cylinder(s._radius, s._length, frame) {
    }
 
    inline
    Cylinder::Cylinder(const Geom::Frame& frame)
      : Cylinder(0., 0., frame) {
    }
 
    inline double
    Cylinder::get_volume() const {
      return M_PI*_radius*_radius*_length;
    }
 
    inline double
    Cylinder::get_greatest_dimension() const {
      double max = get_radius()*2.;
      if (get_length() > max)
        max = get_length();
 
      return max;
    }
 
    inline
    AABB Cylinder::aabb() const {
 
      double xMin = farthest_point_along(Geom::Vector(-1,  0,  0)).x();
      double xMax = farthest_point_along(Geom::Vector( 1,  0,  0)).x();
      double yMin = farthest_point_along(Geom::Vector( 0, -1,  0)).y();
      double yMax = farthest_point_along(Geom::Vector( 0,  1,  0)).y();
      double zMin = farthest_point_along(Geom::Vector( 0,  0, -1)).z();
      double zMax = farthest_point_along(Geom::Vector( 0,  0,  1)).z();
 
      double minPoint[] = { xMin, yMin, zMin };
      double maxPoint[] = { xMax, yMax, zMax };
 
      return StaticAABBTree::new_lonely_aabb(minPoint, maxPoint);
    }
 
    inline void
    Cylinder::compute_inertia_tensor(double density, Geom::Tensor &m) const {
      m.clear();
      const double xx = density*get_volume()*_radius*_radius/2.;
      const double yy_zz = density*get_volume()*(_radius*_radius/4. + _length*_length/12.);
      m.xx() = xx;
      m.yy() = m.zz() = yy_zz;
    }
 
    template<class Archive>
    inline void
    Cylinder::serialize(Archive& ar, const unsigned int ) {
      ar & boost::serialization::base_object<Volume>(*this);
      ar & _radius;
      ar & _length;
      ar & _cRegion;
    }
 
  }
}
 
//Don't forget to export for dynamic serialization of child class
#include <boost/serialization/export.hpp>
BOOST_CLASS_EXPORT_KEY(GranOO3::Shape::Cylinder)
 
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(GranOO3::Shape::Cylinder,0)
GRANOO_SERIALIZE_SHAPE(Cylinder)
 
namespace GranOO3
{
  extern template class Core::ObjectFactoryInterface<Shape::Base, Shape::Cylinder>;
}
 
 
 
#endif