SupportShapeT.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_SupportShapeT_tpp_
#define _libDEM_SupportShapeT_tpp_
 
#include <string>
 
#include "GranOO3/DEM/SupportShape.hpp"
#include "GranOO3/DEM/SupportShapeBoundary.hpp"
#include "GranOO3/Shape/Box.hpp"
#include "GranOO3/Shape/Sphere.hpp"
#include "GranOO3/Shape/Cylinder.hpp"
#include "GranOO3/Shape/Cone.hpp"
#include "GranOO3/Shape/Polyhedron.hpp"
 
#include "GranOO3/Core/ObjectFactory.hpp"
 
 
//SupportShapeT: class for constraining spacially a domain
 
namespace GranOO3
{
  namespace DEM
  {
 
    template<typename shape>
    class SupportShapeT : public SupportShape,
              public shape,
              public Core::Register< SupportShapeT<shape> >,
              public Core::ObjectFactoryInterface<SupportShape,  SupportShapeT<shape> >
    {
      GRANOO_CLASS_T(DEM::SupportShapeT, shape, SupportShape);
      GRANOO_OBJECT_FACTORY(SupportShapeT);
 
    public:
      static SupportShapeT<shape>& get(const std::string& ID);
      static bool exist(const std::string& ID);
 
    public:
      //CONSTRUCTORS & DESTRUCTORS
      SupportShapeT(const std::string& ID, const Geom::Frame &f, const shape& sh);
      SupportShapeT(const std::string& ID, const shape& sh);
      virtual ~SupportShapeT();
      SupportShapeT();
 
      //USEFULL
      virtual std::string info() const;
      void read_xml_element(const TiXmlElement* el);
 
      //ACCESSORS
      const Shape::Base& to_base_shape() const;
      Shape::Base& to_base_shape();
      const Shape::Volume& to_volume_shape() const;
      Shape::Volume& to_volume_shape();
      std::string shape_class_ID() const;
 
      //BOUNDARY & LOCAL FRAME
      void attach_to(Core::SetOf<DiscreteElement> &set, bool update = true, double dist_factor = 1.);
      void recoverer_boundary();
      void update();
 
      // IO
      virtual std::ostream& write_ascii(std::ostream& out) const;
      virtual std::istream& read_ascii(std::istream& in);
      virtual std::ostream& write_ascii_shape(std::ostream& out) const; // for .agdd compatibility
      virtual std::istream& read_ascii_shape(std::istream& in);         // for .agdd compatibility
 
    private:
      SupportShapeT(const SupportShapeT<shape>&)            = delete;
      SupportShapeT& operator=(const SupportShapeT<shape>&) = delete;
 
      //BOOST SERIALIZATION
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive & ar, const unsigned int );
 
    private:
      void init_boundary(const shape &, Core::SetOf<DiscreteElement> &);
    };
 
 
    template<typename shape> SupportShapeT<shape>&
    SupportShapeT<shape>::get(const std::string& id) {
      Core::SetOf< SupportShapeT<shape> >& set = Core::SetOf< SupportShapeT<shape> >::get_global_set();
      for (unsigned int i = 0; i<set.size(); ++i) {
        if (set[i]->SupportShape::get_ID()==id)
          return *set[i];
      }
      UserAssert(0, "can't find discrete shape " + id);
      return set(0);
    }
 
    template<typename shape> bool
    SupportShapeT<shape>::exist(const std::string& id) {
      Core::SetOf< SupportShapeT<shape> >& set = Core::SetOf< SupportShapeT<shape> >::get_global_set();
      for (unsigned int i = 0; i<set.size(); ++i) {
        if (set[i]->SupportShape::get_ID()==id)
          return true;
      }
      return false;
    }
 
    template<typename shape>
    SupportShapeT<shape>::SupportShapeT(const std::string& id, const Geom::Frame &f, const shape& s)
      : SupportShape(id, f),
      shape(s, SupportShape::local_frame()) {
      static_assert(std::is_base_of<Shape::Base, shape>::value,
                    "shape must be a descendant of the Shape::Base<T>");
    }
 
    template<typename shape>
    SupportShapeT<shape>::SupportShapeT(const std::string& id, const shape& s)
      : SupportShape(id, s.local_frame()),
      shape(s, SupportShape::local_frame()) {
      static_assert(std::is_base_of<Shape::Base, shape>::value,
                    "shape must be a descendant of the Shape::Base<T>");
    }
 
    template<typename shape> 
    SupportShapeT<shape>::SupportShapeT()
      : SupportShape(),
      shape(SupportShape::local_frame()) {
      static_assert(std::is_base_of<Shape::Base, shape>::value,
                    "shape must be a descendant of the Shape::Base<T>");
    }
 
    template<typename shape>
    SupportShapeT<shape>::~SupportShapeT() {
    }
 
    template<typename shape> std::string
    SupportShapeT<shape>::info() const {
      std::ostringstream os;
      os << SupportShape::info() << '\n'
         << shape::info() << '\n';
      return os.str();
    }
 
    template<typename shape> void
    SupportShapeT<shape>::read_xml_element(const TiXmlElement* el) {
      SupportShape::read_xml_element(el);
      shape::read_xml_element(el);
    }
 
    //ACCESSORS
    template<class shape> const Shape::Base&
    SupportShapeT<shape>::to_base_shape() const {
      return *this;
    }
 
    template<class shape> Shape::Base&
    SupportShapeT<shape>::to_base_shape() {
      return *this;
    }
 
    template<typename shape> const Shape::Volume&
    SupportShapeT<shape>::to_volume_shape() const {
      return *static_cast<const shape*>(this);
    }
 
    template<typename shape>
    Shape::Volume&
    SupportShapeT<shape>::to_volume_shape() {
      return *static_cast<shape*>(this);
    }
 
    template<typename shape> std::string
    SupportShapeT<shape>::shape_class_ID() const {
      return shape::class_ID();
    }
 
    template<typename shape> void
    SupportShapeT<shape>::attach_to(Core::SetOf<DiscreteElement> &set, bool do_update, double dist_factor) {
 
      SupportShape::attach_to(set, do_update);
      get_boundary().init_setof();
      get_boundary().new_setof();
      init_boundary(*this, set);
      SupportShape::update_average_discrete_element_radius();
      if (do_update)
        update();
    }
 
    template<typename shape> void
    SupportShapeT<shape>::recoverer_boundary() {
      SupportShape::recoverer_boundary();
      get_boundary().init_setof();
      get_boundary().recover_setof();
      SupportShape::update_average_discrete_element_radius();
    }
 
    template<class shape> std::ostream&
    SupportShapeT<shape>::write_ascii (std::ostream& out) const {
      SupportShape::write_ascii(out);
      shape::write_ascii(out);
      return out;
    }
 
    template<class shape> std::istream&
    SupportShapeT<shape>::read_ascii (std::istream& in) {
      SupportShape::read_ascii(in);
      shape::read_ascii(in);
      return in;
    }
 
    template<class shape> std::ostream&
    SupportShapeT<shape>::write_ascii_shape(std::ostream& out) const {
      shape::write_ascii(out);
      return out;
    }
 
    template<class shape> std::istream&
    SupportShapeT<shape>::read_ascii_shape(std::istream& in) {
      shape::read_ascii(in);
      return in;
    }
 
    template<typename shape> template<class Archive> void
    SupportShapeT<shape>::serialize(Archive & ar, const unsigned int ) {
      ar & boost::serialization::base_object<shape>(*this);
      ar & boost::serialization::base_object<SupportShape>(*this);
    }
 
  }
}
 
 
 
 
 
namespace GranOO3
{
  namespace Core
  {
 
    template<class shape>
    struct Read<DEM::SupportShapeT<shape> >
    {
      static Base* new_object(const std::string& classID, std::istream& in) {
        DEM::SupportShapeT<shape>* pt = new DEM::SupportShapeT<shape>();
        pt->read_ascii(in);
        return pt;
      }
    };
 
  }
}
 
 
 
namespace GranOO3
{
  GRANOO_CLASS_DECLARE_TPL(DEM::SupportShapeT<Shape::Sphere>);
  GRANOO_CLASS_DECLARE_TPL(DEM::SupportShapeT<Shape::Box>);
  GRANOO_CLASS_DECLARE_TPL(DEM::SupportShapeT<Shape::Cylinder>);
  GRANOO_CLASS_DECLARE_TPL(DEM::SupportShapeT<Shape::Cone>);
  GRANOO_CLASS_DECLARE_TPL(DEM::SupportShapeT<Shape::Polyhedron>);
}
 
 
#endif