Electrical.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_Prop_Electrical_HPP
#define _LibDEM_Prop_Electrical_HPP
 
 
#include "GranOO3/DEM/DiscreteElement.hpp"
#include "GranOO3/Core/Prop.hpp"
 
namespace GranOO3
{
  namespace DEM
  {
 
    class Electrical : public Core::Prop<Element>,
               public Core::Register<Electrical>
    {
      GRANOO_CLASS(DEM::Electrical, Core::Prop<Element>);
 
    public:
      // Constructors and destructor
      Electrical();
      virtual ~Electrical();
      virtual std::string info() const;
 
      // Accessors and mutators
      GRANOO_ACCESS_POS(conductivity      , double, _electrical_conductivity);
      GRANOO_ACCESS    (potential         , double, _potential              );
      GRANOO_ACCESS_SET(boundary_condition, bool  , _boundary_condition    );
 
      GRANOO_ACCESS(entering_power,   double, _entering_power  );
      GRANOO_ACCESS(leaving_power,    double, _leaving_power   );
      GRANOO_ACCESS(total_power,      double, _leaving_power   );
      GRANOO_ACCESS(joule_power,      double, _joule_power   );
      GRANOO_ACCESS(entering_current, double, _entering_current);
      GRANOO_ACCESS(leaving_current,  double, _leaving_current );
 
      void set_as_positive(bool activate);
      void set_as_ground(bool activate);
      void add_current(double current);
      void add_power(double current, double conductance);
      void clear_all_power();
      void clear_all_current();
 
      void compute_power();
 
      const bool is_boundary_condition() const;
      const bool is_positive() const;
      const bool is_ground() const;
 
    private:
      friend class boost::serialization::access;
      template<class Archive> void serialize(Archive& ar, const unsigned int );
 
    private:
      double _electrical_conductivity;
      double _potential;
      double _entering_power;
      double _leaving_power;
      double _total_power;
      double _joule_power;
      double _entering_current;
      double _leaving_current;
 
      bool _boundary_condition;
      bool _is_ground;
      bool _is_positive;
    };
 
    template<class Archive> void
    Electrical::serialize(Archive& ar, const unsigned int version) {
      ar & boost::serialization::base_object< Core::Prop<Element> >(*this);
      ar & _electrical_conductivity;
      ar & _potential;
      ar & _entering_current;
      ar & _leaving_current;
      ar & _entering_power;
      ar & _leaving_power;
      ar & _total_power;
      if (version >= 1) {
    ar & _joule_power;
      }
    }
 
  }
}
 
 
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(GranOO3::DEM::Electrical, 1)
 
namespace GranOO3 {
  GRANOO_CLASS_DECLARE_TPL(DEM::Electrical);
}
 
 
 
#endif