| Geant4 Cross Reference |
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 // G4Ions
27 //
28 // Class Description:
29 //
30 // This is the base class for all nuclei including pre-defined
31 // light nuclei such as deuteron, alpha, and proton (Hydrogen).
32 // All nuclei/ions created on the fly are objects of this class.
33 // Atomic number and atomic mass are valid only for particles derived
34 // from this class. This class has Excitation Energy in addition to
35 // the normal particle properties.
36
37 // Authors: G.Cosmo, 4 April 1996 - Design based on object model
38 // H.Kurashige, 27 June 1998 - First implementation
39 // --------------------------------------------------------------------
40 #ifndef G4Ions_hh
41 #define G4Ions_hh 1
42
43 #include "G4ParticleDefinition.hh"
44 #include "G4ios.hh"
45 #include "globals.hh"
46
47 class G4Ions : public G4ParticleDefinition
48 {
49 public:
50 // clang-format off
51 G4Ions(
52 const G4String& aName, G4double mass,
53 G4double width, G4double charge,
54 G4int iSpin, G4int iParity,
55 G4int iConjugation, G4int iIsospin,
56 G4int iIsospin3, G4int gParity,
57 const G4String& pType, G4int lepton,
58 G4int baryon, G4int encoding,
59 G4bool stable, G4double lifetime,
60 G4DecayTable* decaytable, G4bool shortlived,
61 const G4String& subType ="",
62 G4int anti_encoding =0,
63 G4double excitation = 0.0,
64 G4int isomer = 0
65 );
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() const;
75
76 // Get Isomer level (=0 for ground state)
77 inline G4int GetIsomerLevel() const;
78
79 enum class G4FloatLevelBase // enumerator for floating level base
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 FloatLevelBase(char flbChar);
99 static G4Ions::G4FloatLevelBase FloatLevelBase(G4int flbIdx);
100 static char FloatLevelBaseChar(G4Ions::G4FloatLevelBase flb);
101
102 // Set/Get methods for floating level base
103 //
104 inline G4Ions::G4FloatLevelBase GetFloatLevelBase() const;
105 inline G4int GetFloatLevelBaseIndex() const;
106 inline void SetFloatLevelBase(G4Ions::G4FloatLevelBase flb);
107 inline void SetFloatLevelBase(char flbChar);
108 inline void SetFloatLevelBase(G4int flbIdx);
109
110 protected:
111 G4Ions() = default;
112
113 private:
114 G4double theExcitationEnergy = 0.0;
115 G4int theIsomerLevel = 0;
116 G4FloatLevelBase floatLevelBase = G4FloatLevelBase::no_Float;
117 };
118
119 #define noFloat G4Ions::G4FloatLevelBase::no_Float
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
139 inline G4Ions* G4Ions::IonsDefinition()
140 {
141 return this;
142 }
143
144 inline G4Ions* G4Ions::Ions()
145 {
146 return this;
147 }
148
149 inline G4double G4Ions::GetExcitationEnergy() const
150 {
151 return theExcitationEnergy;
152 }
153
154 inline G4int G4Ions::GetIsomerLevel() const
155 {
156 return theIsomerLevel;
157 }
158
159 inline G4Ions::G4FloatLevelBase G4Ions::GetFloatLevelBase() const
160 {
161 return floatLevelBase;
162 }
163
164 inline G4int G4Ions::GetFloatLevelBaseIndex() const
165 {
166 return static_cast<G4int>(floatLevelBase);
167 }
168
169 inline void G4Ions::SetFloatLevelBase(G4Ions::G4FloatLevelBase flb)
170 {
171 floatLevelBase = flb;
172 }
173
174 inline void G4Ions::SetFloatLevelBase(char flbChar)
175 {
176 floatLevelBase = FloatLevelBase(flbChar);
177 }
178
179 inline void G4Ions::SetFloatLevelBase(G4int flbIdx)
180 {
181 floatLevelBase = FloatLevelBase(flbIdx);
182 }
183
184 #endif
185