A class for particles. More...

#include <Particle.h>

Inheritance diagram for Particle:

Detailed Description

A class for particles.

Author: HEPfit Collaboration

Copyright: GNU General Public License

This is the class for defining particles and their properties like mass (GeV), width (GeV), charge, isospin. One can also specify the scale, in GeV, at which the mass of a particle is defined.

Definition at line 26 of file Particle.h.

Public Member Functions
double	getCharge () const
	A get method to access the particle charge. More...

int	getIndex () const

double	getIsospin () const
	A get method to access the particle isospin. More...

const double &	getMass () const
	A get method to access the particle mass. More...

double	getMass_scale () const
	A get method to access the scale at which the particle mass is defined. More...

std::string	getName () const

const double &	getWidth () const
	A get method to access the particle width. More...

bool	is (std::string name_i) const

	Particle ()
	The default constructor. More...

	Particle (std::string name, double mass, double mass_scale=0., double width=0., double charge=0., double isospin=0.)
	Constructor. More...

void	setCharge (double charge)
	A set method to fix the particle charge. More...

void	setIsospin (double isospin)
	A set method to fix the particle isospin. More...

void	setMass (double mass)
	A set method to fix the particle mass. More...

void	setMass_scale (double mass_scale)
	A set method to fix the scale at which the particle mass is defined. More...

void	setName (std::string name)

void	setWidth (double width)
	A set method to fix the particle width. More...

virtual	~Particle ()

Protected Member Functions
void	setIndex ()

Protected Attributes
double	charge
	The particle charge. More...

int	index
	The index of the particle. More...

double	isospin
	The particle isospin. More...

double	mass
	The particle mass in GeV. More...

double	mass_scale
	The scale in GeV at which the particle mass is defined. More...

std::string	name
	The particle name. More...

double	width
	The particle width in GeV. More...

Constructor & Destructor Documentation

◆ Particle() [1/2]

Particle::Particle ( )

inline

The default constructor.

Definition at line 33 of file Particle.h.

    {
        name = "";
        mass = 0.;
        mass_scale = 0.;
        width = 0.;
        charge = 0.;
        isospin = 0.;
        setIndex();
    };

◆ Particle() [2/2]

Particle::Particle	(	std::string	name,
		double	mass,
		double	mass_scale = `0.`,
		double	width = `0.`,
		double	charge = `0.`,
		double	isospin = `0.`
	)

Constructor.

The properties of the particle can be initialized by passing arguments.

Parameters

[in]	name	the name of the particle
[in]	mass	the mass of the particle in GeV
[in]	mass_scale	the scale in GeV at which the mass is defined, set to 0 by default
[in]	width	the decay width of the particle in GeV, set to 0 by default
[in]	charge	the charge of the particle, set to 0 by default
[in]	isospin	the isospin of the particle, set to 0 by default

Definition at line 12 of file Particle.cpp.

{
    this->name = name;
    this->mass = mass;
    this->width = width;
    this->charge = charge;
    this->isospin = isospin;
    this->mass_scale = mass_scale;
    setIndex();
}

◆ ~Particle()

virtual Particle::~Particle ( )

inlinevirtual

Definition at line 56 of file Particle.h.

56{};

Member Function Documentation

◆ getCharge()

double Particle::getCharge ( ) const

inline

A get method to access the particle charge.

Returns: the particle charge

Definition at line 97 of file Particle.h.

    {
        return charge;
    }

◆ getIndex()

int Particle::getIndex ( ) const

inline

Definition at line 160 of file Particle.h.

    {
        return index;
    }

◆ getIsospin()

double Particle::getIsospin ( ) const

inline

A get method to access the particle isospin.

Returns: the particle isospin

Definition at line 115 of file Particle.h.

    {
        return isospin;
    }

◆ getMass()

const double & Particle::getMass ( ) const

inline

A get method to access the particle mass.

Returns: the particle mass in GeV

Definition at line 61 of file Particle.h.

    {
        return mass;
    }

◆ getMass_scale()

double Particle::getMass_scale ( ) const

inline

A get method to access the scale at which the particle mass is defined.

Returns: the scale in GeV at which the particle mass is defined

Definition at line 133 of file Particle.h.

    {
        return mass_scale;
    }

◆ getName()

std::string Particle::getName ( ) const

inline

Definition at line 147 of file Particle.h.

    {
        return name;
    }

◆ getWidth()

const double & Particle::getWidth ( ) const

inline

A get method to access the particle width.

Returns: the particle width in GeV

Definition at line 79 of file Particle.h.

    {
        return width;
    }

◆ is()

bool Particle::is ( std::string name_i ) const

Definition at line 23 of file Particle.cpp.

{
    if (name_i.compare("LEPTON") == 0) {
        if (index >= 0 && index <= 5)
            return true;
        else
            return false;
    }
    if (name_i.compare("QUARK") == 0) {
        if (index >= 6 && index <= 11)
            return true;
        else
            return false;
    }
    return (name.compare(name_i) == 0);
}

◆ setCharge()

void Particle::setCharge ( double charge )

inline

A set method to fix the particle charge.

Parameters

[in] charge the particle charge

Definition at line 106 of file Particle.h.

    {
        this->charge = charge;
    }

◆ setIndex()

void Particle::setIndex ( )

protected

Definition at line 40 of file Particle.cpp.

{
    if (name.compare("NEUTRINO_1") == 0)
        index = 0;
    else if (name.compare("NEUTRINO_2") == 0)
        index = 2;
    else if (name.compare("NEUTRINO_3") == 0)
        index = 4;
    else if (name.compare("ELECTRON") == 0)
        index = 1;
    else if (name.compare("MU") == 0)
        index = 3;
    else if (name.compare("TAU") == 0)
        index = 5;
    else if (name.compare("UP") == 0)
        index = 6;
    else if (name.compare("CHARM") == 0)
        index = 8;
    else if (name.compare("TOP") == 0)
        index = 10;
    else if (name.compare("DOWN") == 0)
        index = 7;
    else if (name.compare("STRANGE") == 0)
        index = 9;
    else if (name.compare("BOTTOM") == 0)
        index = 11;
    else
        index = -1;
}

◆ setIsospin()

void Particle::setIsospin ( double isospin )

inline

A set method to fix the particle isospin.

Parameters

[in] isospin the particle isospin

Definition at line 124 of file Particle.h.

    {
        this->isospin = isospin;
    }

◆ setMass()

void Particle::setMass ( double mass )

inline

A set method to fix the particle mass.

Parameters

[in] mass the particle mass in GeV

Definition at line 70 of file Particle.h.

    {
        this->mass = mass;
    }

◆ setMass_scale()

void Particle::setMass_scale ( double mass_scale )

inline

A set method to fix the scale at which the particle mass is defined.

Parameters

[in] mass_scale the scale in GeV at which the particle mass is defined

Definition at line 142 of file Particle.h.

    {
        this->mass_scale = mass_scale;
    }

◆ setName()

void Particle::setName ( std::string name )

inline

Definition at line 152 of file Particle.h.

    {
        this->name = name;
        setIndex();
    }

◆ setWidth()

void Particle::setWidth ( double width )

inline

A set method to fix the particle width.

Parameters

[in] width the particle width in GeV

Definition at line 88 of file Particle.h.

    {
        this->width = width;
    }

Member Data Documentation

◆ charge

double Particle::charge

protected

The particle charge.

Definition at line 168 of file Particle.h.

◆ index

int Particle::index

protected

The index of the particle.

Definition at line 172 of file Particle.h.

◆ isospin

double Particle::isospin

protected

The particle isospin.

Definition at line 170 of file Particle.h.

◆ mass

double Particle::mass

protected

The particle mass in GeV.

Definition at line 166 of file Particle.h.

◆ mass_scale

double Particle::mass_scale

protected

The scale in GeV at which the particle mass is defined.

Definition at line 169 of file Particle.h.

◆ name

std::string Particle::name

protected

The particle name.

Definition at line 171 of file Particle.h.

◆ width

double Particle::width

protected

The particle width in GeV.

Definition at line 167 of file Particle.h.

The documentation for this class was generated from the following files:

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ Particle() [1/2]

◆ Particle() [2/2]

◆ ~Particle()

Member Function Documentation

◆ getCharge()

◆ getIndex()

◆ getIsospin()

◆ getMass()

◆ getMass_scale()

◆ getName()

◆ getWidth()

◆ is()

◆ setCharge()

◆ setIndex()

◆ setIsospin()

◆ setMass()

◆ setMass_scale()

◆ setName()

◆ setWidth()

Member Data Documentation

◆ charge

◆ index

◆ isospin

◆ mass

◆ mass_scale

◆ name

◆ width