#include <G4INCLCluster.hh>

Inheritance diagram for G4INCL::Cluster:

Collaboration diagram for G4INCL::Cluster:

[legend]

Public Member Functions
	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
	Get the particle species. More...

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	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	rotate (const G4double angle, const ThreeVector &axis)
	Rotate position and 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	isInList (ParticleList const &l) const
	Check if the particle belongs to a given list. 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...

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...

Protected Attributes
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

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

Detailed Description

Cluster is a particle (inherits from the Particle class) that is actually a collection of elementary particles.

Definition at line 50 of file G4INCLCluster.hh.

Constructor & Destructor Documentation

G4INCL::Cluster::Cluster	(	const G4int	Z,
		const G4int	A,
		const G4bool	createParticleSampler = `true`
	)

inline

Standard Cluster constructor.

This constructor should mainly be used when constructing Nucleus or when constructing Clusters to be used as composite projectiles.

Definition at line 58 of file G4INCLCluster.hh.

Here is the call graph for this function:

template<class Iterator >

G4INCL::Cluster::Cluster	(	Iterator	begin,
		Iterator	end
	)

inline

A cluster can be directly built from a list of particles.

Definition at line 76 of file G4INCLCluster.hh.

Here is the call graph for this function:

virtual G4INCL::Cluster::~Cluster ( )

inlinevirtual

Definition at line 91 of file G4INCLCluster.hh.

G4INCL::Cluster::Cluster ( const Cluster & rhs )

inline

Copy constructor.

Definition at line 96 of file G4INCLCluster.hh.

Here is the call graph for this function:

Member Function Documentation

void G4INCL::Cluster::addParticle ( Particle *const p )

inline

Add one particle to the cluster. This updates the cluster mass, energy, size, etc.

Definition at line 172 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::addParticles ( ParticleList const & pL )

inline

Add a list of particles to the cluster.

Definition at line 185 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::boost ( const ThreeVector & aBoostVector )

inline

Boost the cluster with the indicated velocity.

The Cluster is boosted as a whole, just like any Particle object; moreover, the internal components (particles list) are also boosted, according to Alain Boudard's off-shell recipe.

Parameters

aBoostVector the velocity to boost to [c]

Definition at line 315 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::clearParticles ( )

inline

Definition at line 140 of file G4INCLCluster.hh.

Here is the caller graph for this function:

void G4INCL::Cluster::deleteParticles ( )

inline

Definition at line 133 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::freezeInternalMotion ( )

inline

Freeze the internal motion of the particles.

Each particle is assigned a frozen momentum four-vector determined by the collective cluster velocity. This is used for propagation, but not for dynamics. Normal propagation is restored by calling the Particle::thawPropagation() method, which should be done in InteractionAvatar::postInteraction.

Definition at line 338 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

G4INCL::ThreeVector G4INCL::Cluster::getAngularMomentum ( ) const

inlinevirtual

Get the total angular momentum (orbital + spin)

Reimplemented from G4INCL::Particle.

Definition at line 395 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Cluster::getExcitationEnergy ( ) const

inline

Get the excitation energy of the cluster.

Definition at line 149 of file G4INCLCluster.hh.

Here is the caller graph for this function:

ParticleList G4INCL::Cluster::getParticleList ( ) const

inline

Returns the list of particles that make up the cluster.

Definition at line 191 of file G4INCLCluster.hh.

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

inline

Get the list of particles in the cluster.

Definition at line 163 of file G4INCLCluster.hh.

Here is the caller graph for this function:

ParticleSpecies G4INCL::Cluster::getSpecies ( ) const

inlinevirtual

Get the particle species.

Reimplemented from G4INCL::Particle.

Definition at line 129 of file G4INCLCluster.hh.

ThreeVector const& G4INCL::Cluster::getSpin ( ) const

inline

Get the spin of the nucleus.

Definition at line 389 of file G4INCLCluster.hh.

Here is the caller graph for this function:

virtual G4double G4INCL::Cluster::getTableMass ( ) const

inlinevirtual

Get the real particle mass.

Overloads the Particle method.

Reimplemented from G4INCL::Particle.

Definition at line 158 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::initializeParticles ( )

virtual

Initialise the NuclearDensity pointer and sample the particles.

Reimplemented in G4INCL::Nucleus.

Definition at line 42 of file G4INCLCluster.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::internalBoostToCM ( )

inline

Boost to the CM of the component particles.

The position of all particles in the particles list is shifted so that their centre of mass is in the origin and their total momentum is zero.

Definition at line 225 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void G4INCL::Cluster::makeParticipant ( )

inlinevirtual

Make all the components participants, too.

Reimplemented from G4INCL::Particle.

Definition at line 381 of file G4INCLCluster.hh.

Here is the call graph for this function:

virtual void G4INCL::Cluster::makeProjectileSpectator ( )

inlinevirtual

Make all the components projectile spectators, too.

Reimplemented from G4INCL::Particle.

Definition at line 365 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void G4INCL::Cluster::makeTargetSpectator ( )

inlinevirtual

Make all the components target spectators, too.

Reimplemented from G4INCL::Particle.

Definition at line 373 of file G4INCLCluster.hh.

Here is the call graph for this function:

Cluster& G4INCL::Cluster::operator= ( const Cluster & rhs )

inline

Assignment operator.

Definition at line 111 of file G4INCLCluster.hh.

Here is the call graph for this function:

std::string G4INCL::Cluster::print ( ) const

inline

Definition at line 193 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::putParticlesOffShell ( )

inline

Put the cluster components off shell.

The Cluster components are put off shell in such a way that their total energy equals the cluster mass.

Definition at line 277 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::removeParticle ( Particle *const p )

inline

Remove a particle from the cluster components.

Definition at line 166 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void G4INCL::Cluster::rotate	(	const G4double	angle,
		const ThreeVector &	axis
	)

inlinevirtual

Rotate position and momentum of all the particles.

This includes the cluster components. Overloads Particle::rotate().

Parameters

angle	the rotation angle
axis	a unit vector representing the rotation axis

Reimplemented from G4INCL::Particle.

Definition at line 357 of file G4INCLCluster.hh.

Here is the call graph for this function:

void G4INCL::Cluster::setA ( const G4int A )

inline

Set the mass number of the cluster.

Definition at line 146 of file G4INCLCluster.hh.

void G4INCL::Cluster::setExcitationEnergy ( const G4double e )

inline

Set the excitation energy of the cluster.

Definition at line 152 of file G4INCLCluster.hh.

Here is the caller graph for this function:

void G4INCL::Cluster::setPosition ( const ThreeVector & position )

inlinevirtual

Set the position of the cluster.

This overloads the Particle method to take into account that the positions of the cluster members must be updated as well.

Reimplemented from G4INCL::Particle.

Definition at line 299 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Cluster::setSpin ( const ThreeVector & j )

inline

Set the spin of the nucleus.

Definition at line 392 of file G4INCLCluster.hh.

Here is the caller graph for this function:

void G4INCL::Cluster::setZ ( const G4int Z )

inline

Set the charge number of the cluster.

Definition at line 143 of file G4INCLCluster.hh.

void G4INCL::Cluster::swap ( Cluster & rhs )

inline

Helper method for the assignment operator.

Definition at line 119 of file G4INCLCluster.hh.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ParticleList G4INCL::Cluster::particles

protected

Definition at line 418 of file G4INCLCluster.hh.

G4double G4INCL::Cluster::theExcitationEnergy

protected

Definition at line 419 of file G4INCLCluster.hh.

ParticleSampler* G4INCL::Cluster::theParticleSampler

protected

Definition at line 421 of file G4INCLCluster.hh.

ThreeVector G4INCL::Cluster::theSpin

protected

Definition at line 420 of file G4INCLCluster.hh.

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

source/source/processes/hadronic/models/inclxx/incl_physics/include/G4INCLCluster.hh
source/source/processes/hadronic/models/inclxx/incl_physics/src/G4INCLCluster.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation