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. More...
void	addParticleEntryAvatar (IAvatar *a)
	Add one ParticleEntry avatar. More...
void	addParticleEntryAvatars (IAvatarList const &al)
	Add one ParticleEntry avatar. More...
void	add (IAvatar *a)
IAvatarList const &	getAvatars () const
void	addIncomingParticle (Particle *const p)
void	removeFromIncoming (Particle *const p)
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 ()
void	timeStep (G4double step)
void	particleHasBeenEjected (Particle *const)
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)
void	particleHasEntered (Particle *const particle)
	Move a particle from incoming to inside. More...
ParticleList const &	getIncomingParticles () const
ParticleList const &	getOutgoingParticles () const
ParticleList	extractDynamicalSpectators ()
	Returns a list of dynamical spectators. More...
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. More...

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

G4INCL::Store::Store

(

Config const *const

config

)

Store constructor

Definition at line 45 of file G4INCLStore.cc.

                                          :
    loadedA(0),
    loadedZ(0),
    loadedStoppingTime(0.),
    theConfig(config)
  {
  }

G4INCL::Store::~Store

(

)

Store destructor

Definition at line 53 of file G4INCLStore.cc.

                {
    theBook.reset();
    clear();
  }

Here is the call graph for this function:

Member Function Documentation

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.

                             {
    inside.push_back(p);
  }

Here is the caller graph for this function:

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.

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

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.

                            {
    // Add the avatar to the avatar map
    avatarList.push_back(a);

    ParticleList pList = a->getParticles();
    for(ParticleIter i=pList.begin(), e=pList.end(); i!=e; ++i) {
      // Connect each particle to the avatar
      connectAvatarToParticle(a, *i);
    }

  }

Here is the call graph for this function:

void G4INCL::Store::addIncomingParticle

(

Particle *const

p

)

Add a particle to the incoming list.

Parameters

p	particle to add

Definition at line 95 of file G4INCLStore.cc.

                                                    {
    incoming.push_back(p);
  }

Here is the caller graph for this function:

void G4INCL::Store::addParticleEntryAvatar

(

IAvatar *

a

)

Add one ParticleEntry avatar.

Definition at line 66 of file G4INCLStore.cc.

                                               {
    // Add the avatar to the avatar map
    avatarList.push_back(a);

    ParticleList pList = a->getParticles();
    for(ParticleIter i=pList.begin(), e=pList.end(); i!=e; ++i) {
      addIncomingParticle((*i));
      // Connect each particle to the avatar
      connectAvatarToParticle(a, *i);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Store::addParticleEntryAvatars

(

IAvatarList const &

al

)

Add one ParticleEntry avatar.

Definition at line 78 of file G4INCLStore.cc.

                                                           {
    for(IAvatarIter a=al.begin(), e=al.end(); a!=e; ++a)
      addParticleEntryAvatar(*a);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

add the particle to the outgoing particle list.

Parameters

p	pointer to the particle to be added

Definition at line 190 of file G4INCLStore.hh.

{ outgoing.push_back(p); }

Here is the caller graph for this function:

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

inline

Add a list of particles to the outgoing particle list.

Parameters

pl	list of particles to be added

Definition at line 196 of file G4INCLStore.hh.

                                               {
      for(ParticleIter p=pl.begin(), e=pl.end(); p!=e; ++p)
        addToOutgoing(*p);
    }

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

lhs	pointer to the first avatar
rhs	pointer to the second avatar

Returns

true iff lhs' time is smaller than rhs'.

Definition at line 352 of file G4INCLStore.hh.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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.

                    {
    clearAvatars();

    clearInside();
    clearOutgoing();

    if( incoming.size() != 0 ) {
      INCL_WARN("Incoming list is not empty when Store::clear() is called" << '\n');
    }
    incoming.clear();

  }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Store::clearAvatars

(

)

Clear avatars only.

Definition at line 193 of file G4INCLStore.cc.

                           {
    for(IAvatarIter iter = avatarList.begin(), e = avatarList.end(); iter != e; ++iter) {
      delete *iter;
    }

    particleAvatarConnections.clear();
    avatarList.clear();
    avatarsToBeRemoved.clear();
  }

Here is the caller graph for this function:

void G4INCL::Store::clearIncoming ( )

inline

Clear the incoming list.

Definition at line 145 of file G4INCLStore.hh.

                                {
      incoming.clear();
    }

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.

                          {
    for(ParticleIter iter=inside.begin(), e=inside.end(); iter!=e; ++iter) {
      delete *iter;
    }
    inside.clear();
  }

Here is the caller graph for this function:

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.

                            {
    for(ParticleIter iter=outgoing.begin(), e=outgoing.end(); iter!=e; ++iter) {
      if((*iter)->isCluster()) {
        Cluster *c = dynamic_cast<Cluster *>(*iter);
// assert(c);
#ifdef INCLXX_IN_GEANT4_MODE
        if(!c)
          continue;
#endif
        c->deleteParticles();
      }
      delete (*iter);
    }
    outgoing.clear();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

G4bool G4INCL::Store::containsCollisions

(

)

const

Definition at line 351 of file G4INCLStore.cc.

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

G4int G4INCL::Store::countCascading ( )

inline

Definition at line 261 of file G4INCLStore.hh.

                           {
      G4int n=0;
      for(ParticleIter i=inside.begin(), e=inside.end(); i!=e; ++i) {
        if(!(*i)->isTargetSpectator())
          ++n;
      }
      return n;
    }

void G4INCL::Store::deleteIncoming ( )

inline

Clear the incoming list and delete the particles.

Definition at line 150 of file G4INCLStore.hh.

                                 {
      for(ParticleIter iter=incoming.begin(), e=incoming.end(); iter!=e; ++iter) {
        delete (*iter);
      }
      clearIncoming();
    }

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.

                                              {
      ParticleList spectators;
      for(ParticleIter p=outgoing.begin(), e=outgoing.end(); p!=e; ++p) {
        if((*p)->isProjectileSpectator()) {
// assert((*p)->isNucleon());
          spectators.push_back(*p); // add them to the list we will return
        }
      }

      // Now erase them from outgoing
      for(ParticleIter i=spectators.begin(); i!=spectators.end(); ++i) {
        outgoing.remove(*i);
      }

      return spectators;
    }

Here is the call graph for this function:

IAvatar * G4INCL::Store::findSmallestTime

(

)

Find the avatar that has the smallest time.

Definition at line 142 of file G4INCLStore.cc.

                                   {
    if(avatarList.empty()) return NULL;

#ifdef INCL_AVATAR_SEARCH_FullSort

    /* Full sort algorithm.
     *
     * Simple, but guaranteed to work.
     */
    avatarList.sort(Store::avatarComparisonPredicate);
    IAvatar *avatar = avatarList.front();

#elif defined(INCL_AVATAR_SEARCH_MinElement)

    /* Algorithm provided by the C++ stdlib. */
    IAvatar *avatar = *(std::min_element(avatarList.begin(), avatarList.end(),
          Store::avatarComparisonPredicate));

#else
#error Unrecognized INCL_AVATAR_SEARCH. Allowed values are: FullSort, MinElement.
#endif

    removeAvatar(avatar);
    return avatar;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Return the list of avatars

Definition at line 126 of file G4INCLStore.hh.

                                          {
      return avatarList;
    }

Book& G4INCL::Store::getBook ( )

inline

Return the pointer to the Book object which keeps track of various counters.

Definition at line 259 of file G4INCLStore.hh.

{ return theBook; };

Here is the caller graph for this function:

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

inline

Get the config object

Definition at line 273 of file G4INCLStore.hh.

{ return theConfig; };

Here is the caller graph for this function:

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.

{ return incoming; }

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.

{ return loadedA; };

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.

{ return loadedStoppingTime; };

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.

{ return loadedZ; };

ParticleList const& G4INCL::Store::getOutgoingParticles ( ) const

inline

Return the list of outgoing particles (i.e. particles that have left the cascade).

Definition at line 223 of file G4INCLStore.hh.

{ return outgoing; }

Here is the caller graph for this function:

ParticleList const& G4INCL::Store::getParticles ( ) const

inline

Return the list of "active" particles (i.e. particles that can participate in collisions).

Definition at line 253 of file G4INCLStore.hh.

{ return inside; }

Here is the caller graph for this function:

void G4INCL::Store::loadParticles

(

std::string const &

filename

)

Load particle configuration from ASCII file (see avatarPredictionTest).

Definition at line 239 of file G4INCLStore.cc.

                                                     {
    clear();
    G4int projectileA, projectileZ, A, Z;
    G4double stoppingTime, cutNN;
    G4int ID, type, isParticipant;
    G4double x, y, z;
    G4double px, py, pz, E, v;

    std::ifstream in(filename.c_str());
    in >> projectileA >> projectileZ >> A >> Z >> stoppingTime >> cutNN;
    loadedA = A;
    loadedZ = Z;
    loadedStoppingTime = stoppingTime;

    G4int readA = 0;
    G4int readZ = 0;
    while(1) { /* Loop checking, 10.07.2015, D.Mancusi */
      in >> ID >> type >> isParticipant >> x >> y >> z >> px >> py >> pz >> E >> v;
      if(!in.good()) break;
      ParticleType t;
      if(type == 1) {
    t = Proton;
    readZ++;
    readA++;
      }
      else if(type == -1) {
    t = Neutron;
    readA++;
      }
      else {
        INCL_FATAL("Unrecognized particle type while loading particles; type=" << type << '\n');
        t = UnknownParticle;
      }

      Particle *p = new Particle(t, E, ThreeVector(px, py, pz),
                 ThreeVector(x, y, z));
      p->setPotentialEnergy(v);
      if(isParticipant == 1) {
        p->makeParticipant();
        theBook.incrementCascading();
      }
      add(p);
    }

    in.close();
  }

Here is the call graph for this function:

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.

                                                         {
    particleHasBeenUpdated(p);
    // Have to destroy the particle here, the Store will forget about it
    inside.remove(p);
    delete p;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

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.

                                                       {
    particleHasBeenUpdated(p);
    // The particle will be destroyed when destroying the Store
    inside.remove(p);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

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.

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

Here is the caller graph for this function:

void G4INCL::Store::particleHasEntered

(

Particle *const

particle

)

Move a particle from incoming to inside.

Parameters

particle

pointer to a particle

Definition at line 188 of file G4INCLStore.cc.

                                                          {
    removeFromIncoming(particle);
    add(particle);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

std::string G4INCL::Store::printAvatars

(

)

Print the list of avatars

Definition at line 343 of file G4INCLStore.cc.

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

std::string G4INCL::Store::printParticleConfiguration

(

)

Print the nucleon configuration of the nucleus.

Definition at line 286 of file G4INCLStore.cc.

                                              {
    std::stringstream ss;
    G4int A = 0, Z = 0;
    for(ParticleIter i=inside.begin(), e=inside.end(); i!=e; ++i) {
      if((*i)->getType() == Proton) {
    A++;
    Z++;
      }
      if((*i)->getType() == Neutron) {
    A++;
      }
    }
    // Note: Projectile A and Z are set to 0 (we don't really know
    // anything about them at this point).
    ss << "0 0 " << A << " " << Z << " "
          << "100.0" << " "
          << "0.0" << '\n';

    for(ParticleIter i=inside.begin(), e=inside.end(); i!=e; ++i) {
      G4int ID = (*i)->getID();
      G4int type = 0;
      if((*i)->getType() == Proton) {
    type = 1;
      }
      if((*i)->getType() == Neutron) {
    type = -1;
      }

      G4int isParticipant = 0;
      if((*i)->isParticipant()) {
    isParticipant = 1;
      }

      G4double x = (*i)->getPosition().getX();
      G4double y = (*i)->getPosition().getY();
      G4double z = (*i)->getPosition().getZ();
      G4double E = (*i)->getEnergy();
      G4double px = (*i)->getMomentum().getX();
      G4double py = (*i)->getMomentum().getY();
      G4double pz = (*i)->getMomentum().getZ();
      G4double V = (*i)->getPotentialEnergy();

      ss << ID << " " << type << " " << isParticipant << " "
        << x << " " << y << " " << z << " "
        << px << " " << py << " " << pz << " "
     << E << " " << V << '\n';
    }

    return ss.str();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Add a particle to the incoming list.

Parameters

p	particle to add

Definition at line 142 of file G4INCLStore.hh.

{ incoming.remove(p); }

Here is the caller graph for this function:

void G4INCL::Store::removeScheduledAvatars

(

)

Remove avatars that have been scheduled.

Definition at line 134 of file G4INCLStore.cc.

                                     {
    for(ASIter a=avatarsToBeRemoved.begin(), e=avatarsToBeRemoved.end(); a!=e; ++a) {
      removeAvatar(*a);
      delete *a;
    }
    avatarsToBeRemoved.clear();
  }

Here is the caller graph for this function:

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.

                                    {
    for(ParticleIter particleIter = inside.begin(), particleEnd=inside.end();
    particleIter != particleEnd; ++particleIter) {
      (*particleIter)->propagate(step);
    }
  }

Here is the caller graph for this function:

void G4INCL::Store::writeParticles

(

std::string const &

filename

)

Print the nucleon configuration of the nucleus.

Definition at line 337 of file G4INCLStore.cc.

                                                      {
    std::ofstream out(filename.c_str());
    out << printParticleConfiguration();
    out.close();
  }

Here is the call graph for this function:

---

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

• source/geant4.10.03.p03/source/processes/hadronic/models/inclxx/incl_physics/include/G4INCLStore.hh
• source/geant4.10.03.p03/source/processes/hadronic/models/inclxx/incl_physics/src/G4INCLStore.cc