Geant4 11.2.2
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
G4INCL::Store Class Reference

#include <G4INCLStore.hh>

Public Member Functions

 Store (Config const *const config)
 
 ~Store ()
 
void add (Particle *p)
 
void add (ParticleList const &pL)
 Add a list of particles to the Store.
 
void addParticleEntryAvatar (IAvatar *a)
 Add one ParticleEntry avatar.
 
void addParticleEntryAvatars (IAvatarList const &al)
 Add one ParticleEntry avatar.
 
void add (IAvatar *a)
 
IAvatarList const & getAvatars () const
 
void addIncomingParticle (Particle *const p)
 
void removeFromIncoming (Particle *const p)
 
void clearIncoming ()
 Clear the incoming list.
 
void deleteIncoming ()
 Clear the incoming list and delete the particles.
 
void particleHasBeenUpdated (Particle *const)
 Notify the Store about a particle update.
 
void removeScheduledAvatars ()
 Remove avatars that have been scheduled.
 
IAvatarfindSmallestTime ()
 
void timeStep (G4double step)
 
void particleHasBeenEjected (Particle *const)
 
void addToOutgoing (Particle *p)
 add the particle to the outgoing particle list.
 
void addToOutgoing (ParticleList const &pl)
 Add a list of particles to the outgoing particle list.
 
void particleHasBeenDestroyed (Particle *const)
 
void particleHasEntered (Particle *const particle)
 Move a particle from incoming to inside.
 
ParticleList const & getIncomingParticles () const
 
ParticleList const & getOutgoingParticles () const
 
ParticleList extractDynamicalSpectators ()
 Returns a list of dynamical spectators.
 
ParticleList const & getParticles () const
 
BookgetBook ()
 
G4int countCascading ()
 
Config const * getConfig ()
 
void clear ()
 
void clearInside ()
 
void clearOutgoing ()
 
void clearAvatars ()
 
void loadParticles (std::string const &filename)
 
G4int getLoadedA ()
 
G4int getLoadedZ ()
 
G4double getLoadedStoppingTime ()
 
std::string printParticleConfiguration ()
 
void writeParticles (std::string const &filename)
 
std::string printAvatars ()
 
G4bool containsCollisions () const
 

Static Public Member Functions

static G4bool avatarComparisonPredicate (IAvatar *lhs, IAvatar *rhs)
 Comparison predicate for avatars.
 

Detailed Description

The purpose of the Store object is to act as a "particle manager" that keeps track ofall the particles in our simulation. It also tracks the avatars and their connections to particles.

Definition at line 73 of file G4INCLStore.hh.

Constructor & Destructor Documentation

◆ Store()

G4INCL::Store::Store ( Config const *const config)

Store constructor

Definition at line 45 of file G4INCLStore.cc.

45 :
46 loadedA(0),
47 loadedZ(0),
48 loadedStoppingTime(0.),
49 theConfig(config)
50 {
51 }

◆ ~Store()

G4INCL::Store::~Store ( )

Store destructor

Definition at line 53 of file G4INCLStore.cc.

53 {
54 theBook.reset();
55 clear();
56 }

Member Function Documentation

◆ add() [1/3]

void G4INCL::Store::add ( IAvatar * a)

Add one avatar to the store

Avatars know about the particles they are associated with. Adding an avatar consists of the following steps:

  1. Add the new avatar to the avatar list
  2. Add any related new particles to the store by calling add(Particle*) (this should not happen, by the time we are adding avatars all particles should have already been added)
  3. Connect the particles involved to the avatar in the map: particleAvatarConnections :: ParticleID -> [AvatarID]
  4. Add the new avatar to the map: avatarParticleConnections :: AvatarID -> [ParticleID]

Definition at line 83 of file G4INCLStore.cc.

83 {
84 // Add the avatar to the avatar map
85 avatarList.push_back(a);
86
87 ParticleList pList = a->getParticles();
88 for(ParticleIter i=pList.begin(), e=pList.end(); i!=e; ++i) {
89 // Connect each particle to the avatar
90 connectAvatarToParticle(a, *i);
91 }
92
93 }
ParticleList::const_iterator ParticleIter

◆ add() [2/3]

void G4INCL::Store::add ( Particle * p)

Add one particle to the store.

Particle objects don't know anything about avatars so this method will only do two things:

  1. add the particle to the particle map ParticleID -> Particle*
  2. add an empty entry for this particle into map AvatarID -> [ParticleID]

Definition at line 58 of file G4INCLStore.cc.

58 {
59 inside.push_back(p);
60 }

Referenced by G4INCL::Nucleus::applyFinalState(), G4INCL::Nucleus::initializeParticles(), loadParticles(), particleHasEntered(), and G4INCL::StandardPropagationModel::registerAvatar().

◆ add() [3/3]

void G4INCL::Store::add ( ParticleList const & pL)

Add a list of particles to the Store.

This acts as if add(Particle *) was called on each element of the list.

Definition at line 62 of file G4INCLStore.cc.

62 {
63 inside.insert(inside.end(), pL.begin(), pL.end());
64 }

◆ addIncomingParticle()

void G4INCL::Store::addIncomingParticle ( Particle *const p)

Add a particle to the incoming list.

Parameters
pparticle to add

Definition at line 95 of file G4INCLStore.cc.

95 {
96 incoming.push_back(p);
97 }

Referenced by addParticleEntryAvatar().

◆ addParticleEntryAvatar()

void G4INCL::Store::addParticleEntryAvatar ( IAvatar * a)

Add one ParticleEntry avatar.

Definition at line 66 of file G4INCLStore.cc.

66 {
67 // Add the avatar to the avatar map
68 avatarList.push_back(a);
69
70 ParticleList pList = a->getParticles();
71 for(ParticleIter i=pList.begin(), e=pList.end(); i!=e; ++i) {
73 // Connect each particle to the avatar
74 connectAvatarToParticle(a, *i);
75 }
76 }
void addIncomingParticle(Particle *const p)

Referenced by addParticleEntryAvatars(), and G4INCL::StandardPropagationModel::shootParticle().

◆ addParticleEntryAvatars()

void G4INCL::Store::addParticleEntryAvatars ( IAvatarList const & al)

Add one ParticleEntry avatar.

Definition at line 78 of file G4INCLStore.cc.

78 {
79 for(IAvatarIter a=al.begin(), e=al.end(); a!=e; ++a)
81 }
void addParticleEntryAvatar(IAvatar *a)
Add one ParticleEntry avatar.
UnorderedVector< IAvatar * >::const_iterator IAvatarIter

Referenced by G4INCL::StandardPropagationModel::shootAtrest(), and G4INCL::StandardPropagationModel::shootComposite().

◆ addToOutgoing() [1/2]

◆ addToOutgoing() [2/2]

void G4INCL::Store::addToOutgoing ( ParticleList const & pl)
inline

Add a list of particles to the outgoing particle list.

Parameters
pllist of particles to be added

Definition at line 196 of file G4INCLStore.hh.

196 {
197 for(ParticleIter p=pl.begin(), e=pl.end(); p!=e; ++p)
198 addToOutgoing(*p);
199 }
void addToOutgoing(Particle *p)
add the particle to the outgoing particle list.

◆ avatarComparisonPredicate()

static G4bool G4INCL::Store::avatarComparisonPredicate ( IAvatar * lhs,
IAvatar * rhs )
inlinestatic

Comparison predicate for avatars.

avatarComparisonPredicate is used by the std::sort or std::min_element functions to compare the avatar objects according to their time.

Parameters
lhspointer to the first avatar
rhspointer to the second avatar
Returns
true iff lhs' time is smaller than rhs'.

Definition at line 352 of file G4INCLStore.hh.

352 {
353 return (lhs->getTime() < rhs->getTime());
354 }

Referenced by findSmallestTime().

◆ clear()

void G4INCL::Store::clear ( )

Clear all avatars and particles from the store.

Warning! This actually deletes the objects as well!

Definition at line 203 of file G4INCLStore.cc.

203 {
204 clearAvatars();
205
206 clearInside();
208
209 if( incoming.size() != 0 ) {
210 INCL_WARN("Incoming list is not empty when Store::clear() is called" << '\n');
211 }
212 incoming.clear();
213
214 }
#define INCL_WARN(x)
void clearAvatars()
void clearOutgoing()

Referenced by loadParticles(), and ~Store().

◆ clearAvatars()

void G4INCL::Store::clearAvatars ( )

Clear avatars only.

Definition at line 193 of file G4INCLStore.cc.

193 {
194 for(IAvatarIter iter = avatarList.begin(), e = avatarList.end(); iter != e; ++iter) {
195 delete *iter;
196 }
197
198 particleAvatarConnections.clear();
199 avatarList.clear();
200 avatarsToBeRemoved.clear();
201 }

Referenced by clear(), and G4INCL::StandardPropagationModel::propagate().

◆ clearIncoming()

void G4INCL::Store::clearIncoming ( )
inline

Clear the incoming list.

Definition at line 145 of file G4INCLStore.hh.

145 {
146 incoming.clear();
147 }

◆ clearInside()

void G4INCL::Store::clearInside ( )

Clear all inside particles from the store.

Warning! This actually deletes the objects as well!

Definition at line 216 of file G4INCLStore.cc.

216 {
217 for(ParticleIter iter=inside.begin(), e=inside.end(); iter!=e; ++iter) {
218 delete *iter;
219 }
220 inside.clear();
221 }

Referenced by clear().

◆ clearOutgoing()

void G4INCL::Store::clearOutgoing ( )

Clear all outgoing particles from the store.

Warning! This actually deletes the objects as well!

Definition at line 223 of file G4INCLStore.cc.

223 {
224 for(ParticleIter iter=outgoing.begin(), e=outgoing.end(); iter!=e; ++iter) {
225 if((*iter)->isCluster()) {
226 Cluster *c = dynamic_cast<Cluster *>(*iter);
227// assert(c);
228#ifdef INCLXX_IN_GEANT4_MODE
229 if(!c)
230 continue;
231#endif
232 c->deleteParticles();
233 }
234 delete (*iter);
235 }
236 outgoing.clear();
237 }

Referenced by clear().

◆ containsCollisions()

G4bool G4INCL::Store::containsCollisions ( ) const

Definition at line 346 of file G4INCLStore.cc.

346 {
347 for(IAvatarIter i = avatarList.begin(), e = avatarList.end(); i != e; ++i)
348 if((*i)->getType()==CollisionAvatarType) return true;
349 return false;
350 }
@ CollisionAvatarType

◆ countCascading()

G4int G4INCL::Store::countCascading ( )
inline

Definition at line 261 of file G4INCLStore.hh.

261 {
262 G4int n=0;
263 for(ParticleIter i=inside.begin(), e=inside.end(); i!=e; ++i) {
264 if(!(*i)->isTargetSpectator())
265 ++n;
266 }
267 return n;
268 }
int G4int
Definition G4Types.hh:85

◆ deleteIncoming()

void G4INCL::Store::deleteIncoming ( )
inline

Clear the incoming list and delete the particles.

Definition at line 150 of file G4INCLStore.hh.

150 {
151 for(ParticleIter iter=incoming.begin(), e=incoming.end(); iter!=e; ++iter) {
152 delete (*iter);
153 }
155 }
void clearIncoming()
Clear the incoming list.

◆ extractDynamicalSpectators()

ParticleList G4INCL::Store::extractDynamicalSpectators ( )
inline

Returns a list of dynamical spectators.

Looks in the outgoing list for particles without collisions and decays, removes them from outgoing and returns them in a list.

Returns
the (possibly empty) list of dynamical spectators

Definition at line 232 of file G4INCLStore.hh.

232 {
233 ParticleList spectators;
234 for(ParticleIter p=outgoing.begin(), e=outgoing.end(); p!=e; ++p) {
235 if((*p)->isProjectileSpectator()) {
236// assert((*p)->isNucleon() || (*p)->isLambda());
237 spectators.push_back(*p); // add them to the list we will return
238 }
239 }
240
241 // Now erase them from outgoing
242 for(ParticleIter i=spectators.begin(); i!=spectators.end(); ++i) {
243 outgoing.remove(*i);
244 }
245
246 return spectators;
247 }

◆ findSmallestTime()

IAvatar * G4INCL::Store::findSmallestTime ( )

Find the avatar that has the smallest time.

Definition at line 142 of file G4INCLStore.cc.

142 {
143 if(avatarList.empty()) return NULL;
144
145#ifdef INCL_AVATAR_SEARCH_FullSort
146
147 /* Full sort algorithm.
148 *
149 * Simple, but guaranteed to work.
150 */
151 avatarList.sort(Store::avatarComparisonPredicate);
152 IAvatar *avatar = avatarList.front();
153
154#elif defined(INCL_AVATAR_SEARCH_MinElement)
155
156 /* Algorithm provided by the C++ stdlib. */
157 IAvatar *avatar = *(std::min_element(avatarList.begin(), avatarList.end(),
159
160#else
161#error Unrecognized INCL_AVATAR_SEARCH. Allowed values are: FullSort, MinElement.
162#endif
163
164 removeAvatar(avatar);
165 return avatar;
166 }
static G4bool avatarComparisonPredicate(IAvatar *lhs, IAvatar *rhs)
Comparison predicate for avatars.

Referenced by G4INCL::StandardPropagationModel::propagate().

◆ getAvatars()

IAvatarList const & G4INCL::Store::getAvatars ( ) const
inline

Return the list of avatars

Definition at line 126 of file G4INCLStore.hh.

126 {
127 return avatarList;
128 }

◆ getBook()

◆ getConfig()

◆ getIncomingParticles()

ParticleList const & G4INCL::Store::getIncomingParticles ( ) const
inline

Return the list of incoming particles (i.e. particles that have yet to enter the cascade).

Definition at line 217 of file G4INCLStore.hh.

217{ return incoming; }

◆ getLoadedA()

G4int G4INCL::Store::getLoadedA ( )
inline

Get the value of the nucleus mass number that we read from file with loadParticles.

Definition at line 311 of file G4INCLStore.hh.

311{ return loadedA; };

◆ getLoadedStoppingTime()

G4double G4INCL::Store::getLoadedStoppingTime ( )
inline

Get the value of the stopping time that we read from file with loadParticles.

Definition at line 323 of file G4INCLStore.hh.

323{ return loadedStoppingTime; };

◆ getLoadedZ()

G4int G4INCL::Store::getLoadedZ ( )
inline

Get the value of the nucleus charge number that we read from file with loadParticles.

Definition at line 317 of file G4INCLStore.hh.

317{ return loadedZ; };

◆ getOutgoingParticles()

◆ getParticles()

◆ loadParticles()

void G4INCL::Store::loadParticles ( std::string const & filename)

Load particle configuration from ASCII file (see avatarPredictionTest).

Definition at line 239 of file G4INCLStore.cc.

239 {
240 clear();
241 G4int projectileA, projectileZ, A, Z;
242 G4double stoppingTime, cutNN;
243 G4int ID, type, isParticipant;
244 G4double x, y, z;
245 G4double px, py, pz, E, v;
246
247 std::ifstream in(filename.c_str());
248 in >> projectileA >> projectileZ >> A >> Z >> stoppingTime >> cutNN;
249 loadedA = A;
250 loadedZ = Z;
251 loadedStoppingTime = stoppingTime;
252
253 while(1) { /* Loop checking, 10.07.2015, D.Mancusi */
254 in >> ID >> type >> isParticipant >> x >> y >> z >> px >> py >> pz >> E >> v;
255 if(!in.good()) break;
256 ParticleType t;
257 if(type == 1) {
258 t = Proton;
259 }
260 else if(type == -1) {
261 t = Neutron;
262 }
263 else {
264 INCL_FATAL("Unrecognized particle type while loading particles; type=" << type << '\n');
265 t = UnknownParticle;
266 }
267
268 Particle *p = new Particle(t, E, ThreeVector(px, py, pz),
269 ThreeVector(x, y, z));
270 p->setPotentialEnergy(v);
271 if(isParticipant == 1) {
272 p->makeParticipant();
273 theBook.incrementCascading();
274 }
275 add(p);
276 }
277
278 in.close();
279 }
#define INCL_FATAL(x)
double G4double
Definition G4Types.hh:83
const G4double A[17]
void incrementCascading()
Definition G4INCLBook.hh:77
void add(Particle *p)

◆ particleHasBeenDestroyed()

void G4INCL::Store::particleHasBeenDestroyed ( Particle * const p)

Remove the particle from the system. This also removes all avatars related to this particle.

Definition at line 181 of file G4INCLStore.cc.

181 {
183 // Have to destroy the particle here, the Store will forget about it
184 inside.remove(p);
185 delete p;
186 }
void particleHasBeenUpdated(Particle *const)
Notify the Store about a particle update.

Referenced by G4INCL::Nucleus::applyFinalState().

◆ particleHasBeenEjected()

void G4INCL::Store::particleHasBeenEjected ( Particle * const p)

Mark the particle as ejected. This removes it from the list of inside particles and removes all avatars related to this particle.

Definition at line 175 of file G4INCLStore.cc.

175 {
177 // The particle will be destroyed when destroying the Store
178 inside.remove(p);
179 }

Referenced by G4INCL::Nucleus::applyFinalState(), G4INCL::Nucleus::emitInsideKaon(), G4INCL::Nucleus::emitInsideLambda(), G4INCL::Nucleus::emitInsidePions(), and G4INCL::Nucleus::emitInsideStrangeParticles().

◆ particleHasBeenUpdated()

void G4INCL::Store::particleHasBeenUpdated ( Particle * const particle)

Notify the Store about a particle update.

Notify the Store that a particle has been updated. This schedules the removal of obsolete avatars and their disconnection from the particle.

Definition at line 127 of file G4INCLStore.cc.

127 {
128 PAIterPair iterPair = particleAvatarConnections.equal_range(particle);
129 for(PAIter i=iterPair.first, last=iterPair.second; i!=last; ++i) {
130 avatarsToBeRemoved.insert(i->second);
131 }
132 }

Referenced by G4INCL::Nucleus::applyFinalState(), particleHasBeenDestroyed(), and particleHasBeenEjected().

◆ particleHasEntered()

void G4INCL::Store::particleHasEntered ( Particle *const particle)

Move a particle from incoming to inside.

Parameters
particlepointer to a particle

Definition at line 188 of file G4INCLStore.cc.

188 {
189 removeFromIncoming(particle);
190 add(particle);
191 }
void removeFromIncoming(Particle *const p)

Referenced by G4INCL::Nucleus::insertParticle().

◆ printAvatars()

std::string G4INCL::Store::printAvatars ( )

Print the list of avatars

Definition at line 338 of file G4INCLStore.cc.

338 {
339 std::stringstream ss;
340 for(IAvatarIter i = avatarList.begin(), e = avatarList.end(); i != e; ++i) {
341 ss << (*i)->toString() << '\n';
342 }
343 return ss.str();
344 }

◆ printParticleConfiguration()

std::string G4INCL::Store::printParticleConfiguration ( )

Print the nucleon configuration of the nucleus.

Definition at line 281 of file G4INCLStore.cc.

281 {
282 std::stringstream ss;
283 G4int A = 0, Z = 0;
284 for(ParticleIter i=inside.begin(), e=inside.end(); i!=e; ++i) {
285 if((*i)->getType() == Proton) {
286 A++;
287 Z++;
288 }
289 if((*i)->getType() == Neutron) {
290 A++;
291 }
292 }
293 // Note: Projectile A and Z are set to 0 (we don't really know
294 // anything about them at this point).
295 ss << "0 0 " << A << " " << Z << " "
296 << "100.0" << " "
297 << "0.0" << '\n';
298
299 for(ParticleIter i=inside.begin(), e=inside.end(); i!=e; ++i) {
300 G4int ID = (G4int)(*i)->getID();
301 G4int type = 0;
302 if((*i)->getType() == Proton) {
303 type = 1;
304 }
305 if((*i)->getType() == Neutron) {
306 type = -1;
307 }
308
309 G4int isParticipant = 0;
310 if((*i)->isParticipant()) {
311 isParticipant = 1;
312 }
313
314 G4double x = (*i)->getPosition().getX();
315 G4double y = (*i)->getPosition().getY();
316 G4double z = (*i)->getPosition().getZ();
317 G4double E = (*i)->getEnergy();
318 G4double px = (*i)->getMomentum().getX();
319 G4double py = (*i)->getMomentum().getY();
320 G4double pz = (*i)->getMomentum().getZ();
321 G4double V = (*i)->getPotentialEnergy();
322
323 ss << ID << " " << type << " " << isParticipant << " "
324 << x << " " << y << " " << z << " "
325 << px << " " << py << " " << pz << " "
326 << E << " " << V << '\n';
327 }
328
329 return ss.str();
330 }

Referenced by writeParticles().

◆ removeFromIncoming()

void G4INCL::Store::removeFromIncoming ( Particle *const p)
inline

Add a particle to the incoming list.

Parameters
pparticle to add

Definition at line 142 of file G4INCLStore.hh.

142{ incoming.remove(p); }

Referenced by particleHasEntered().

◆ removeScheduledAvatars()

void G4INCL::Store::removeScheduledAvatars ( )

Remove avatars that have been scheduled.

Definition at line 134 of file G4INCLStore.cc.

134 {
135 for(ASIter a=avatarsToBeRemoved.begin(), e=avatarsToBeRemoved.end(); a!=e; ++a) {
136 removeAvatar(*a);
137 delete *a;
138 }
139 avatarsToBeRemoved.clear();
140 }

Referenced by G4INCL::Nucleus::applyFinalState().

◆ timeStep()

void G4INCL::Store::timeStep ( G4double step)

Make one time step: propagate particles and subtract the length of the step from the avatar times.

Definition at line 168 of file G4INCLStore.cc.

168 {
169 for(ParticleIter particleIter = inside.begin(), particleEnd=inside.end();
170 particleIter != particleEnd; ++particleIter) {
171 (*particleIter)->propagate(step);
172 }
173 }

Referenced by G4INCL::StandardPropagationModel::propagate().

◆ writeParticles()

void G4INCL::Store::writeParticles ( std::string const & filename)

Print the nucleon configuration of the nucleus.

Definition at line 332 of file G4INCLStore.cc.

332 {
333 std::ofstream out(filename.c_str());
335 out.close();
336 }
std::string printParticleConfiguration()

The documentation for this class was generated from the following files: