#include <G4ParticleGun.hh>

Inheritance diagram for G4ParticleGun:

Public Member Functions
	G4ParticleGun ()

	G4ParticleGun (G4int numberofparticles)

	G4ParticleGun (G4ParticleDefinition *particleDef, G4int numberofparticles=1)

	~G4ParticleGun () override

	G4ParticleGun (const G4ParticleGun &)=delete

const G4ParticleGun &	operator= (const G4ParticleGun &)=delete

G4bool	operator== (const G4ParticleGun &) const =delete

G4bool	operator!= (const G4ParticleGun &) const =delete

void	GeneratePrimaryVertex (G4Event *evt) override

void	SetParticleDefinition (G4ParticleDefinition *aParticleDefinition)

void	SetParticleEnergy (G4double aKineticEnergy)

void	SetParticleMomentum (G4double aMomentum)

void	SetParticleMomentum (G4ParticleMomentum aMomentum)

void	SetParticleMomentumDirection (G4ParticleMomentum aMomDirection)

void	SetParticleCharge (G4double aCharge)

void	SetParticlePolarization (G4ThreeVector aVal)

void	SetNumberOfParticles (G4int i)

void	SetParticleWeight (G4double w)

G4ParticleDefinition *	GetParticleDefinition () const

G4ParticleMomentum	GetParticleMomentumDirection () const

G4double	GetParticleEnergy () const

G4double	GetParticleMomentum () const

G4double	GetParticleCharge () const

G4ThreeVector	GetParticlePolarization () const

G4int	GetNumberOfParticles () const

G4double	GetParticleWeight () const

Public Member Functions inherited from G4VPrimaryGenerator
	G4VPrimaryGenerator ()=default

virtual	~G4VPrimaryGenerator ()=default

G4ThreeVector	GetParticlePosition ()

G4double	GetParticleTime ()

void	SetParticlePosition (G4ThreeVector aPosition)

void	SetParticleTime (G4double aTime)

Protected Member Functions
virtual void	SetInitialValues ()

Protected Attributes
G4int	NumberOfParticlesToBeGenerated = 0

G4ParticleDefinition *	particle_definition = nullptr

G4ParticleMomentum	particle_momentum_direction

G4double	particle_energy = 0.0

G4double	particle_momentum = 0.0

G4double	particle_charge = 0.0

G4ThreeVector	particle_polarization

G4double	particle_weight = 1.0

Protected Attributes inherited from G4VPrimaryGenerator
G4ThreeVector	particle_position

G4double	particle_time = 0.0

Additional Inherited Members
Static Public Member Functions inherited from G4VPrimaryGenerator
static G4bool	CheckVertexInsideWorld (const G4ThreeVector &pos)

Detailed Description

Definition at line 64 of file G4ParticleGun.hh.

Constructor & Destructor Documentation

◆ G4ParticleGun() [1/4]

G4ParticleGun::G4ParticleGun ( )

Definition at line 38 of file G4ParticleGun.cc.

{
  SetInitialValues();
}

◆ G4ParticleGun() [2/4]

G4ParticleGun::G4ParticleGun ( G4int numberofparticles )

explicit

Definition at line 43 of file G4ParticleGun.cc.

{
  SetInitialValues();
  NumberOfParticlesToBeGenerated = numberofparticles;
}

◆ G4ParticleGun() [3/4]

G4ParticleGun::G4ParticleGun	(	G4ParticleDefinition *	particleDef,
		G4int	numberofparticles = 1 )

explicit

Definition at line 49 of file G4ParticleGun.cc.

{
  SetInitialValues();
  NumberOfParticlesToBeGenerated = numberofparticles;
  SetParticleDefinition( particleDef );
}

◆ ~G4ParticleGun()

G4ParticleGun::~G4ParticleGun ( )

override

Definition at line 72 of file G4ParticleGun.cc.

{
  delete theMessenger;
}

◆ G4ParticleGun() [4/4]

G4ParticleGun::G4ParticleGun ( const G4ParticleGun & )

delete

Member Function Documentation

◆ GeneratePrimaryVertex()

void G4ParticleGun::GeneratePrimaryVertex ( G4Event * evt )

overridevirtual

Implements G4VPrimaryGenerator.

Definition at line 203 of file G4ParticleGun.cc.

{
  if(particle_definition == nullptr) 
  {
    G4ExceptionDescription ED;
    ED << "Particle definition is not defined." << G4endl;
    ED << "G4ParticleGun::SetParticleDefinition() has to be invoked beforehand."
       << G4endl;
    G4Exception("G4ParticleGun::GeneratePrimaryVertex()", "Event0109",
                FatalException, ED);
    return;
  }
 
  // Create a new vertex
  //
  auto* vertex = 
    new G4PrimaryVertex(particle_position,particle_time);
 
  // Create new primaries and set them to the vertex
  //
  G4double mass =  particle_definition->GetPDGMass();
  for( G4int i=0; i<NumberOfParticlesToBeGenerated; ++i )
  {
    auto* particle =
      new G4PrimaryParticle(particle_definition);
    particle->SetKineticEnergy( particle_energy );
    particle->SetMass( mass );
    particle->SetMomentumDirection( particle_momentum_direction );
    particle->SetCharge( particle_charge );
    particle->SetPolarization(particle_polarization.x(),
                              particle_polarization.y(),
                              particle_polarization.z());
    particle->SetWeight( particle_weight );
    vertex->SetPrimary( particle );
  }
  evt->AddPrimaryVertex( vertex );
}

◆ GetNumberOfParticles()

G4int G4ParticleGun::GetNumberOfParticles ( ) const

inline

Definition at line 119 of file G4ParticleGun.hh.

120 { return NumberOfParticlesToBeGenerated; }

Referenced by G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticleCharge()

G4double G4ParticleGun::GetParticleCharge ( ) const

inline

Definition at line 115 of file G4ParticleGun.hh.

116 { return particle_charge; }

◆ GetParticleDefinition()

G4ParticleDefinition * G4ParticleGun::GetParticleDefinition ( ) const

inline

Definition at line 107 of file G4ParticleGun.hh.

108 { return particle_definition; }

Referenced by G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticleEnergy()

G4double G4ParticleGun::GetParticleEnergy ( ) const

inline

Definition at line 111 of file G4ParticleGun.hh.

112 { return particle_energy; }

Referenced by G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticleMomentum()

G4double G4ParticleGun::GetParticleMomentum ( ) const

inline

Definition at line 113 of file G4ParticleGun.hh.

114 { return particle_momentum; }

G4ParticleGun::particle_momentum

G4double particle_momentum

Definition G4ParticleGun.hh:132

Referenced by G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticleMomentumDirection()

G4ParticleMomentum G4ParticleGun::GetParticleMomentumDirection ( ) const

inline

Definition at line 109 of file G4ParticleGun.hh.

110 { return particle_momentum_direction; }

Referenced by G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticlePolarization()

G4ThreeVector G4ParticleGun::GetParticlePolarization ( ) const

inline

Definition at line 117 of file G4ParticleGun.hh.

118 { return particle_polarization; }

Referenced by G4ParticleGunMessenger::GetCurrentValue().

◆ GetParticleWeight()

G4double G4ParticleGun::GetParticleWeight ( ) const

inline

Definition at line 121 of file G4ParticleGun.hh.

122 { return particle_weight; }

◆ operator!=()

G4bool G4ParticleGun::operator!= ( const G4ParticleGun & ) const

delete

◆ operator=()

const G4ParticleGun & G4ParticleGun::operator= ( const G4ParticleGun & )

delete

◆ operator==()

G4bool G4ParticleGun::operator== ( const G4ParticleGun & ) const

delete

◆ SetInitialValues()

void G4ParticleGun::SetInitialValues ( )

protectedvirtual

Definition at line 57 of file G4ParticleGun.cc.

{
  NumberOfParticlesToBeGenerated = 1;
  particle_definition = nullptr;
  G4ThreeVector zero;
  particle_momentum_direction = (G4ParticleMomentum)zero;
  particle_energy = 0.0;
  particle_momentum = 0.0;
  particle_position = zero;
  particle_time = 0.0;
  particle_polarization = zero;
  particle_charge = 0.0;
  theMessenger = new G4ParticleGunMessenger(this);
}

Referenced by G4ParticleGun(), G4ParticleGun(), and G4ParticleGun().

◆ SetNumberOfParticles()

void G4ParticleGun::SetNumberOfParticles ( G4int i )

inline

Definition at line 102 of file G4ParticleGun.hh.

103 { NumberOfParticlesToBeGenerated = i; }

Referenced by G4ParticleGunMessenger::SetNewValue().

◆ SetParticleCharge()

void G4ParticleGun::SetParticleCharge ( G4double aCharge )

inline

Definition at line 98 of file G4ParticleGun.hh.

99 { particle_charge = aCharge; }

◆ SetParticleDefinition()

void G4ParticleGun::SetParticleDefinition ( G4ParticleDefinition * aParticleDefinition )

Definition at line 77 of file G4ParticleGun.cc.

{ 
  if(aParticleDefinition == nullptr)
  {
    G4Exception("G4ParticleGun::SetParticleDefinition()", "Event0101",
                FatalException, "Null pointer is given.");
  }
  if(aParticleDefinition->IsShortLived())
  {
    if(aParticleDefinition->GetDecayTable() == nullptr)
    {
      G4ExceptionDescription ED;
      ED << "G4ParticleGun does not support shooting a short-lived "
         << "particle without a valid decay table." << G4endl;
      ED << "G4ParticleGun::SetParticleDefinition for "
         << aParticleDefinition->GetParticleName() << " is ignored." << G4endl;
      G4Exception("G4ParticleGun::SetParticleDefinition()", "Event0102",
                  JustWarning, ED);
      return;
    }
  }
  particle_definition = aParticleDefinition; 
  particle_charge = particle_definition->GetPDGCharge();
  if(particle_momentum>0.0)
  {
    G4double mass = particle_definition->GetPDGMass();
    particle_energy =
      std::sqrt(particle_momentum*particle_momentum+mass*mass)-mass;
  }
}

Referenced by G4ParticleGun(), G4ParticleGunMessenger::G4ParticleGunMessenger(), and G4ParticleGunMessenger::SetNewValue().

◆ SetParticleEnergy()

void G4ParticleGun::SetParticleEnergy ( G4double aKineticEnergy )

Definition at line 109 of file G4ParticleGun.cc.

{
  particle_energy = aKineticEnergy;
  if(particle_momentum>0.0)
  {
    if(particle_definition != nullptr)
    {
      G4cout << "G4ParticleGun::" << particle_definition->GetParticleName()
             << G4endl;
    }
    else
    {
      G4cout << "G4ParticleGun::" << " " << G4endl;
    }
    G4cout << " was defined in terms of Momentum: " 
           << particle_momentum/GeV << "GeV/c" << G4endl;
    G4cout << " is now defined in terms of KineticEnergy: " 
           << particle_energy/GeV   << "GeV"   << G4endl;
    particle_momentum = 0.0;
  }
}

Referenced by G4ParticleGunMessenger::G4ParticleGunMessenger(), and G4ParticleGunMessenger::SetNewValue().

◆ SetParticleMomentum() [1/2]

void G4ParticleGun::SetParticleMomentum ( G4double aMomentum )

Definition at line 131 of file G4ParticleGun.cc.

{
  if(particle_energy>0.0)
  {
    if(particle_definition != nullptr)
    {
      G4cout << "G4ParticleGun::" << particle_definition->GetParticleName()
             << G4endl;
    }
    else
    {
      G4cout << "G4ParticleGun::" << " " << G4endl;
    }
    G4cout << " was defined in terms of KineticEnergy: "
           << particle_energy/GeV << "GeV"   << G4endl;
    G4cout << " is now defined in terms Momentum: "
           << aMomentum/GeV       << "GeV/c" << G4endl;
  }
  if(particle_definition == nullptr)
  {
    G4cout << "Particle Definition not defined yet for G4ParticleGun"
           << G4endl;
    G4cout << "Zero Mass is assumed" << G4endl;
    particle_momentum = aMomentum;
    particle_energy = aMomentum;
  }
  else
  {
    G4double mass = particle_definition->GetPDGMass();
    particle_momentum = aMomentum;
    particle_energy =
      std::sqrt(particle_momentum*particle_momentum+mass*mass)-mass;
  }
}

Referenced by G4ParticleGunMessenger::SetNewValue().

◆ SetParticleMomentum() [2/2]

void G4ParticleGun::SetParticleMomentum ( G4ParticleMomentum aMomentum )

Definition at line 166 of file G4ParticleGun.cc.

{
  if(particle_energy>0.0)
  {
    if(particle_definition != nullptr)
    {
      G4cout << "G4ParticleGun::" << particle_definition->GetParticleName()
             << G4endl;
    }
    else
    {
      G4cout << "G4ParticleGun::" << " " << G4endl;
    }
    G4cout << " was defined in terms of KineticEnergy: "
           << particle_energy/GeV << "GeV"   << G4endl;
    G4cout << " is now defined in terms Momentum: "
           << aMomentum.mag()/GeV << "GeV/c" << G4endl;
  }
  if(particle_definition == nullptr)
  {
    G4cout << "Particle Definition not defined yet for G4ParticleGun"
           << G4endl;
    G4cout << "Zero Mass is assumed" << G4endl;
    particle_momentum_direction = aMomentum.unit();
    particle_momentum = aMomentum.mag();
    particle_energy = aMomentum.mag();
  } 
  else 
  {
    G4double mass =  particle_definition->GetPDGMass();
    particle_momentum = aMomentum.mag();
    particle_momentum_direction = aMomentum.unit();
    particle_energy = 
      std::sqrt(particle_momentum*particle_momentum+mass*mass)-mass;
  }
}

◆ SetParticleMomentumDirection()

void G4ParticleGun::SetParticleMomentumDirection ( G4ParticleMomentum aMomDirection )

inline

Definition at line 96 of file G4ParticleGun.hh.

97 { particle_momentum_direction = aMomDirection.unit(); }

Referenced by G4ParticleGunMessenger::G4ParticleGunMessenger(), and G4ParticleGunMessenger::SetNewValue().

◆ SetParticlePolarization()

void G4ParticleGun::SetParticlePolarization ( G4ThreeVector aVal )

inline

Definition at line 100 of file G4ParticleGun.hh.

101 { particle_polarization = aVal; }

Referenced by G4ParticleGunMessenger::SetNewValue().

◆ SetParticleWeight()

void G4ParticleGun::SetParticleWeight ( G4double w )

inline

Definition at line 104 of file G4ParticleGun.hh.

105 { particle_weight = w; }

Member Data Documentation

◆ NumberOfParticlesToBeGenerated

G4int G4ParticleGun::NumberOfParticlesToBeGenerated = 0

protected

Definition at line 128 of file G4ParticleGun.hh.

Referenced by G4ParticleGun(), G4ParticleGun(), GeneratePrimaryVertex(), GetNumberOfParticles(), SetInitialValues(), and SetNumberOfParticles().

◆ particle_charge

G4double G4ParticleGun::particle_charge = 0.0

protected

Definition at line 133 of file G4ParticleGun.hh.

Referenced by GeneratePrimaryVertex(), GetParticleCharge(), SetInitialValues(), SetParticleCharge(), and SetParticleDefinition().

◆ particle_definition

G4ParticleDefinition* G4ParticleGun::particle_definition = nullptr

protected

Definition at line 129 of file G4ParticleGun.hh.

Referenced by GeneratePrimaryVertex(), GetParticleDefinition(), SetInitialValues(), SetParticleDefinition(), SetParticleEnergy(), SetParticleMomentum(), and SetParticleMomentum().

◆ particle_energy

G4double G4ParticleGun::particle_energy = 0.0

protected

Definition at line 131 of file G4ParticleGun.hh.

Referenced by GeneratePrimaryVertex(), GetParticleEnergy(), SetInitialValues(), SetParticleDefinition(), SetParticleEnergy(), SetParticleMomentum(), and SetParticleMomentum().

◆ particle_momentum

G4double G4ParticleGun::particle_momentum = 0.0

protected

Definition at line 132 of file G4ParticleGun.hh.

Referenced by GetParticleMomentum(), SetInitialValues(), SetParticleDefinition(), SetParticleEnergy(), SetParticleMomentum(), and SetParticleMomentum().

◆ particle_momentum_direction

G4ParticleMomentum G4ParticleGun::particle_momentum_direction

protected

Definition at line 130 of file G4ParticleGun.hh.

Referenced by GeneratePrimaryVertex(), GetParticleMomentumDirection(), SetInitialValues(), SetParticleMomentum(), and SetParticleMomentumDirection().

◆ particle_polarization

G4ThreeVector G4ParticleGun::particle_polarization

protected

Definition at line 134 of file G4ParticleGun.hh.

Referenced by GeneratePrimaryVertex(), GetParticlePolarization(), SetInitialValues(), and SetParticlePolarization().

◆ particle_weight

G4double G4ParticleGun::particle_weight = 1.0

protected

Definition at line 135 of file G4ParticleGun.hh.

Referenced by GeneratePrimaryVertex(), GetParticleWeight(), and SetParticleWeight().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4ParticleGun() [1/4]

◆ G4ParticleGun() [2/4]

◆ G4ParticleGun() [3/4]

◆ ~G4ParticleGun()

◆ G4ParticleGun() [4/4]

Member Function Documentation

◆ GeneratePrimaryVertex()

◆ GetNumberOfParticles()

◆ GetParticleCharge()

◆ GetParticleDefinition()

◆ GetParticleEnergy()

◆ GetParticleMomentum()

◆ GetParticleMomentumDirection()

◆ GetParticlePolarization()

◆ GetParticleWeight()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ SetInitialValues()

◆ SetNumberOfParticles()

◆ SetParticleCharge()

◆ SetParticleDefinition()

◆ SetParticleEnergy()

◆ SetParticleMomentum() [1/2]

◆ SetParticleMomentum() [2/2]

◆ SetParticleMomentumDirection()

◆ SetParticlePolarization()

◆ SetParticleWeight()

Member Data Documentation

◆ NumberOfParticlesToBeGenerated

◆ particle_charge

◆ particle_definition

◆ particle_energy

◆ particle_momentum

◆ particle_momentum_direction

◆ particle_polarization

◆ particle_weight