Material.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 _Physic_Prop_Material_HPP
#define _Physic_Prop_Material_HPP
 
#include <boost/serialization/vector.hpp>
#include <boost/serialization/string.hpp>
#include <boost/serialization/serialization.hpp>
#include <map>
 
#include "GranOO3/Core/Macro.hpp"
 
 
namespace GranOO3 {
  namespace Physic {
 
    // a class that stores physical properties of material 
    class Material;
 
    // a simple struct that stores property that emerges when two materials interact
    struct MaterialCouple {
      void parse_xml();     
 
      double _normal_stiffness = 0.;
      double _adhesion_force    = 0.;
      double _restitution_coeff = 0.;
      double _damping_factor    = 0.;
      double _tangential_stiffness = 0.;
      double _static_friction      = 0.;
      double _dynamic_friction     = 0.;
      double _friction_slope       = 1e5;
      double _rolling_stiffness    = 0.;
      double _rolling_limit        = 0.; 
    };
    
 
    // the Material class, here we can put all physical properties related 
    // to a particular material such as density, elastic properties... Note that
    // a Core::Base object can own a Physic::Material. So, a material can be applied
    // to all GranOO's main classes and objects. The material is not serialized.
    // This class can be used with the NEW-MATERIAL and the NEW-MATERIAL-COUPLE plugins.
    class Material {
      friend class MaterialCouple;
      
      // the default material 
    public:
      static Material* get_default();
      static Material* get(const std::string& name);
      static bool exist(const std::string& name);
 
    private:
      static Material* _default;
      static std::map<std::string, Material*> _all;
      static void add(Material*);
      
    private:
      Material();
 
    public:
      Material(const std::string& name);
      virtual ~Material();
 
      void parse_xml();
 
      void add_bimat(Material* other_mat, MaterialCouple& bi);
      const MaterialCouple& get_bimat(Material* other_mat) const;
      // Accessors and mutators
      GRANOO_ACCESS(name         , std::string, _name          );
      GRANOO_ACCESS(young_modulus, double     , _young_modulus );
      GRANOO_ACCESS(poisson_ratio, double     , _poisson_ratio );
 
    private:
      //SERIALIZATION (not used)
      friend class boost::serialization::access;
      template<class Archive> void save(Archive &, const unsigned int) const;
      template<class Archive> void load(Archive &, const unsigned int);
      BOOST_SERIALIZATION_SPLIT_MEMBER();
      
    private:
      std::string  _name;
      double       _young_modulus;
      double       _poisson_ratio;
      std::map<Material*, MaterialCouple> _bimat;
    };
 
 
    template<class Archive>
    void
    Material::save(Archive& ar, const unsigned int v) const {
      ar << _name;
      ar << _young_modulus;
      ar << _poisson_ratio;
      ar << _bimat;
    }
    
     template<class Archive>
    void
    Material::load(Archive& ar, const unsigned int v) {
       ar >> _name;
       ar >> _young_modulus;
       ar >> _poisson_ratio;
       ar >> _bimat;
       add(this);
     }
    
  }
}
 
 
 
#endif