| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4Ions <<
27 // 26 //
28 // Class Description: << 27 // $Id: G4Ions.hh 69557 2013-05-08 12:01:40Z gcosmo $
29 // 28 //
30 // This is the base class for all nuclei inclu << 29 //
31 // light nuclei such as deuteron, alpha, and p << 30 // ------------------------------------------------------------
32 // All nuclei/ions created on the fly are obje << 31 // GEANT 4 class header file
33 // Atomic number and atomic mass are valid onl << 32 //
34 // from this class. This class has Excitation << 33 // History: first implementation, based on object model of
35 // the normal particle properties. << 34 // Hisaya Kurashige, 27 June 1998
36 << 35 // ----------------------------------------------------------------
37 // Authors: G.Cosmo, 4 April 1996 - Design bas << 36 // Add excitation energy 17 Aug. 1999 H.Kurashige
38 // H.Kurashige, 27 June 1998 - First << 37 // Add isomer level 30 Apr. H.Kurashige
39 // ------------------------------------------- << 38
40 #ifndef G4Ions_hh << 39
41 #define G4Ions_hh 1 << 40 #ifndef G4Ions_h
>> 41 #define G4Ions_h 1
42 42
43 #include "G4ParticleDefinition.hh" <<
44 #include "G4ios.hh" <<
45 #include "globals.hh" 43 #include "globals.hh"
>> 44 #include "G4ios.hh"
>> 45 #include "G4ParticleDefinition.hh"
>> 46
>> 47 // ######################################################################
>> 48 // ### Ions ###
>> 49 // ######################################################################
46 50
47 class G4Ions : public G4ParticleDefinition 51 class G4Ions : public G4ParticleDefinition
48 { 52 {
49 public: << 53 // Class Description
50 // clang-format off << 54 // This is the base class for all nuclei including pre-defined
51 G4Ions( << 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(
52 const G4String& aName, G4dou 67 const G4String& aName, G4double mass,
53 G4double width, G4dou 68 G4double width, G4double charge,
54 G4int iSpin, G4int 69 G4int iSpin, G4int iParity,
55 G4int iConjugation, G4int 70 G4int iConjugation, G4int iIsospin,
56 G4int iIsospin3, G4int 71 G4int iIsospin3, G4int gParity,
57 const G4String& pType, G4int 72 const G4String& pType, G4int lepton,
58 G4int baryon, G4int 73 G4int baryon, G4int encoding,
59 G4bool stable, G4dou 74 G4bool stable, G4double lifetime,
60 G4DecayTable* decaytable, G4boo << 75 G4DecayTable *decaytable, G4bool shortlived,
61 const G4String& subType ="", 76 const G4String& subType ="",
62 G4int anti_encoding =0, 77 G4int anti_encoding =0,
63 G4double excitation = 0.0, 78 G4double excitation = 0.0,
64 G4int isomer = 0 79 G4int isomer = 0
65 ); << 80 );
66 // clang-format on <<
67 <<
68 ~G4Ions() override = default; <<
69 <<
70 inline G4Ions* IonsDefinition(); <<
71 inline G4Ions* Ions(); <<
72 <<
73 // Get excitation energy of nucleus <<
74 inline G4double GetExcitationEnergy() cons <<
75 <<
76 // Get Isomer level (=0 for ground state) <<
77 inline G4int GetIsomerLevel() const; <<
78 <<
79 enum class G4FloatLevelBase // enumerator <<
80 { <<
81 no_Float = 0, <<
82 plus_X, <<
83 plus_Y, <<
84 plus_Z, <<
85 plus_U, <<
86 plus_V, <<
87 plus_W, <<
88 plus_R, <<
89 plus_S, <<
90 plus_T, <<
91 plus_A, <<
92 plus_B, <<
93 plus_C, <<
94 plus_D, <<
95 plus_E <<
96 }; <<
97 <<
98 static G4Ions::G4FloatLevelBase FloatLevel <<
99 static G4Ions::G4FloatLevelBase FloatLevel <<
100 static char FloatLevelBaseChar(G4Ions::G4F <<
101 <<
102 // Set/Get methods for floating level base <<
103 // <<
104 inline G4Ions::G4FloatLevelBase GetFloatLe <<
105 inline G4int GetFloatLevelBaseIndex() cons <<
106 inline void SetFloatLevelBase(G4Ions::G4Fl <<
107 inline void SetFloatLevelBase(char flbChar <<
108 inline void SetFloatLevelBase(G4int flbIdx <<
109 <<
110 protected: <<
111 G4Ions() = default; <<
112 81
>> 82 public:
>> 83 virtual ~G4Ions();
>> 84 G4Ions* IonsDefinition();
>> 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
113 private: 94 private:
114 G4double theExcitationEnergy = 0.0; << 95 G4double theExcitationEnergy;
115 G4int theIsomerLevel = 0; << 96 G4int theIsomerLevel;
116 G4FloatLevelBase floatLevelBase = G4FloatL <<
117 }; <<
118 97
119 #define noFloat G4Ions::G4FloatLevelBase::no_F << 98 };
120 #define plusU G4Ions::G4FloatLevelBase::plus_U <<
121 #define plusV G4Ions::G4FloatLevelBase::plus_V <<
122 #define plusW G4Ions::G4FloatLevelBase::plus_W <<
123 #define plusX G4Ions::G4FloatLevelBase::plus_X <<
124 #define plusY G4Ions::G4FloatLevelBase::plus_Y <<
125 #define plusZ G4Ions::G4FloatLevelBase::plus_Z <<
126 #define plusR G4Ions::G4FloatLevelBase::plus_R <<
127 #define plusS G4Ions::G4FloatLevelBase::plus_S <<
128 #define plusT G4Ions::G4FloatLevelBase::plus_T <<
129 #define plusA G4Ions::G4FloatLevelBase::plus_A <<
130 #define plusB G4Ions::G4FloatLevelBase::plus_B <<
131 #define plusC G4Ions::G4FloatLevelBase::plus_C <<
132 #define plusD G4Ions::G4FloatLevelBase::plus_D <<
133 #define plusE G4Ions::G4FloatLevelBase::plus_E <<
134 <<
135 // ------------------------ <<
136 // Inline methods <<
137 // ------------------------ <<
138 99
139 inline G4Ions* G4Ions::IonsDefinition() << 100 inline
>> 101 G4Ions* G4Ions::IonsDefinition()
140 { 102 {
141 return this; 103 return this;
142 } 104 }
143 105
144 inline G4Ions* G4Ions::Ions() << 106 inline
>> 107 G4Ions* G4Ions::Ions()
145 { 108 {
146 return this; 109 return this;
147 } 110 }
148 111
149 inline G4double G4Ions::GetExcitationEnergy() << 112 inline
>> 113 G4double G4Ions::GetExcitationEnergy() const
150 { 114 {
151 return theExcitationEnergy; 115 return theExcitationEnergy;
152 } 116 }
153 117
154 inline G4int G4Ions::GetIsomerLevel() const << 118 inline
>> 119 G4int G4Ions::GetIsomerLevel() const
155 { 120 {
156 return theIsomerLevel; 121 return theIsomerLevel;
157 } 122 }
>> 123
>> 124 #endif
>> 125
>> 126
158 127
159 inline G4Ions::G4FloatLevelBase G4Ions::GetFlo <<
160 { <<
161 return floatLevelBase; <<
162 } <<
163 128
164 inline G4int G4Ions::GetFloatLevelBaseIndex() <<
165 { <<
166 return static_cast<G4int>(floatLevelBase); <<
167 } <<
168 129
169 inline void G4Ions::SetFloatLevelBase(G4Ions:: <<
170 { <<
171 floatLevelBase = flb; <<
172 } <<
173 130
174 inline void G4Ions::SetFloatLevelBase(char flb <<
175 { <<
176 floatLevelBase = FloatLevelBase(flbChar); <<
177 } <<
178 131
179 inline void G4Ions::SetFloatLevelBase(G4int fl <<
180 { <<
181 floatLevelBase = FloatLevelBase(flbIdx); <<
182 } <<
183 132
184 #endif <<
185 133