Geant4 11.1.1
Toolkit for the simulation of the passage of particles through matter
|
#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. | |
IAvatar * | findSmallestTime () |
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 |
Book & | getBook () |
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. | |
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.
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.
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.
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.
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.
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.
Referenced by addParticleEntryAvatar().
void G4INCL::Store::addParticleEntryAvatar | ( | IAvatar * | a | ) |
Add one ParticleEntry avatar.
Definition at line 66 of file G4INCLStore.cc.
Referenced by addParticleEntryAvatars(), and G4INCL::StandardPropagationModel::shootParticle().
void G4INCL::Store::addParticleEntryAvatars | ( | IAvatarList const & | al | ) |
Add one ParticleEntry avatar.
Definition at line 78 of file G4INCLStore.cc.
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::decayMe(), G4INCL::Nucleus::decayOutgoingClusters(), G4INCL::Nucleus::decayOutgoingDeltas(), G4INCL::Nucleus::decayOutgoingPionResonances(), G4INCL::Nucleus::decayOutgoingSigmaZero(), G4INCL::Nucleus::emitInsideKaon(), G4INCL::Nucleus::emitInsideLambda(), G4INCL::Nucleus::emitInsidePions(), and G4INCL::Nucleus::emitInsideStrangeParticles().
|
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.
Referenced by findSmallestTime().
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.
Referenced by loadParticles(), and ~Store().
void G4INCL::Store::clearAvatars | ( | ) |
Clear avatars only.
Definition at line 193 of file G4INCLStore.cc.
Referenced by clear(), and G4INCL::StandardPropagationModel::propagate().
|
inline |
Clear the incoming list.
Definition at line 145 of file G4INCLStore.hh.
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.
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.
Referenced by clear().
G4bool G4INCL::Store::containsCollisions | ( | ) | const |
Definition at line 346 of file G4INCLStore.cc.
|
inline |
Definition at line 261 of file G4INCLStore.hh.
|
inline |
Clear the incoming list and delete the particles.
Definition at line 150 of file G4INCLStore.hh.
|
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.
IAvatar * G4INCL::Store::findSmallestTime | ( | ) |
Find the avatar that has the smallest time.
Definition at line 142 of file G4INCLStore.cc.
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::Nucleus::emitInsideKaon(), G4INCL::Nucleus::emitInsideLambda(), G4INCL::Nucleus::emitInsidePions(), G4INCL::Nucleus::emitInsideStrangeParticles(), 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::BinaryCollisionAvatar::postInteraction(), G4INCL::InteractionAvatar::postInteraction(), G4INCL::SurfaceAvatar::postInteraction(), G4INCL::DecayAvatar::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::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.
|
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::computeRecoilKinematics(), G4INCL::Nucleus::computeSeparationEnergyBalance(), G4INCL::Nucleus::decayOutgoingClusters(), G4INCL::Nucleus::decayOutgoingDeltas(), G4INCL::Nucleus::decayOutgoingNeutralKaon(), G4INCL::Nucleus::decayOutgoingPionResonances(), G4INCL::Nucleus::decayOutgoingSigmaZero(), G4INCL::Nucleus::fillEventInfo(), G4INCL::Nucleus::getConservationBalance(), 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::computeTotalEnergy(), G4INCL::Nucleus::containsAntiKaon(), G4INCL::Nucleus::containsDeltas(), G4INCL::Nucleus::containsEtas(), G4INCL::Nucleus::containsKaon(), G4INCL::Nucleus::containsLambda(), G4INCL::Nucleus::containsOmegas(), G4INCL::Nucleus::containsSigma(), G4INCL::Nucleus::decayInsideDeltas(), G4INCL::Nucleus::decayInsideStrangeParticles(), G4INCL::Nucleus::emitInsideKaon(), G4INCL::Nucleus::emitInsideLambda(), G4INCL::Nucleus::emitInsidePions(), G4INCL::Nucleus::emitInsideStrangeParticles(), G4INCL::StandardPropagationModel::generateAllAvatars(), G4INCL::PauliStandard::getBlockingProbability(), G4INCL::ClusteringModelIntercomparison::getCluster(), 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.
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.
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.
Referenced by G4INCL::Nucleus::applyFinalState(), G4INCL::Nucleus::emitInsideKaon(), G4INCL::Nucleus::emitInsideLambda(), G4INCL::Nucleus::emitInsidePions(), and G4INCL::Nucleus::emitInsideStrangeParticles().
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.
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.
Referenced by G4INCL::Nucleus::insertParticle().
std::string G4INCL::Store::printAvatars | ( | ) |
Print the list of avatars
Definition at line 338 of file G4INCLStore.cc.
std::string G4INCL::Store::printParticleConfiguration | ( | ) |
Print the nucleon configuration of the nucleus.
Definition at line 281 of file G4INCLStore.cc.
Referenced by writeParticles().
|
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.
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.
Referenced by G4INCL::StandardPropagationModel::propagate().
void G4INCL::Store::writeParticles | ( | std::string const & | filename | ) |
Print the nucleon configuration of the nucleus.
Definition at line 332 of file G4INCLStore.cc.