Geant4  10.03.p03
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4ParticleDefinition.hh
Go to the documentation of this file.
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 //
27 // $Id: G4ParticleDefinition.hh 101025 2016-11-04 08:36:30Z gcosmo $
28 //
29 //
30 // ------------------------------------------------------------
31 // GEANT 4 class header file
32 //
33 // History: first implementation, based on object model of
34 // 2nd December 1995, G.Cosmo
35 // ---------------- G4ParticleDefinition ----------------
36 // first implementation by Makoto Asai - 29 January 1996
37 // revised - G.Cosmo - 29 February 1996
38 // revised - H.Kurashige - 19 April 1996
39 // revised - H.Kurashige - 4 July 1996
40 // added GetEnergyCuts() and GetLengthCuts() - G.Cosmo - 11 July 1996
41 // added Set/GetVerboseLevel() - H.Kurashige - 11 November 1997
42 // added SetCuts() and ResetCuts - H.Kurashige - 15 November 1996
43 // change SetProcessManager as public - H.Kurashige - 06 June 1998
44 // added GetEnergyThreshold - H.Kurashige - 08 June 1998
45 // added ShortLived flag and ApplyCuts flag - H.Kurashige - 27 June 1998
46 // fixed some improper codings - H.Kurashige - 08 April 1999
47 // added sub-type - H.Kurashige - 15 February 2000
48 // added RestoreCuts - H.Kurashige - 09 March 2001
49 // restructuring for Cuts per Region - H.Kurashige - 11 March 2003
50 // added MagneticMoment - H.Kurashige - March 2007
51 // modified for thread-safety for MT - G.Cosmo, A.Dotti - January 2013
52 // ------------------------------------------------------------
53 
54 #ifndef G4ParticleDefinition_h
55 #define G4ParticleDefinition_h 1
56 
57 #include <vector>
59 
60 #include "globals.hh"
61 #include "G4ios.hh"
62 #include "G4PDefManager.hh"
63 
64 class G4ProcessManager;
65 class G4DecayTable;
66 class G4ParticleTable;
68 
69 //typedef G4PDefSplitter<G4PDefData> G4PDefManager;
71 
73 {
74  // Class Description:
75  //
76  // This class containes all the static data of a particle.
77  // It also has uses a process manager in order to collect
78  // all the processes this kind of particle can undertake.
79 
81 
82  public: // With Description
83 
84  // Only one type of constructor can be used for G4ParticleDefinition.
85  // If you want to create new particle, you must set name of the particle
86  // at construction. Most of members seen as arguments of the constructor
87  // (except last 3 arguments concerning with decay ) are "constant"
88  // and can not be changed later. (No "SET" methods are available)
89  // Each type of particle must be constructed as a unique object
90  // of special class derived from G4ParticleDefinition.
91  // see G4ParticleTypes for detail
92 
93  G4ParticleDefinition(const G4String& aName,
94  G4double mass,
96  G4double charge,
97  G4int iSpin,
98  G4int iParity,
99  G4int iConjugation,
100  G4int iIsospin,
101  G4int iIsospinZ,
102  G4int gParity,
103  const G4String& pType,
104  G4int lepton,
105  G4int baryon,
106  G4int encoding,
107  G4bool stable,
108  G4double lifetime,
109  G4DecayTable *decaytable,
110  G4bool shortlived = false,
111  const G4String& subType ="",
112  G4int anti_encoding =0,
113  G4double magneticMoment = 0.0);
114 
115  virtual ~G4ParticleDefinition();
116 
117  // With the following Getxxxx methods, one can get values
118  // for members which can not be changed
119 
120  const G4String& GetParticleName() const { return theParticleName; }
121 
122  G4double GetPDGMass() const { return thePDGMass; }
123  G4double GetPDGWidth() const { return thePDGWidth; }
124  G4double GetPDGCharge() const { return thePDGCharge; }
125 
126  G4double GetPDGSpin() const { return thePDGSpin; }
127  G4int GetPDGiSpin() const { return thePDGiSpin; }
128  G4int GetPDGiParity() const { return thePDGiParity; }
129  G4int GetPDGiConjugation() const { return thePDGiConjugation; }
130  G4double GetPDGIsospin() const { return thePDGIsospin; }
131  G4double GetPDGIsospin3() const { return thePDGIsospin3; }
132  G4int GetPDGiIsospin() const { return thePDGiIsospin; }
133  G4int GetPDGiIsospin3() const { return thePDGiIsospin3; }
134  G4int GetPDGiGParity() const { return thePDGiGParity; }
135 
136  G4double GetPDGMagneticMoment() const { return thePDGMagneticMoment; }
137  void SetPDGMagneticMoment(G4double mageticMoment);
138  G4double CalculateAnomaly() const;
139  // Gives the anomaly of magnetic moment for spin 1/2 particles
140 
141  const G4String& GetParticleType() const { return theParticleType; }
142  const G4String& GetParticleSubType() const { return theParticleSubType; }
143  G4int GetLeptonNumber() const { return theLeptonNumber; }
144  G4int GetBaryonNumber() const { return theBaryonNumber; }
145 
146  G4int GetPDGEncoding() const { return thePDGEncoding; }
147  G4int GetAntiPDGEncoding() const { return theAntiPDGEncoding; }
148  void SetAntiPDGEncoding(G4int aEncoding);
149 
150 
151  G4int GetQuarkContent(G4int flavor) const;
152  G4int GetAntiQuarkContent(G4int flavor) const;
153  // Returns the number of quark with flavor contained in this particle.
154  // The value of flavor is assigned as follows
155  // 1:d, 2:u, 3:s, 4:c, 5:b, 6:t
156 
157  G4bool IsShortLived() const { return fShortLivedFlag; }
158 
159  G4bool GetPDGStable() const;
160  void SetPDGStable(const G4bool aFlag) { thePDGStable=aFlag; }
161 
162  G4double GetPDGLifeTime() const;
163  void SetPDGLifeTime(G4double aLifeTime) { thePDGLifeTime=aLifeTime; }
164 
165  G4double GetIonLifeTime() const;
166  // Get life time of a generic ion through G4NuclideTable.
167 
168  G4DecayTable* GetDecayTable() const;
169  void SetDecayTable(G4DecayTable* aDecayTable);
170  // Set/Get Decay Table
171  // !! Decay Table can be modified !!
172 
174  void SetProcessManager(G4ProcessManager* aProcessManager);
175  // Set/Get Process Manager
176  // !! Process Manager can be modified !!
177 
179  // Get pointer to the particle table
180 
181  G4int GetAtomicNumber() const;
182  G4int GetAtomicMass() const;
183  // Get AtomicNumber and AtomicMass
184  // These properties are defined for nucleus
185 
186  void DumpTable() const;
187  // Prints information of data members.
188 
190  G4int GetVerboseLevel() const;
191  // controle flag for output message
192  // 0: Silent
193  // 1: Warning message
194  // 2: More
195 
196  void SetApplyCutsFlag(G4bool);
197  G4bool GetApplyCutsFlag() const;
198 
199  G4bool IsGeneralIon() const;
200  // true only if the particle is G4Ions
201  // (it means that theProcessManager is same as one for G4GenricIon)
202 
205 
206  public : // without description
207 
209  // Returns the process manager master pointer.
210  inline void SetMasterProcessManager(G4ProcessManager* aNewPM);
211  //Sets the shadow master pointer (not to be used by user)
212 
213  inline G4int GetInstanceID() const;
214  // Returns the instance ID.
215 
216  static const G4PDefManager& GetSubInstanceManager();
217  // Returns the private data instance manager.
218  private:
219  // --- Shadow of master pointers.
220 
221  G4ProcessManager *theProcessManagerShadow;
222  // Each worker thread can access this field from the master thread
223  // through this pointer.
224 
225  G4int g4particleDefinitionInstanceID;
226  // This field is used as instance ID.
227 
228  G4PART_DLL static G4PDefManager subInstanceManager;
229  // This field helps to use the class G4PDefManager introduced above.
230 
231  protected:
232 
234  // Calculates quark and anti-quark contents
235  // return value is PDG encoding for this particle.
236  // It means error if the return value is deffernt from
237  // this->thePDGEncoding.
238 
239  void SetParticleSubType(const G4String& subtype);
240 
241  void SetAtomicNumber(G4int );
242  void SetAtomicMass(G4int );
243 
244  // !!! can not use "copy constructor" nor "default constructor" !!!!
245  //
248 
249  private:
250 
251  // !!! Assignment operation is forbidden !!!
252  //
254 
255  protected:
256 
260  // the number of quark (minus Sign means anti-quark) contents
261  // The value of flavor is assigned as follows
262  // 0:d, 1:u, 2:s, 3:c, 4:b, 5:t
263 
264  private:
265 
266  // --- Following values can not be changed
267  // --- i.e. No Setxxxx Methods for them
268 
269  G4String theParticleName;
270  // The name of the particle.
271  // Each object must have its specific name!!
272 
273  // --- Following member values must be defined with Units
274 
275  G4double thePDGMass;
276  // The mass of the particle, in units of equivalent energy.
277 
278  G4double thePDGWidth;
279  // The decay width of the particle, usually the width of a
280  // Breit-Wigner function, assuming that you are near the
281  // mass center anyway. (in units of equivalent energy)
282 
283  G4double thePDGCharge;
284  // The charge of the particle.(in units of Coulomb)
285 
286  // --- Following members are quantum number
287  // i.e. discrete numbers can be allowded
288  // So, you can defined only by using integer in constructor
289 
290  G4int thePDGiSpin;
291  // The total spin of the particle, also often denoted as
292  // capital J, in units of 1/2.
293  G4double thePDGSpin;
294  // The total spin of the particle, in units of 1.
295 
296  G4int thePDGiParity;
297  // The parity quantum number, in units of 1. If the parity
298  // is not defined for this particle, we will set this to 0.
299 
300  G4int thePDGiConjugation;
301  // This charge conjugation quantum number in units of 1.
302 
303  G4int thePDGiGParity;
304  // The value of the G-parity quantum number.
305 
306  G4int thePDGiIsospin;
307  G4int thePDGiIsospin3;
308  // The isospin and its 3rd-component in units of 1/2.
309  G4double thePDGIsospin;
310  G4double thePDGIsospin3;
311  // The isospin quantum number in units of 1.
312 
313  G4double thePDGMagneticMoment;
314  // The magnetic moment.
315 
316  G4int theLeptonNumber;
317  // The lepton quantum number.
318 
319  G4int theBaryonNumber;
320  // The baryon quantum number.
321 
322  G4String theParticleType;
323  // More general textual type description of the particle.
324 
325  G4String theParticleSubType;
326  // Textual type description of the particle
327  // eg. pion, lamda etc.
328 
329  G4int thePDGEncoding;
330  // The Particle Data Group integer identifier of this particle
331 
332  G4int theAntiPDGEncoding;
333  // The Particle Data Group integer identifier of the anti-particle
334 
335  // --- Following members can be changed after construction
336 
337  G4bool fShortLivedFlag;
338  // Particles which have true value of this flag
339  // will not be tracked by TrackingManager
340 
341  G4bool thePDGStable;
342  // Is an indicator that this particle is stable. It must
343  // not decay. If the user tries to assign a kind of decay
344  // object to it, it will refuse to take it.
345 
346  G4double thePDGLifeTime;
347  // Is related to the decay width of the particle. The mean
348  // life time is given in seconds.
349 
350  G4DecayTable *theDecayTable;
351  // Points DecayTable
352 
353  private:
354 
355  G4ParticleTable* theParticleTable;
356 
357  G4int theAtomicNumber;
358  G4int theAtomicMass;
359 
360  G4int verboseLevel;
361  G4bool fApplyCutsFlag;
362 
363  protected:
365 
366  public:
367  void SetParticleDefinitionID(G4int id=-1);
369 };
370 
371 #include "G4ParticleDefinition.icc"
372 
373 #endif
G4int GetParticleDefinitionID() const
void SetDecayTable(G4DecayTable *aDecayTable)
void SetAtomicNumber(G4int)
void SetPDGStable(const G4bool aFlag)
void SetParticleDefinitionID(G4int id=-1)
void SetProcessManager(G4ProcessManager *aProcessManager)
G4double GetPDGIsospin3() const
void SetAntiPDGEncoding(G4int aEncoding)
G4double GetPDGIsospin() const
G4int operator!=(const G4ParticleDefinition &right) const
G4int GetVerboseLevel() const
G4bool GetPDGStable() const
void SetPDGLifeTime(G4double aLifeTime)
G4int GetAntiQuarkContent(G4int flavor) const
#define width
const G4String & GetParticleSubType() const
static const G4PDefManager & GetSubInstanceManager()
int G4int
Definition: G4Types.hh:78
G4int GetInstanceID() const
const G4String & GetParticleName() const
G4int GetAtomicNumber() const
G4bool IsGeneralIon() const
G4int GetAntiPDGEncoding() const
G4double GetIonLifeTime() const
G4ParticleTable * GetParticleTable() const
G4DecayTable * GetDecayTable() const
G4double GetPDGWidth() const
G4ProcessManager * GetMasterProcessManager() const
const XML_Char int const XML_Char * value
Definition: expat.h:331
G4double CalculateAnomaly() const
bool G4bool
Definition: G4Types.hh:79
G4int GetQuarkContent(G4int flavor) const
const G4String & GetParticleType() const
void SetVerboseLevel(G4int value)
G4int GetAtomicMass() const
G4int operator==(const G4ParticleDefinition &right) const
G4int GetPDGiConjugation() const
G4int theAntiQuarkContent[NumberOfQuarkFlavor]
G4PDefManager G4ParticleDefinitionSubInstanceManager
G4double GetPDGMass() const
G4ProcessManager * GetProcessManager() const
G4int theQuarkContent[NumberOfQuarkFlavor]
void SetParticleSubType(const G4String &subtype)
G4double GetPDGSpin() const
G4double GetPDGLifeTime() const
G4bool GetApplyCutsFlag() const
#define G4PART_DLL
Definition: pwdefs.hh:48
G4double GetPDGMagneticMoment() const
double G4double
Definition: G4Types.hh:76
G4double GetPDGCharge() const
G4ParticlePropertyTable & operator=(const G4ParticlePropertyTable &right)
void SetMasterProcessManager(G4ProcessManager *aNewPM)
void SetAtomicMass(G4int)
void SetPDGMagneticMoment(G4double mageticMoment)