Rivet API documentation

Rivet 4.1.3
Standalone beam-compatibility functions

Functions

bool Rivet::compatibleBeamID (PdgId p, PdgId allowed)
 Find whether ParticleName p is compatible with the template ParticleName allowed.
bool Rivet::compatibleBeamIDs (const PdgIdPair &pair, const PdgIdPair &allowedpair)
 Find whether PdgIdPair pair is compatible with the template PdgIdPair allowedpair.
bool Rivet::compatibleBeamIDs (const ParticlePair &ppair, const PdgIdPair &allowedpair)
 Check particle compatibility of two Particle pairs.
bool Rivet::compatibleBeamIDs (const ParticlePair &a, const ParticlePair &b)
 Check particle compatibility of two Particle pairs.
bool Rivet::compatibleBeamEnergies (const pair< double, double > &energies, const pair< double, double > &allowedenergies, const double reltol=1e-3)
 Check the energy compatibility of two pairs of particle energies.
bool Rivet::compatibleBeamEnergies (const ParticlePair &ppair, const pair< double, double > &allowedenergies, double reltol=1e-3)
 Check the energy compatibility of a pair of particles.
bool Rivet::compatibleBeamEnergies (const ParticlePair &ppair, const ParticlePair &allowedppair, double reltol=1e-3)
 Check the energy compatibility of two Particle pairs.
bool Rivet::compatibleBeamEnergy (const pair< double, double > &energies, double allowedsqrts, double reltol=1e-3)
 Check the sqrt(s) compatibility of two massless opposing beams.
bool Rivet::compatibleBeamEnergy (const ParticlePair &ppair, const pair< double, double > &allowedenergies, double reltol=1e-3)
 Check the sqrt(s) compatibility of two massless opposing beams.
bool Rivet::compatibleBeamEnergy (const ParticlePair &ppair, const double allowedsqrts, double reltol=1e-3)
 Check the sqrt(s) compatibility of a Particle pair.
bool Rivet::compatibleBeams (const ParticlePair &ppair, const PdgIdPair &allowedpids, double allowedsqrts)
 Check the particle ID and beam-energy compatibility of two Particle pairs.
bool Rivet::compatibleBeams (const ParticlePair &ppair, const PdgIdPair &allowedpids, const pair< double, double > &allowedenergies)
 Check the particle ID and beam-energy compatibility of two Particle pairs.
bool Rivet::compatibleBeams (const ParticlePair &a, const ParticlePair &b)
 Check the particle ID and beam-energy compatibility of two Particle pairs.

Detailed Description

Function Documentation

◆ compatibleBeamID()

bool Rivet::compatibleBeamID ( PdgId p,
PdgId allowed )
inline

Find whether ParticleName p is compatible with the template ParticleName allowed.

Effectively this is asking whether p is a subset of allowed.

References Rivet::Kin::p().

Referenced by compatibleBeamIDs().

◆ compatibleBeamIDs()

bool Rivet::compatibleBeamIDs ( const PdgIdPair & pair,
const PdgIdPair & allowedpair )
inline

Find whether PdgIdPair pair is compatible with the template PdgIdPair allowedpair.

This assesses whether either of the two possible pairings of pair's constituents is compatible.

References compatibleBeamID().

Referenced by compatibleBeamIDs(), compatibleBeamIDs(), compatibleBeams(), compatibleBeams(), and compatibleBeams().