Rivet API documentation

Rivet 4.1.3
Nucleus/ion functions

Functions

bool Rivet::PID::isNucleus (int pid)
 Is this a nucleus PID?
int Rivet::PID::nuclZ (int pid)
int Rivet::PID::Z (int pid)
int Rivet::PID::nuclA (int pid)
int Rivet::PID::A (int pid)
int Rivet::PID::nuclNlambda (int pid)
int Rivet::PID::lambda (int pid)

Detailed Description

Function Documentation

◆ A()

int Rivet::PID::A ( int pid)
inline
Deprecated
Use nuclA()

References nuclA(), and Rivet::pid().

◆ isNucleus()

bool Rivet::PID::isNucleus ( int pid)
inline

Is this a nucleus PID?

This implements the 2006 Monte Carlo nuclear code scheme. Ion numbers are +/- 10LZZZAAAI. AAA is A - total baryon number ZZZ is Z - total charge L is the total number of strange quarks. I is the isomer number, with I=0 corresponding to the ground state.

References Rivet::pid().

Referenced by nuclA(), nuclNlambda(), and nuclZ().

◆ lambda()

int Rivet::PID::lambda ( int pid)
inline

◆ nuclA()

int Rivet::PID::nuclA ( int pid)
inline

Get the atomic weight (number of nucleons) in a nucleus/ion

Note
Ion numbers are +/- 10LZZZAAAI.

References isNucleus(), and Rivet::pid().

Referenced by A().

◆ nuclNlambda()

int Rivet::PID::nuclNlambda ( int pid)
inline

If this is a nucleus (ion), get nLambda

Note
Ion numbers are +/- 10LZZZAAAI.

References isNucleus(), and Rivet::pid().

Referenced by lambda().

◆ nuclZ()

int Rivet::PID::nuclZ ( int pid)
inline

Get the atomic number (number of protons) in a nucleus/ion

Note
Ion numbers are +/- 10LZZZAAAI.

References isNucleus(), and Rivet::pid().

Referenced by Z().

◆ Z()

int Rivet::PID::Z ( int pid)
inline
Deprecated
Use nuclZ()

References nuclZ(), and Rivet::pid().