Geant4  10.02.p01
G4Ions.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: G4Ions.hh 69557 2013-05-08 12:01:40Z gcosmo $
28 //
29 //
30 // ------------------------------------------------------------
31 // GEANT 4 class header file
32 //
33 // History: first implementation, based on object model of
34 // Hisaya Kurashige, 27 June 1998
35 // ----------------------------------------------------------------
36 // Add excitation energy 17 Aug. 1999 H.Kurashige
37 // Add isomer level 30 Apr. H.Kurashige
38 
39 
40 #ifndef G4Ions_h
41 #define G4Ions_h 1
42 
43 #include "globals.hh"
44 #include "G4ios.hh"
45 #include "G4ParticleDefinition.hh"
46 
47 // ######################################################################
48 // ### Ions ###
49 // ######################################################################
50 
52 {
53  // Class Description
54  // This is the base class for all nuclei including pre-defined
55  // light nuclei such as deuteron, alpha, and proton (Hydrogen)
56  // All nuclei/ions created on the fly are objects of this class
57  // Atomic number and atomic mass are vaild only for particles derived
58  // from this class. This class has Excitation Energy in addition to
59  // the normal particle properties.
60 
61  protected:
62  G4Ions(){};
63 
64 
65  public: //With Description
66  G4Ions(
67  const G4String& aName, G4double mass,
68  G4double width, G4double charge,
69  G4int iSpin, G4int iParity,
70  G4int iConjugation, G4int iIsospin,
71  G4int iIsospin3, G4int gParity,
72  const G4String& pType, G4int lepton,
74  G4bool stable, G4double lifetime,
75  G4DecayTable *decaytable, G4bool shortlived,
76  const G4String& subType ="",
77  G4int anti_encoding =0,
78  G4double excitation = 0.0,
79  G4int isomer = 0
80  );
81 
82  public:
83  virtual ~G4Ions();
85  G4Ions* Ions();
86 
87  public: //With Description
88  // Get excitation energy of nucleus
89  G4double GetExcitationEnergy() const ;
90 
91  // Get Isomer level (=0 for ground state)
92  G4int GetIsomerLevel() const;
93 
94  private:
97 
98 };
99 
100 inline
102 {
103  return this;
104 }
105 
106 inline
108 {
109  return this;
110 }
111 
112 inline
114 {
115  return theExcitationEnergy;
116 }
117 
118 inline
120 {
121  return theIsomerLevel;
122 }
123 
124 #endif
125 
126 
127 
128 
129 
130 
131 
132 
G4double theExcitationEnergy
Definition: G4Ions.hh:95
G4int GetIsomerLevel() const
Definition: G4Ions.hh:119
G4Ions()
Definition: G4Ions.hh:62
G4Ions * IonsDefinition()
Definition: G4Ions.hh:101
G4double GetExcitationEnergy() const
Definition: G4Ions.hh:113
G4Ions * Ions()
Definition: G4Ions.hh:107
#define width
int G4int
Definition: G4Types.hh:78
Definition: G4Ions.hh:51
bool G4bool
Definition: G4Types.hh:79
#define encoding
Definition: xmlparse.cc:605
virtual ~G4Ions()
Definition: G4Ions.cc:98
double G4double
Definition: G4Types.hh:76
G4int theIsomerLevel
Definition: G4Ions.hh:96