Primary generator. More...

#include <Doxymodules_basic.h>

Inheritance diagram for B5::PrimaryGeneratorAction:

Public Member Functions
	PrimaryGeneratorAction ()

	~PrimaryGeneratorAction () override

void	GeneratePrimaries (G4Event *) override

void	SetMomentum (G4double val)

G4double	GetMomentum () const

void	SetSigmaMomentum (G4double val)

G4double	GetSigmaMomentum () const

void	SetSigmaAngle (G4double val)

G4double	GetSigmaAngle () const

void	SetRandomize (G4bool val)

G4bool	GetRandomize () const

Private Member Functions
void	DefineCommands ()

Private Attributes
G4ParticleGun *	fParticleGun = nullptr

G4GenericMessenger *	fMessenger = nullptr

G4ParticleDefinition *	fPositron = nullptr

G4ParticleDefinition *	fMuon = nullptr

G4ParticleDefinition *	fPion = nullptr

G4ParticleDefinition *	fKaon = nullptr

G4ParticleDefinition *	fProton = nullptr

G4double	fMomentum = 1000. * CLHEP::MeV

G4double	fSigmaMomentum = 50. * CLHEP::MeV

G4double	fSigmaAngle = 2. * CLHEP::deg

G4bool	fRandomizePrimary = true

Detailed Description

Primary generator.

A single particle is generated. User can select

the initial momentum and angle
the momentum and angle spreads
random selection of a particle type from proton, kaon+, pi+, muon+, e+

Definition at line 197 of file Doxymodules_basic.h.

Constructor & Destructor Documentation

◆ PrimaryGeneratorAction()

B5::PrimaryGeneratorAction::PrimaryGeneratorAction ( )

Definition at line 45 of file PrimaryGeneratorAction.cc.

{
  G4int nofParticles = 1;
  fParticleGun  = new G4ParticleGun(nofParticles);
 
  auto particleTable = G4ParticleTable::GetParticleTable();
  fPositron = particleTable->FindParticle("e+");
  fMuon = particleTable->FindParticle("mu+");
  fPion = particleTable->FindParticle("pi+");
  fKaon = particleTable->FindParticle("kaon+");
  fProton = particleTable->FindParticle("proton");
 
  // default particle kinematics
  fParticleGun->SetParticlePosition(G4ThreeVector(0.,0.,-8.*m));
  fParticleGun->SetParticleDefinition(fPositron);
 
  // define commands for this class
  DefineCommands();
}

◆ ~PrimaryGeneratorAction()

B5::PrimaryGeneratorAction::~PrimaryGeneratorAction ( )

override

Definition at line 75 of file PrimaryGeneratorAction.cc.

{
  delete fParticleGun;
  delete fMessenger;
}

Member Function Documentation

◆ GeneratePrimaries()

void B5::PrimaryGeneratorAction::GeneratePrimaries ( G4Event * event )

override

Definition at line 83 of file PrimaryGeneratorAction.cc.

{
  G4ParticleDefinition* particle;
  if (fRandomizePrimary) {
    auto i = (int)(5. * G4UniformRand());
    switch(i) {
      case 0:
          particle = fPositron;
          break;
      case 1:
          particle = fMuon;
          break;
      case 2:
          particle = fPion;
          break;
      case 3:
          particle = fKaon;
          break;
      default:
          particle = fProton;
          break;
    }
    fParticleGun->SetParticleDefinition(particle);
  }
  else {
    particle = fParticleGun->GetParticleDefinition();
  }
 
  auto pp = fMomentum + (G4UniformRand()-0.5)*fSigmaMomentum;
  auto mass = particle->GetPDGMass();
  auto ekin = std::sqrt(pp*pp+mass*mass)-mass;
  fParticleGun->SetParticleEnergy(ekin);
 
  auto angle = (G4UniformRand()-0.5)*fSigmaAngle;
  fParticleGun->SetParticleMomentumDirection(
                  G4ThreeVector(std::sin(angle),0.,std::cos(angle)));
 
  fParticleGun->GeneratePrimaryVertex(event);
}

◆ SetMomentum()

void B5::PrimaryGeneratorAction::SetMomentum ( G4double val )

inline

Definition at line 63 of file PrimaryGeneratorAction.hh.

63{ fMomentum = val; }

◆ GetMomentum()

G4double B5::PrimaryGeneratorAction::GetMomentum ( ) const

inline

Definition at line 64 of file PrimaryGeneratorAction.hh.

64{ return fMomentum; }

◆ SetSigmaMomentum()

void B5::PrimaryGeneratorAction::SetSigmaMomentum ( G4double val )

inline

Definition at line 66 of file PrimaryGeneratorAction.hh.

66{ fSigmaMomentum = val; }

◆ GetSigmaMomentum()

G4double B5::PrimaryGeneratorAction::GetSigmaMomentum ( ) const

inline

Definition at line 67 of file PrimaryGeneratorAction.hh.

67{ return fSigmaMomentum; }

◆ SetSigmaAngle()

void B5::PrimaryGeneratorAction::SetSigmaAngle ( G4double val )

inline

Definition at line 69 of file PrimaryGeneratorAction.hh.

69{ fSigmaAngle = val; }

◆ GetSigmaAngle()

G4double B5::PrimaryGeneratorAction::GetSigmaAngle ( ) const

inline

Definition at line 70 of file PrimaryGeneratorAction.hh.

70{ return fSigmaAngle; }

◆ SetRandomize()

void B5::PrimaryGeneratorAction::SetRandomize ( G4bool val )

inline

Definition at line 72 of file PrimaryGeneratorAction.hh.

72{ fRandomizePrimary = val; }

◆ GetRandomize()

G4bool B5::PrimaryGeneratorAction::GetRandomize ( ) const

inline

Definition at line 73 of file PrimaryGeneratorAction.hh.

73{ return fRandomizePrimary; }

◆ DefineCommands()

void B5::PrimaryGeneratorAction::DefineCommands ( )

private

Definition at line 125 of file PrimaryGeneratorAction.cc.

{
  // Define /B5/generator command directory using generic messenger class
  fMessenger
    = new G4GenericMessenger(this,
                             "/B5/generator/",
                             "Primary generator control");
 
  // momentum command
  auto& momentumCmd
    = fMessenger->DeclarePropertyWithUnit("momentum", "GeV", fMomentum,
        "Mean momentum of primaries.");
  momentumCmd.SetParameterName("p", true);
  momentumCmd.SetRange("p>=0.");
  momentumCmd.SetDefaultValue("1.");
  // ok
  //momentumCmd.SetParameterName("p", true);
  //momentumCmd.SetRange("p>=0.");
 
  // sigmaMomentum command
  auto& sigmaMomentumCmd
    = fMessenger->DeclarePropertyWithUnit("sigmaMomentum",
        "MeV", fSigmaMomentum, "Sigma momentum of primaries.");
  sigmaMomentumCmd.SetParameterName("sp", true);
  sigmaMomentumCmd.SetRange("sp>=0.");
  sigmaMomentumCmd.SetDefaultValue("50.");
 
  // sigmaAngle command
  auto& sigmaAngleCmd
    = fMessenger->DeclarePropertyWithUnit("sigmaAngle", "deg", fSigmaAngle,
        "Sigma angle divergence of primaries.");
  sigmaAngleCmd.SetParameterName("t", true);
  sigmaAngleCmd.SetRange("t>=0.");
  sigmaAngleCmd.SetDefaultValue("2.");
 
  // randomizePrimary command
  auto& randomCmd
    = fMessenger->DeclareProperty("randomizePrimary", fRandomizePrimary);
  G4String guidance
    = "Boolean flag for randomizing primary particle types.\n";
  guidance
    += "In case this flag is false, you can select the primary particle\n";
  guidance += "  with /gun/particle command.";
  randomCmd.SetGuidance(guidance);
  randomCmd.SetParameterName("flg", true);
  randomCmd.SetDefaultValue("true");
}

Member Data Documentation

◆ fParticleGun

G4ParticleGun* B5::PrimaryGeneratorAction::fParticleGun = nullptr

private

Definition at line 78 of file PrimaryGeneratorAction.hh.

◆ fMessenger

G4GenericMessenger* B5::PrimaryGeneratorAction::fMessenger = nullptr

private

Definition at line 79 of file PrimaryGeneratorAction.hh.

◆ fPositron

G4ParticleDefinition* B5::PrimaryGeneratorAction::fPositron = nullptr

private

Definition at line 80 of file PrimaryGeneratorAction.hh.

◆ fMuon

G4ParticleDefinition* B5::PrimaryGeneratorAction::fMuon = nullptr

private

Definition at line 81 of file PrimaryGeneratorAction.hh.

◆ fPion

G4ParticleDefinition* B5::PrimaryGeneratorAction::fPion = nullptr

private

Definition at line 82 of file PrimaryGeneratorAction.hh.

◆ fKaon

G4ParticleDefinition* B5::PrimaryGeneratorAction::fKaon = nullptr

private

Definition at line 83 of file PrimaryGeneratorAction.hh.

◆ fProton

G4ParticleDefinition* B5::PrimaryGeneratorAction::fProton = nullptr

private

Definition at line 84 of file PrimaryGeneratorAction.hh.

◆ fMomentum

G4double B5::PrimaryGeneratorAction::fMomentum = 1000. * CLHEP::MeV

private

Definition at line 85 of file PrimaryGeneratorAction.hh.

◆ fSigmaMomentum

G4double B5::PrimaryGeneratorAction::fSigmaMomentum = 50. * CLHEP::MeV

private

Definition at line 86 of file PrimaryGeneratorAction.hh.

◆ fSigmaAngle

G4double B5::PrimaryGeneratorAction::fSigmaAngle = 2. * CLHEP::deg

private

Definition at line 87 of file PrimaryGeneratorAction.hh.

◆ fRandomizePrimary

G4bool B5::PrimaryGeneratorAction::fRandomizePrimary = true

private

Definition at line 88 of file PrimaryGeneratorAction.hh.

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

.doxygen/Doxymodules_basic.h
basic/B5/include/PrimaryGeneratorAction.hh
basic/B5/src/PrimaryGeneratorAction.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PrimaryGeneratorAction()

◆ ~PrimaryGeneratorAction()

Member Function Documentation

◆ GeneratePrimaries()

◆ SetMomentum()

◆ GetMomentum()

◆ SetSigmaMomentum()

◆ GetSigmaMomentum()

◆ SetSigmaAngle()

◆ GetSigmaAngle()

◆ SetRandomize()

◆ GetRandomize()

◆ DefineCommands()

Member Data Documentation

◆ fParticleGun

◆ fMessenger

◆ fPositron

◆ fMuon

◆ fPion

◆ fKaon

◆ fProton

◆ fMomentum

◆ fSigmaMomentum

◆ fSigmaAngle

◆ fRandomizePrimary