thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.2.1
Interfaces defined for the ThePEG::ParticleData class.
Brief class description:
See ThePEG::ParticleData

Name: DecayModes
Type: Varying size vector of references to objects of class ThePEG::DecayMode

Description:
The list of decay modes defined for this particle type.

Name: Width_generator
Type: Reference to objects of class ThePEG::WidthGenerator

Description:
An object derived from the ThePEG::WidthGenerator class, which is able to calculate the full and partial widths forthis particle type and for a given instance of this particle type.

Name: Mass_generator
Type: Reference to objects of class ThePEG::MassGenerator

Description:
An object derived from the ThePEG::MassGeneratorclass, which is able to generate a mass for a given particle instance

Name: Synchronized
Type: Switch

Description:
Indicates if the changes to this particle is propagated to its anti-partner or not. Note that setting this switch does not actually synchronize the properties with the anti-partner, it only assures that following changes are propagated. To sync the particle with its anti-particle, use the Synchronize command.
Registered options:
0(Not_synchronized)
Changes to this particle will propagate to its anti-partner
1(Synchronized)
Changes to this particle will propagate to its anti-partner
Default value: 1

Name: VariableRatio
Type: Switch

Description:
Indicates if the branching ratios of the particle are allowed to vary for given Particle instances depending on the mass of the instance.
Registered options:
0(No)
The branching ratio does not vary.
1(Yes)
The branching ratio varies.
Default value: 0

Name: Stable
Type: Switch

Description:
Indicates if the particle is stable or not.
Registered options:
0(Unstable)
This particle is not stable
1(Stable)
This particle is stable
Default value: 0

Name: DefaultSpin
Type: Parameter

Description:
The default spin quantim number of this particle on the form 2j+1.
Default value: 0
Minimum value: 0
Maximum value: 9

Name: Spin
Type: Integer parameter

Description:
The spin quantim number of this particle on the form 2j+1.
Default value: 0 (May be changed by member function.)
Minimum value: 0
Maximum value: 9

Name: DefaultCharge
Type: Parameter

Description:
The default charge of this particle in units of e/3. See also the command interface SetCharge.
Default value: 0
Minimum value: -24
Maximum value: 24

Name: Charge
Type: Integer parameter

Description:
The charge of this particle in units of e/3. See also the command interface SetCharge.
Default value: 0 (May be changed by member function.)
Minimum value: -24
Maximum value: 24

Name: DefaultColour
Type: Switch

Description:
The default colour quantum number of this particle type.
Registered options:
-6(AntiSextet)
This particle is a colour anti-sextet.
-3(AntiTriplet)
This particle is a colour anti-triplet.
-1(Undefined)
The coulur is undefined.
0(Neutral)
This particle is colour neutral.
3(Triplet)
This particle is a colour triplet.
6(Sextet)
This particle is a colour sextet.
8(Octet)
This particle is a colour octet.
Default value: -1

Name: Colour
Type: Switch

Description:
The colour quantum number of this particle type.
Registered options:
-6(AntiSextet)
This particle is a colour anti-sextet.
-3(AntiTriplet)
This particle is a colour anti-triplet.
-1(Undefined)
The coulur is undefined.
0(Neutral)
This particle is colour neutral.
3(Triplet)
This particle is a colour triplet.
6(Sextet)
This particle is a colour sextet.
8(Octet)
This particle is a colour octet.
Default value: -1 (May be changed by member function.)

Name: DefaultLifeTime
Type: Parameter

Description:
c times the default average lifetime of the particle measuerd in mm.The actual lifetime of a particle instance is generated from this number by the Mass_generator object associated with the particle.
Default value: 0
Minimum value: 0

Name: LifeTime
Type: Parameter

Description:
c times the average lifetime of the particle measuerd in mm.The actual lifetime of a particle instance is generated from this number by the Mass_generator object associated with the particle.
Default value: 0 (May be changed by member function.)
Minimum value: 0

Name: DefaultWidthCut
Type: Parameter

Description:
The default hard cutoff in GeV in generated mass, which is the maximum allowed deviation from the nominal mass. For the actual cutoff, the upper and lower cut can be set separately.
Default value: 0
Minimum value: 0

Name: WidthCut
Type: Parameter

Description:
The hard cutoff in GeV in generated mass, which is the maximum allowed deviation from the nominal mass. Sets both the upper and lower cut. (The displayed value is the maximium of the upper and lower cut.) A negative value corresponds to no limit.
Default value: 0 (May be changed by member function.)
Minimum value: -1

Name: WidthLoCut
Type: Parameter

Description:
The lower hard cutoff in GeV in generated mass, which is the maximum allowed downwards deviation from the nominal mass. A negative value corresponds to no limit.
Default value: 0 (May be changed by member function.)
Minimum value: -1

Name: WidthUpCut
Type: Parameter

Description:
The upper hard cutoff in GeV in generated mass, which is the maximum allowed upwards deviation from the nominal mass. A negative value corresponds to no limit.
Default value: 0 (May be changed by member function.)
Minimum value: -1

Name: DefaultWidth
Type: Parameter

Description:
The default width of the particle in GeV.
Default value: 0
Minimum value: 0

Name: HardProcessWidth
Type: Parameter

Description:
The width in GeV of the particle to be used in calculating hard process cross sections.
Default value: 0
Minimum value: 0

Name: Width
Type: Parameter

Description:
The width of the particle in GeV.
Default value: 0 (May be changed by member function.)
Minimum value: 0

Name: DefaultMass
Type: Parameter

Description:
The default nominal mass in GeV of the particle. The actual mass of a particle instance is generated depending on the nominal mass and the width and is generated by the Mass_generator object associated with the particle.
Default value: 0
Minimum value: 0

Name: HardProcessMass
Type: Parameter

Description:
The mass in GeV of the particle to be used in calculating hard process cross sections.
Default value: 0
Minimum value: 0

Name: NominalMass
Type: Parameter

Description:
The nominal mass in GeV of the particle. The actual mass of a particle instance is generated depending on the nominal mass and the width and is generated by the Mass_generator object associated with the particle.
Default value: 0 (May be changed by member function.)
Minimum value: 0

Name: UnsetHardProcessWidth
Type: Command

Description:
Unset a previously set hard process width.

Name: AdjustNominalMass
Type: Command

Description:
Unset a previously set hard process mass.

Name: UnsetHardProcessMass
Type: Command

Description:
Unset a previously set hard process mass.

Name: PrintDecayModes
Type: Command

Description:
Print all decay modes of this particle.

Name: SelectDecayModes
Type: Command

Description:
Only the decay modes which are given as (white-space separated) decay tags will be switched on, all others will be switched off. If no argument or 'none' is given, all decay modes are switched off. If the argument is 'all', all decay modes are switched on.

Name: Synchronize
Type: Command

Description:
Synchronizes this particle so that all its properties correspond to those of its anti-partner

Name: SetCharge
Type: Command

Description:
Set the charge of this particle. The argument should be given as an interger giving three times the unit charge, or 'unknown', 'charged', 'positive' or 'negative'