Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/event/src/G4ParticleGun.cc

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  1 //
  2 // ********************************************************************
  3 // * License and Disclaimer                                           *
  4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.                             *
 10 // *                                                                  *
 11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                                                  *
 18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // ********************************************************************
 25 //
 26 // G4ParticleGun class implementation
 27 //
 28 // Author: Makoto Asai, 1997
 29 // --------------------------------------------------------------------
 30 
 31 #include "G4ParticleGun.hh"
 32 #include "G4SystemOfUnits.hh"
 33 #include "G4PrimaryParticle.hh"
 34 #include "G4ParticleGunMessenger.hh"
 35 #include "G4Event.hh"
 36 #include "G4ios.hh"
 37 
 38 G4ParticleGun::G4ParticleGun()
 39 {
 40   SetInitialValues();
 41 }
 42 
 43 G4ParticleGun::G4ParticleGun(G4int numberofparticles)
 44 {
 45   SetInitialValues();
 46   NumberOfParticlesToBeGenerated = numberofparticles;
 47 }
 48 
 49 G4ParticleGun::G4ParticleGun(G4ParticleDefinition* particleDef,
 50                              G4int numberofparticles)
 51 {
 52   SetInitialValues();
 53   NumberOfParticlesToBeGenerated = numberofparticles;
 54   SetParticleDefinition( particleDef );
 55 }
 56 
 57 void G4ParticleGun::SetInitialValues()
 58 {
 59   NumberOfParticlesToBeGenerated = 1;
 60   particle_definition = nullptr;
 61   G4ThreeVector zero;
 62   particle_momentum_direction = (G4ParticleMomentum)zero;
 63   particle_energy = 0.0;
 64   particle_momentum = 0.0;
 65   particle_position = zero;
 66   particle_time = 0.0;
 67   particle_polarization = zero;
 68   particle_charge = 0.0;
 69   theMessenger = new G4ParticleGunMessenger(this);
 70 }
 71 
 72 G4ParticleGun::~G4ParticleGun()
 73 {
 74   delete theMessenger;
 75 }
 76 
 77 void G4ParticleGun::
 78 SetParticleDefinition(G4ParticleDefinition* aParticleDefinition)
 79 { 
 80   if(aParticleDefinition == nullptr)
 81   {
 82     G4Exception("G4ParticleGun::SetParticleDefinition()", "Event0101",
 83                 FatalException, "Null pointer is given.");
 84   }
 85   if(aParticleDefinition->IsShortLived())
 86   {
 87     if(aParticleDefinition->GetDecayTable() == nullptr)
 88     {
 89       G4ExceptionDescription ED;
 90       ED << "G4ParticleGun does not support shooting a short-lived "
 91          << "particle without a valid decay table." << G4endl;
 92       ED << "G4ParticleGun::SetParticleDefinition for "
 93          << aParticleDefinition->GetParticleName() << " is ignored." << G4endl;
 94       G4Exception("G4ParticleGun::SetParticleDefinition()", "Event0102",
 95                   JustWarning, ED);
 96       return;
 97     }
 98   }
 99   particle_definition = aParticleDefinition; 
100   particle_charge = particle_definition->GetPDGCharge();
101   if(particle_momentum>0.0)
102   {
103     G4double mass = particle_definition->GetPDGMass();
104     particle_energy =
105       std::sqrt(particle_momentum*particle_momentum+mass*mass)-mass;
106   }
107 }
108 
109 void G4ParticleGun::SetParticleEnergy(G4double aKineticEnergy)
110 {
111   particle_energy = aKineticEnergy;
112   if(particle_momentum>0.0)
113   {
114     if(particle_definition != nullptr)
115     {
116       G4cout << "G4ParticleGun::" << particle_definition->GetParticleName()
117              << G4endl;
118     }
119     else
120     {
121       G4cout << "G4ParticleGun::" << " " << G4endl;
122     }
123     G4cout << " was defined in terms of Momentum: " 
124            << particle_momentum/GeV << "GeV/c" << G4endl;
125     G4cout << " is now defined in terms of KineticEnergy: " 
126            << particle_energy/GeV   << "GeV"   << G4endl;
127     particle_momentum = 0.0;
128   }
129 }
130 
131 void G4ParticleGun::SetParticleMomentum(G4double aMomentum)
132 {
133   if(particle_energy>0.0)
134   {
135     if(particle_definition != nullptr)
136     {
137       G4cout << "G4ParticleGun::" << particle_definition->GetParticleName()
138              << G4endl;
139     }
140     else
141     {
142       G4cout << "G4ParticleGun::" << " " << G4endl;
143     }
144     G4cout << " was defined in terms of KineticEnergy: "
145            << particle_energy/GeV << "GeV"   << G4endl;
146     G4cout << " is now defined in terms Momentum: "
147            << aMomentum/GeV       << "GeV/c" << G4endl;
148   }
149   if(particle_definition == nullptr)
150   {
151     G4cout << "Particle Definition not defined yet for G4ParticleGun"
152            << G4endl;
153     G4cout << "Zero Mass is assumed" << G4endl;
154     particle_momentum = aMomentum;
155     particle_energy = aMomentum;
156   }
157   else
158   {
159     G4double mass = particle_definition->GetPDGMass();
160     particle_momentum = aMomentum;
161     particle_energy =
162       std::sqrt(particle_momentum*particle_momentum+mass*mass)-mass;
163   }
164 }
165  
166 void G4ParticleGun::SetParticleMomentum(G4ParticleMomentum aMomentum)
167 {
168   if(particle_energy>0.0)
169   {
170     if(particle_definition != nullptr)
171     {
172       G4cout << "G4ParticleGun::" << particle_definition->GetParticleName()
173              << G4endl;
174     }
175     else
176     {
177       G4cout << "G4ParticleGun::" << " " << G4endl;
178     }
179     G4cout << " was defined in terms of KineticEnergy: "
180            << particle_energy/GeV << "GeV"   << G4endl;
181     G4cout << " is now defined in terms Momentum: "
182            << aMomentum.mag()/GeV << "GeV/c" << G4endl;
183   }
184   if(particle_definition == nullptr)
185   {
186     G4cout << "Particle Definition not defined yet for G4ParticleGun"
187            << G4endl;
188     G4cout << "Zero Mass is assumed" << G4endl;
189     particle_momentum_direction = aMomentum.unit();
190     particle_momentum = aMomentum.mag();
191     particle_energy = aMomentum.mag();
192   } 
193   else 
194   {
195     G4double mass =  particle_definition->GetPDGMass();
196     particle_momentum = aMomentum.mag();
197     particle_momentum_direction = aMomentum.unit();
198     particle_energy = 
199       std::sqrt(particle_momentum*particle_momentum+mass*mass)-mass;
200   }
201 }
202 
203 void G4ParticleGun::GeneratePrimaryVertex(G4Event* evt)
204 {
205   if(particle_definition == nullptr) 
206   {
207     G4ExceptionDescription ED;
208     ED << "Particle definition is not defined." << G4endl;
209     ED << "G4ParticleGun::SetParticleDefinition() has to be invoked beforehand."
210        << G4endl;
211     G4Exception("G4ParticleGun::GeneratePrimaryVertex()", "Event0109",
212                 FatalException, ED);
213     return;
214   }
215 
216   // Create a new vertex
217   //
218   auto* vertex = 
219     new G4PrimaryVertex(particle_position,particle_time);
220 
221   // Create new primaries and set them to the vertex
222   //
223   G4double mass =  particle_definition->GetPDGMass();
224   for( G4int i=0; i<NumberOfParticlesToBeGenerated; ++i )
225   {
226     auto* particle =
227       new G4PrimaryParticle(particle_definition);
228     particle->SetKineticEnergy( particle_energy );
229     particle->SetMass( mass );
230     particle->SetMomentumDirection( particle_momentum_direction );
231     particle->SetCharge( particle_charge );
232     particle->SetPolarization(particle_polarization.x(),
233                               particle_polarization.y(),
234                               particle_polarization.z());
235     particle->SetWeight( particle_weight );
236     vertex->SetPrimary( particle );
237   }
238   evt->AddPrimaryVertex( vertex );
239 }
240