G4INCL::Particle Class Reference

#include <G4INCLParticle.hh>

Inheritance diagram for G4INCL::Particle:

Collaboration diagram for G4INCL::Particle:

Public Member Functions
	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
virtual G4INCL::ParticleSpecies	getSpecies () const
	Get the particle species. More...
void	setType (ParticleType t)
G4bool	isNucleon () const
ParticipantType	getParticipantType () const
void	setParticipantType (ParticipantType const p)
G4bool	isParticipant () const
G4bool	isTargetSpectator () const
G4bool	isProjectileSpectator () const
virtual void	makeParticipant ()
virtual void	makeTargetSpectator ()
virtual void	makeProjectileSpectator ()
G4bool	isPion () const
	Is this a pion? More...
G4bool	isEta () const
	Is this a eta? More...
G4bool	isOmega () const
	Is this a omega? More...
G4bool	isEtaPrime () const
	Is this a etaprime? 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...
virtual G4double	getTableMass () const
	Get the tabulated 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 G4INCL::ThreeVector	getAngularMomentum () const
virtual void	setMomentum (const G4INCL::ThreeVector &momentum)
const G4INCL::ThreeVector &	getPosition () const
virtual void	setPosition (const G4INCL::ThreeVector &position)
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...
virtual void	rotatePosition (const G4double angle, const ThreeVector &axis)
	Rotate the particle position. More...
virtual void	rotateMomentum (const G4double angle, const ThreeVector &axis)
	Rotate the particle 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...

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

Protected Attributes
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 73 of file G4INCLParticle.hh.

Constructor & Destructor Documentation

G4INCL::Particle::Particle

(

)

Definition at line 52 of file G4INCLParticle.cc.

    : theZ(0), theA(0),
    theParticipantType(TargetSpectator),
    theType(UnknownParticle),
    theEnergy(0.0),
    thePropagationEnergy(&theEnergy),
    theFrozenEnergy(theEnergy),
    theMomentum(ThreeVector(0.,0.,0.)),
    thePropagationMomentum(&theMomentum),
    theFrozenMomentum(theMomentum),
    thePosition(ThreeVector(0.,0.,0.)),
    nCollisions(0),
    nDecays(0),
    thePotentialEnergy(0.0),
    rpCorrelated(false),
    uncorrelatedMomentum(0.),
    theHelicity(0.0),
    emissionTime(0.0),
    outOfWell(false),
    theMass(0.)
  {
    ID = nextID;
    nextID++;
  }

Here is the caller graph for this function:

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

Definition at line 77 of file G4INCLParticle.cc.

    : theEnergy(energy),
    thePropagationEnergy(&theEnergy),
    theFrozenEnergy(theEnergy),
    theMomentum(momentum),
    thePropagationMomentum(&theMomentum),
    theFrozenMomentum(theMomentum),
    thePosition(position),
    nCollisions(0), nDecays(0),
      thePotentialEnergy(0.),
      rpCorrelated(false),
      uncorrelatedMomentum(theMomentum.mag()),
      theHelicity(0.0),
      emissionTime(0.0), outOfWell(false)
  {
    theParticipantType = TargetSpectator;
    ID = nextID;
    nextID++;
    if(theEnergy <= 0.0) {
      INCL_WARN("Particle with energy " << theEnergy << " created." << '\n');
    }
    setType(t);
    setMass(getInvariantMass());
  }

Here is the call graph for this function:

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

Definition at line 103 of file G4INCLParticle.cc.

    : thePropagationEnergy(&theEnergy),
    theMomentum(momentum),
    thePropagationMomentum(&theMomentum),
    theFrozenMomentum(theMomentum),
    thePosition(position),
    nCollisions(0), nDecays(0),
      thePotentialEnergy(0.),
      rpCorrelated(false),
      uncorrelatedMomentum(theMomentum.mag()),
      theHelicity(0.0),
      emissionTime(0.0), outOfWell(false)
  {
    theParticipantType = TargetSpectator;
    ID = nextID;
    nextID++;
    setType(t);
    if( isResonance() ) {
      INCL_ERROR("Cannot create resonance without specifying its momentum four-vector." << '\n');
    }
    G4double energy = std::sqrt(theMomentum.mag2() + theMass*theMass);
    theEnergy = energy;
    theFrozenEnergy = theEnergy;
  }

Here is the call graph for this function:

virtual G4INCL::Particle::~Particle ( )

inlinevirtual

Definition at line 78 of file G4INCLParticle.hh.

{}

G4INCL::Particle::Particle ( const Particle &  rhs )

inline

Copy constructor.

Does not copy the particle ID.

Definition at line 84 of file G4INCLParticle.hh.

                                  :
      theZ(rhs.theZ),
      theA(rhs.theA),
      theParticipantType(rhs.theParticipantType),
      theType(rhs.theType),
      theEnergy(rhs.theEnergy),
      theFrozenEnergy(rhs.theFrozenEnergy),
      theMomentum(rhs.theMomentum),
      theFrozenMomentum(rhs.theFrozenMomentum),
      thePosition(rhs.thePosition),
      nCollisions(rhs.nCollisions),
      nDecays(rhs.nDecays),
      thePotentialEnergy(rhs.thePotentialEnergy),
      rpCorrelated(rhs.rpCorrelated),
      uncorrelatedMomentum(rhs.uncorrelatedMomentum),
      theHelicity(rhs.theHelicity),
      emissionTime(rhs.emissionTime),
      outOfWell(rhs.outOfWell),
      theMass(rhs.theMass)
      {
        if(rhs.thePropagationEnergy == &(rhs.theFrozenEnergy))
          thePropagationEnergy = &theFrozenEnergy;
        else
          thePropagationEnergy = &theEnergy;
        if(rhs.thePropagationMomentum == &(rhs.theFrozenMomentum))
          thePropagationMomentum = &theFrozenMomentum;
        else
          thePropagationMomentum = &theMomentum;
        // ID intentionally not copied
        ID = nextID++;
      }

Member Function Documentation

G4double G4INCL::Particle::adjustEnergyFromMomentum

(

)

Recompute the energy to match the momentum.

Definition at line 142 of file G4INCLParticle.cc.

                                              {
    theEnergy = std::sqrt(theMomentum.mag2() + theMass*theMass);
    return theEnergy;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

const ThreeVector & G4INCL::Particle::adjustMomentumFromEnergy

(

)

Rescale the momentum to match the total energy.

Definition at line 129 of file G4INCLParticle.cc.

                                                        {
    const G4double p2 = theMomentum.mag2();
    G4double newp2 = theEnergy*theEnergy - theMass*theMass;
    if( newp2<0.0 ) {
      INCL_ERROR("Particle has E^2 < m^2." << '\n' << print());
      newp2 = 0.0;
      theEnergy = theMass;
    }

    theMomentum *= std::sqrt(newp2/p2);
    return theMomentum;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Boost the particle using a boost vector.

Example (go to the particle rest frame): particle->boost(particle->boostVector());

Definition at line 319 of file G4INCLParticle.hh.

                                                {
      const G4double beta2 = aBoostVector.mag2();
      const G4double gamma = 1.0 / std::sqrt(1.0 - beta2);
      const G4double bp = theMomentum.dot(aBoostVector);
      const G4double alpha = (gamma*gamma)/(1.0 + gamma);

      theMomentum = theMomentum + aBoostVector * (alpha * bp - gamma * theEnergy);
      theEnergy = gamma * (theEnergy - bp);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ThreeVector G4INCL::Particle::boostVector ( ) const

inline

Returns a three vector we can give to the boost() -method.

In order to go to the particle rest frame you need to multiply the boost vector by -1.0.

Definition at line 309 of file G4INCLParticle.hh.

                                    {
      return theMomentum / theEnergy;
    }

Here is the caller graph for this function:

std::string G4INCL::Particle::dump ( ) const

inline

Definition at line 752 of file G4INCLParticle.hh.

                           {
      std::stringstream ss;
      ss << "(particle " << ID << " ";
      ss << ParticleTable::getName(theType);
      ss << '\n'
        << thePosition.dump()
        << '\n'
        << theMomentum.dump()
        << '\n'
        << theEnergy << ")" << '\n';
      return ss.str();
    };

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Particle::freezePropagation ( )

inline

Freeze particle propagation.

Make the particle use theFrozenMomentum and theFrozenEnergy for propagation. The normal state can be restored by calling the thawPropagation() method.

Definition at line 692 of file G4INCLParticle.hh.

                             {
      thePropagationMomentum = &theFrozenMomentum;
      thePropagationEnergy = &theFrozenEnergy;
    }

G4int G4INCL::Particle::getA ( ) const

inline

Returns the baryon number.

Definition at line 293 of file G4INCLParticle.hh.

{ return theA; }

Here is the caller graph for this function:

virtual G4INCL::ThreeVector G4INCL::Particle::getAngularMomentum ( ) const

inlinevirtual

Get the angular momentum w.r.t. the origin

Reimplemented in G4INCL::Cluster.

Definition at line 584 of file G4INCLParticle.hh.

    {
      return thePosition.vector(theMomentum);
    };

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Particle::getBeta ( ) const

inline

Definition at line 298 of file G4INCLParticle.hh.

                             {
      const G4double P = theMomentum.mag();
      return P/theEnergy;
    }

Here is the call graph for this function:

G4double G4INCL::Particle::getCosRPAngle ( ) const

inline

Get the cosine of the angle between position and momentum.

Definition at line 798 of file G4INCLParticle.hh.

                                   {
      const G4double norm = thePosition.mag2()*thePropagationMomentum->mag2();
      if(norm>0.)
        return thePosition.dot(*thePropagationMomentum) / std::sqrt(norm);
      else
        return 1.;
    }

Here is the call graph for this function:

G4double G4INCL::Particle::getEmissionQValueCorrection ( const G4int  AParent, const G4int  ZParent  ) const

inline

Computes correction on the emission Q-value.

Computes the correction that must be applied to INCL particles in order to obtain the correct Q-value for particle emission from a given nucleus. For absorption, the correction is obviously equal to minus the value returned by this function.

Parameters

AParent	the mass number of the emitting nucleus
ZParent	the charge number of the emitting nucleus

Returns

the correction

Definition at line 469 of file G4INCLParticle.hh.

                                                                                         {
      const G4int ADaughter = AParent - theA;
      const G4int ZDaughter = ZParent - theZ;

      // Note the minus sign here
      G4double theQValue;
      if(isCluster())
        theQValue = -ParticleTable::getTableQValue(theA, theZ, ADaughter, ZDaughter);
      else {
        const G4double massTableParent = ParticleTable::getTableMass(AParent,ZParent);
        const G4double massTableDaughter = ParticleTable::getTableMass(ADaughter,ZDaughter);
        const G4double massTableParticle = getTableMass();
        theQValue = massTableParent - massTableDaughter - massTableParticle;
      }

      const G4double massINCLParent = ParticleTable::getINCLMass(AParent,ZParent);
      const G4double massINCLDaughter = ParticleTable::getINCLMass(ADaughter,ZDaughter);
      const G4double massINCLParticle = getINCLMass();

      // The rhs corresponds to the INCL Q-value
      return theQValue - (massINCLParent-massINCLDaughter-massINCLParticle);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Particle::getEmissionTime ( )

inline

Definition at line 649 of file G4INCLParticle.hh.

{ return emissionTime; };

Here is the caller graph for this function:

G4double G4INCL::Particle::getEnergy ( ) const

inline

Get the energy of the particle in MeV.

Definition at line 554 of file G4INCLParticle.hh.

    {
      return theEnergy;
    };

Here is the caller graph for this function:

G4double G4INCL::Particle::getFrozenEnergy ( ) const

inline

Get the frozen particle momentum.

Definition at line 681 of file G4INCLParticle.hh.

{ return theFrozenEnergy; }

ThreeVector G4INCL::Particle::getFrozenMomentum ( ) const

inline

Get the frozen particle momentum.

Definition at line 678 of file G4INCLParticle.hh.

{ return theFrozenMomentum; }

G4double G4INCL::Particle::getHelicity ( )

inline

Definition at line 610 of file G4INCLParticle.hh.

{ return theHelicity; };

long G4INCL::Particle::getID ( ) const

inline

Definition at line 765 of file G4INCLParticle.hh.

{ return ID; };

Here is the caller graph for this function:

G4double G4INCL::Particle::getINCLMass ( ) const

inline

Get the INCL particle mass.

Definition at line 351 of file G4INCLParticle.hh.

                                        {
      switch(theType) {
        case Proton:
        case Neutron:
        case PiPlus:
        case PiMinus:
        case PiZero:
        case Eta:
        case Omega:
        case EtaPrime:
        case Photon:
          return ParticleTable::getINCLMass(theType);
          break;

        case DeltaPlusPlus:
        case DeltaPlus:
        case DeltaZero:
        case DeltaMinus:
          return theMass;
          break;

        case Composite:
          return ParticleTable::getINCLMass(theA,theZ);
          break;

        default:
          INCL_ERROR("Particle::getINCLMass: Unknown particle type." << '\n');
          return 0.0;
          break;
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Particle::getInvariantMass ( ) const

inline

Get the the particle invariant mass.

Uses the relativistic invariant

Definition at line 532 of file G4INCLParticle.hh.

                                      {
      const G4double mass = std::pow(theEnergy, 2) - theMomentum.dot(theMomentum);
      if(mass < 0.0) {
        INCL_ERROR("E*E - p*p is negative." << '\n');
        return 0.0;
      } else {
        return std::sqrt(mass);
      }
    };

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Particle::getKineticEnergy ( ) const

inline

Get the particle kinetic energy.

Definition at line 543 of file G4INCLParticle.hh.

{ return theEnergy - theMass; }

Here is the caller graph for this function:

ThreeVector G4INCL::Particle::getLongitudinalPosition ( ) const

inline

Longitudinal component of the position w.r.t. the momentum.

Definition at line 657 of file G4INCLParticle.hh.

                                                {
      return *thePropagationMomentum * (thePosition.dot(*thePropagationMomentum)/thePropagationMomentum->mag2());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Particle::getMass ( ) const

inline

Get the cached particle mass.

Definition at line 348 of file G4INCLParticle.hh.

{ return theMass; }

Here is the caller graph for this function:

const G4INCL::ThreeVector& G4INCL::Particle::getMomentum ( ) const

inline

Get the momentum vector.

Definition at line 578 of file G4INCLParticle.hh.

    {
      return theMomentum;
    };

Here is the caller graph for this function:

G4int G4INCL::Particle::getNumberOfCollisions ( ) const

inline

Return the number of collisions undergone by the particle.

Definition at line 618 of file G4INCLParticle.hh.

{ return nCollisions; }

Here is the caller graph for this function:

G4int G4INCL::Particle::getNumberOfDecays ( ) const

inline

Return the number of decays undergone by the particle.

Definition at line 627 of file G4INCLParticle.hh.

{ return nDecays; }

ParticipantType G4INCL::Particle::getParticipantType ( ) const

inline

Definition at line 239 of file G4INCLParticle.hh.

                                               {
      return theParticipantType;
    }

Here is the caller graph for this function:

ParticleList const* G4INCL::Particle::getParticles ( ) const

inline

Return a NULL pointer

Definition at line 770 of file G4INCLParticle.hh.

                                             {
      INCL_WARN("Particle::getParticles() method was called on a Particle object" << '\n');
      return 0;
    }

const G4INCL::ThreeVector& G4INCL::Particle::getPosition ( ) const

inline

Set the position vector.

Definition at line 600 of file G4INCLParticle.hh.

    {
      return thePosition;
    };

Here is the caller graph for this function:

G4double G4INCL::Particle::getPotentialEnergy ( ) const

inline

Get the particle potential energy.

Definition at line 546 of file G4INCLParticle.hh.

{ return thePotentialEnergy; }

Here is the caller graph for this function:

ThreeVector G4INCL::Particle::getPropagationVelocity ( ) const

inline

Get the propagation velocity of the particle.

Definition at line 684 of file G4INCLParticle.hh.

{ return (*thePropagationMomentum)/(*thePropagationEnergy); }

Here is the caller graph for this function:

G4double G4INCL::Particle::getRealMass ( ) const

inline

Get the real particle mass.

Definition at line 417 of file G4INCLParticle.hh.

                                        {
      switch(theType) {
        case Proton:
        case Neutron:
        case PiPlus:
        case PiMinus:
        case PiZero:
        case Eta:
        case Omega:
        case EtaPrime:
        case Photon:
          return ParticleTable::getRealMass(theType);
          break;

        case DeltaPlusPlus:
        case DeltaPlus:
        case DeltaZero:
        case DeltaMinus:
          return theMass;
          break;

        case Composite:
          return ParticleTable::getRealMass(theA,theZ);
          break;

        default:
          INCL_ERROR("Particle::getRealMass: Unknown particle type." << '\n');
          return 0.0;
          break;
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4INCL::Particle::getReflectionMomentum ( ) const

inline

Return the reflection momentum.

The reflection momentum is used by calls to getSurfaceRadius to compute the radius of the sphere where the nucleon moves. It is necessary to introduce fuzzy r-p correlations.

Definition at line 781 of file G4INCLParticle.hh.

                                           {
      if(rpCorrelated)
        return theMomentum.mag();
      else
        return uncorrelatedMomentum;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual G4INCL::ParticleSpecies G4INCL::Particle::getSpecies ( ) const

inlinevirtual

Get the particle species.

Reimplemented in G4INCL::Cluster.

Definition at line 171 of file G4INCLParticle.hh.

                                                     {
      return ParticleSpecies(theType);
    };

Here is the caller graph for this function:

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

inlinevirtual

Get the tabulated particle mass.

Reimplemented in G4INCL::Cluster.

Definition at line 384 of file G4INCLParticle.hh.

                                                 {
      switch(theType) {
        case Proton:
        case Neutron:
        case PiPlus:
        case PiMinus:
        case PiZero:
        case Eta:
        case Omega:
        case EtaPrime:
        case Photon:
          return ParticleTable::getTableParticleMass(theType);
          break;

        case DeltaPlusPlus:
        case DeltaPlus:
        case DeltaZero:
        case DeltaMinus:
          return theMass;
          break;

        case Composite:
          return ParticleTable::getTableMass(theA,theZ);
          break;

        default:
          INCL_ERROR("Particle::getTableMass: Unknown particle type." << '\n');
          return 0.0;
          break;
      }
    }

Here is the caller graph for this function:

G4double G4INCL::Particle::getTransferQValueCorrection ( const G4int  AFrom, const G4int  ZFrom, const G4int  ATo, const G4int  ZTo  ) const

inline

Computes correction on the transfer Q-value.

Computes the correction that must be applied to INCL particles in order to obtain the correct Q-value for particle transfer from a given nucleus to another.

Assumes that the receving nucleus is INCL's target nucleus, with the INCL separation energy.

Parameters

AFrom	the mass number of the donating nucleus
ZFrom	the charge number of the donating nucleus
ATo	the mass number of the receiving nucleus
ZTo	the charge number of the receiving nucleus

Returns

the correction

Definition at line 507 of file G4INCLParticle.hh.

                                                                                                                       {
      const G4int AFromDaughter = AFrom - theA;
      const G4int ZFromDaughter = ZFrom - theZ;
      const G4int AToDaughter = ATo + theA;
      const G4int ZToDaughter = ZTo + theZ;
      const G4double theQValue = ParticleTable::getTableQValue(AToDaughter,ZToDaughter,AFromDaughter,ZFromDaughter,AFrom,ZFrom);

      const G4double massINCLTo = ParticleTable::getINCLMass(ATo,ZTo);
      const G4double massINCLToDaughter = ParticleTable::getINCLMass(AToDaughter,ZToDaughter);
      /* Note that here we have to use the table mass in the INCL Q-value. We
       * cannot use theMass, because at this stage the particle is probably
       * still off-shell; and we cannot use getINCLMass(), because it leads to
       * violations of global energy conservation.
       */
      const G4double massINCLParticle = getTableMass();

      // The rhs corresponds to the INCL Q-value for particle absorption
      return theQValue - (massINCLToDaughter-massINCLTo-massINCLParticle);
    }

Here is the call graph for this function:

ThreeVector G4INCL::Particle::getTransversePosition ( ) const

inline

Transverse component of the position w.r.t. the momentum.

Definition at line 652 of file G4INCLParticle.hh.

                                              {
      return thePosition - getLongitudinalPosition();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

G4INCL::ParticleType G4INCL::Particle::getType ( ) const

inline

Get the particle type.

See Also

G4INCL::ParticleType

Definition at line 166 of file G4INCLParticle.hh.

                                       {
      return theType;
    };

G4int G4INCL::Particle::getZ ( ) const

inline

Returns the charge number.

Definition at line 296 of file G4INCLParticle.hh.

{ return theZ; }

Here is the caller graph for this function:

void G4INCL::Particle::incrementNumberOfCollisions ( )

inline

Increment the number of collisions undergone by the particle.

Definition at line 624 of file G4INCLParticle.hh.

{ nCollisions++; }

void G4INCL::Particle::incrementNumberOfDecays ( )

inline

Increment the number of decays undergone by the particle.

Definition at line 633 of file G4INCLParticle.hh.

{ nDecays++; }

G4bool G4INCL::Particle::isCluster ( ) const

inline

Definition at line 667 of file G4INCLParticle.hh.

                             {
      return (theType == Composite);
    }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isDelta ( ) const

inline

Is it a Delta?

Definition at line 287 of file G4INCLParticle.hh.

                                  {
      return (theType==DeltaPlusPlus || theType==DeltaPlus ||
          theType==DeltaZero || theType==DeltaMinus);
    }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isEta ( ) const

inline

Is this a eta?

Definition at line 275 of file G4INCLParticle.hh.

{ return (theType == Eta); }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isEtaPrime ( ) const

inline

Is this a etaprime?

Definition at line 281 of file G4INCLParticle.hh.

{ return (theType == EtaPrime); }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isNucleon ( ) const

inline

Is this a nucleon?

Definition at line 232 of file G4INCLParticle.hh.

                             {
      if(theType == G4INCL::Proton || theType == G4INCL::Neutron)
    return true;
      else
    return false;
    };

Here is the caller graph for this function:

G4bool G4INCL::Particle::isOmega ( ) const

inline

Is this a omega?

Definition at line 278 of file G4INCLParticle.hh.

{ return (theType == Omega); }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isOutOfWell ( ) const

inline

Check if the particle is out of its potential well.

Definition at line 646 of file G4INCLParticle.hh.

{ return outOfWell; }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isParticipant ( ) const

inline

Definition at line 247 of file G4INCLParticle.hh.

                                 {
      return (theParticipantType==Participant);
    }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isPion ( ) const

inline

Is this a pion?

Definition at line 272 of file G4INCLParticle.hh.

{ return (theType == PiPlus || theType == PiZero || theType == PiMinus); }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isProjectileSpectator ( ) const

inline

Definition at line 255 of file G4INCLParticle.hh.

                                         {
      return (theParticipantType==ProjectileSpectator);
    }

Here is the caller graph for this function:

G4bool G4INCL::Particle::isResonance ( ) const

inline

Is it a resonance?

Definition at line 284 of file G4INCLParticle.hh.

{ return isDelta(); }

Here is the call graph for this function:

Here is the caller graph for this function:

G4bool G4INCL::Particle::isTargetSpectator ( ) const

inline

Definition at line 251 of file G4INCLParticle.hh.

                                     {
      return (theParticipantType==TargetSpectator);
    }

Here is the caller graph for this function:

void G4INCL::Particle::lorentzContract ( const ThreeVector &  aBoostVector, const ThreeVector &  refPos  )

inline

Lorentz-contract the particle position around some center.

Apply Lorentz contraction to the position component along the direction of the boost vector.

Parameters

aBoostVector	the boost vector (velocity) [c]
refPos	the reference position

Definition at line 337 of file G4INCLParticle.hh.

                                                                                     {
      const G4double beta2 = aBoostVector.mag2();
      const G4double gamma = 1.0 / std::sqrt(1.0 - beta2);
      const ThreeVector theRelativePosition = thePosition - refPos;
      const ThreeVector transversePosition = theRelativePosition - aBoostVector * (theRelativePosition.dot(aBoostVector) / aBoostVector.mag2());
      const ThreeVector longitudinalPosition = theRelativePosition - transversePosition;

      thePosition = refPos + transversePosition + longitudinalPosition / gamma;
    }

Here is the call graph for this function:

virtual void G4INCL::Particle::makeParticipant ( )

inlinevirtual

Reimplemented in G4INCL::Cluster.

Definition at line 259 of file G4INCLParticle.hh.

                                   {
      theParticipantType = Participant;
    }

Here is the caller graph for this function:

virtual void G4INCL::Particle::makeProjectileSpectator ( )

inlinevirtual

Reimplemented in G4INCL::Cluster.

Definition at line 267 of file G4INCLParticle.hh.

                                           {
      theParticipantType = ProjectileSpectator;
    }

Here is the caller graph for this function:

virtual void G4INCL::Particle::makeTargetSpectator ( )

inlinevirtual

Reimplemented in G4INCL::Cluster.

Definition at line 263 of file G4INCLParticle.hh.

                                       {
      theParticipantType = TargetSpectator;
    }

Here is the caller graph for this function:

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

inline

Assignment operator.

Does not copy the particle ID.

Definition at line 156 of file G4INCLParticle.hh.

                                             {
      Particle temporaryParticle(rhs);
      swap(temporaryParticle);
      return *this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

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

inline

Definition at line 737 of file G4INCLParticle.hh.

                            {
      std::stringstream ss;
      ss << "Particle (ID = " << ID << ") type = ";
      ss << ParticleTable::getName(theType);
      ss << '\n'
        << "   energy = " << theEnergy << '\n'
        << "   momentum = "
        << theMomentum.print()
        << '\n'
        << "   position = "
        << thePosition.print()
        << '\n';
      return ss.str();
    };

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Particle::propagate ( G4double  step )

inline

Definition at line 613 of file G4INCLParticle.hh.

                                  {
      thePosition += ((*thePropagationMomentum)*(step/(*thePropagationEnergy)));
    };

Here is the caller graph for this function:

virtual void G4INCL::Particle::rotateMomentum ( const G4double  angle, const ThreeVector &  axis  )

inlinevirtual

Rotate the particle momentum.

Parameters

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

Reimplemented in G4INCL::Cluster.

Definition at line 732 of file G4INCLParticle.hh.

                                                                               {
      theMomentum.rotate(angle, axis);
      theFrozenMomentum.rotate(angle, axis);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void G4INCL::Particle::rotatePosition ( const G4double  angle, const ThreeVector &  axis  )

inlinevirtual

Rotate the particle position.

Parameters

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

Reimplemented in G4INCL::Cluster.

Definition at line 723 of file G4INCLParticle.hh.

                                                                               {
      thePosition.rotate(angle, axis);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void G4INCL::Particle::rotatePositionAndMomentum ( const G4double  angle, const ThreeVector &  axis  )

inlinevirtual

Rotate the particle position and momentum.

Parameters

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

Definition at line 713 of file G4INCLParticle.hh.

                                                                                          {
      rotatePosition(angle, axis);
      rotateMomentum(angle, axis);
    }

Here is the call graph for this function:

void G4INCL::Particle::rpCorrelate ( )

inline

Make the particle follow a strict r-p correlation.

Definition at line 792 of file G4INCLParticle.hh.

{ rpCorrelated = true; }

Here is the caller graph for this function:

void G4INCL::Particle::rpDecorrelate ( )

inline

Make the particle not follow a strict r-p correlation.

Definition at line 795 of file G4INCLParticle.hh.

{ rpCorrelated = false; }

void G4INCL::Particle::setEmissionTime ( G4double  t )

inline

Definition at line 648 of file G4INCLParticle.hh.

{ emissionTime = t; }

Here is the caller graph for this function:

void G4INCL::Particle::setEnergy ( G4double  energy )

inline

Set the energy of the particle in MeV.

Definition at line 570 of file G4INCLParticle.hh.

    {
      this->theEnergy = energy;
    };

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Particle::setFrozenEnergy ( const G4double  energy )

inline

Set the frozen particle momentum.

Definition at line 675 of file G4INCLParticle.hh.

{ theFrozenEnergy = energy; }

Here is the call graph for this function:

void G4INCL::Particle::setFrozenMomentum ( const ThreeVector &  momentum )

inline

Set the frozen particle momentum.

Definition at line 672 of file G4INCLParticle.hh.

{ theFrozenMomentum = momentum; }

void G4INCL::Particle::setHelicity ( G4double  h )

inline

Definition at line 611 of file G4INCLParticle.hh.

{ theHelicity = h; };

Here is the caller graph for this function:

void G4INCL::Particle::setINCLMass ( )

inline

Set the mass of the Particle to its table mass.

Definition at line 456 of file G4INCLParticle.hh.

{ setMass(getINCLMass()); }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Particle::setMass ( G4double  mass )

inline

Set the mass of the particle in MeV/c^2.

Definition at line 562 of file G4INCLParticle.hh.

    {
      this->theMass = mass;
    }

Here is the caller graph for this function:

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

inlinevirtual

Set the momentum vector.

Definition at line 592 of file G4INCLParticle.hh.

    {
      this->theMomentum = momentum;
    };

Here is the caller graph for this function:

void G4INCL::Particle::setNumberOfCollisions ( G4int  n )

inline

Set the number of collisions undergone by the particle.

Definition at line 621 of file G4INCLParticle.hh.

{ nCollisions = n; }

void G4INCL::Particle::setNumberOfDecays ( G4int  n )

inline

Set the number of decays undergone by the particle.

Definition at line 630 of file G4INCLParticle.hh.

{ nDecays = n; }

void G4INCL::Particle::setOutOfWell ( )

inline

Mark the particle as out of its potential well.

This flag is used to control pions created outside their potential well in delta decay. The pion potential checks it and returns zero if it is true (necessary in order to correctly enforce energy conservation). The Nucleus::applyFinalState() method uses it to determine whether new avatars should be generated for the particle.

Definition at line 643 of file G4INCLParticle.hh.

{ outOfWell = true; }

void G4INCL::Particle::setParticipantType ( ParticipantType const  p )

inline

Definition at line 243 of file G4INCLParticle.hh.

                                                     {
      theParticipantType = p;
    }

virtual void G4INCL::Particle::setPosition ( const G4INCL::ThreeVector &  position )

inlinevirtual

Reimplemented in G4INCL::Cluster.

Definition at line 605 of file G4INCLParticle.hh.

    {
      this->thePosition = position;
    };

Here is the caller graph for this function:

void G4INCL::Particle::setPotentialEnergy ( G4double  v )

inline

Set the particle potential energy.

Definition at line 549 of file G4INCLParticle.hh.

{ thePotentialEnergy = v; }

Here is the caller graph for this function:

void G4INCL::Particle::setRealMass ( )

inline

Set the mass of the Particle to its real mass.

Definition at line 450 of file G4INCLParticle.hh.

{ setMass(getRealMass()); }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Particle::setTableMass ( )

inline

Set the mass of the Particle to its table mass.

Definition at line 453 of file G4INCLParticle.hh.

{ setMass(getTableMass()); }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Particle::setType ( ParticleType  t )

inline

Definition at line 175 of file G4INCLParticle.hh.

                                 {
      theType = t;
      switch(theType)
      {
        case DeltaPlusPlus:
          theA = 1;
          theZ = 2;
          break;
        case Proton:
        case DeltaPlus:
          theA = 1;
          theZ = 1;
          break;
        case Neutron:
        case DeltaZero:
          theA = 1;
          theZ = 0;
          break;
        case DeltaMinus:
          theA = 1;
          theZ = -1;
          break;
        case PiPlus:
          theA = 0;
          theZ = 1;
          break;
        case PiZero:
        case Eta:
        case Omega:
        case EtaPrime:
        case Photon:
          theA = 0;
          theZ = 0;
          break;
        case PiMinus:
          theA = 0;
          theZ = -1;
          break;
        case Composite:
         // INCL_ERROR("Trying to set particle type to Composite! Construct a Cluster object instead" << '\n');
          theA = 0;
          theZ = 0;
          break;
        case UnknownParticle:
          theA = 0;
          theZ = 0;
          INCL_ERROR("Trying to set particle type to Unknown!" << '\n');
          break;
      }

      if( !isResonance() && t!=Composite )
        setINCLMass();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4INCL::Particle::setUncorrelatedMomentum ( const G4double  p )

inline

Set the uncorrelated momentum.

Definition at line 789 of file G4INCLParticle.hh.

{ uncorrelatedMomentum = p; }

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

inlineprotected

Helper method for the assignment operator.

Definition at line 118 of file G4INCLParticle.hh.

                             {
      std::swap(theZ, rhs.theZ);
      std::swap(theA, rhs.theA);
      std::swap(theParticipantType, rhs.theParticipantType);
      std::swap(theType, rhs.theType);
      if(rhs.thePropagationEnergy == &(rhs.theFrozenEnergy))
        thePropagationEnergy = &theFrozenEnergy;
      else
        thePropagationEnergy = &theEnergy;
      std::swap(theEnergy, rhs.theEnergy);
      std::swap(theFrozenEnergy, rhs.theFrozenEnergy);
      if(rhs.thePropagationMomentum == &(rhs.theFrozenMomentum))
        thePropagationMomentum = &theFrozenMomentum;
      else
        thePropagationMomentum = &theMomentum;
      std::swap(theMomentum, rhs.theMomentum);
      std::swap(theFrozenMomentum, rhs.theFrozenMomentum);
      std::swap(thePosition, rhs.thePosition);
      std::swap(nCollisions, rhs.nCollisions);
      std::swap(nDecays, rhs.nDecays);
      std::swap(thePotentialEnergy, rhs.thePotentialEnergy);
      // ID intentionally not swapped

      std::swap(theHelicity, rhs.theHelicity);
      std::swap(emissionTime, rhs.emissionTime);
      std::swap(outOfWell, rhs.outOfWell);

      std::swap(theMass, rhs.theMass);
      std::swap(rpCorrelated, rhs.rpCorrelated);
      std::swap(uncorrelatedMomentum, rhs.uncorrelatedMomentum);
    }

Here is the caller graph for this function:

void G4INCL::Particle::thawPropagation ( )

inline

Unfreeze particle propagation.

Make the particle use theMomentum and theEnergy for propagation. Call this method to restore the normal propagation if the freezePropagation() method has been called.

Definition at line 703 of file G4INCLParticle.hh.

                           {
      thePropagationMomentum = &theMomentum;
      thePropagationEnergy = &theEnergy;
    }

Here is the caller graph for this function:

Member Data Documentation

long G4INCL::Particle::ID

protected

Definition at line 820 of file G4INCLParticle.hh.

G4int G4INCL::Particle::nCollisions

protected

Definition at line 817 of file G4INCLParticle.hh.

G4int G4INCL::Particle::nDecays

protected

Definition at line 818 of file G4INCLParticle.hh.

G4bool G4INCL::Particle::rpCorrelated

protected

Definition at line 822 of file G4INCLParticle.hh.

G4int G4INCL::Particle::theA

protected

Definition at line 807 of file G4INCLParticle.hh.

G4double G4INCL::Particle::theEnergy

protected

Definition at line 810 of file G4INCLParticle.hh.

G4double G4INCL::Particle::theFrozenEnergy

protected

Definition at line 812 of file G4INCLParticle.hh.

G4INCL::ThreeVector G4INCL::Particle::theFrozenMomentum

protected

Definition at line 815 of file G4INCLParticle.hh.

G4INCL::ThreeVector G4INCL::Particle::theMomentum

protected

Definition at line 813 of file G4INCLParticle.hh.

ParticipantType G4INCL::Particle::theParticipantType

protected

Definition at line 808 of file G4INCLParticle.hh.

G4INCL::ThreeVector G4INCL::Particle::thePosition

protected

Definition at line 816 of file G4INCLParticle.hh.

G4double G4INCL::Particle::thePotentialEnergy

protected

Definition at line 819 of file G4INCLParticle.hh.

G4double* G4INCL::Particle::thePropagationEnergy

protected

Definition at line 811 of file G4INCLParticle.hh.

G4INCL::ThreeVector* G4INCL::Particle::thePropagationMomentum

protected

Definition at line 814 of file G4INCLParticle.hh.

G4INCL::ParticleType G4INCL::Particle::theType

protected

Definition at line 809 of file G4INCLParticle.hh.

G4int G4INCL::Particle::theZ

protected

Definition at line 807 of file G4INCLParticle.hh.

G4double G4INCL::Particle::uncorrelatedMomentum

protected

Definition at line 823 of file G4INCLParticle.hh.

---

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

• geant4.10.03.p01/source/processes/hadronic/models/inclxx/utils/include/G4INCLParticle.hh
• geant4.10.03.p01/source/processes/hadronic/models/inclxx/utils/src/G4INCLParticle.cc