Geant4
10.01.p02
|
The purpose of the Store object is to act as a "particle manager" that keeps track ofall the particles in our simulation. More...
#include <G4INCLStore.hh>
Public Member Functions | |
Store (Config const *const config) | |
Store constructor. More... | |
~Store () | |
Store destructor. More... | |
void | add (Particle *p) |
Add one particle to the store. More... | |
void | add (ParticleList const &pL) |
Add a list of particles to the Store. More... | |
void | addParticleEntryAvatar (IAvatar *a) |
Add one ParticleEntry avatar. More... | |
void | addParticleEntryAvatars (IAvatarList const &al) |
Add one ParticleEntry avatar. More... | |
void | add (IAvatar *a) |
Add one avatar to the store. More... | |
IAvatarList const & | getAvatars () const |
Return the list of avatars. More... | |
void | addIncomingParticle (Particle *const p) |
Add a particle to the incoming list. More... | |
void | removeFromIncoming (Particle *const p) |
Add a particle to the incoming list. More... | |
void | clearIncoming () |
Clear the incoming list. More... | |
void | deleteIncoming () |
Clear the incoming list and delete the particles. More... | |
void | particleHasBeenUpdated (Particle *const) |
Notify the Store about a particle update. More... | |
void | removeScheduledAvatars () |
Remove avatars that have been scheduled. More... | |
IAvatar * | findSmallestTime () |
Find the avatar that has the smallest time. More... | |
void | timeStep (G4double step) |
Make one time step: propagate particles and subtract the length of the step from the avatar times. More... | |
void | particleHasBeenEjected (Particle *const) |
Mark the particle as ejected. More... | |
void | addToOutgoing (Particle *p) |
add the particle to the outgoing particle list. More... | |
void | addToOutgoing (ParticleList const &pl) |
Add a list of particles to the outgoing particle list. More... | |
void | particleHasBeenDestroyed (Particle *const) |
Remove the particle from the system. More... | |
void | particleHasEntered (Particle *const particle) |
Move a particle from incoming to inside. More... | |
ParticleList const & | getIncomingParticles () const |
Return the list of incoming particles (i.e. More... | |
ParticleList const & | getOutgoingParticles () const |
Return the list of outgoing particles (i.e. More... | |
ParticleList | extractDynamicalSpectators () |
Returns a list of dynamical spectators. More... | |
ParticleList const & | getParticles () const |
Return the list of "active" particles (i.e. More... | |
Book & | getBook () |
Return the pointer to the Book object which keeps track of various counters. More... | |
G4int | countCascading () |
Config const * | getConfig () |
Get the config object. More... | |
void | clear () |
Clear all avatars and particles from the store. More... | |
void | clearInside () |
Clear all inside particles from the store. More... | |
void | clearOutgoing () |
Clear all outgoing particles from the store. More... | |
void | clearAvatars () |
Clear avatars only. More... | |
void | loadParticles (std::string const &filename) |
Load particle configuration from ASCII file (see avatarPredictionTest). More... | |
G4int | getLoadedA () |
Get the value of the nucleus mass number that we read from file with loadParticles. More... | |
G4int | getLoadedZ () |
Get the value of the nucleus charge number that we read from file with loadParticles. More... | |
G4double | getLoadedStoppingTime () |
Get the value of the stopping time that we read from file with loadParticles. More... | |
std::string | printParticleConfiguration () |
Print the nucleon configuration of the nucleus. More... | |
void | writeParticles (std::string const &filename) |
Print the nucleon configuration of the nucleus. More... | |
std::string | printAvatars () |
Print the list of avatars. More... | |
G4bool | containsCollisions () const |
Static Public Member Functions | |
static G4bool | avatarComparisonPredicate (IAvatar *lhs, IAvatar *rhs) |
Comparison predicate for avatars. More... | |
Private Types | |
typedef std::multimap < Particle *, IAvatar * > ::value_type | PAPair |
typedef std::multimap < Particle *, IAvatar * > ::iterator | PAIter |
typedef std::pair< PAIter, PAIter > | PAIterPair |
typedef std::set< IAvatar * > ::const_iterator | ASIter |
Private Member Functions | |
Store (const Store &rhs) | |
Dummy copy constructor to shut up Coverity warnings. More... | |
Store & | operator= (Store const &rhs) |
Dummy assignment operator to shut up Coverity warnings. More... | |
void | connectAvatarToParticle (IAvatar *const a, Particle *const p) |
Connect an avatar to a particle. More... | |
void | disconnectAvatarFromParticle (IAvatar *const a, Particle *const p) |
Disconnect an avatar from a particle. More... | |
void | removeAvatar (IAvatar *const a) |
Remove an avatar from the list of avatars. More... | |
Private Attributes | |
std::multimap< Particle *, IAvatar * > | particleAvatarConnections |
Map particle -> [avatar]. More... | |
std::set< IAvatar * > | avatarsToBeRemoved |
Set of avatars to be removed. More... | |
IAvatarList | avatarList |
List of all avatars. More... | |
ParticleList | incoming |
List of incoming particles. More... | |
ParticleList | inside |
List of particles that are inside the nucleus. More... | |
ParticleList | outgoing |
List of outgoing particles. More... | |
ParticleList | geomSpectators |
List of geometrical spectators. More... | |
G4double | currentTime |
The current time in the simulation. More... | |
Book | theBook |
The Book object keeps track of global counters. More... | |
G4int | loadedA |
The target nucleus mass number that was loaded from a particle file. More... | |
G4int | loadedZ |
The target nucleus charge number that was loaded from a particle file. More... | |
G4double | loadedStoppingTime |
The stopping time that was loaded from a particle file. More... | |
Config const * | theConfig |
Pointer to the Config object. More... | |
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.
|
private |
Definition at line 406 of file G4INCLStore.hh.
|
private |
Definition at line 401 of file G4INCLStore.hh.
|
private |
Definition at line 402 of file G4INCLStore.hh.
|
private |
Definition at line 400 of file G4INCLStore.hh.
G4INCL::Store::Store | ( | Config const *const | config | ) |
Store constructor.
Definition at line 45 of file G4INCLStore.cc.
G4INCL::Store::~Store | ( | ) |
Store destructor.
Definition at line 53 of file G4INCLStore.cc.
References clear(), G4INCL::Book::reset(), and theBook.
|
private |
Dummy copy constructor to shut up Coverity warnings.
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:
Definition at line 58 of file G4INCLStore.cc.
References inside.
Referenced by G4INCL::Nucleus::applyFinalState(), G4INCL::Nucleus::initializeParticles(), loadParticles(), particleHasEntered(), and G4INCL::StandardPropagationModel::registerAvatar().
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.
References inside.
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:
Definition at line 83 of file G4INCLStore.cc.
References avatarList, connectAvatarToParticle(), and G4INCL::IAvatar::getParticles().
void G4INCL::Store::addIncomingParticle | ( | Particle *const | p | ) |
Add a particle to the incoming list.
p | particle to add |
Definition at line 95 of file G4INCLStore.cc.
References incoming.
Referenced by addParticleEntryAvatar().
void G4INCL::Store::addParticleEntryAvatar | ( | IAvatar * | a | ) |
Add one ParticleEntry avatar.
Definition at line 66 of file G4INCLStore.cc.
References addIncomingParticle(), avatarList, connectAvatarToParticle(), and G4INCL::IAvatar::getParticles().
Referenced by addParticleEntryAvatars(), G4INCL::INCL::makeCompoundNucleus(), and G4INCL::StandardPropagationModel::shootParticle().
void G4INCL::Store::addParticleEntryAvatars | ( | IAvatarList const & | al | ) |
Add one ParticleEntry avatar.
Definition at line 78 of file G4INCLStore.cc.
References a, and addParticleEntryAvatar().
Referenced by G4INCL::StandardPropagationModel::shootComposite().
|
inline |
add the particle to the outgoing particle list.
p | pointer to the particle to be added |
Definition at line 190 of file G4INCLStore.hh.
Referenced by G4INCL::Nucleus::applyFinalState(), G4INCL::Nucleus::computeOneNucleonRecoilKinematics(), G4INCL::Nucleus::decayMe(), G4INCL::Nucleus::decayOutgoingClusters(), G4INCL::Nucleus::decayOutgoingDeltas(), G4INCL::Nucleus::emitInsidePions(), and G4INCL::INCL::makeProjectileRemnant().
|
inline |
Add a list of particles to the outgoing particle list.
pl | list of particles to be added |
Definition at line 196 of file G4INCLStore.hh.
|
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.
lhs | pointer to the first avatar |
rhs | pointer to the second avatar |
Definition at line 352 of file G4INCLStore.hh.
References G4INCL::IAvatar::getTime().
Referenced by findSmallestTime().
void G4INCL::Store::clear | ( | void | ) |
Clear all avatars and particles from the store.
Warning! This actually deletes the objects as well!
Definition at line 203 of file G4INCLStore.cc.
References clearAvatars(), clearInside(), clearOutgoing(), INCL_WARN, and incoming.
Referenced by loadParticles(), and ~Store().
void G4INCL::Store::clearAvatars | ( | ) |
Clear avatars only.
Definition at line 193 of file G4INCLStore.cc.
References avatarList, avatarsToBeRemoved, and particleAvatarConnections.
Referenced by clear(), and G4INCL::StandardPropagationModel::propagate().
|
inline |
Clear the incoming list.
Definition at line 145 of file G4INCLStore.hh.
Referenced by G4INCL::INCL::makeCompoundNucleus(), and G4INCL::INCL::postCascade().
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.
References inside.
Referenced by clear().
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.
References G4INCL::Cluster::deleteParticles(), and outgoing.
Referenced by clear(), and G4INCL::INCL::makeCompoundNucleus().
Connect an avatar to a particle.
Adds the avatar to the list of avatars where the particle appears. This is typically called when the avatar is created.
p | the particle |
a | the avatar |
Definition at line 99 of file G4INCLStore.cc.
References particleAvatarConnections.
Referenced by add(), and addParticleEntryAvatar().
G4bool G4INCL::Store::containsCollisions | ( | ) | const |
Definition at line 351 of file G4INCLStore.cc.
References avatarList, and G4INCL::CollisionAvatarType.
|
inline |
Definition at line 261 of file G4INCLStore.hh.
References n.
|
inline |
Clear the incoming list and delete the particles.
Definition at line 150 of file G4INCLStore.hh.
Referenced by G4INCL::INCL::postCascade().
Disconnect an avatar from a particle.
Removes the avatar from the list of avatars where the particle appears. This is typically called when the avatar has been invalidated or realised.
p | the particle |
a | the avatar |
Definition at line 103 of file G4INCLStore.cc.
References INCL_WARN, and particleAvatarConnections.
Referenced by removeAvatar().
|
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.
Definition at line 232 of file G4INCLStore.hh.
References G4INCL::UnorderedVector< T >::remove().
Referenced by G4INCL::INCL::makeProjectileRemnant().
IAvatar * G4INCL::Store::findSmallestTime | ( | ) |
Find the avatar that has the smallest time.
Definition at line 142 of file G4INCLStore.cc.
References avatarComparisonPredicate(), avatarList, and removeAvatar().
Referenced by G4INCL::StandardPropagationModel::propagate().
|
inline |
Return the list of avatars.
Definition at line 126 of file G4INCLStore.hh.
|
inline |
Return the pointer to the Book object which keeps track of various counters.
Definition at line 259 of file G4INCLStore.hh.
Referenced by G4INCL::Nucleus::applyFinalState(), G4INCL::CascadeAction::beforeAvatarDefaultAction(), G4INCL::Nucleus::computeOneNucleonRecoilKinematics(), G4INCL::INCL::continueCascade(), G4INCL::Nucleus::emitInsidePions(), G4INCL::InteractionAvatar::enforceEnergyConservation(), G4INCL::Nucleus::fillEventInfo(), G4INCL::StandardPropagationModel::generateBinaryCollisionAvatar(), G4INCL::BinaryCollisionAvatar::getChannel(), G4INCL::SurfaceAvatar::getChannel(), G4INCL::INCL::initializeTarget(), G4INCL::Nucleus::insertParticle(), G4INCL::PauliStrictStandard::isBlocked(), G4INCL::Nucleus::isEventTransparent(), G4INCL::DecayAvatar::postInteraction(), G4INCL::BinaryCollisionAvatar::postInteraction(), G4INCL::SurfaceAvatar::postInteraction(), G4INCL::InteractionAvatar::postInteraction(), G4INCL::StandardPropagationModel::propagate(), and G4INCL::InteractionAvatar::shouldUseLocalEnergy().
|
inline |
Get the config object.
Definition at line 273 of file G4INCLStore.hh.
Referenced by G4INCL::SurfaceAvatar::getChannel(), G4INCL::ClusteringModelIntercomparison::getCluster(), G4INCL::SurfaceAvatar::getTransmissionProbability(), G4INCL::ParticleEntryChannel::particleEnters(), G4INCL::InteractionAvatar::postInteraction(), and G4INCL::InteractionAvatar::shouldUseLocalEnergy().
|
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.
Referenced by G4INCL::INCL::continueCascade().
|
inline |
Get the value of the nucleus mass number that we read from file with loadParticles.
Definition at line 311 of file G4INCLStore.hh.
|
inline |
Get the value of the stopping time that we read from file with loadParticles.
Definition at line 323 of file G4INCLStore.hh.
|
inline |
Get the value of the nucleus charge number that we read from file with loadParticles.
Definition at line 317 of file G4INCLStore.hh.
|
inline |
Return the list of outgoing particles (i.e.
particles that have left the cascade).
Definition at line 223 of file G4INCLStore.hh.
Referenced by G4INCL::Nucleus::computeOneNucleonRecoilKinematics(), G4INCL::Nucleus::computeRecoilKinematics(), G4INCL::Nucleus::computeSeparationEnergyBalance(), G4INCL::Nucleus::decayOutgoingClusters(), G4INCL::Nucleus::decayOutgoingDeltas(), G4INCL::Nucleus::fillEventInfo(), G4INCL::Nucleus::getConservationBalance(), G4INCL::INCL::postCascade(), and G4INCL::Nucleus::print().
|
inline |
Return the list of "active" particles (i.e.
particles that can participate in collisions).
Definition at line 253 of file G4INCLStore.hh.
Referenced by G4INCL::AvatarDumpAction::afterAvatarUserAction(), G4INCL::Nucleus::computeCenterOfMass(), G4INCL::Nucleus::computeOneNucleonRecoilKinematics(), G4INCL::Nucleus::computeTotalEnergy(), G4INCL::Nucleus::containsDeltas(), G4INCL::Nucleus::decayInsideDeltas(), G4INCL::Nucleus::emitInsidePions(), G4INCL::StandardPropagationModel::generateAllAvatars(), G4INCL::PauliStandard::getBlockingProbability(), G4INCL::ClusteringModelIntercomparison::getCluster(), G4INCL::PauliGlobal::isBlocked(), G4INCL::CDPP::isBlocked(), G4INCL::Nucleus::print(), and G4INCL::StandardPropagationModel::updateAvatars().
void G4INCL::Store::loadParticles | ( | std::string const & | filename | ) |
Load particle configuration from ASCII file (see avatarPredictionTest).
Definition at line 239 of file G4INCLStore.cc.
References A, add(), clear(), INCL_FATAL, G4INCL::Book::incrementCascading(), loadedA, loadedStoppingTime, loadedZ, G4INCL::Particle::makeParticipant(), G4INCL::Neutron, G4INCL::Proton, G4INCL::Particle::setPotentialEnergy(), theBook, G4INCL::UnknownParticle, and z.
Dummy assignment operator to shut up Coverity warnings.
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.
References inside, particleHasBeenUpdated(), and G4INCL::UnorderedVector< T >::remove().
Referenced by G4INCL::Nucleus::applyFinalState().
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.
References inside, particleHasBeenUpdated(), and G4INCL::UnorderedVector< T >::remove().
Referenced by G4INCL::Nucleus::applyFinalState(), G4INCL::Nucleus::computeOneNucleonRecoilKinematics(), and G4INCL::Nucleus::emitInsidePions().
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.
References avatarsToBeRemoved, and particleAvatarConnections.
Referenced by G4INCL::Nucleus::applyFinalState(), particleHasBeenDestroyed(), and particleHasBeenEjected().
void G4INCL::Store::particleHasEntered | ( | Particle *const | particle | ) |
Move a particle from incoming to inside.
particle | pointer to a particle |
Definition at line 188 of file G4INCLStore.cc.
References add(), and removeFromIncoming().
Referenced by G4INCL::Nucleus::insertParticle().
std::string G4INCL::Store::printAvatars | ( | ) |
std::string G4INCL::Store::printParticleConfiguration | ( | ) |
Print the nucleon configuration of the nucleus.
Definition at line 286 of file G4INCLStore.cc.
References A, inside, G4INCL::Neutron, G4INCL::Proton, and z.
Referenced by writeParticles().
|
private |
Remove an avatar from the list of avatars.
Removes an avatar from the list of all avatars. The avatar is not deleted.
a | the avatar to remove |
Definition at line 115 of file G4INCLStore.cc.
References avatarList, disconnectAvatarFromParticle(), G4INCL::IAvatar::getParticles(), and G4INCL::UnorderedVector< T >::remove().
Referenced by findSmallestTime(), and removeScheduledAvatars().
|
inline |
Add a particle to the incoming list.
p | particle to add |
Definition at line 142 of file G4INCLStore.hh.
Referenced by particleHasEntered().
void G4INCL::Store::removeScheduledAvatars | ( | ) |
Remove avatars that have been scheduled.
Definition at line 134 of file G4INCLStore.cc.
References a, avatarsToBeRemoved, and removeAvatar().
Referenced by G4INCL::Nucleus::applyFinalState().
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.
References inside.
Referenced by G4INCL::StandardPropagationModel::propagate().
void G4INCL::Store::writeParticles | ( | std::string const & | filename | ) |
Print the nucleon configuration of the nucleus.
Definition at line 337 of file G4INCLStore.cc.
References printParticleConfiguration().
|
private |
List of all avatars.
Definition at line 412 of file G4INCLStore.hh.
Referenced by add(), addParticleEntryAvatar(), clearAvatars(), containsCollisions(), findSmallestTime(), printAvatars(), and removeAvatar().
|
private |
Set of avatars to be removed.
Definition at line 405 of file G4INCLStore.hh.
Referenced by clearAvatars(), particleHasBeenUpdated(), and removeScheduledAvatars().
|
private |
The current time in the simulation.
Definition at line 437 of file G4INCLStore.hh.
|
private |
List of geometrical spectators.
Definition at line 432 of file G4INCLStore.hh.
|
private |
List of incoming particles.
Definition at line 417 of file G4INCLStore.hh.
Referenced by addIncomingParticle(), and clear().
|
private |
List of particles that are inside the nucleus.
Definition at line 422 of file G4INCLStore.hh.
Referenced by add(), clearInside(), particleHasBeenDestroyed(), particleHasBeenEjected(), printParticleConfiguration(), and timeStep().
|
private |
The target nucleus mass number that was loaded from a particle file.
Definition at line 447 of file G4INCLStore.hh.
Referenced by loadParticles().
|
private |
The stopping time that was loaded from a particle file.
Definition at line 457 of file G4INCLStore.hh.
Referenced by loadParticles().
|
private |
The target nucleus charge number that was loaded from a particle file.
Definition at line 452 of file G4INCLStore.hh.
Referenced by loadParticles().
|
private |
List of outgoing particles.
Definition at line 427 of file G4INCLStore.hh.
Referenced by clearOutgoing().
Map particle -> [avatar].
Definition at line 399 of file G4INCLStore.hh.
Referenced by clearAvatars(), connectAvatarToParticle(), disconnectAvatarFromParticle(), and particleHasBeenUpdated().
|
private |
The Book object keeps track of global counters.
Definition at line 442 of file G4INCLStore.hh.
Referenced by loadParticles(), and ~Store().
|
private |
Pointer to the Config object.
Definition at line 462 of file G4INCLStore.hh.