G4DecayProducts Class Reference

#include <G4DecayProducts.hh>

Public Types
using	G4DecayProductVector = std::vector< G4DynamicParticle * >

Public Member Functions
void	Boost (G4double betax, G4double betay, G4double betaz)
void	Boost (G4double totalEnergy, const G4ThreeVector &momentumDirection)
void	DumpInfo () const
G4int	entries () const
	G4DecayProducts ()
	G4DecayProducts (const G4DecayProducts &right)
	G4DecayProducts (const G4DynamicParticle &aParticle)
const G4DynamicParticle *	GetParentParticle () const
G4bool	IsChecked () const
G4bool	operator!= (const G4DecayProducts &right) const
G4DecayProducts &	operator= (const G4DecayProducts &right)
G4bool	operator== (const G4DecayProducts &right) const
G4DynamicParticle *	operator[] (G4int anIndex) const
G4DynamicParticle *	PopProducts ()
G4int	PushProducts (G4DynamicParticle *aParticle)
void	SetParentParticle (const G4DynamicParticle &aParticle)
	~G4DecayProducts ()

Private Attributes
G4int	numberOfProducts = 0
G4DynamicParticle *	theParentParticle = nullptr
G4DecayProductVector *	theProductVector = nullptr

Detailed Description

Definition at line 43 of file G4DecayProducts.hh.

Member Typedef Documentation

G4DecayProductVector

using G4DecayProducts::G4DecayProductVector = std::vector<G4DynamicParticle*>

Definition at line 86 of file G4DecayProducts.hh.

Constructor & Destructor Documentation

G4DecayProducts() [1/3]

G4DecayProducts::G4DecayProducts

(

)

Definition at line 40 of file G4DecayProducts.cc.

{ 
  theProductVector = new G4DecayProductVector();
}

References theProductVector.

Referenced by G4DecayProducts(), and operator=().

G4DecayProducts() [2/3]

G4DecayProducts::G4DecayProducts

(

const G4DynamicParticle &

aParticle

)

Definition at line 45 of file G4DecayProducts.cc.

{
  theParentParticle = new G4DynamicParticle(aParticle);
  theProductVector = new G4DecayProductVector();
}

References theParentParticle, and theProductVector.

G4DecayProducts() [3/3]

G4DecayProducts::G4DecayProducts

(

const G4DecayProducts &

right

)

Definition at line 51 of file G4DecayProducts.cc.

{
  theProductVector = new G4DecayProductVector();
 
  // copy parent (Deep Copy)
  theParentParticle = new G4DynamicParticle(*right.theParentParticle);
 
  //copy daughters (Deep Copy)
  for (G4int index=0; index<right.numberOfProducts; ++index)
  {
    G4DynamicParticle* daughter = right.theProductVector->at(index);
    G4DynamicParticle* pDaughter =  new G4DynamicParticle(*daughter);
 
    G4double properTime = daughter->GetPreAssignedDecayProperTime();
    if(properTime>0.0) pDaughter->SetPreAssignedDecayProperTime(properTime); 
 
    const G4DecayProducts* pPreAssigned
      = daughter->GetPreAssignedDecayProducts();
    if (pPreAssigned != nullptr)
    {
      G4DecayProducts* pPA = new G4DecayProducts(*pPreAssigned);
      pDaughter->SetPreAssignedDecayProducts(pPA);
    }
    theProductVector->push_back( pDaughter );
  }
  numberOfProducts = right.numberOfProducts;
}

References G4DecayProducts(), G4DynamicParticle::GetPreAssignedDecayProducts(), G4DynamicParticle::GetPreAssignedDecayProperTime(), numberOfProducts, G4DynamicParticle::SetPreAssignedDecayProducts(), G4DynamicParticle::SetPreAssignedDecayProperTime(), theParentParticle, and theProductVector.

~G4DecayProducts()

G4DecayProducts::~G4DecayProducts

(

)

Definition at line 119 of file G4DecayProducts.cc.

{
  //delete parent
  if (theParentParticle != nullptr) delete theParentParticle;
  theParentParticle = nullptr;
 
  // delete G4DynamicParticle object
  for (G4int index=0; index<numberOfProducts; ++index)
  {
    delete theProductVector->at(index);
  }
  theProductVector->clear();
  numberOfProducts = 0;    
  delete theProductVector;
  theProductVector = nullptr;
}

References numberOfProducts, theParentParticle, and theProductVector.

Member Function Documentation

Boost() [1/2]

void G4DecayProducts::Boost	(	G4double	betax,
		G4double	betay,
		G4double	betaz
	)

Definition at line 193 of file G4DecayProducts.cc.

{ 
  G4double mass = theParentParticle->GetMass();
  G4double energy  = theParentParticle->GetTotalEnergy();
  G4double momentum  = 0.0;
 
  G4ThreeVector direction(0.0,0.0,1.0);    
  G4LorentzVector p4;
 
  if (energy - mass > DBL_MIN)
  {
    // calcurate  beta of initial state
    momentum  = theParentParticle->GetTotalMomentum();
    direction = theParentParticle->GetMomentumDirection();
    G4double betax = -1.0*direction.x()*momentum/energy;  
    G4double betay = -1.0*direction.y()*momentum/energy;  
    G4double betaz = -1.0*direction.z()*momentum/energy;  
    
    for (G4int index=0; index<numberOfProducts; ++index)
    {
      // make G4LorentzVector for secondaries
      p4 = (theProductVector->at(index))->Get4Momentum();
 
      // boost secondaries to theParentParticle's rest frame 
      p4.boost(betax, betay, betaz);
 
      // boost secondaries to  new frame 
      p4.boost(newbetax, newbetay, newbetaz);
 
      // change energy/momentum
      (theProductVector->at(index))->Set4Momentum(p4);
    }
  }
  else
  {
    for (G4int index=0; index<numberOfProducts; ++index)
    {
      // make G4LorentzVector for secondaries
      p4 = (theProductVector->at(index))->Get4Momentum();
 
      // boost secondaries to  new frame 
      p4.boost(newbetax, newbetay, newbetaz);
 
      // change energy/momentum
      (theProductVector->at(index))->Set4Momentum(p4);
    }
  }
 
  // make G4LorentzVector for parent in its rest frame
  mass = theParentParticle->GetMass();
  G4LorentzVector parent4( 0.0, 0.0, 0.0, mass);
 
  // boost parent to new frame 
  parent4.boost(newbetax, newbetay, newbetaz);
 
  // change energy/momentum
  theParentParticle->Set4Momentum(parent4);
}

References CLHEP::HepLorentzVector::boost(), DBL_MIN, G4INCL::KinematicsUtils::energy(), G4DynamicParticle::GetMass(), G4DynamicParticle::GetMomentumDirection(), G4DynamicParticle::GetTotalEnergy(), G4DynamicParticle::GetTotalMomentum(), numberOfProducts, G4DynamicParticle::Set4Momentum(), theParentParticle, theProductVector, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Boost() [2/2]

void G4DecayProducts::Boost	(	G4double	totalEnergy,
		const G4ThreeVector &	momentumDirection
	)

Definition at line 177 of file G4DecayProducts.cc.

{
  // calculate new beta
  G4double mass = theParentParticle->GetMass();
  G4double totalMomentum(0);
  if ( totalEnergy > mass )
  {
    totalMomentum  = std::sqrt( (totalEnergy - mass)*(totalEnergy + mass) );
  }
  G4double betax = momentumDirection.x()*totalMomentum/totalEnergy;  
  G4double betay = momentumDirection.y()*totalMomentum/totalEnergy;  
  G4double betaz = momentumDirection.z()*totalMomentum/totalEnergy;  
  Boost(betax, betay, betaz);
}

References Boost(), G4DynamicParticle::GetMass(), theParentParticle, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by Boost(), G4RadioactiveDecay::DecayAnalog(), G4Decay::DecayIt(), G4UnknownDecay::DecayIt(), G4MuonicAtomDecay::DecayIt(), and G4IntraNucleiCascader::decayTrappedParticle().

DumpInfo()

void G4DecayProducts::DumpInfo

(

)

const

Definition at line 334 of file G4DecayProducts.cc.

{
   G4cout << " ----- List of DecayProducts  -----" << G4endl;
   G4cout << " ------ Parent Particle ----------" << G4endl;
   if (theParentParticle != 0) theParentParticle->DumpInfo();
   G4cout << " ------ Daughter Particles  ------" << G4endl;  
   for (G4int index=0; index<numberOfProducts; ++index)
   {
     G4cout << " ----------" << index+1 << " -------------" << G4endl;  
     (theProductVector->at(index))-> DumpInfo();
   }
   G4cout << " ----- End List of DecayProducts  -----" << G4endl;
   G4cout << G4endl;
} 

References DumpInfo(), G4DynamicParticle::DumpInfo(), G4cout, G4endl, numberOfProducts, theParentParticle, and theProductVector.

Referenced by G4RadioactiveDecay::DecayAnalog(), G4Decay::DecayIt(), G4UnknownDecay::DecayIt(), G4MuonicAtomDecay::DecayIt(), G4DalitzDecayChannel::DecayIt(), G4KL3DecayChannel::DecayIt(), G4MuonDecayChannel::DecayIt(), G4MuonDecayChannelWithSpin::DecayIt(), G4MuonRadiativeDecayChannelWithSpin::DecayIt(), G4NeutronBetaDecayChannel::DecayIt(), G4PionRadiativeDecayChannel::DecayIt(), G4TauLeptonicDecayChannel::DecayIt(), DumpInfo(), G4PhaseSpaceDecayChannel::ManyBodyDecayIt(), G4GeneralPhaseSpaceDecay::ManyBodyDecayIt(), G4PhaseSpaceDecayChannel::OneBodyDecayIt(), G4GeneralPhaseSpaceDecay::OneBodyDecayIt(), G4PhaseSpaceDecayChannel::ThreeBodyDecayIt(), G4GeneralPhaseSpaceDecay::ThreeBodyDecayIt(), G4PhaseSpaceDecayChannel::TwoBodyDecayIt(), and G4GeneralPhaseSpaceDecay::TwoBodyDecayIt().

entries()

G4int G4DecayProducts::entries ( ) const

inline

Definition at line 79 of file G4DecayProducts.hh.

{ return numberOfProducts; }

References numberOfProducts.

Referenced by G4Radioactivation::AddDeexcitationSpectrumForBiasMode(), G4PrimaryTransformer::CheckDynamicParticle(), G4RadioactiveDecay::CollimateDecay(), G4PionDecayMakeSpin::DaughterPolarization(), G4KineticTrack::Decay(), G4RadioactiveDecay::DecayAnalog(), G4Decay::DecayIt(), G4UnknownDecay::DecayIt(), G4Radioactivation::DecayIt(), G4MuonicAtomDecay::DecayIt(), and G4IntraNucleiCascader::decayTrappedParticle().

GetParentParticle()

const G4DynamicParticle * G4DecayProducts::GetParentParticle ( ) const

inline

Definition at line 112 of file G4DecayProducts.hh.

{
  return theParentParticle;
}

References theParentParticle.

Referenced by G4PionDecayMakeSpin::DaughterPolarization().

IsChecked()

G4bool G4DecayProducts::IsChecked

(

)

const

Definition at line 254 of file G4DecayProducts.cc.

{
  G4bool returnValue = true;
 
  // check parent 
  // energy/momentum
  G4double parent_energy  = theParentParticle->GetTotalEnergy();
  G4ThreeVector direction = theParentParticle->GetMomentumDirection();
  G4ThreeVector parent_momentum
    = direction*(theParentParticle->GetTotalMomentum());
 
  // check momentum direction is a unit vector
  if ((parent_momentum.mag() >0.0) && (std::fabs(direction.mag()-1.0) >1.0e-6))
  {
#ifdef G4VERBOSE
    G4cout << "G4DecayProducts::IsChecked()::  "
           << " Momentum Direction Vector of Parent is not normalized "
           << "  (=" << direction.mag() << ")" << G4endl;
#endif
    returnValue = false;
    parent_momentum = parent_momentum * (1./direction.mag());
  }
 
  // daughters
  G4double mass, energy;
  G4ThreeVector momentum;
  G4double total_energy = parent_energy;
  G4ThreeVector total_momentum = parent_momentum;
 
  for (G4int index=0; index < numberOfProducts; ++index)
  {
    G4DynamicParticle* part = theProductVector->at(index);
    mass = part->GetMass();
    energy = part->GetTotalEnergy();
    direction = part->GetMomentumDirection();
    momentum = direction*(part->GetTotalMomentum());
 
    // check momentum direction is a unit vector
    if ( (momentum.mag()>0.0) && (std::fabs(direction.mag()-1.0) > 1.0e-6))
    {
#ifdef G4VERBOSE
      G4cout <<  "G4DecayProducts::IsChecked()::  "
             << " Momentum Direction Vector of Daughter [" << index
             << "]  is not normalized (=" << direction.mag() << ")" << G4endl;
#endif
      returnValue = false;
      momentum = momentum * (1./direction.mag());
    }
    // whether daughter stops or not
    if (energy - mass < DBL_MIN )
    {
#ifdef G4VERBOSE
      G4cout <<  "G4DecayProducts::IsChecked()::  "
             << "  Daughter [" << index << "] has no kinetic energy "<< G4endl;
#endif
      returnValue = false;
    }
    total_energy -= energy; 
    total_momentum -= momentum;
  }
  // check energy/momentum conservation
  if ( (std::fabs(total_energy) >1.0e-9*MeV)
    || (total_momentum.mag() >1.0e-9*MeV ) )
  { 
#ifdef G4VERBOSE
    G4cout <<  "G4DecayProducts::IsChecked()::  "
           << " Energy/Momentum is not conserved   "<< G4endl;
    G4cout << " difference between parent energy & sum of daughters energy: "
           << total_energy /MeV << "[MeV]  " << G4endl;
    G4cout << " difference between parent momentum & sum of daughters momentum: "
           << " x:" << total_momentum.getX()/MeV
           << " y:" << total_momentum.getY()/MeV
           << " z:" << total_momentum.getZ()/MeV
           << G4endl;
#endif
    returnValue = false;
  }
  return returnValue;
}

References DBL_MIN, G4INCL::KinematicsUtils::energy(), G4cout, G4endl, G4DynamicParticle::GetMass(), G4DynamicParticle::GetMomentumDirection(), G4DynamicParticle::GetTotalEnergy(), G4DynamicParticle::GetTotalMomentum(), CLHEP::Hep3Vector::getX(), CLHEP::Hep3Vector::getY(), CLHEP::Hep3Vector::getZ(), CLHEP::Hep3Vector::mag(), MeV, numberOfProducts, theParentParticle, and theProductVector.

Referenced by G4RadioactiveDecay::DecayAnalog(), G4Decay::DecayIt(), and G4MuonicAtomDecay::DecayIt().

operator!=()

G4bool G4DecayProducts::operator!= ( const G4DecayProducts &  right ) const

inline

Definition at line 106 of file G4DecayProducts.hh.

{
  return (this != (G4DecayProducts *) &right);
}

operator=()

G4DecayProducts & G4DecayProducts::operator=

(

const G4DecayProducts &

right

)

Definition at line 79 of file G4DecayProducts.cc.

{
  G4int index;
 
  if (this != &right)
  { 
    // recreate parent
    if (theParentParticle != nullptr) delete theParentParticle;
    theParentParticle = new G4DynamicParticle(*right.theParentParticle);
 
    // delete G4DynamicParticle objects
    for (index=0; index<numberOfProducts; ++index)
    {
      delete theProductVector->at(index);
    }
    theProductVector->clear();
 
    //copy daughters (Deep Copy)
    for (index=0; index<right.numberOfProducts; ++index)
    {
      G4DynamicParticle* daughter = right.theProductVector->at(index);
      G4DynamicParticle* pDaughter =  new G4DynamicParticle(*daughter);
 
      G4double properTime = daughter->GetPreAssignedDecayProperTime();
      if(properTime>0.0) pDaughter->SetPreAssignedDecayProperTime(properTime); 
      
      const G4DecayProducts* pPreAssigned
        = daughter->GetPreAssignedDecayProducts();
      if (pPreAssigned != nullptr)
      {
        G4DecayProducts* pPA = new G4DecayProducts(*pPreAssigned);
        pDaughter->SetPreAssignedDecayProducts(pPA);
      }
      theProductVector->push_back( pDaughter );
    } 
    numberOfProducts = right.numberOfProducts;
  }
  return *this;
}

References G4DecayProducts(), G4DynamicParticle::GetPreAssignedDecayProducts(), G4DynamicParticle::GetPreAssignedDecayProperTime(), numberOfProducts, G4DynamicParticle::SetPreAssignedDecayProducts(), G4DynamicParticle::SetPreAssignedDecayProperTime(), theParentParticle, and theProductVector.

operator==()

G4bool G4DecayProducts::operator== ( const G4DecayProducts &  right ) const

inline

Definition at line 100 of file G4DecayProducts.hh.

{
  return (this == (G4DecayProducts *) &right);
}

operator[]()

G4DynamicParticle * G4DecayProducts::operator[]

(

G4int

anIndex

)

const

Definition at line 158 of file G4DecayProducts.cc.

{
  if ((numberOfProducts > anIndex) && (anIndex >=0) )
  {
    return  theProductVector->at(anIndex);
  }
  else
  {
    return nullptr;
  }
}

References numberOfProducts, and theProductVector.

PopProducts()

G4DynamicParticle * G4DecayProducts::PopProducts

(

)

Definition at line 136 of file G4DecayProducts.cc.

{
  if ( numberOfProducts >0 )
  {
    numberOfProducts -= 1;   
    G4DynamicParticle* part = theProductVector->back();
    theProductVector->pop_back();
    return part;
  }
  else
  {
    return nullptr;
  }
}

References numberOfProducts, and theProductVector.

Referenced by G4Radioactivation::AddDeexcitationSpectrumForBiasMode(), G4KineticTrack::Decay(), G4RadioactiveDecay::DecayAnalog(), G4Decay::DecayIt(), G4UnknownDecay::DecayIt(), G4Radioactivation::DecayIt(), and G4MuonicAtomDecay::DecayIt().

PushProducts()

G4int G4DecayProducts::PushProducts

(

G4DynamicParticle *

aParticle

)

Definition at line 151 of file G4DecayProducts.cc.

{
  theProductVector->push_back(aParticle);
  numberOfProducts += 1; 
  return numberOfProducts;
}

References numberOfProducts, and theProductVector.

Referenced by G4DalitzDecayChannel::DecayIt(), G4KL3DecayChannel::DecayIt(), G4MuonDecayChannel::DecayIt(), G4MuonDecayChannelWithSpin::DecayIt(), G4MuonRadiativeDecayChannelWithSpin::DecayIt(), G4NeutronBetaDecayChannel::DecayIt(), G4PionRadiativeDecayChannel::DecayIt(), G4TauLeptonicDecayChannel::DecayIt(), G4AlphaDecay::DecayIt(), G4BetaMinusDecay::DecayIt(), G4BetaPlusDecay::DecayIt(), G4ECDecay::DecayIt(), G4ITDecay::DecayIt(), G4NeutronDecay::DecayIt(), G4ProtonDecay::DecayIt(), G4SFDecay::DecayIt(), G4TritonDecay::DecayIt(), G4PhaseSpaceDecayChannel::ManyBodyDecayIt(), G4GeneralPhaseSpaceDecay::ManyBodyDecayIt(), G4PhaseSpaceDecayChannel::OneBodyDecayIt(), G4GeneralPhaseSpaceDecay::OneBodyDecayIt(), G4PrimaryTransformer::SetDecayProducts(), G4PhaseSpaceDecayChannel::ThreeBodyDecayIt(), G4GeneralPhaseSpaceDecay::ThreeBodyDecayIt(), G4PhaseSpaceDecayChannel::TwoBodyDecayIt(), and G4GeneralPhaseSpaceDecay::TwoBodyDecayIt().

SetParentParticle()

void G4DecayProducts::SetParentParticle

(

const G4DynamicParticle &

aParticle

)

Definition at line 170 of file G4DecayProducts.cc.

{
  if (theParentParticle != nullptr) delete theParentParticle;
  theParentParticle = new G4DynamicParticle(aParticle);
}

References theParentParticle.

Field Documentation

numberOfProducts

G4int G4DecayProducts::numberOfProducts = 0

private

Definition at line 90 of file G4DecayProducts.hh.

Referenced by Boost(), DumpInfo(), entries(), G4DecayProducts(), IsChecked(), operator=(), operator[](), PopProducts(), PushProducts(), and ~G4DecayProducts().

theParentParticle

G4DynamicParticle* G4DecayProducts::theParentParticle = nullptr

private

Definition at line 91 of file G4DecayProducts.hh.

Referenced by Boost(), DumpInfo(), G4DecayProducts(), GetParentParticle(), IsChecked(), operator=(), SetParentParticle(), and ~G4DecayProducts().

theProductVector

G4DecayProductVector* G4DecayProducts::theProductVector = nullptr

private

Definition at line 92 of file G4DecayProducts.hh.

Referenced by Boost(), DumpInfo(), G4DecayProducts(), IsChecked(), operator=(), operator[](), PopProducts(), PushProducts(), and ~G4DecayProducts().

---

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

• source/particles/management/include/G4DecayProducts.hh
• source/particles/management/src/G4DecayProducts.cc