Allows the configuration of properties of kaons produced in the simulation, in particular setting their lifetime and branching ratios. More...

#include <KaonPhysics.h>

Public Member Functions
	KaonPhysics (const G4String &name, const framework::config::Parameters &parameters)

void	setDecayProperties (G4ParticleDefinition *kaon, const std::vector< double > &branching_ratios, double lifetime_factor) const
	Set the lifetime and branching ratios for one of the kaon species.

void	ConstructParticle () override
	Construct/Update particles.

void	DumpDecayDetails (const G4ParticleDefinition *kaon) const

void	ConstructProcess () override
	Construct processes.

Private Types
enum	ChargedKaonDecayChannel { mu_nu = 0 , pi_pi0 = 1 , pi_pi_pi = 2 , pi0_e_nu = 3 , pi0_mu_nu = 4 , pi_pi0_pi0 = 5 }
	Represents the 6 possible decay channels for charged kaons in Geant4 (See G4KaonMinus.cc and G4KaonPlus.cc in the Geant4 sources) in the order they appear in the decay table. More...

enum	KaonZeroLongDecayChannel { pim_e_nu = 0 , pip_e_nu = 1 , pi0_pi0_pi0 = 2 , pim_mu_nu = 3 , pip_mu_nu = 4 , pi0_pip_pim = 5 }
	Corresponding entries for the K^0_L. More...

enum	KaonZeroShortDecayChannel { pip_pim = 0 , pi0_pi0 = 1 }

Private Attributes
double	kplus_lifetime_factor {1}

double	kminus_lifetime_factor {1}

double	k0l_lifetime_factor {1}

double	k0s_lifetime_factor {1}

std::vector< double >	kplus_branching_ratios

std::vector< double >	kminus_branching_ratios

std::vector< double >	k0l_branching_ratios

std::vector< double >	k0s_branching_ratios

int	verbosity

framework::logging::logger	theLog_

Detailed Description

Allows the configuration of properties of kaons produced in the simulation, in particular setting their lifetime and branching ratios.

Definition at line 32 of file KaonPhysics.h.

Member Enumeration Documentation

◆ ChargedKaonDecayChannel

enum simcore::KaonPhysics::ChargedKaonDecayChannel

private

Represents the 6 possible decay channels for charged kaons in Geant4 (See G4KaonMinus.cc and G4KaonPlus.cc in the Geant4 sources) in the order they appear in the decay table.

The processes are K^+ -> \mu^+ + \nu_\mu K^+ -> \pi^+ + \pi^0 K^+ -> \pi^+ + \pi^- + \pi^+ K^+ -> \pi^0 + e^+ + \nu_e K^+ -> \pi^0 + \mu^+ + \nu_\mu K^+ -> \pi^+ + \pi^0 + \pi^0

And vice versa for K^-. The indices here correspond to the position of the branching ratio for that process in the corresponding parameter as well as the position in the decay table.

Note: : The order in the the decay table is sorted by the branching ratios of the default physics settings since G4DecayTable::insert sorts its entries by branching ratio!

Definition at line 59 of file KaonPhysics.h.

                               {
    mu_nu = 0,
    pi_pi0 = 1,
    pi_pi_pi = 2,
    pi0_e_nu = 3,
    pi0_mu_nu = 4,
    pi_pi0_pi0 = 5,
  };

◆ KaonZeroLongDecayChannel

enum simcore::KaonPhysics::KaonZeroLongDecayChannel

private

Corresponding entries for the K^0_L.

Note that K^0_L and K^0_S decays are not symmetric like the charged ones so they need to be handled manually.

The processes are

K^0_L -> \pi^- + e^+ + \nu_e K^0_L -> \pi^+ + e^- + \nu_e K^0_L -> \pi^0 + \pi^0 + \pi^0 K^0_L -> \pi^- + \mu^+ + \nu_\mu K^0_L -> \pi^+ + \mu^- + \nu_\mu K^0_L -> \pi^0 + \pi^+ + \pi^-

and

K^0_S -> \pi^+ + \pi^- K^0_S -> \pi^0 + \pi^0

Note: : The order in the the decay table is sorted by the branching ratios of the default physics settings since G4DecayTable::insert sorts its entries by branching ratio!

Definition at line 91 of file KaonPhysics.h.

                                {
    pim_e_nu = 0,
    pip_e_nu = 1,
    pi0_pi0_pi0 = 2,
    pim_mu_nu = 3,
    pip_mu_nu = 4,
    pi0_pip_pim = 5,
  };

◆ KaonZeroShortDecayChannel

enum simcore::KaonPhysics::KaonZeroShortDecayChannel

private

Definition at line 99 of file KaonPhysics.h.

                                 {
    pip_pim = 0,
    pi0_pi0 = 1,
  };

Constructor & Destructor Documentation

◆ KaonPhysics()

simcore::KaonPhysics::KaonPhysics	(	const G4String &	name,
		const framework::config::Parameters &	parameters
	)

Definition at line 4 of file KaonPhysics.cxx.

    : G4VPhysicsConstructor(name) {
  kplus_branching_ratios =
      parameters.getParameter<std::vector<double>>("kplus_branching_ratios");
  kminus_branching_ratios =
      parameters.getParameter<std::vector<double>>("kminus_branching_ratios");
  k0l_branching_ratios =
      parameters.getParameter<std::vector<double>>("k0l_branching_ratios");
  k0s_branching_ratios =
      parameters.getParameter<std::vector<double>>("k0s_branching_ratios");
  kplus_lifetime_factor =
      parameters.getParameter<double>("kplus_lifetime_factor");
  kminus_lifetime_factor =
      parameters.getParameter<double>("kminus_lifetime_factor");
  k0l_lifetime_factor = parameters.getParameter<double>("k0l_lifetime_factor");
  k0s_lifetime_factor = parameters.getParameter<double>("k0s_lifetime_factor");
  verbosity = parameters.getParameter<int>("verbosity");
}

Member Function Documentation

◆ ConstructParticle()

void simcore::KaonPhysics::ConstructParticle ( )

override

Construct/Update particles.

Update the particle definitions for charged kaons

Scale their lifetime by the corresponding lifetime factor
Set their branching ratios to those in the corresponding branching raito parameter

Definition at line 77 of file KaonPhysics.cxx.

                                    {
  auto kaonPlus{G4KaonPlus::Definition()};
  auto kaonMinus{G4KaonMinus::Definition()};
  auto kaonLong{G4KaonZeroLong::Definition()};
  auto kaonShort{G4KaonZeroShort::Definition()};
 
  if (!kaonPlus || !kaonMinus || !kaonLong || !kaonShort) {
    EXCEPTION_RAISE("KaonPhysics",
                    "Unable to get the charged kaon particle definitions, "
                    "something is very wrong with the configuration.");
  }
  setDecayProperties(kaonPlus, kplus_branching_ratios, kplus_lifetime_factor);
  setDecayProperties(kaonMinus, kminus_branching_ratios,
                     kminus_lifetime_factor);
  setDecayProperties(kaonLong, k0l_branching_ratios, k0l_lifetime_factor);
  setDecayProperties(kaonShort, k0s_branching_ratios, k0s_lifetime_factor);
}

◆ ConstructProcess()

void simcore::KaonPhysics::ConstructProcess ( )

inlineoverride

Construct processes.

We don't do anything here since we are just attaching/updating the kaon particle definitions.

Definition at line 155 of file KaonPhysics.h.

155{};

◆ DumpDecayDetails()

void simcore::KaonPhysics::DumpDecayDetails ( const G4ParticleDefinition * kaon ) const

Definition at line 95 of file KaonPhysics.cxx.

                                                                         {
  ldmx_log(info) << "Decay table details for " << kaon->GetParticleName()
                 << std::scientific << std::setprecision(15)
                 << " (PDG Lifetime " << kaon->GetPDGLifeTime() << ")"
                 << std::endl;
  const auto table{kaon->GetDecayTable()};
  const int entries{table->entries()};
  for (auto i{0}; i < entries; ++i) {
    const auto channel{(*table)[i]};
    const auto daughters{channel->GetNumberOfDaughters()};
    std::string products{};
    // N-1 to avoid extra " + "
    for (auto j{0}; j < daughters - 1; ++j) {
      products += channel->GetDaughter(j)->GetParticleName();
      products += " + ";
    }
    // Special formatting for last one :)
    products += channel->GetDaughter(daughters - 1)->GetParticleName();
    ldmx_log(info) << "Channel " << i << " (" << kaon->GetParticleName()
                   << " -> " << products << ") Kinematics type "
                   << channel->GetKinematicsName() << " with BR "
                   << channel->GetBR() << std::endl;
  }
}

◆ setDecayProperties()

void simcore::KaonPhysics::setDecayProperties	(	G4ParticleDefinition *	kaon,
		const std::vector< double > &	branching_ratios,
		double	lifetime_factor
	)		const

Set the lifetime and branching ratios for one of the kaon species.

Definition at line 23 of file KaonPhysics.cxx.

                                  {
  auto table{kaon->GetDecayTable()};
  if (!table) {
    EXCEPTION_RAISE("KaonPhysics", "Unable to get the decay table from " +
                                       kaon->GetParticleName());
  }
  if (verbosity > 1) {
    ldmx_log(info) << "Decay details (" << kaon->GetParticleName()
                   << ") before setting branching ratios and lifetimes"
                   << std::endl;
    DumpDecayDetails(kaon);
  }
  kaon->SetPDGLifeTime(kaon->GetPDGLifeTime() * lifetime_factor);
  if (kaon == G4KaonZeroLong::Definition()) {
    (*table)[KaonZeroLongDecayChannel::pi0_pi0_pi0]->SetBR(
        branching_ratios[KaonZeroLongDecayChannel::pi0_pi0_pi0]);
    (*table)[KaonZeroLongDecayChannel::pi0_pip_pim]->SetBR(
        branching_ratios[KaonZeroLongDecayChannel::pi0_pip_pim]);
    (*table)[KaonZeroLongDecayChannel::pip_e_nu]->SetBR(
        branching_ratios[KaonZeroLongDecayChannel::pip_e_nu]);
    (*table)[KaonZeroLongDecayChannel::pim_e_nu]->SetBR(
        branching_ratios[KaonZeroLongDecayChannel::pim_e_nu]);
    (*table)[KaonZeroLongDecayChannel::pim_mu_nu]->SetBR(
        branching_ratios[KaonZeroLongDecayChannel::pim_mu_nu]);
    (*table)[KaonZeroLongDecayChannel::pip_mu_nu]->SetBR(
        branching_ratios[KaonZeroLongDecayChannel::pip_mu_nu]);
  } else if (kaon == G4KaonZeroShort::Definition()) {
    (*table)[KaonZeroShortDecayChannel::pip_pim]->SetBR(
        branching_ratios[KaonZeroShortDecayChannel::pip_pim]);
    (*table)[KaonZeroShortDecayChannel::pi0_pi0]->SetBR(
        branching_ratios[KaonZeroShortDecayChannel::pi0_pi0]);
  } else {
    (*table)[ChargedKaonDecayChannel::mu_nu]->SetBR(
        branching_ratios[ChargedKaonDecayChannel::mu_nu]);
    (*table)[ChargedKaonDecayChannel::pi_pi0]->SetBR(
        branching_ratios[ChargedKaonDecayChannel::pi_pi0]);
    (*table)[ChargedKaonDecayChannel::pi_pi_pi]->SetBR(
        branching_ratios[ChargedKaonDecayChannel::pi_pi_pi]);
    (*table)[ChargedKaonDecayChannel::pi_pi0_pi0]->SetBR(
        branching_ratios[ChargedKaonDecayChannel::pi_pi0_pi0]);
    (*table)[ChargedKaonDecayChannel::pi0_e_nu]->SetBR(
        branching_ratios[ChargedKaonDecayChannel::pi0_e_nu]);
    (*table)[ChargedKaonDecayChannel::pi0_mu_nu]->SetBR(
        branching_ratios[ChargedKaonDecayChannel::pi0_mu_nu]);
  }
  if (verbosity > 0) {
    ldmx_log(info) << "Decay details (" << kaon->GetParticleName()
                   << ") after setting branching ratios and lifetimes"
                   << std::endl;
    DumpDecayDetails(kaon);
  }
}

Member Data Documentation

◆ k0l_branching_ratios

std::vector<double> simcore::KaonPhysics::k0l_branching_ratios

private

Definition at line 115 of file KaonPhysics.h.

◆ k0l_lifetime_factor

double simcore::KaonPhysics::k0l_lifetime_factor {1}

private

Definition at line 108 of file KaonPhysics.h.

108{1};

◆ k0s_branching_ratios

std::vector<double> simcore::KaonPhysics::k0s_branching_ratios

private

Definition at line 116 of file KaonPhysics.h.

◆ k0s_lifetime_factor

double simcore::KaonPhysics::k0s_lifetime_factor {1}

private

Definition at line 109 of file KaonPhysics.h.

109{1};

◆ kminus_branching_ratios

std::vector<double> simcore::KaonPhysics::kminus_branching_ratios

private

Definition at line 114 of file KaonPhysics.h.

◆ kminus_lifetime_factor

double simcore::KaonPhysics::kminus_lifetime_factor {1}

private

Definition at line 107 of file KaonPhysics.h.

107{1};

◆ kplus_branching_ratios

std::vector<double> simcore::KaonPhysics::kplus_branching_ratios

private

Definition at line 113 of file KaonPhysics.h.

◆ kplus_lifetime_factor

double simcore::KaonPhysics::kplus_lifetime_factor {1}

private

Definition at line 106 of file KaonPhysics.h.

106{1};

◆ theLog_

framework::logging::logger simcore::KaonPhysics::theLog_

mutableprivate

Initial value:

{

framework::logging::makeLogger("KaonPhysics")}

Definition at line 158 of file KaonPhysics.h.

158 {

159 framework::logging::makeLogger("KaonPhysics")};

◆ verbosity

int simcore::KaonPhysics::verbosity

private

Definition at line 120 of file KaonPhysics.h.

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

SimCore/include/SimCore/KaonPhysics.h
SimCore/src/SimCore/KaonPhysics.cxx

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ChargedKaonDecayChannel

◆ KaonZeroLongDecayChannel

◆ KaonZeroShortDecayChannel

Constructor & Destructor Documentation

◆ KaonPhysics()

Member Function Documentation

◆ ConstructParticle()

◆ ConstructProcess()

◆ DumpDecayDetails()

◆ setDecayProperties()

Member Data Documentation

◆ k0l_branching_ratios

◆ k0l_lifetime_factor

◆ k0s_branching_ratios

◆ k0s_lifetime_factor

◆ kminus_branching_ratios

◆ kminus_lifetime_factor

◆ kplus_branching_ratios

◆ kplus_lifetime_factor

◆ theLog_

◆ verbosity