Geant4  10.00.p02
Public Member Functions | Private Member Functions | Private Attributes | List of all members
G4INCL::StandardPropagationModel Class Reference

Standard INCL4 particle propagation and avatar prediction. More...

#include <G4INCLStandardPropagationModel.hh>

+ Inheritance diagram for G4INCL::StandardPropagationModel:
+ Collaboration diagram for G4INCL::StandardPropagationModel:

Public Member Functions

 StandardPropagationModel (LocalEnergyType localEnergyType, LocalEnergyType localEnergyDeltaType)
 
virtual ~StandardPropagationModel ()
 
G4double getCurrentTime ()
 Returns the current global time of the system. More...
 
void setNucleus (G4INCL::Nucleus *nucleus)
 Set the nucleus for this propagation model. More...
 
G4INCL::Nucleus * getNucleus ()
 Get the nucleus. More...
 
G4double shoot (ParticleSpecies const projectileSpecies, const G4double kineticEnergy, const G4double impactParameter, const G4double phi)
 
G4double shootParticle (ParticleType const t, const G4double kineticEnergy, const G4double impactParameter, const G4double phi)
 
G4double shootComposite (ParticleSpecies const s, const G4double kineticEnergy, const G4double impactParameter, const G4double phi)
 
void setStoppingTime (G4double)
 Set the stopping time of the simulation. More...
 
G4double getStoppingTime ()
 Get the current stopping time. More...
 
void registerAvatar (G4INCL::IAvatar *anAvatar)
 Add an avatar to the storage. More...
 
IAvatar * generateBinaryCollisionAvatar (Particle *const p1, Particle *const p2)
 Generate a two-particle avatar. More...
 
G4double getReflectionTime (G4INCL::Particle const *const aParticle)
 Get the reflection time. More...
 
G4double getTime (G4INCL::Particle const *const particleA, G4INCL::Particle const *const particleB, G4double *minDistOfApproach) const
 Get the predicted time of the collision between two particles. More...
 
void generateUpdatedCollisions (const ParticleList &updatedParticles, const ParticleList &particles)
 Generate and register collisions between a list of updated particles and all the other particles. More...
 
void generateCollisions (const ParticleList &particles)
 Generate and register collisions among particles in a list, except between those in another list. More...
 
void generateCollisions (const ParticleList &particles, const ParticleList &except)
 Generate and register collisions among particles in a list, except between those in another list. More...
 
void generateDecays (const ParticleList &particles)
 Generate decays for particles that can decay. More...
 
void updateAvatars (const ParticleList &particles)
 Update all avatars related to a particle. More...
 
void generateAllAvatars ()
 (Re)Generate all possible avatars. More...
 
G4INCL::IAvatar * propagate ()
 Propagate all particles and return the first avatar. More...
 
- Public Member Functions inherited from G4INCL::IPropagationModel
 IPropagationModel ()
 
virtual ~IPropagationModel ()
 

Private Member Functions

void putSpectatorsOnShell (IAvatarList const &entryAvatars, ParticleList const &spectators)
 Put spectators on shell by extracting energy from the participants. More...
 

Private Attributes

G4INCL::Nucleus * theNucleus
 
G4double maximumTime
 
G4double currentTime
 
G4bool firstAvatar
 
LocalEnergyType theLocalEnergyType
 
LocalEnergyType theLocalEnergyDeltaType
 
Particle backupParticle1
 
Particle backupParticle2
 

Additional Inherited Members

Detailed Description

Standard INCL4 particle propagation and avatar prediction.

This class implements the standard INCL4 avatar prediction and particle propagation logic. The main idea is to predict all collisions between particles and their reflections from the potential wall. After this we select the avatar with the smallest time, propagate all particles to their positions at that time and return the avatar to the INCL kernel

See also
G4INCL::Kernel.

The particle trajectories in this propagation model are straight lines and all particles are assumed to move with constant velocity.

Definition at line 68 of file G4INCLStandardPropagationModel.hh.

Constructor & Destructor Documentation

G4INCL::StandardPropagationModel::StandardPropagationModel ( LocalEnergyType  localEnergyType,
LocalEnergyType  localEnergyDeltaType 
)

Definition at line 62 of file G4INCLStandardPropagationModel.cc.

G4INCL::StandardPropagationModel::~StandardPropagationModel ( )
virtual

Definition at line 69 of file G4INCLStandardPropagationModel.cc.

References theNucleus.

Member Function Documentation

void G4INCL::StandardPropagationModel::generateAllAvatars ( )

(Re)Generate all possible avatars.

Definition at line 433 of file G4INCLStandardPropagationModel.cc.

References generateCollisions(), generateDecays(), G4INCL::Store::getParticles(), getReflectionTime(), G4INCL::Nucleus::getStore(), maximumTime, registerAvatar(), and theNucleus.

Referenced by shootComposite(), and shootParticle().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

IAvatar * G4INCL::StandardPropagationModel::generateBinaryCollisionAvatar ( Particle *const  p1,
Particle *const  p2 
)

Generate a two-particle avatar.

Generate a two-particle avatar, if all the appropriate conditions are met.

Definition at line 261 of file G4INCLStandardPropagationModel.cc.

References G4INCL::AlwaysLocalEnergy, backupParticle1, backupParticle2, currentTime, G4INCL::FirstCollisionLocalEnergy, G4INCL::Book::getAcceptedCollisions(), G4INCL::Store::getBook(), G4INCL::BinaryCollisionAvatar::getCutNNSquared(), G4INCL::Particle::getParticipantType(), G4INCL::Particle::getPosition(), G4INCL::Nucleus::getStore(), G4INCL::Nucleus::getSurfaceRadius(), getTime(), G4INCL::Particle::isNucleon(), G4INCL::Particle::isParticipant(), G4INCL::Particle::isPion(), G4INCL::Particle::isResonance(), G4INCL::ThreeVector::mag(), maximumTime, G4INCL::Particle::propagate(), G4INCL::KinematicsUtils::squareTotalEnergyInCM(), G4INCL::Math::tenPi, theLocalEnergyDeltaType, theLocalEnergyType, theNucleus, G4INCL::CrossSections::total(), and G4INCL::KinematicsUtils::transformToLocalEnergyFrame().

Referenced by generateCollisions(), and generateUpdatedCollisions().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4INCL::StandardPropagationModel::generateCollisions ( const ParticleList &  particles)

Generate and register collisions among particles in a list, except between those in another list.

This method generates all possible collisions among the particles. Each collision is generated only once.

Parameters
particleslist of particles

Definition at line 393 of file G4INCLStandardPropagationModel.cc.

References generateBinaryCollisionAvatar(), and registerAvatar().

Referenced by generateAllAvatars().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4INCL::StandardPropagationModel::generateCollisions ( const ParticleList &  particles,
const ParticleList &  except 
)

Generate and register collisions among particles in a list, except between those in another list.

This method generates all possible collisions among the particles. Each collision is generated only once. The collision is NOT generated if BOTH collision partners belong to the except list.

You should pass an empty list as the except parameter if you want to generate all possible collisions among particles.

Parameters
particleslist of particles
exceptlist of excluded particles

Definition at line 403 of file G4INCLStandardPropagationModel.cc.

References generateBinaryCollisionAvatar(), and registerAvatar().

+ Here is the call graph for this function:

void G4INCL::StandardPropagationModel::generateDecays ( const ParticleList &  particles)

Generate decays for particles that can decay.

The list of particles given as an argument is allowed to contain also stable particles.

Parameters
particleslist of particles to (possibly) generate decays for

Definition at line 458 of file G4INCLStandardPropagationModel.cc.

References G4INCL::DeltaDecayChannel::computeDecayTime(), currentTime, maximumTime, registerAvatar(), and theNucleus.

Referenced by generateAllAvatars(), and propagate().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4INCL::StandardPropagationModel::generateUpdatedCollisions ( const ParticleList &  updatedParticles,
const ParticleList &  particles 
)

Generate and register collisions between a list of updated particles and all the other particles.

This method does not generate collisions among the particles in updatedParticles; in other words, it generates a collision between one of the updatedParticles and one of the particles ONLY IF the latter does not belong to updatedParticles.

If you intend to generate all possible collisions among particles in a list, use generateCollisions().

Parameters
updatedParticleslist of updated particles
particleslist of particles

Definition at line 374 of file G4INCLStandardPropagationModel.cc.

References generateBinaryCollisionAvatar(), and registerAvatar().

Referenced by updateAvatars().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4double G4INCL::StandardPropagationModel::getCurrentTime ( )
virtual

Returns the current global time of the system.

Implements G4INCL::IPropagationModel.

Definition at line 247 of file G4INCLStandardPropagationModel.cc.

References currentTime.

G4INCL::Nucleus * G4INCL::StandardPropagationModel::getNucleus ( )
virtual

Get the nucleus.

Implements G4INCL::IPropagationModel.

Definition at line 74 of file G4INCLStandardPropagationModel.cc.

References theNucleus.

G4double G4INCL::StandardPropagationModel::getReflectionTime ( G4INCL::Particle const *const  aParticle)

Get the reflection time.

Returns the reflection time of a particle on the potential wall.

Parameters
aParticlepointer to the particle

Definition at line 337 of file G4INCLStandardPropagationModel.cc.

References currentTime, G4INCL::Intersection::exists, G4INCL::IntersectionFactory::getLaterTrajectoryIntersection(), G4INCL::Particle::getPosition(), G4INCL::Particle::getPropagationVelocity(), G4INCL::Nucleus::getSurfaceRadius(), INCL_ERROR, G4INCL::Particle::print(), theNucleus, and G4INCL::Intersection::time.

Referenced by generateAllAvatars(), and updateAvatars().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4double G4INCL::StandardPropagationModel::getStoppingTime ( )
virtual

Get the current stopping time.

Implements G4INCL::IPropagationModel.

Definition at line 238 of file G4INCLStandardPropagationModel.cc.

References maximumTime.

G4double G4INCL::StandardPropagationModel::getTime ( G4INCL::Particle const *const  particleA,
G4INCL::Particle const *const  particleB,
G4double *  minDistOfApproach 
) const

Get the predicted time of the collision between two particles.

Definition at line 354 of file G4INCLStandardPropagationModel.cc.

References currentTime, G4INCL::ThreeVector::dot(), G4INCL::Particle::getPosition(), G4INCL::Particle::getPropagationVelocity(), and G4INCL::ThreeVector::mag2().

Referenced by generateBinaryCollisionAvatar().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4INCL::IAvatar * G4INCL::StandardPropagationModel::propagate ( )
virtual

Propagate all particles and return the first avatar.

Implements G4INCL::IPropagationModel.

Definition at line 470 of file G4INCLStandardPropagationModel.cc.

References G4INCL::Store::clearAvatars(), currentTime, G4INCL::Store::findSmallestTime(), generateDecays(), G4INCL::Nucleus::getBlockedDelta(), G4INCL::Store::getBook(), G4INCL::Nucleus::getCreatedParticles(), G4INCL::Nucleus::getStore(), G4INCL::IAvatar::getTime(), G4INCL::Nucleus::getUpdatedParticles(), INCL_ERROR, G4INCL::Store::initialiseParticleAvatarConnections(), G4INCL::Book::setCurrentTime(), theNucleus, G4INCL::Store::timeStep(), and updateAvatars().

+ Here is the call graph for this function:

void G4INCL::StandardPropagationModel::putSpectatorsOnShell ( IAvatarList const &  entryAvatars,
ParticleList const &  spectators 
)
private

Put spectators on shell by extracting energy from the participants.

Definition at line 515 of file G4INCLStandardPropagationModel.cc.

References a, G4INCL::KinematicsUtils::energy(), G4INCL::Particle::getEnergy(), G4INCL::ParticleTable::getINCLMass(), G4INCL::Particle::getMomentum(), G4INCL::Particle::getParticles(), G4INCL::ParticleTable::getTableParticleMass, G4INCL::Particle::getType(), G4INCL::ThreeVector::mag2(), G4INCL::Particle::setEnergy(), and G4INCL::Particle::setMass().

+ Here is the call graph for this function:

void G4INCL::StandardPropagationModel::registerAvatar ( G4INCL::IAvatar *  anAvatar)

Add an avatar to the storage.

Definition at line 256 of file G4INCLStandardPropagationModel.cc.

References G4INCL::Store::add(), G4INCL::Nucleus::getStore(), and theNucleus.

Referenced by generateAllAvatars(), generateCollisions(), generateDecays(), generateUpdatedCollisions(), and updateAvatars().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4INCL::StandardPropagationModel::setNucleus ( G4INCL::Nucleus *  nucleus)
virtual

Set the nucleus for this propagation model.

Implements G4INCL::IPropagationModel.

Definition at line 251 of file G4INCLStandardPropagationModel.cc.

References theNucleus.

void G4INCL::StandardPropagationModel::setStoppingTime ( G4double  time)
virtual

Set the stopping time of the simulation.

Implements G4INCL::IPropagationModel.

Definition at line 242 of file G4INCLStandardPropagationModel.cc.

References maximumTime.

G4double G4INCL::StandardPropagationModel::shoot ( ParticleSpecies const  projectileSpecies,
const G4double  kineticEnergy,
const G4double  impactParameter,
const G4double  phi 
)
virtual

Implements G4INCL::IPropagationModel.

Definition at line 79 of file G4INCLStandardPropagationModel.cc.

References G4INCL::Composite, shootComposite(), shootParticle(), and G4INCL::ParticleSpecies::theType.

+ Here is the call graph for this function:

G4double G4INCL::StandardPropagationModel::shootComposite ( ParticleSpecies const  s,
const G4double  kineticEnergy,
const G4double  impactParameter,
const G4double  phi 
)
virtual

Implements G4INCL::IPropagationModel.

Definition at line 160 of file G4INCLStandardPropagationModel.cc.

References G4INCL::Store::addParticleEntryAvatars(), G4INCL::Particle::boostVector(), G4INCL::CoulombDistortion::bringToSurface(), currentTime, firstAvatar, generateAllAvatars(), G4INCL::Particle::getA(), G4INCL::Cluster::getAngularMomentum(), G4INCL::Particle::getEnergy(), G4INCL::ParticleTable::getLargestNuclearRadius(), G4INCL::Particle::getMomentum(), G4INCL::Nucleus::getStore(), G4INCL::ParticleTable::getTableMass, G4INCL::Particle::getTransversePosition(), G4INCL::Nucleus::getUniverseRadius(), G4INCL::Particle::getZ(), INCL_DEBUG, G4INCL::ThreeVector::mag(), G4INCL::CoulombDistortion::maxImpactParameter(), maximumTime, position, G4INCL::Nucleus::setIncomingAngularMomentum(), G4INCL::Nucleus::setIncomingMomentum(), G4INCL::Nucleus::setInitialEnergy(), G4INCL::Nucleus::setNucleusNucleusCollision(), G4INCL::Cluster::setPosition(), G4INCL::Nucleus::setProjectileChargeNumber(), G4INCL::Nucleus::setProjectileMassNumber(), G4INCL::Nucleus::setProjectileRemnant(), G4INCL::ProjectileRemnant::storeComponents(), and theNucleus.

Referenced by shoot().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

G4double G4INCL::StandardPropagationModel::shootParticle ( ParticleType const  t,
const G4double  kineticEnergy,
const G4double  impactParameter,
const G4double  phi 
)
virtual

Implements G4INCL::IPropagationModel.

Definition at line 86 of file G4INCLStandardPropagationModel.cc.

References G4INCL::Store::addParticleEntryAvatar(), G4INCL::Particle::adjustMomentumFromEnergy(), G4INCL::Particle::boostVector(), G4INCL::CoulombDistortion::bringToSurface(), currentTime, G4INCL::KinematicsUtils::energy(), firstAvatar, generateAllAvatars(), G4INCL::Particle::getA(), G4INCL::Particle::getAngularMomentum(), G4INCL::Particle::getEnergy(), G4INCL::Particle::getMass(), G4INCL::Particle::getMomentum(), G4INCL::Particle::getSpecies(), G4INCL::Nucleus::getStore(), G4INCL::ParticleTable::getTableMass, G4INCL::ParticleTable::getTableParticleMass, G4INCL::Particle::getTransversePosition(), G4INCL::Nucleus::getUniverseRadius(), G4INCL::Particle::getZ(), INCL_DEBUG, G4INCL::Particle::isNucleon(), G4INCL::ThreeVector::mag(), G4INCL::Particle::makeProjectileSpectator(), G4INCL::CoulombDistortion::maxImpactParameter(), maximumTime, position, G4INCL::Particle::setEnergy(), G4INCL::Particle::setINCLMass(), G4INCL::Nucleus::setIncomingAngularMomentum(), G4INCL::Nucleus::setIncomingMomentum(), G4INCL::Nucleus::setInitialEnergy(), G4INCL::Nucleus::setParticleNucleusCollision(), G4INCL::Particle::setPosition(), G4INCL::Nucleus::setProjectileChargeNumber(), G4INCL::Nucleus::setProjectileMassNumber(), and theNucleus.

Referenced by shoot().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void G4INCL::StandardPropagationModel::updateAvatars ( const ParticleList &  particles)

Update all avatars related to a particle.

Definition at line 423 of file G4INCLStandardPropagationModel.cc.

References generateUpdatedCollisions(), G4INCL::Store::getParticles(), getReflectionTime(), G4INCL::Nucleus::getStore(), maximumTime, registerAvatar(), and theNucleus.

Referenced by propagate().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

Particle G4INCL::StandardPropagationModel::backupParticle1
private

Definition at line 198 of file G4INCLStandardPropagationModel.hh.

Referenced by generateBinaryCollisionAvatar().

Particle G4INCL::StandardPropagationModel::backupParticle2
private

Definition at line 198 of file G4INCLStandardPropagationModel.hh.

Referenced by generateBinaryCollisionAvatar().

G4double G4INCL::StandardPropagationModel::currentTime
private

Definition at line 195 of file G4INCLStandardPropagationModel.hh.

Referenced by generateBinaryCollisionAvatar(), generateDecays(), getCurrentTime(), getReflectionTime(), getTime(), propagate(), shootComposite(), and shootParticle().

G4bool G4INCL::StandardPropagationModel::firstAvatar
private

Definition at line 196 of file G4INCLStandardPropagationModel.hh.

Referenced by shootComposite(), and shootParticle().

G4double G4INCL::StandardPropagationModel::maximumTime
private

Definition at line 194 of file G4INCLStandardPropagationModel.hh.

Referenced by generateAllAvatars(), generateBinaryCollisionAvatar(), generateDecays(), getStoppingTime(), setStoppingTime(), shootComposite(), shootParticle(), and updateAvatars().

LocalEnergyType G4INCL::StandardPropagationModel::theLocalEnergyDeltaType
private

Definition at line 197 of file G4INCLStandardPropagationModel.hh.

Referenced by generateBinaryCollisionAvatar().

LocalEnergyType G4INCL::StandardPropagationModel::theLocalEnergyType
private

Definition at line 197 of file G4INCLStandardPropagationModel.hh.

Referenced by generateBinaryCollisionAvatar().

G4INCL::Nucleus* G4INCL::StandardPropagationModel::theNucleus
private

Definition at line 193 of file G4INCLStandardPropagationModel.hh.

Referenced by generateAllAvatars(), generateBinaryCollisionAvatar(), generateDecays(), getNucleus(), getReflectionTime(), propagate(), registerAvatar(), setNucleus(), shootComposite(), shootParticle(), updateAvatars(), and ~StandardPropagationModel().

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