| 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 // INCL++ intra-nuclear cascade model 26 // INCL++ intra-nuclear cascade model
27 // Alain Boudard, CEA-Saclay, France << 27 // Pekka Kaitaniemi, CEA and Helsinki Institute of Physics
28 // Joseph Cugnon, University of Liege, Belgium << 28 // Davide Mancusi, CEA
29 // Jean-Christophe David, CEA-Saclay, France << 29 // Alain Boudard, CEA
30 // Pekka Kaitaniemi, CEA-Saclay, France, and H << 30 // Sylvie Leray, CEA
31 // Sylvie Leray, CEA-Saclay, France << 31 // Joseph Cugnon, University of Liege
32 // Davide Mancusi, CEA-Saclay, France <<
33 // 32 //
34 #define INCLXX_IN_GEANT4_MODE 1 33 #define INCLXX_IN_GEANT4_MODE 1
35 34
36 #include "globals.hh" 35 #include "globals.hh"
37 36
38 /* \file G4INCLInteractionAvatar.hh 37 /* \file G4INCLInteractionAvatar.hh
39 * \brief Virtual class for interaction avatar 38 * \brief Virtual class for interaction avatars.
40 * 39 *
41 * This class is inherited by decay and collis 40 * This class is inherited by decay and collision avatars. The goal is to
42 * provide a uniform treatment of common physi 41 * provide a uniform treatment of common physics, such as Pauli blocking,
43 * enforcement of energy conservation, etc. 42 * enforcement of energy conservation, etc.
44 * 43 *
45 * \date Mar 1st, 2011 44 * \date Mar 1st, 2011
46 * \author Davide Mancusi 45 * \author Davide Mancusi
47 */ 46 */
48 47
49 #ifndef G4INCLINTERACTIONAVATAR_HH_ 48 #ifndef G4INCLINTERACTIONAVATAR_HH_
50 #define G4INCLINTERACTIONAVATAR_HH_ 49 #define G4INCLINTERACTIONAVATAR_HH_
51 50
52 #include "G4INCLIAvatar.hh" 51 #include "G4INCLIAvatar.hh"
53 #include "G4INCLNucleus.hh" 52 #include "G4INCLNucleus.hh"
54 #include "G4INCLFinalState.hh" 53 #include "G4INCLFinalState.hh"
55 #include "G4INCLRootFinder.hh" 54 #include "G4INCLRootFinder.hh"
56 #include "G4INCLKinematicsUtils.hh" 55 #include "G4INCLKinematicsUtils.hh"
57 #include "G4INCLAllocationPool.hh" <<
58 56
59 namespace G4INCL { 57 namespace G4INCL {
60 58
61 class InteractionAvatar : public G4INCL::IAv 59 class InteractionAvatar : public G4INCL::IAvatar {
62 public: 60 public:
63 InteractionAvatar(G4double, G4INCL::Nucl 61 InteractionAvatar(G4double, G4INCL::Nucleus*, G4INCL::Particle*);
64 InteractionAvatar(G4double, G4INCL::Nucl 62 InteractionAvatar(G4double, G4INCL::Nucleus*, G4INCL::Particle*, G4INCL::Particle*);
65 virtual ~InteractionAvatar(); 63 virtual ~InteractionAvatar();
66 64
67 /// \brief Target accuracy in the determ 65 /// \brief Target accuracy in the determination of the local-energy Q-value
68 static const G4double locEAccuracy; 66 static const G4double locEAccuracy;
69 /// \brief Max number of iterations for 67 /// \brief Max number of iterations for the determination of the local-energy Q-value
70 static const G4int maxIterLocE; 68 static const G4int maxIterLocE;
71 69
72 /// \brief Release the memory allocated <<
73 static void deleteBackupParticles(); <<
74 <<
75 protected: 70 protected:
76 virtual G4INCL::IChannel* getChannel() = << 71 virtual G4INCL::IChannel* getChannel() const = 0;
77 72
78 G4bool bringParticleInside(Particle * co 73 G4bool bringParticleInside(Particle * const p);
79 74
80 /** \brief Apply local-energy transforma 75 /** \brief Apply local-energy transformation, if appropriate
81 * 76 *
82 * \param p particle to apply the transf 77 * \param p particle to apply the transformation to
83 */ 78 */
84 void preInteractionLocalEnergy(Particle 79 void preInteractionLocalEnergy(Particle * const p);
85 80
86 /** \brief Store the state of the partic 81 /** \brief Store the state of the particles before the interaction
87 * 82 *
88 * If the interaction cannot be realised 83 * If the interaction cannot be realised for any reason, we will need to
89 * restore the particle state as it was 84 * restore the particle state as it was before. This is done by calling
90 * the restoreParticles() method. 85 * the restoreParticles() method.
91 */ 86 */
92 void preInteractionBlocking(); 87 void preInteractionBlocking();
93 88
94 void preInteraction(); 89 void preInteraction();
95 void postInteraction(FinalState *); << 90 FinalState *postInteraction(FinalState *);
96 91
97 /** \brief Restore the state of both par 92 /** \brief Restore the state of both particles.
98 * 93 *
99 * The state must first be stored by cal 94 * The state must first be stored by calling preInteractionBlocking().
100 */ 95 */
101 void restoreParticles() const; 96 void restoreParticles() const;
102 97
103 /// \brief true if the given avatar shou 98 /// \brief true if the given avatar should use local energy
104 G4bool shouldUseLocalEnergy() const; << 99 G4bool shouldUseLocalEnergy() const {
>> 100 if(!theNucleus) return false;
>> 101 LocalEnergyType theLocalEnergyType;
>> 102 if(getType()==DecayAvatarType || isPiN)
>> 103 theLocalEnergyType = theNucleus->getStore()->getConfig()->getLocalEnergyPiType();
>> 104 else
>> 105 theLocalEnergyType = theNucleus->getStore()->getConfig()->getLocalEnergyBBType();
>> 106
>> 107 const G4bool firstAvatar = (theNucleus->getStore()->getBook()->getAcceptedCollisions() == 0);
>> 108 return ((theLocalEnergyType == FirstCollisionLocalEnergy && firstAvatar) ||
>> 109 theLocalEnergyType == AlwaysLocalEnergy);
>> 110 }
105 111
106 Nucleus *theNucleus; << 112 G4INCL::Nucleus *theNucleus;
107 Particle *particle1, *particle2; << 113 G4INCL::Particle *particle1, *particle2;
108 static G4ThreadLocal Particle *backupPar <<
109 ThreeVector boostVector; 114 ThreeVector boostVector;
110 G4double oldTotalEnergy, oldXSec; << 115 ParticleType oldParticle1Type, oldParticle2Type;
>> 116 G4double oldParticle1Energy, oldParticle2Energy, oldTotalEnergy, oldXSec;
>> 117 G4double oldParticle1Potential, oldParticle2Potential;
>> 118 G4double oldParticle1Mass, oldParticle2Mass;
>> 119 G4double oldParticle1Helicity, oldParticle2Helicity;
>> 120 ThreeVector oldParticle1Momentum, oldParticle2Momentum;
>> 121 ThreeVector oldParticle1Position, oldParticle2Position;
111 G4bool isPiN; 122 G4bool isPiN;
112 G4double weight; <<
113 123
114 private: 124 private:
115 /// \brief RootFunctor-derived object fo 125 /// \brief RootFunctor-derived object for enforcing energy conservation in N-N.
116 class ViolationEMomentumFunctor : public 126 class ViolationEMomentumFunctor : public RootFunctor {
117 public: 127 public:
118 /** \brief Prepare for calling the ( 128 /** \brief Prepare for calling the () operator and scaleParticleMomenta
119 * 129 *
120 * The constructor sets the private 130 * The constructor sets the private class members.
121 */ 131 */
122 ViolationEMomentumFunctor(Nucleus * << 132 ViolationEMomentumFunctor(Nucleus * const nucleus, FinalState const * const finalState, ThreeVector const * const boost, const G4bool localE);
123 virtual ~ViolationEMomentumFunctor() << 133 virtual ~ViolationEMomentumFunctor() { particleMomenta.clear(); }
124 134
125 /** \brief Compute the energy-conser 135 /** \brief Compute the energy-conservation violation.
126 * 136 *
127 * \param x scale factor for the par 137 * \param x scale factor for the particle momenta
128 * \return the energy-conservation v 138 * \return the energy-conservation violation
129 */ 139 */
130 G4double operator()(const G4double x 140 G4double operator()(const G4double x) const;
131 141
132 /// \brief Clean up after root findi 142 /// \brief Clean up after root finding
133 void cleanUp(const G4bool success) c 143 void cleanUp(const G4bool success) const;
134 144
135 private: 145 private:
136 /// \brief List of final-state parti 146 /// \brief List of final-state particles.
137 ParticleList finalParticles; 147 ParticleList finalParticles;
138 /// \brief CM particle momenta, as d 148 /// \brief CM particle momenta, as determined by the channel.
139 std::vector<ThreeVector> particleMom << 149 std::list<ThreeVector> particleMomenta;
140 /// \brief Total energy before the i 150 /// \brief Total energy before the interaction.
141 G4double initialEnergy; 151 G4double initialEnergy;
142 /// \brief Pointer to the nucleus 152 /// \brief Pointer to the nucleus
143 Nucleus *theNucleus; 153 Nucleus *theNucleus;
144 /// \brief Pointer to the boost vect 154 /// \brief Pointer to the boost vector
145 ThreeVector const &boostVector; << 155 ThreeVector const *boostVector;
>> 156 /// \brief true if we must apply local energy to nucleons
>> 157 G4bool hasLocalEnergy;
>> 158 /// \brief true if we must apply local energy to deltas
>> 159 G4bool hasLocalEnergyDelta;
146 160
147 /// \brief True if we should use loc 161 /// \brief True if we should use local energy
148 const G4bool shouldUseLocalEnergy; 162 const G4bool shouldUseLocalEnergy;
149 163
150 /** \brief Scale the momenta of the 164 /** \brief Scale the momenta of the modified and created particles.
151 * 165 *
152 * Set the momenta of the modified a 166 * Set the momenta of the modified and created particles to alpha times
153 * their original momenta (stored in 167 * their original momenta (stored in particleMomenta). You must call
154 * init() before using this method. 168 * init() before using this method.
155 * << 169 *
156 * \param alpha scale factor 170 * \param alpha scale factor
157 */ 171 */
158 void scaleParticleMomenta(const G4do 172 void scaleParticleMomenta(const G4double alpha) const;
159 173
160 }; 174 };
161 175
162 /// \brief RootFunctor-derived object fo << 176 /// \brief RootFunctor-derived object for enforcing energy conservation in pi-N.
163 class ViolationEEnergyFunctor : public R 177 class ViolationEEnergyFunctor : public RootFunctor {
164 public: 178 public:
165 /** \brief Prepare for calling the ( << 179 /** \brief Prepare for calling the () operator and scaleParticleMomenta
166 * 180 *
167 * The constructor sets the private 181 * The constructor sets the private class members.
168 */ 182 */
169 ViolationEEnergyFunctor(Nucleus * co << 183 ViolationEEnergyFunctor(Nucleus * const nucleus, FinalState const * const finalState);
170 virtual ~ViolationEEnergyFunctor() { 184 virtual ~ViolationEEnergyFunctor() {}
171 185
172 /** \brief Compute the energy-conser 186 /** \brief Compute the energy-conservation violation.
173 * 187 *
174 * \param x scale factor for the par << 188 * \param x scale factor for the particle momenta
175 * \return the energy-conservation v 189 * \return the energy-conservation violation
176 */ 190 */
177 G4double operator()(const G4double x 191 G4double operator()(const G4double x) const;
178 192
179 /// \brief Clean up after root findi 193 /// \brief Clean up after root finding
180 void cleanUp(const G4bool success) c 194 void cleanUp(const G4bool success) const;
181 195
182 /** \brief Set the energy of the par 196 /** \brief Set the energy of the particle.
183 * 197 *
184 * \param energy 198 * \param energy
185 */ 199 */
186 void setParticleEnergy(const G4doubl 200 void setParticleEnergy(const G4double energy) const;
187 201
188 private: 202 private:
189 /// \brief Total energy before the i 203 /// \brief Total energy before the interaction.
190 G4double initialEnergy; 204 G4double initialEnergy;
191 /// \brief Pointer to the nucleus. 205 /// \brief Pointer to the nucleus.
192 Nucleus *theNucleus; 206 Nucleus *theNucleus;
193 /// \brief The final-state particle. 207 /// \brief The final-state particle.
194 Particle *theParticle; 208 Particle *theParticle;
195 /// \brief The initial energy of the 209 /// \brief The initial energy of the particle.
196 G4double theEnergy; 210 G4double theEnergy;
197 /// \brief The initial momentum of t 211 /// \brief The initial momentum of the particle.
198 ThreeVector theMomentum; 212 ThreeVector theMomentum;
199 /** \brief Threshold for the energy 213 /** \brief Threshold for the energy of the particle
200 * 214 *
201 * The particle (a delta) cannot hav 215 * The particle (a delta) cannot have less than this energy.
202 */ 216 */
203 G4double energyThreshold; 217 G4double energyThreshold;
204 /// \brief Whether we should use loc <<
205 const G4bool shouldUseLocalEnergy; <<
206 }; 218 };
207 219
208 RootFunctor *violationEFunctor; 220 RootFunctor *violationEFunctor;
209 221
210 protected: 222 protected:
211 /** \brief Enforce energy conservation. 223 /** \brief Enforce energy conservation.
212 * 224 *
213 * Final states generated by the channel 225 * Final states generated by the channels might violate energy conservation
214 * because of different reasons (energy- 226 * because of different reasons (energy-dependent potentials, local
215 * energy...). This conservation law mus 227 * energy...). This conservation law must therefore be enforced by hand. We
216 * do so by rescaling the momenta of the 228 * do so by rescaling the momenta of the final-state particles in the CM
217 * frame. If this turns out to be imposs 229 * frame. If this turns out to be impossible, this method returns false.
218 * 230 *
219 * \return true if the algorithm succeed 231 * \return true if the algorithm succeeded
220 */ 232 */
221 G4bool enforceEnergyConservation(FinalSt 233 G4bool enforceEnergyConservation(FinalState * const fs);
222 234
223 ParticleList modified, created, modified <<
224 <<
225 INCL_DECLARE_ALLOCATION_POOL(Interaction <<
226 }; 235 };
227 236
228 } 237 }
229 238
230 #endif /* G4INCLINTERACTIONAVATAR_HH_ */ 239 #endif /* G4INCLINTERACTIONAVATAR_HH_ */
231 240