Particle.hh

//
// This file is part of MARLEY (Model of Argon Reaction Low Energy Yields)
//
// MARLEY is free software: you can redistribute it and/or modify it under the
// terms of version 3 of the GNU General Public License as published by the
// Free Software Foundation.
//
// For the full text of the license please see COPYING or
// visit http://opensource.org/licenses/GPL-3.0
//
// Please respect the MCnet academic usage guidelines. See GUIDELINES
// or visit https://www.montecarlonet.org/GUIDELINES for details.
 
#pragma once
#include <fstream>
 
 
namespace marley {
 
  #ifndef __MAKECINT__
  // Forward declare the JSON class so that we can define a function that
  // creates a JSON representation of a Particle. Hide the JSON class from
  // rootcint so that we won't have issues using marley::Particle objects with
  // ROOT 5.
  class JSON;
  #endif
 
  class Particle {
 
    public:
 
      Particle();
 
      Particle(int pdg_code, double m);
 
      Particle(int pdg_code, double m, int q);
 
      Particle(int pdg_code, double px, double py, double pz, double m);
 
      Particle(int pdg_code, double px, double py, double pz, double m, int q);
 
      Particle(int pdg_code, double E, double px, double py, double pz,
        double m);
 
      Particle(int pdg_code, double E, double px, double py, double pz,
        double m, int q);
 
      inline double mass() const;
      inline void set_mass(double m);
 
      inline double total_energy() const;
      inline void set_total_energy(double Etot);
 
      inline double px() const;
      inline void set_px(double px);
 
      inline double py() const;
      inline void set_py(double py);
 
      inline double pz() const;
      inline void set_pz(double pz);
 
      inline int pdg_code() const;
 
      inline double charge() const;
      inline void set_charge(int q);
 
      double momentum_magnitude() const;
      double kinetic_energy() const;
 
      void print(std::ostream& out) const;
 
      void read(std::istream& in);
 
      #ifndef __MAKECINT__
      marley::JSON to_json() const;
 
      void from_json(const marley::JSON& json);
      #endif
 
      void clear();
 
    protected:
 
      double four_momentum_[4];
 
      int pdg_code_ = 0;
 
      double mass_ = 0.;
 
      int charge_ = 0;
  };
 
  // Inline function definitions
  inline double Particle::mass() const { return mass_; }
  inline void Particle::set_mass(double m) { mass_ = m; }
 
  inline double Particle::total_energy() const { return four_momentum_[0]; }
  inline void Particle::set_total_energy(double Etot)
    { four_momentum_[0] = Etot; }
 
  inline double Particle::px() const { return four_momentum_[1]; }
  inline void Particle::set_px(double px) { four_momentum_[1] = px; }
 
  inline double Particle::py() const { return four_momentum_[2]; }
  inline void Particle::set_py(double py) { four_momentum_[2] = py; }
 
  inline double Particle::pz() const { return four_momentum_[3]; }
  inline void Particle::set_pz(double pz) { four_momentum_[3] = pz; }
 
  inline int Particle::pdg_code() const { return pdg_code_; }
 
  inline double Particle::charge() const { return charge_; }
  inline void Particle::set_charge(int q) { charge_ = q; }
}
 
// Operator for printing Particle objects to a std::ostream
inline std::ostream& operator<<(std::ostream& out, const marley::Particle& p)
{
  p.print(out);
  return out;
}
 
// Operator for reading in Particle objects from a std::istream
inline std::istream& operator>>(std::istream& in, marley::Particle& p)
{
  p.read(in);
  return in;
}