GitHub

Particle

A Particle represents a particle type used in transport calculations. Reserved-particle constructors (Photon, Electron, ...) pre-load the mass and charge from physical constants; the generic Particle(tag, mass, charge) constructor creates a user-defined particle.

Structure

Setters

Radiant.set_tag — Method
set_tag(this::Particle,tag::String)

Set the particle tag (string identifier).

Input Argument(s)

  • this::Particle : particle.
  • tag::String : tag.
source

Getters

Radiant.get_tag — Method
get_tag(this::Particle)

Get the particle tag (string identifier).

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • tag::String : tag.
source
Radiant.get_mass — Method
get_mass(this::Particle)

Get the mass of the particle [in MeV].

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • charge::Float64 : particle mass.
source
Radiant.get_charge — Method
get_charge(this::Particle)

Get the charge of the particle.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • charge::Float64 : particle charge.
source
Radiant.get_type — Method
get_type(this::Particle)

Get the particle type.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • type::Type : type of particle.
source

Type Predicates

Radiant.is_photon — Method
is_photon(this::Particle)

Determines whether the given particle is a photon.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_photon::Bool : is it a photon or not.
source
Radiant.is_electron — Method
is_electron(this::Particle)

Determines whether the given particle is an electron.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_electron::Bool : is it an electron or not.
source
Radiant.is_positron — Method
is_positron(this::Particle)

Determines whether the given particle is a positron.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_positron::Bool : is it a positron or not.
source
Radiant.is_proton — Method
is_proton(this::Particle)

Determines whether the given particle is a proton.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_proton::Bool : is it a proton or not.
source
Radiant.is_antiproton — Method
is_antiproton(this::Particle)

Determines whether the given particle is an antiproton.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_antiproton::Bool : is it an antiproton or not.
source
Radiant.is_alpha — Method
is_alpha(this::Particle)

Determines whether the given particle is an alpha particle.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_alpha::Bool : is it an alpha particle or not.
source
Radiant.is_muon — Method
is_muon(this::Particle)

Determines whether the given particle is a muon.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_muon::Bool : is it a muon or not.
source
Radiant.is_antimuon — Method
is_antimuon(this::Particle)

Determines whether the given particle is an antimuon.

Input Argument(s)

  • this::Particle : particle.

Output Argument(s)

  • is_antimuon::Bool : is it a antimuon or not.
source