G4ParticleGun Class Reference

#include <G4ParticleGun.hh>

Inheritance diagram for G4ParticleGun:

Collaboration diagram for G4ParticleGun:

Public Member Functions
	G4ParticleGun ()
	G4ParticleGun (G4int numberofparticles)
	G4ParticleGun (G4ParticleDefinition *particleDef, G4int numberofparticles=1)
virtual	~G4ParticleGun ()
virtual void	GeneratePrimaryVertex (G4Event *evt)
void	SetParticleDefinition (G4ParticleDefinition *aParticleDefinition)
void	SetParticleEnergy (G4double aKineticEnergy)
void	SetParticleMomentum (G4double aMomentum)
void	SetParticleMomentum (G4ParticleMomentum aMomentum)
void	SetParticleMomentumDirection (G4ParticleMomentum aMomentumDirection)
void	SetParticleCharge (G4double aCharge)
void	SetParticlePolarization (G4ThreeVector aVal)
void	SetNumberOfParticles (G4int i)
G4ParticleDefinition *	GetParticleDefinition () const
G4ParticleMomentum	GetParticleMomentumDirection () const
G4double	GetParticleEnergy () const
G4double	GetParticleMomentum () const
G4double	GetParticleCharge () const
G4ThreeVector	GetParticlePolarization () const
G4int	GetNumberOfParticles () const
Public Member Functions inherited from G4VPrimaryGenerator
	G4VPrimaryGenerator ()
virtual	~G4VPrimaryGenerator ()
G4ThreeVector	GetParticlePosition ()
G4double	GetParticleTime ()
void	SetParticlePosition (G4ThreeVector aPosition)
void	SetParticleTime (G4double aTime)

Protected Member Functions
virtual void	SetInitialValues ()

Protected Attributes
G4int	NumberOfParticlesToBeGenerated
G4ParticleDefinition *	particle_definition
G4ParticleMomentum	particle_momentum_direction
G4double	particle_energy
G4double	particle_momentum
G4double	particle_charge
G4ThreeVector	particle_polarization
Protected Attributes inherited from G4VPrimaryGenerator
G4ThreeVector	particle_position
G4double	particle_time

Private Member Functions
	G4ParticleGun (const G4ParticleGun &)=delete
const G4ParticleGun &	operator= (const G4ParticleGun &)=delete
G4int	operator== (const G4ParticleGun &) const =delete
G4int	operator!= (const G4ParticleGun &) const =delete

Private Attributes
G4ParticleGunMessenger *	theMessenger

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

Detailed Description

Definition at line 62 of file G4ParticleGun.hh.

Constructor & Destructor Documentation

G4ParticleGun() [1/4]

G4ParticleGun::G4ParticleGun

(

)

Definition at line 38 of file G4ParticleGun.cc.

{
  SetInitialValues();
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4ParticleGun() [2/4]

G4ParticleGun::G4ParticleGun

(

G4int

numberofparticles

)

Definition at line 43 of file G4ParticleGun.cc.

{
  SetInitialValues();
  NumberOfParticlesToBeGenerated = numberofparticles;
}

Here is the call graph for this function:

G4ParticleGun() [3/4]

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

Definition at line 50 of file G4ParticleGun.cc.

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

Here is the call graph for this function:

~G4ParticleGun()

G4ParticleGun::~G4ParticleGun ( )

virtual

Definition at line 72 of file G4ParticleGun.cc.

{
  delete theMessenger;
}

Here is the call graph for this function:

G4ParticleGun() [4/4]

G4ParticleGun::G4ParticleGun ( const G4ParticleGun &  right )

privatedelete

Definition at line 47 of file pyG4ParticleGun.cc.

{
  *this= right;
}

Member Function Documentation

GeneratePrimaryVertex()

void G4ParticleGun::GeneratePrimaryVertex ( G4Event *  evt )

virtual

Implements G4VPrimaryGenerator.

Definition at line 212 of file G4ParticleGun.cc.

{
  if(!particle_definition) 
  {
    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
  G4PrimaryVertex* 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++ ){
    G4PrimaryParticle* 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());
    vertex->SetPrimary( particle );
  }

  evt->AddPrimaryVertex( vertex );
}

Here is the call graph for this function:

GetNumberOfParticles()

G4int G4ParticleGun::GetNumberOfParticles ( ) const

inline

Definition at line 118 of file G4ParticleGun.hh.

     { return NumberOfParticlesToBeGenerated; }

Here is the call graph for this function:

Here is the caller graph for this function:

GetParticleCharge()

G4double G4ParticleGun::GetParticleCharge ( ) const

inline

Definition at line 114 of file G4ParticleGun.hh.

     { return particle_charge; }

Here is the caller graph for this function:

GetParticleDefinition()

G4ParticleDefinition* G4ParticleGun::GetParticleDefinition ( ) const

inline

Definition at line 106 of file G4ParticleGun.hh.

     { return particle_definition; }

Here is the caller graph for this function:

GetParticleEnergy()

G4double G4ParticleGun::GetParticleEnergy ( ) const

inline

Definition at line 110 of file G4ParticleGun.hh.

     { return particle_energy; }

Here is the caller graph for this function:

GetParticleMomentum()

G4double G4ParticleGun::GetParticleMomentum ( ) const

inline

Definition at line 112 of file G4ParticleGun.hh.

     { return particle_momentum; }

Here is the caller graph for this function:

GetParticleMomentumDirection()

G4ParticleMomentum G4ParticleGun::GetParticleMomentumDirection ( ) const

inline

Definition at line 108 of file G4ParticleGun.hh.

     { return particle_momentum_direction; }

Here is the caller graph for this function:

GetParticlePolarization()

G4ThreeVector G4ParticleGun::GetParticlePolarization ( ) const

inline

Definition at line 116 of file G4ParticleGun.hh.

     { return particle_polarization; }

Here is the caller graph for this function:

operator!=()

G4int G4ParticleGun::operator!= ( const G4ParticleGun &  right ) const

privatedelete

Definition at line 75 of file pyG4ParticleGun.cc.

{
  return 0;
}

operator=()

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

privatedelete

Definition at line 54 of file pyG4ParticleGun.cc.

{
   NumberOfParticlesToBeGenerated= right.NumberOfParticlesToBeGenerated;
   particle_definition= right.particle_definition;
   particle_momentum_direction= right.particle_momentum_direction;
   particle_energy= right.particle_energy;
   particle_charge= right.particle_charge;
   particle_polarization= right.particle_polarization;

   return *this;
}

operator==()

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

privatedelete

Definition at line 68 of file pyG4ParticleGun.cc.

{
  return 0;
}

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);
}

Here is the caller graph for this function:

SetNumberOfParticles()

void G4ParticleGun::SetNumberOfParticles ( G4int  i )

inline

Definition at line 102 of file G4ParticleGun.hh.

     { NumberOfParticlesToBeGenerated = i; }

Here is the caller graph for this function:

SetParticleCharge()

void G4ParticleGun::SetParticleCharge ( G4double  aCharge )

inline

Definition at line 98 of file G4ParticleGun.hh.

     { particle_charge = aCharge; }

Here is the caller graph for this function:

SetParticleDefinition()

void G4ParticleGun::SetParticleDefinition

(

G4ParticleDefinition *

aParticleDefinition

)

Definition at line 102 of file G4ParticleGun.cc.

{ 
  if(!aParticleDefinition)
  {
    G4Exception("G4ParticleGun::SetParticleDefinition()","Event0101",
     FatalException,"Null pointer is given.");
  }
  if(aParticleDefinition->IsShortLived())
  {
    if(!(aParticleDefinition->GetDecayTable()))
    {
      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;
  }
}

Here is the call graph for this function:

SetParticleEnergy()

void G4ParticleGun::SetParticleEnergy

(

G4double

aKineticEnergy

)

Definition at line 132 of file G4ParticleGun.cc.

{
  particle_energy = aKineticEnergy;
  if(particle_momentum>0.0){
    if(particle_definition){
      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;
  }
}

Here is the call graph for this function:

SetParticleMomentum() [1/2]

void G4ParticleGun::SetParticleMomentum

(

G4double

aMomentum

)

Definition at line 150 of file G4ParticleGun.cc.

{
  if(particle_energy>0.0){
    if(particle_definition){
      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)
  {
    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;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetParticleMomentum() [2/2]

void G4ParticleGun::SetParticleMomentum

(

G4ParticleMomentum

aMomentum

)

Definition at line 180 of file G4ParticleGun.cc.

{
  if(particle_energy>0.0){
    if(particle_definition){
      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)
  {
    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;
  }
}

Here is the call graph for this function:

SetParticleMomentumDirection()

void G4ParticleGun::SetParticleMomentumDirection ( G4ParticleMomentum  aMomentumDirection )

inline

Definition at line 96 of file G4ParticleGun.hh.

     { particle_momentum_direction =  aMomentumDirection.unit(); }

Here is the call graph for this function:

SetParticlePolarization()

void G4ParticleGun::SetParticlePolarization ( G4ThreeVector  aVal )

inline

Definition at line 100 of file G4ParticleGun.hh.

     { particle_polarization = aVal; }

Here is the caller graph for this function:

Member Data Documentation

NumberOfParticlesToBeGenerated

G4int G4ParticleGun::NumberOfParticlesToBeGenerated

protected

Definition at line 124 of file G4ParticleGun.hh.

particle_charge

G4double G4ParticleGun::particle_charge

protected

Definition at line 129 of file G4ParticleGun.hh.

particle_definition

G4ParticleDefinition* G4ParticleGun::particle_definition

protected

Definition at line 125 of file G4ParticleGun.hh.

particle_energy

G4double G4ParticleGun::particle_energy

protected

Definition at line 127 of file G4ParticleGun.hh.

particle_momentum

G4double G4ParticleGun::particle_momentum

protected

Definition at line 128 of file G4ParticleGun.hh.

particle_momentum_direction

G4ParticleMomentum G4ParticleGun::particle_momentum_direction

protected

Definition at line 126 of file G4ParticleGun.hh.

particle_polarization

G4ThreeVector G4ParticleGun::particle_polarization

protected

Definition at line 130 of file G4ParticleGun.hh.

theMessenger

G4ParticleGunMessenger* G4ParticleGun::theMessenger

private

Definition at line 133 of file G4ParticleGun.hh.

---

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

• G4ParticleGun.hh
• pyG4ParticleGun.cc
• G4ParticleGun.cc