G4ParticleGun Class Reference

#include <G4ParticleGun.hh>

Inheritance diagram for G4ParticleGun:

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

Static Public Member Functions
static G4bool	CheckVertexInsideWorld (const G4ThreeVector &pos)

Protected Member Functions
virtual void	SetInitialValues ()

Protected Attributes
G4int	NumberOfParticlesToBeGenerated = 0
G4double	particle_charge = 0.0
G4ParticleDefinition *	particle_definition = nullptr
G4double	particle_energy = 0.0
G4double	particle_momentum = 0.0
G4ParticleMomentum	particle_momentum_direction
G4ThreeVector	particle_polarization
G4ThreeVector	particle_position
G4double	particle_time = 0.0

Private Attributes
G4ParticleGunMessenger *	theMessenger = nullptr

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

References SetInitialValues().

G4ParticleGun() [2/4]

G4ParticleGun::G4ParticleGun

(

G4int

numberofparticles

)

Definition at line 43 of file G4ParticleGun.cc.

{
  SetInitialValues();
  NumberOfParticlesToBeGenerated = numberofparticles;
}

References NumberOfParticlesToBeGenerated, and SetInitialValues().

G4ParticleGun() [3/4]

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

Definition at line 49 of file G4ParticleGun.cc.

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

References NumberOfParticlesToBeGenerated, SetInitialValues(), and SetParticleDefinition().

~G4ParticleGun()

G4ParticleGun::~G4ParticleGun ( )

virtual

Definition at line 72 of file G4ParticleGun.cc.

{
  delete theMessenger;
}

References theMessenger.

G4ParticleGun() [4/4]

G4ParticleGun::G4ParticleGun ( const G4ParticleGun &  right )

delete

Definition at line 46 of file pyG4ParticleGun.cc.

{
  *this= right;
}

Member Function Documentation

CheckVertexInsideWorld()

G4bool G4VPrimaryGenerator::CheckVertexInsideWorld ( const G4ThreeVector &  pos )

staticinherited

Definition at line 43 of file G4VPrimaryGenerator.cc.

{
  G4Navigator* navigator= G4TransportationManager::GetTransportationManager()
                                                 -> GetNavigatorForTracking();
  
  G4VPhysicalVolume* world= navigator-> GetWorldVolume();
  G4VSolid* solid = world-> GetLogicalVolume()-> GetSolid();
  EInside qinside = solid-> Inside(pos);
  
  return (qinside != kInside) ? false : true;
}

References G4TransportationManager::GetTransportationManager(), kInside, write_gdml::navigator, and pos.

GeneratePrimaryVertex()

void G4ParticleGun::GeneratePrimaryVertex ( G4Event *  evt )

virtual

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

References G4Event::AddPrimaryVertex(), FatalException, G4endl, G4Exception(), G4ParticleDefinition::GetPDGMass(), NumberOfParticlesToBeGenerated, particle_charge, particle_definition, particle_energy, particle_momentum_direction, particle_polarization, G4VPrimaryGenerator::particle_position, G4VPrimaryGenerator::particle_time, G4PrimaryParticle::SetCharge(), G4PrimaryParticle::SetKineticEnergy(), G4PrimaryParticle::SetMass(), G4PrimaryParticle::SetMomentumDirection(), G4PrimaryParticle::SetPolarization(), G4PrimaryVertex::SetPrimary(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by export_G4ParticleGun(), and PrimaryGeneratorAction::GeneratePrimaries().

GetNumberOfParticles()

G4int G4ParticleGun::GetNumberOfParticles ( ) const

inline

Definition at line 117 of file G4ParticleGun.hh.

      { return NumberOfParticlesToBeGenerated; }

References NumberOfParticlesToBeGenerated.

Referenced by export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

GetParticleCharge()

G4double G4ParticleGun::GetParticleCharge ( ) const

inline

Definition at line 113 of file G4ParticleGun.hh.

      { return particle_charge; }

References particle_charge.

Referenced by export_G4ParticleGun().

GetParticleDefinition()

G4ParticleDefinition * G4ParticleGun::GetParticleDefinition ( ) const

inline

Definition at line 105 of file G4ParticleGun.hh.

      { return particle_definition; }

References particle_definition.

Referenced by RunAction::BeginOfRunAction(), export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

GetParticleEnergy()

G4double G4ParticleGun::GetParticleEnergy ( ) const

inline

Definition at line 109 of file G4ParticleGun.hh.

      { return particle_energy; }

References particle_energy.

Referenced by RunAction::BeginOfRunAction(), export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

GetParticleMomentum()

G4double G4ParticleGun::GetParticleMomentum ( ) const

inline

Definition at line 111 of file G4ParticleGun.hh.

      { return particle_momentum; }

References particle_momentum.

Referenced by G4ParticleGunMessenger::GetCurrentValue().

GetParticleMomentumDirection()

G4ParticleMomentum G4ParticleGun::GetParticleMomentumDirection ( ) const

inline

Definition at line 107 of file G4ParticleGun.hh.

      { return particle_momentum_direction; }

References particle_momentum_direction.

Referenced by export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

GetParticlePolarization()

G4ThreeVector G4ParticleGun::GetParticlePolarization ( ) const

inline

Definition at line 115 of file G4ParticleGun.hh.

      { return particle_polarization; }

References particle_polarization.

Referenced by export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

GetParticlePosition()

G4ThreeVector G4VPrimaryGenerator::GetParticlePosition ( )

inlineinherited

Definition at line 60 of file G4VPrimaryGenerator.hh.

{ return particle_position; }

References G4VPrimaryGenerator::particle_position.

Referenced by export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

GetParticleTime()

G4double G4VPrimaryGenerator::GetParticleTime ( )

inlineinherited

Definition at line 61 of file G4VPrimaryGenerator.hh.

{ return particle_time; }

References G4VPrimaryGenerator::particle_time.

Referenced by export_G4ParticleGun(), and G4ParticleGunMessenger::GetCurrentValue().

operator!=()

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

delete

Definition at line 74 of file pyG4ParticleGun.cc.

{
  return false;
}

operator=()

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

delete

Definition at line 53 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;
}

References NumberOfParticlesToBeGenerated, particle_charge, particle_definition, particle_energy, particle_momentum_direction, and particle_polarization.

operator==()

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

delete

Definition at line 67 of file pyG4ParticleGun.cc.

{
  return false;
}

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

References NumberOfParticlesToBeGenerated, particle_charge, particle_definition, particle_energy, particle_momentum, particle_momentum_direction, particle_polarization, G4VPrimaryGenerator::particle_position, G4VPrimaryGenerator::particle_time, theMessenger, and anonymous_namespace{G4CascadeDeexciteBase.cc}::zero.

Referenced by G4ParticleGun().

SetNumberOfParticles()

void G4ParticleGun::SetNumberOfParticles ( G4int  i )

inline

Definition at line 102 of file G4ParticleGun.hh.

      { NumberOfParticlesToBeGenerated = i; }

References NumberOfParticlesToBeGenerated.

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

SetParticleCharge()

void G4ParticleGun::SetParticleCharge ( G4double  aCharge )

inline

Definition at line 98 of file G4ParticleGun.hh.

      { particle_charge = aCharge; }

References particle_charge.

Referenced by export_G4ParticleGun(), G4ParticleGunMessenger::IonCommand(), and G4ParticleGunMessenger::IonLevelCommand().

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

References FatalException, G4endl, G4Exception(), G4ParticleDefinition::GetDecayTable(), G4ParticleDefinition::GetParticleName(), G4ParticleDefinition::GetPDGCharge(), G4ParticleDefinition::GetPDGMass(), G4ParticleDefinition::IsShortLived(), JustWarning, particle_charge, particle_definition, particle_energy, and particle_momentum.

Referenced by export_G4ParticleGun(), G4ParticleGun(), G4ParticleGunMessenger::G4ParticleGunMessenger(), G4ParticleGunMessenger::IonCommand(), G4ParticleGunMessenger::IonLevelCommand(), PrimaryGeneratorAction::SetDefaultKinematic(), 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;
  }
}

References G4cout, G4endl, G4ParticleDefinition::GetParticleName(), GeV, particle_definition, particle_energy, and particle_momentum.

Referenced by export_G4ParticleGun(), G4ParticleGunMessenger::G4ParticleGunMessenger(), PrimaryGeneratorAction::SetDefaultKinematic(), 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;
  }
}

References G4cout, G4endl, G4ParticleDefinition::GetParticleName(), G4ParticleDefinition::GetPDGMass(), GeV, particle_definition, particle_energy, and particle_momentum.

Referenced by export_G4ParticleGun(), and 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;
  }
}

References G4cout, G4endl, G4ParticleDefinition::GetParticleName(), G4ParticleDefinition::GetPDGMass(), GeV, CLHEP::Hep3Vector::mag(), particle_definition, particle_energy, particle_momentum, particle_momentum_direction, and CLHEP::Hep3Vector::unit().

SetParticleMomentumDirection()

void G4ParticleGun::SetParticleMomentumDirection ( G4ParticleMomentum  aMomDirection )

inline

Definition at line 96 of file G4ParticleGun.hh.

      { particle_momentum_direction =  aMomDirection.unit(); }

References particle_momentum_direction, and CLHEP::Hep3Vector::unit().

Referenced by export_G4ParticleGun(), G4ParticleGunMessenger::G4ParticleGunMessenger(), PrimaryGeneratorAction::SetDefaultKinematic(), and G4ParticleGunMessenger::SetNewValue().

SetParticlePolarization()

void G4ParticleGun::SetParticlePolarization ( G4ThreeVector  aVal )

inline

Definition at line 100 of file G4ParticleGun.hh.

      { particle_polarization = aVal; }

References particle_polarization.

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

SetParticlePosition()

void G4VPrimaryGenerator::SetParticlePosition ( G4ThreeVector  aPosition )

inlineinherited

Definition at line 63 of file G4VPrimaryGenerator.hh.

      { particle_position = aPosition; }

References G4VPrimaryGenerator::particle_position.

Referenced by export_G4ParticleGun(), G4ParticleGunMessenger::G4ParticleGunMessenger(), PrimaryGeneratorAction::SetDefaultKinematic(), and G4ParticleGunMessenger::SetNewValue().

SetParticleTime()

void G4VPrimaryGenerator::SetParticleTime ( G4double  aTime )

inlineinherited

Definition at line 65 of file G4VPrimaryGenerator.hh.

      { particle_time = aTime; }

References G4VPrimaryGenerator::particle_time.

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

Field Documentation

NumberOfParticlesToBeGenerated

G4int G4ParticleGun::NumberOfParticlesToBeGenerated = 0

protected

Definition at line 124 of file G4ParticleGun.hh.

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

particle_charge

G4double G4ParticleGun::particle_charge = 0.0

protected

Definition at line 129 of file G4ParticleGun.hh.

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

particle_definition

G4ParticleDefinition* G4ParticleGun::particle_definition = nullptr

protected

Definition at line 125 of file G4ParticleGun.hh.

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

particle_energy

G4double G4ParticleGun::particle_energy = 0.0

protected

Definition at line 127 of file G4ParticleGun.hh.

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

particle_momentum

G4double G4ParticleGun::particle_momentum = 0.0

protected

Definition at line 128 of file G4ParticleGun.hh.

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

particle_momentum_direction

G4ParticleMomentum G4ParticleGun::particle_momentum_direction

protected

Definition at line 126 of file G4ParticleGun.hh.

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

particle_polarization

G4ThreeVector G4ParticleGun::particle_polarization

protected

Definition at line 130 of file G4ParticleGun.hh.

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

particle_position

G4ThreeVector G4VPrimaryGenerator::particle_position

protectedinherited

Definition at line 70 of file G4VPrimaryGenerator.hh.

Referenced by G4HEPEvtInterface::G4HEPEvtInterface(), G4HEPEvtInterface::GeneratePrimaryVertex(), GeneratePrimaryVertex(), G4VPrimaryGenerator::GetParticlePosition(), SetInitialValues(), and G4VPrimaryGenerator::SetParticlePosition().

particle_time

G4double G4VPrimaryGenerator::particle_time = 0.0

protectedinherited

Definition at line 71 of file G4VPrimaryGenerator.hh.

Referenced by G4HEPEvtInterface::G4HEPEvtInterface(), G4HEPEvtInterface::GeneratePrimaryVertex(), GeneratePrimaryVertex(), G4VPrimaryGenerator::GetParticleTime(), SetInitialValues(), and G4VPrimaryGenerator::SetParticleTime().

theMessenger

G4ParticleGunMessenger* G4ParticleGun::theMessenger = nullptr

private

Definition at line 134 of file G4ParticleGun.hh.

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

---

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

• source/event/include/G4ParticleGun.hh
• environments/g4py/source/event/pyG4ParticleGun.cc
• source/event/src/G4ParticleGun.cc