#include <G4INCLProjectileRemnant.hh>

Inheritance diagram for G4INCL::ProjectileRemnant:

Collaboration diagram for G4INCL::ProjectileRemnant:

Public Types
typedef std::vector< G4double >	EnergyLevels

typedef std::map< long, G4double >	EnergyLevelMap

Public Member Functions
	ProjectileRemnant (ParticleSpecies const &species, const G4double kineticEnergy)

	~ProjectileRemnant ()

void	reset ()
	Reset the projectile remnant to the state at the beginning of the cascade. More...

void	removeParticle (Particle *const p, const G4double theProjectileCorrection)
	Remove a nucleon from the projectile remnant. More...

ParticleList	addDynamicalSpectators (ParticleList pL)
	Add back dynamical spectators to the projectile remnant. More...

ParticleList	addMostDynamicalSpectators (ParticleList pL)
	Add back dynamical spectators to the projectile remnant. More...

ParticleList	addAllDynamicalSpectators (ParticleList const &pL)
	Add back all dynamical spectators to the projectile remnant. More...

void	deleteStoredComponents ()
	Clear the stored projectile components and delete the particles. More...

void	clearStoredComponents ()
	Clear the stored projectile components. More...

void	clearEnergyLevels ()
	Clear the stored energy levels. More...

G4double	computeExcitationEnergyExcept (const long exceptID) const
	Compute the excitation energy when a nucleon is removed. More...

G4double	computeExcitationEnergyWith (const ParticleList &pL) const
	Compute the excitation energy if some nucleons are put back. More...

void	storeComponents ()
	Store the projectile components. More...

G4int	getNumberStoredComponents () const
	Get the number of the stored components. More...

void	storeEnergyLevels ()
	Store the energy levels. More...

EnergyLevels const &	getGroundStateEnergies () const

Public Member Functions inherited from G4INCL::Cluster
	Cluster (const G4int Z, const G4int A, const G4bool createParticleSampler=true)
	Standard Cluster constructor. More...

template<class Iterator >
	Cluster (Iterator begin, Iterator end)

virtual	~Cluster ()

	Cluster (const Cluster &rhs)
	Copy constructor. More...

Cluster &	operator= (const Cluster &rhs)
	Assignment operator. More...

void	swap (Cluster &rhs)
	Helper method for the assignment operator. More...

ParticleSpecies	getSpecies () const

void	deleteParticles ()

void	clearParticles ()

void	setZ (const G4int Z)
	Set the charge number of the cluster. More...

void	setA (const G4int A)
	Set the mass number of the cluster. More...

G4double	getExcitationEnergy () const
	Get the excitation energy of the cluster. More...

void	setExcitationEnergy (const G4double e)
	Set the excitation energy of the cluster. More...

virtual G4double	getTableMass () const
	Get the real particle mass. More...

ParticleList const &	getParticles () const

void	removeParticle (Particle *const p)
	Remove a particle from the cluster components. More...

void	addParticle (Particle *const p)

void	updateClusterParameters ()
	Set total cluster mass, energy, size, etc. from the particles. More...

void	addParticles (ParticleList const &pL)
	Add a list of particles to the cluster. More...

ParticleList	getParticleList () const
	Returns the list of particles that make up the cluster. More...

std::string	print () const

virtual void	initializeParticles ()
	Initialise the NuclearDensity pointer and sample the particles. More...

void	internalBoostToCM ()
	Boost to the CM of the component particles. More...

void	putParticlesOffShell ()
	Put the cluster components off shell. More...

void	setPosition (const ThreeVector &position)
	Set the position of the cluster. More...

void	boost (const ThreeVector &aBoostVector)
	Boost the cluster with the indicated velocity. More...

void	freezeInternalMotion ()
	Freeze the internal motion of the particles. More...

virtual void	rotatePosition (const G4double angle, const ThreeVector &axis)
	Rotate position of all the particles. More...

virtual void	rotateMomentum (const G4double angle, const ThreeVector &axis)
	Rotate momentum of all the particles. More...

virtual void	makeProjectileSpectator ()
	Make all the components projectile spectators, too. More...

virtual void	makeTargetSpectator ()
	Make all the components target spectators, too. More...

virtual void	makeParticipant ()
	Make all the components participants, too. More...

ThreeVector const &	getSpin () const
	Get the spin of the nucleus. More...

void	setSpin (const ThreeVector &j)
	Set the spin of the nucleus. More...

G4INCL::ThreeVector	getAngularMomentum () const
	Get the total angular momentum (orbital + spin) More...

Public Member Functions inherited from G4INCL::Particle
	Particle ()

	Particle (ParticleType t, G4double energy, ThreeVector const &momentum, ThreeVector const &position)

	Particle (ParticleType t, ThreeVector const &momentum, ThreeVector const &position)

virtual	~Particle ()

	Particle (const Particle &rhs)
	Copy constructor. More...

Particle &	operator= (const Particle &rhs)
	Assignment operator. More...

G4INCL::ParticleType	getType () const

void	setType (ParticleType t)

G4bool	isNucleon () const

ParticipantType	getParticipantType () const

void	setParticipantType (ParticipantType const p)

G4bool	isParticipant () const

G4bool	isTargetSpectator () const

G4bool	isProjectileSpectator () const

G4bool	isPion () const
	Is this a pion? More...

G4bool	isResonance () const
	Is it a resonance? More...

G4bool	isDelta () const
	Is it a Delta? More...

G4int	getA () const
	Returns the baryon number. More...

G4int	getZ () const
	Returns the charge number. More...

G4double	getBeta () const

ThreeVector	boostVector () const

void	boost (const ThreeVector &aBoostVector)

void	lorentzContract (const ThreeVector &aBoostVector, const ThreeVector &refPos)
	Lorentz-contract the particle position around some center. More...

G4double	getMass () const
	Get the cached particle mass. More...

G4double	getINCLMass () const
	Get the INCL particle mass. More...

G4double	getRealMass () const
	Get the real particle mass. More...

void	setRealMass ()
	Set the mass of the Particle to its real mass. More...

void	setTableMass ()
	Set the mass of the Particle to its table mass. More...

void	setINCLMass ()
	Set the mass of the Particle to its table mass. More...

G4double	getEmissionQValueCorrection (const G4int AParent, const G4int ZParent) const
	Computes correction on the emission Q-value. More...

G4double	getTransferQValueCorrection (const G4int AFrom, const G4int ZFrom, const G4int ATo, const G4int ZTo) const
	Computes correction on the transfer Q-value. More...

G4double	getInvariantMass () const
	Get the the particle invariant mass. More...

G4double	getKineticEnergy () const
	Get the particle kinetic energy. More...

G4double	getPotentialEnergy () const
	Get the particle potential energy. More...

void	setPotentialEnergy (G4double v)
	Set the particle potential energy. More...

G4double	getEnergy () const

void	setMass (G4double mass)

void	setEnergy (G4double energy)

const G4INCL::ThreeVector &	getMomentum () const

virtual void	setMomentum (const G4INCL::ThreeVector &momentum)

const G4INCL::ThreeVector &	getPosition () const

G4double	getHelicity ()

void	setHelicity (G4double h)

void	propagate (G4double step)

G4int	getNumberOfCollisions () const
	Return the number of collisions undergone by the particle. More...

void	setNumberOfCollisions (G4int n)
	Set the number of collisions undergone by the particle. More...

void	incrementNumberOfCollisions ()
	Increment the number of collisions undergone by the particle. More...

G4int	getNumberOfDecays () const
	Return the number of decays undergone by the particle. More...

void	setNumberOfDecays (G4int n)
	Set the number of decays undergone by the particle. More...

void	incrementNumberOfDecays ()
	Increment the number of decays undergone by the particle. More...

void	setOutOfWell ()
	Mark the particle as out of its potential well. More...

G4bool	isOutOfWell () const
	Check if the particle is out of its potential well. More...

void	setEmissionTime (G4double t)

G4double	getEmissionTime ()

ThreeVector	getTransversePosition () const
	Transverse component of the position w.r.t. the momentum. More...

ThreeVector	getLongitudinalPosition () const
	Longitudinal component of the position w.r.t. the momentum. More...

const ThreeVector &	adjustMomentumFromEnergy ()
	Rescale the momentum to match the total energy. More...

G4double	adjustEnergyFromMomentum ()
	Recompute the energy to match the momentum. More...

G4bool	isCluster () const

void	setFrozenMomentum (const ThreeVector &momentum)
	Set the frozen particle momentum. More...

void	setFrozenEnergy (const G4double energy)
	Set the frozen particle momentum. More...

ThreeVector	getFrozenMomentum () const
	Get the frozen particle momentum. More...

G4double	getFrozenEnergy () const
	Get the frozen particle momentum. More...

ThreeVector	getPropagationVelocity () const
	Get the propagation velocity of the particle. More...

void	freezePropagation ()
	Freeze particle propagation. More...

void	thawPropagation ()
	Unfreeze particle propagation. More...

virtual void	rotatePositionAndMomentum (const G4double angle, const ThreeVector &axis)
	Rotate the particle position and momentum. More...

std::string	print () const

std::string	dump () const

long	getID () const

ParticleList const *	getParticles () const

G4double	getReflectionMomentum () const
	Return the reflection momentum. More...

void	setUncorrelatedMomentum (const G4double p)
	Set the uncorrelated momentum. More...

void	rpCorrelate ()
	Make the particle follow a strict r-p correlation. More...

void	rpDecorrelate ()
	Make the particle not follow a strict r-p correlation. More...

G4double	getCosRPAngle () const
	Get the cosine of the angle between position and momentum. More...

Private Member Functions
G4double	computeExcitationEnergy (const EnergyLevels &levels) const
	Compute the excitation energy for a given configuration. More...

EnergyLevels	getPresentEnergyLevelsExcept (const long exceptID) const

EnergyLevels	getPresentEnergyLevelsWith (const ParticleList &pL) const

ParticleList	shuffleStoredComponents ()
	Shuffle the list of stored projectile components. More...

ParticleList	getStoredComponents () const

ThreeVector const &	getStoredMomentum (Particle const *const p) const
	Return the stored momentum of a given projectile component. More...

G4bool	addDynamicalSpectator (Particle *const p)
	Add back a nucleon to the projectile remnant. More...

	INCL_DECLARE_ALLOCATION_POOL (ProjectileRemnant)

Private Attributes
std::map< long, Particle * >	storedComponents
	Return the stored energy of a given projectile component. More...

EnergyLevelMap	theInitialEnergyLevels
	Initial energy levels of the projectile. More...

EnergyLevels	theGroundStateEnergies
	Ground-state energies for any number of nucleons. More...

Additional Inherited Members
Protected Member Functions inherited from G4INCL::Cluster
	INCL_DECLARE_ALLOCATION_POOL (Cluster)

Protected Member Functions inherited from G4INCL::Particle
void	swap (Particle &rhs)
	Helper method for the assignment operator. More...

Protected Attributes inherited from G4INCL::Cluster
ParticleList	particles

G4double	theExcitationEnergy

ThreeVector	theSpin

ParticleSampler *	theParticleSampler

Protected Attributes inherited from G4INCL::Particle
G4int	theZ

G4int	theA

ParticipantType	theParticipantType

G4INCL::ParticleType	theType

G4double	theEnergy

G4double *	thePropagationEnergy

G4double	theFrozenEnergy

G4INCL::ThreeVector	theMomentum

G4INCL::ThreeVector *	thePropagationMomentum

G4INCL::ThreeVector	theFrozenMomentum

G4INCL::ThreeVector	thePosition

G4int	nCollisions

G4int	nDecays

G4double	thePotentialEnergy

long	ID

G4bool	rpCorrelated

G4double	uncorrelatedMomentum

Detailed Description

Definition at line 58 of file G4INCLProjectileRemnant.hh.

Member Typedef Documentation

◆ EnergyLevelMap

typedef std::map<long, G4double> G4INCL::ProjectileRemnant::EnergyLevelMap

Definition at line 63 of file G4INCLProjectileRemnant.hh.

◆ EnergyLevels

typedef std::vector<G4double> G4INCL::ProjectileRemnant::EnergyLevels

Definition at line 62 of file G4INCLProjectileRemnant.hh.

Constructor & Destructor Documentation

◆ ProjectileRemnant()

G4INCL::ProjectileRemnant::ProjectileRemnant	(	ParticleSpecies const &	species,
		const G4double	kineticEnergy
	)

inline

Definition at line 65 of file G4INCLProjectileRemnant.hh.

       : Cluster(species.theZ, species.theA) {
 
       // Use the table mass
       setTableMass();
 
       // Set the kinematics
       const G4double projectileMass = getMass();
       const G4double energy = kineticEnergy + projectileMass;
       const G4double momentumZ = std::sqrt(energy*energy - projectileMass*projectileMass);
 
       // Initialise the particles
       initializeParticles();
       internalBoostToCM();
       putParticlesOffShell();
 
       // Store the energy levels of the ProjectileRemnant (used to compute its
       // excitation energy)
       storeEnergyLevels();
 
       // Boost the whole thing
       const ThreeVector aBoostVector = ThreeVector(0.0, 0.0, momentumZ / energy);
       boost(-aBoostVector);
 
       // Freeze the internal motion of the particles
       freezeInternalMotion();
 
       // Set as projectile spectator
       makeProjectileSpectator();
     }

Here is the call graph for this function:

◆ ~ProjectileRemnant()

G4INCL::ProjectileRemnant::~ProjectileRemnant ( )

inline

Definition at line 96 of file G4INCLProjectileRemnant.hh.

                          {
       deleteStoredComponents();
       // The ProjectileRemnant owns its particles
       deleteParticles();
       clearEnergyLevels();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAllDynamicalSpectators()

ParticleList G4INCL::ProjectileRemnant::addAllDynamicalSpectators ( ParticleList const & pL )

Add back all dynamical spectators to the projectile remnant.

Return a list of rejected dynamical spectators.

Here is the caller graph for this function:

◆ addDynamicalSpectator()

G4bool G4INCL::ProjectileRemnant::addDynamicalSpectator ( Particle *const p )

private

Add back a nucleon to the projectile remnant.

Try to add a dynamical spectator back to the projectile remnant. Refuse to do so if this leads to a negative projectile excitation energy. Return true on success, false on failure.

Here is the caller graph for this function:

◆ addDynamicalSpectators()

ParticleList G4INCL::ProjectileRemnant::addDynamicalSpectators ( ParticleList pL )

Add back dynamical spectators to the projectile remnant.

Try to add the dynamical spectators back to the projectile remnant. Refuse to do so if this leads to a negative projectile excitation energy.

Return a list of rejected dynamical spectators.

Here is the caller graph for this function:

◆ addMostDynamicalSpectators()

ParticleList G4INCL::ProjectileRemnant::addMostDynamicalSpectators ( ParticleList pL )

Add back dynamical spectators to the projectile remnant.

Try as hard as possible to add back all the dynamical spectators. Don't add spectators that lead to negative excitation energies. Start by adding all of them, and repeatedly remove the most troublesome one until the excitation energy becomes non-negative.

Return a list of rejected dynamical spectators.

Here is the caller graph for this function:

◆ clearEnergyLevels()

void G4INCL::ProjectileRemnant::clearEnergyLevels ( )

inline

Clear the stored energy levels.

Definition at line 153 of file G4INCLProjectileRemnant.hh.

                              {
       theInitialEnergyLevels.clear();
       theGroundStateEnergies.clear();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearStoredComponents()

void G4INCL::ProjectileRemnant::clearStoredComponents ( )

inline

Clear the stored projectile components.

Definition at line 148 of file G4INCLProjectileRemnant.hh.

                                  {
       storedComponents.clear();
     }

Here is the caller graph for this function:

◆ computeExcitationEnergy()

G4double G4INCL::ProjectileRemnant::computeExcitationEnergy ( const EnergyLevels & levels ) const

private

Compute the excitation energy for a given configuration.

The function that does the real job of calculating the excitation energy for a given configuration of energy levels.

Parameters

levels a configuration of energy levels

Returns: the excitation energy

Here is the caller graph for this function:

◆ computeExcitationEnergyExcept()

G4double G4INCL::ProjectileRemnant::computeExcitationEnergyExcept ( const long exceptID ) const

Compute the excitation energy when a nucleon is removed.

Compute the excitation energy of the projectile-like remnant as the difference between the initial and the present configuration. This follows the algorithm proposed by A. Boudard in INCL4.2-HI, as implemented in Geant4.

Returns: the excitation energy

Here is the caller graph for this function:

◆ computeExcitationEnergyWith()

G4double G4INCL::ProjectileRemnant::computeExcitationEnergyWith ( const ParticleList & pL ) const

Compute the excitation energy if some nucleons are put back.

Returns: the excitation energy

Here is the caller graph for this function:

◆ deleteStoredComponents()

void G4INCL::ProjectileRemnant::deleteStoredComponents ( )

inline

Clear the stored projectile components and delete the particles.

Definition at line 141 of file G4INCLProjectileRemnant.hh.

                                   {
       for(std::map<long,Particle*>::const_iterator p=storedComponents.begin(), e=storedComponents.end(); p!=e; ++p)
         delete p->second;
       clearStoredComponents();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGroundStateEnergies()

EnergyLevels const& G4INCL::ProjectileRemnant::getGroundStateEnergies ( ) const

inline

Definition at line 207 of file G4INCLProjectileRemnant.hh.

                                                        {
       return theGroundStateEnergies;
     }

Here is the call graph for this function:

◆ getNumberStoredComponents()

G4int G4INCL::ProjectileRemnant::getNumberStoredComponents ( ) const

inline

Get the number of the stored components.

Definition at line 184 of file G4INCLProjectileRemnant.hh.

                                             {
       return storedComponents.size();
     }

◆ getPresentEnergyLevelsExcept()

EnergyLevels G4INCL::ProjectileRemnant::getPresentEnergyLevelsExcept ( const long exceptID ) const

private

Here is the caller graph for this function:

◆ getPresentEnergyLevelsWith()

EnergyLevels G4INCL::ProjectileRemnant::getPresentEnergyLevelsWith ( const ParticleList & pL ) const

private

Here is the caller graph for this function:

◆ getStoredComponents()

ParticleList G4INCL::ProjectileRemnant::getStoredComponents ( ) const

inlineprivate

Definition at line 234 of file G4INCLProjectileRemnant.hh.

                                              {
       ParticleList pL;
       for(std::map<long,Particle*>::const_iterator p=storedComponents.begin(), e=storedComponents.end(); p!=e; ++p)
         pL.push_back(p->second);
       return pL;
     }

Here is the caller graph for this function:

◆ getStoredMomentum()

ThreeVector const& G4INCL::ProjectileRemnant::getStoredMomentum ( Particle const *const p ) const

inlineprivate

Return the stored momentum of a given projectile component.

Definition at line 242 of file G4INCLProjectileRemnant.hh.

                                                                          {
       std::map<long,Particle*>::const_iterator i = storedComponents.find(p->getID());
       if(i==storedComponents.end()) {
         INCL_ERROR("Couldn't find particle " << p->getID() << " in the list of projectile components" << '\n');
         return p->getMomentum();
       } else {
         return i->second->getMomentum();
       }
     }

Here is the call graph for this function:

◆ INCL_DECLARE_ALLOCATION_POOL()

G4INCL::ProjectileRemnant::INCL_DECLARE_ALLOCATION_POOL ( ProjectileRemnant )

private

◆ removeParticle()

void G4INCL::ProjectileRemnant::removeParticle	(	Particle *const	p,
		const G4double	theProjectileCorrection
	)

Remove a nucleon from the projectile remnant.

Parameters

p	particle to be removed
theProjectileCorrection	correction to be given to the projectile total energy

Here is the caller graph for this function:

◆ reset()

void G4INCL::ProjectileRemnant::reset ( )

Reset the projectile remnant to the state at the beginning of the cascade.

Here is the caller graph for this function:

◆ shuffleStoredComponents()

ParticleList G4INCL::ProjectileRemnant::shuffleStoredComponents ( )

inlineprivate

Shuffle the list of stored projectile components.

Definition at line 228 of file G4INCLProjectileRemnant.hh.

                                            {
       ParticleList pL = getStoredComponents();
       std::random_shuffle(pL.begin(), pL.end(), Random::getAdapter());
       return pL;
     }

Here is the call graph for this function:

◆ storeComponents()

void G4INCL::ProjectileRemnant::storeComponents ( )

inline

Store the projectile components.

Definition at line 176 of file G4INCLProjectileRemnant.hh.

                            {
       for(ParticleIter p=particles.begin(), e=particles.end(); p!=e; ++p) {
         // Store the particles (needed for forced CN)
         storedComponents[(*p)->getID()]=new Particle(**p);
       }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeEnergyLevels()

void G4INCL::ProjectileRemnant::storeEnergyLevels ( )

inline

Store the energy levels.

Definition at line 189 of file G4INCLProjectileRemnant.hh.

                              {
       EnergyLevels energies;
 
       for(ParticleIter p=particles.begin(), e=particles.end(); p!=e; ++p) {
         const G4double theCMEnergy = (*p)->getEnergy();
         // Store the CM energy in the EnergyLevels map
         theInitialEnergyLevels[(*p)->getID()] = theCMEnergy;
         energies.push_back(theCMEnergy);
       }
 
       std::sort(energies.begin(), energies.end());
 // assert(energies.size()==(unsigned int)theA);
       theGroundStateEnergies.resize(energies.size());
       // Compute the partial sums of the CM energies -- they are our reference
       // ground-state energies for any number of nucleons
       std::partial_sum(energies.begin(), energies.end(), theGroundStateEnergies.begin());
     }

Here is the caller graph for this function:

Member Data Documentation

◆ storedComponents

std::map<long, Particle*> G4INCL::ProjectileRemnant::storedComponents

private

Return the stored energy of a given projectile component.

Stored projectile components

These particles are owned by the ProjectileRemnant.

Definition at line 275 of file G4INCLProjectileRemnant.hh.

◆ theGroundStateEnergies

EnergyLevels G4INCL::ProjectileRemnant::theGroundStateEnergies

private

Ground-state energies for any number of nucleons.

Definition at line 281 of file G4INCLProjectileRemnant.hh.

◆ theInitialEnergyLevels

EnergyLevelMap G4INCL::ProjectileRemnant::theInitialEnergyLevels

private

Initial energy levels of the projectile.

Definition at line 278 of file G4INCLProjectileRemnant.hh.

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

G4INCLProjectileRemnant.hh

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ EnergyLevelMap

◆ EnergyLevels

Constructor & Destructor Documentation

◆ ProjectileRemnant()

◆ ~ProjectileRemnant()

Member Function Documentation

◆ addAllDynamicalSpectators()

◆ addDynamicalSpectator()

◆ addDynamicalSpectators()

◆ addMostDynamicalSpectators()

◆ clearEnergyLevels()

◆ clearStoredComponents()

◆ computeExcitationEnergy()

◆ computeExcitationEnergyExcept()

◆ computeExcitationEnergyWith()

◆ deleteStoredComponents()

◆ getGroundStateEnergies()

◆ getNumberStoredComponents()

◆ getPresentEnergyLevelsExcept()

◆ getPresentEnergyLevelsWith()

◆ getStoredComponents()

◆ getStoredMomentum()

◆ INCL_DECLARE_ALLOCATION_POOL()

◆ removeParticle()

◆ reset()

◆ shuffleStoredComponents()

◆ storeComponents()

◆ storeEnergyLevels()

Member Data Documentation

◆ storedComponents

◆ theGroundStateEnergies

◆ theInitialEnergyLevels