G4AtimaEnergyLossModel Class Reference

#include <G4AtimaEnergyLossModel.hh>

Inheritance diagram for G4AtimaEnergyLossModel:

Public Member Functions
	G4AtimaEnergyLossModel (const G4ParticleDefinition *p=nullptr, const G4String &nam="Atima")
	~G4AtimaEnergyLossModel () override
void	Initialise (const G4ParticleDefinition *, const G4DataVector &) override
G4double	MinEnergyCut (const G4ParticleDefinition *, const G4MaterialCutsCouple *couple) override
G4double	ComputeCrossSectionPerElectron (const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy, G4double maxEnergy)
G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kineticEnergy, G4double Z, G4double A, G4double cutEnergy, G4double maxEnergy) override
G4double	CrossSectionPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy, G4double maxEnergy) override
G4double	ComputeDEDXPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double) override
G4double	GetChargeSquareRatio (const G4ParticleDefinition *p, const G4Material *mat, G4double kineticEnergy) override
G4double	GetParticleCharge (const G4ParticleDefinition *p, const G4Material *mat, G4double kineticEnergy) override
void	CorrectionsAlongStep (const G4MaterialCutsCouple *, const G4DynamicParticle *, const G4double &, G4double &) override
void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double tmin, G4double maxEnergy) override
Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)
virtual	~G4VEmModel ()
virtual void	InitialiseLocal (const G4ParticleDefinition *, G4VEmModel *masterModel)
virtual void	InitialiseForMaterial (const G4ParticleDefinition *, const G4Material *)
virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)
virtual G4double	GetPartialCrossSection (const G4Material *, G4int level, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	ComputeCrossSectionPerShell (const G4ParticleDefinition *, G4int Z, G4int shellIdx, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
virtual G4double	ChargeSquareRatio (const G4Track &)
virtual void	StartTracking (G4Track *)
virtual G4double	Value (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	MinPrimaryEnergy (const G4Material *, const G4ParticleDefinition *, G4double cut=0.0)
virtual void	SetupForMaterial (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual void	DefineForRegion (const G4Region *)
virtual void	FillNumberOfSecondaries (G4int &numberOfTriplets, G4int &numberOfRecoil)
virtual void	ModelDescription (std::ostream &outFile) const
void	InitialiseElementSelectors (const G4ParticleDefinition *, const G4DataVector &)
std::vector< G4EmElementSelector * > *	GetElementSelectors ()
void	SetElementSelectors (std::vector< G4EmElementSelector * > *)
G4double	ComputeDEDX (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=DBL_MAX)
G4double	CrossSection (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4double	ComputeMeanFreePath (const G4ParticleDefinition *, G4double kineticEnergy, const G4Material *, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, const G4Element *, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	SelectRandomAtom (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	SelectTargetAtom (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double logKineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	SelectRandomAtom (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	GetCurrentElement (const G4Material *mat=nullptr) const
G4int	SelectRandomAtomNumber (const G4Material *) const
const G4Isotope *	GetCurrentIsotope (const G4Element *elm=nullptr) const
G4int	SelectIsotopeNumber (const G4Element *) const
void	SetParticleChange (G4VParticleChange *, G4VEmFluctuationModel *f=nullptr)
void	SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)
G4ElementData *	GetElementData ()
G4PhysicsTable *	GetCrossSectionTable ()
G4VEmFluctuationModel *	GetModelOfFluctuations ()
G4VEmAngularDistribution *	GetAngularDistribution ()
G4VEmModel *	GetTripletModel ()
void	SetTripletModel (G4VEmModel *)
void	SetAngularDistribution (G4VEmAngularDistribution *)
G4double	HighEnergyLimit () const
G4double	LowEnergyLimit () const
G4double	HighEnergyActivationLimit () const
G4double	LowEnergyActivationLimit () const
G4double	PolarAngleLimit () const
G4double	SecondaryThreshold () const
G4bool	DeexcitationFlag () const
G4bool	ForceBuildTableFlag () const
G4bool	UseAngularGeneratorFlag () const
void	SetAngularGeneratorFlag (G4bool)
void	SetHighEnergyLimit (G4double)
void	SetLowEnergyLimit (G4double)
void	SetActivationHighEnergyLimit (G4double)
void	SetActivationLowEnergyLimit (G4double)
G4bool	IsActive (G4double kinEnergy) const
void	SetPolarAngleLimit (G4double)
void	SetSecondaryThreshold (G4double)
void	SetDeexcitationFlag (G4bool val)
void	SetForceBuildTable (G4bool val)
void	SetFluctuationFlag (G4bool val)
void	SetMasterThread (G4bool val)
G4bool	IsMaster () const
void	SetUseBaseMaterials (G4bool val)
G4bool	UseBaseMaterials () const
G4double	MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)
const G4String &	GetName () const
void	SetCurrentCouple (const G4MaterialCutsCouple *)
G4bool	IsLocked () const
void	SetLocked (G4bool)
void	SetLPMFlag (G4bool)
G4VEmModel &	operator= (const G4VEmModel &right)=delete
	G4VEmModel (const G4VEmModel &)=delete

Protected Member Functions
G4double	MaxSecondaryEnergy (const G4ParticleDefinition *, G4double kinEnergy) override
G4double	GetChargeSquareRatio () const
void	SetChargeSquareRatio (G4double val)
Protected Member Functions inherited from G4VEmModel
G4ParticleChangeForLoss *	GetParticleChangeForLoss ()
G4ParticleChangeForGamma *	GetParticleChangeForGamma ()
const G4MaterialCutsCouple *	CurrentCouple () const
void	SetCurrentElement (const G4Element *)

Additional Inherited Members
Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData = nullptr
G4VParticleChange *	pParticleChange = nullptr
G4PhysicsTable *	xSectionTable = nullptr
const G4Material *	pBaseMaterial = nullptr
const std::vector< G4double > *	theDensityFactor = nullptr
const std::vector< G4int > *	theDensityIdx = nullptr
G4double	inveplus
G4double	pFactor = 1.0
std::size_t	currentCoupleIndex = 0
std::size_t	basedCoupleIndex = 0
G4bool	lossFlucFlag = true

Detailed Description

Definition at line 57 of file G4AtimaEnergyLossModel.hh.

Constructor & Destructor Documentation

G4AtimaEnergyLossModel()

G4AtimaEnergyLossModel::G4AtimaEnergyLossModel ( const G4ParticleDefinition * p = nullptr, const G4String & nam = "Atima" )

explicit

Definition at line 74 of file G4AtimaEnergyLossModel.cc.

  : G4VEmModel(nam),
    particle(nullptr)
{
  g4calc = G4Pow::GetInstance();
  fParticleChange = nullptr;
  theElectron = G4Electron::Electron();
  corr = G4LossTableManager::Instance()->EmCorrections();  
  nist = G4NistManager::Instance();
  SetLowEnergyLimit(2.0*MeV);
  MLN10 = 2.30258509299;
  atomic_mass_unit = 931.4940954; // MeV/c^2
  dedx_constant = 0.3070749187;  //4*pi*Na*me*c^2*r_e^2  //MeV cm^2
  electron_mass = 0.510998928;   // MeV/c^2
  fine_structure = 1.0/137.035999139;
  domega2dx_constant = dedx_constant*electron_mass;  //4*pi*Na*me*c^2*r_e^2  //MeV^2 cm^2
  if(tableE[0] == 0.0) {
    G4double logmin = 0.;
    G4double logmax = 5.;
    stepE = (logmax-logmin)/199.;
    for(G4int i=0; i<200; ++i){
      tableE[i] = G4Exp(MLN10*(logmin + ((G4double)i)*stepE));
    }
  }
}

~G4AtimaEnergyLossModel()

G4AtimaEnergyLossModel::~G4AtimaEnergyLossModel ( )

overridedefault

Member Function Documentation

ComputeCrossSectionPerAtom()

G4double G4AtimaEnergyLossModel::ComputeCrossSectionPerAtom ( const G4ParticleDefinition * p, G4double kineticEnergy, G4double Z, G4double A, G4double cutEnergy, G4double maxEnergy )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 222 of file G4AtimaEnergyLossModel.cc.

{
  G4double cross = Z*ComputeCrossSectionPerElectron
                                         (p,kineticEnergy,cutEnergy,maxEnergy);
  return cross;
}

ComputeCrossSectionPerElectron()

G4double G4AtimaEnergyLossModel::ComputeCrossSectionPerElectron	(	const G4ParticleDefinition *	p,
		G4double	kineticEnergy,
		G4double	cutEnergy,
		G4double	maxEnergy )

Definition at line 191 of file G4AtimaEnergyLossModel.cc.

{
  G4double cross = 0.0;
  G4double tmax = MaxSecondaryEnergy(p, kineticEnergy);
  G4double maxEnergy = std::min(tmax,maxKinEnergy);
  if(cutEnergy < maxEnergy) {
 
    G4double totEnergy = kineticEnergy + mass;
    G4double energy2   = totEnergy*totEnergy;
    G4double beta2     = kineticEnergy*(kineticEnergy + 2.0*mass)/energy2;
 
    cross = (maxEnergy - cutEnergy)/(cutEnergy*maxEnergy) 
      - beta2*G4Log(maxEnergy/cutEnergy)/tmax;
 
    // +term for spin=1/2 particle
    if( 0.0 < spin ) { cross += 0.5*(maxEnergy - cutEnergy)/energy2; }
 
    cross *= twopi_mc2_rcl2*chargeSquare/beta2;
  }
  
   // G4cout << "BB: e= " << kineticEnergy << " tmin= " << cutEnergy 
   //        << " tmax= " << tmax << " cross= " << cross << G4endl;
  
  return cross;
}

Referenced by ComputeCrossSectionPerAtom(), and CrossSectionPerVolume().

ComputeDEDXPerVolume()

G4double G4AtimaEnergyLossModel::ComputeDEDXPerVolume ( const G4Material * material, const G4ParticleDefinition * p, G4double kineticEnergy, G4double  )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 251 of file G4AtimaEnergyLossModel.cc.

{
  //Call to ATIMA Stopping Power function
  G4double zt = material->GetIonisation()->GetZeffective();
  zt = std::min(zt,93.); 
  G4double at = nist->GetAtomicMassAmu(G4lrint(zt));
  G4double dedx = StoppingPower(p->GetPDGMass(), p->GetPDGCharge(), 
    kineticEnergy/(MeV), at, zt) *material->GetDensity()/(g/cm3);
  dedx = std::max(dedx, 0.0);
 
  //  G4cout << "E(MeV)= " << kineticEnergy/MeV << " dedx= " << dedx 
  //          << "  " << material->GetName() << G4endl;
  return dedx;
}

Referenced by CorrectionsAlongStep().

CorrectionsAlongStep()

void G4AtimaEnergyLossModel::CorrectionsAlongStep ( const G4MaterialCutsCouple * couple, const G4DynamicParticle * dp, const G4double & length, G4double & eloss )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 271 of file G4AtimaEnergyLossModel.cc.

{
  if(isIon) {
    const G4ParticleDefinition* p = dp->GetDefinition();
    const G4Material* mat = couple->GetMaterial();
    G4double cutEnergy = DBL_MAX;
    G4double kineticEnergy = dp->GetKineticEnergy();
    eloss = ComputeDEDXPerVolume(mat, p, kineticEnergy, cutEnergy)*length/(cm);
  }
}

CrossSectionPerVolume()

G4double G4AtimaEnergyLossModel::CrossSectionPerVolume ( const G4Material * material, const G4ParticleDefinition * p, G4double kineticEnergy, G4double cutEnergy, G4double maxEnergy )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 236 of file G4AtimaEnergyLossModel.cc.

{
  G4double eDensity = material->GetElectronDensity();
  G4double cross = eDensity*ComputeCrossSectionPerElectron
                                         (p,kineticEnergy,cutEnergy,maxEnergy);
  return cross;
}

GetChargeSquareRatio() [1/2]

G4double G4AtimaEnergyLossModel::GetChargeSquareRatio ( ) const

inlineprotected

Definition at line 207 of file G4AtimaEnergyLossModel.hh.

{
  return chargeSquare;
}

GetChargeSquareRatio() [2/2]

G4double G4AtimaEnergyLossModel::GetChargeSquareRatio ( const G4ParticleDefinition * p, const G4Material * mat, G4double kineticEnergy )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 130 of file G4AtimaEnergyLossModel.cc.

{
  // this method is called only for ions
  G4double q2 = corr->EffectiveChargeSquareRatio(p,mat,kineticEnergy);
  corrFactor = q2*corr->EffectiveChargeCorrection(p,mat,kineticEnergy);
  return corrFactor;
}

GetParticleCharge()

G4double G4AtimaEnergyLossModel::GetParticleCharge ( const G4ParticleDefinition * p, const G4Material * mat, G4double kineticEnergy )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 142 of file G4AtimaEnergyLossModel.cc.

{
  //G4cout<<"G4AtimaEnergyLossModel::GetParticleCharge e= "<<kineticEnergy <<
  //  " q= " <<  corr->GetParticleCharge(p,mat,kineticEnergy) <<G4endl;
  // this method is called only for ions, so no check if it is an ion
  return corr->GetParticleCharge(p,mat,kineticEnergy);
}

Initialise()

void G4AtimaEnergyLossModel::Initialise ( const G4ParticleDefinition * p, const G4DataVector &  )

overridevirtual

Implements G4VEmModel.

Definition at line 107 of file G4AtimaEnergyLossModel.cc.

{
  SetGenericIon(p);
  SetParticle(p);
 
  //G4cout << "G4AtimaEnergyLossModel::Initialise for " << p->GetParticleName()
  //         << "  isIon= " << isIon
  //         << G4endl;
 
  // always false before the run
  SetDeexcitationFlag(false);
 
  if(nullptr == fParticleChange) {
    fParticleChange = GetParticleChangeForLoss();
    if(UseAngularGeneratorFlag() && !GetAngularDistribution()) {
      SetAngularDistribution(new G4DeltaAngle());
    }
  }
}

MaxSecondaryEnergy()

G4double G4AtimaEnergyLossModel::MaxSecondaryEnergy ( const G4ParticleDefinition * pd, G4double kinEnergy )

overrideprotectedvirtual

Reimplemented from G4VEmModel.

Definition at line 402 of file G4AtimaEnergyLossModel.cc.

{
  // here particle type is checked for any method
  SetParticle(pd);
  G4double tau  = kinEnergy/mass;
  G4double tmax = 2.0*electron_mass_c2*tau*(tau + 2.) /
                  (1. + 2.0*(tau + 1.)*ratio + ratio*ratio);
  return std::min(tmax,tlimit);
}

Referenced by ComputeCrossSectionPerElectron(), and SampleSecondaries().

MinEnergyCut()

G4double G4AtimaEnergyLossModel::MinEnergyCut ( const G4ParticleDefinition * , const G4MaterialCutsCouple * couple )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 182 of file G4AtimaEnergyLossModel.cc.

{
  return couple->GetMaterial()->GetIonisation()->GetMeanExcitationEnergy();
}

SampleSecondaries()

void G4AtimaEnergyLossModel::SampleSecondaries ( std::vector< G4DynamicParticle * > * vdp, const G4MaterialCutsCouple * couple, const G4DynamicParticle * dp, G4double tmin, G4double maxEnergy )

overridevirtual

Implements G4VEmModel.

Definition at line 287 of file G4AtimaEnergyLossModel.cc.

{
  G4double kineticEnergy = dp->GetKineticEnergy();
  G4double tmax = MaxSecondaryEnergy(dp->GetDefinition(),kineticEnergy);
 
  G4double maxKinEnergy = std::min(maxEnergy,tmax);
  if(minKinEnergy >= maxKinEnergy) { return; }
 
  //G4cout << "G4AtimaEnergyLossModel::SampleSecondaries Emin= " << minKinEnergy
  //         << " Emax= " << maxKinEnergy << G4endl;
 
  G4double totEnergy     = kineticEnergy + mass;
  G4double etot2         = totEnergy*totEnergy;
  G4double beta2         = kineticEnergy*(kineticEnergy + 2.0*mass)/etot2;
 
  G4double deltaKinEnergy, f; 
  G4double f1 = 0.0;
  G4double fmax = 1.0;
  if( 0.0 < spin ) { fmax += 0.5*maxKinEnergy*maxKinEnergy/etot2; }
 
  CLHEP::HepRandomEngine* rndmEngineMod = G4Random::getTheEngine();
  G4double rndm[2];
 
  // sampling without nuclear size effect
  do {
    rndmEngineMod->flatArray(2, rndm);
    deltaKinEnergy = minKinEnergy*maxKinEnergy
                    /(minKinEnergy*(1.0 - rndm[0]) + maxKinEnergy*rndm[0]);
 
    f = 1.0 - beta2*deltaKinEnergy/tmax;
    if( 0.0 < spin ) {
      f1 = 0.5*deltaKinEnergy*deltaKinEnergy/etot2;
      f += f1;
    }
 
    // Loop checking, 03-Aug-2015, Vladimir Ivanchenko
  } while( fmax*rndm[1] > f);
 
  // projectile formfactor - suppresion of high energy
  // delta-electron production at high energy
  
  G4double x = formfact*deltaKinEnergy*(deltaKinEnergy + 2*electron_mass_c2);
  if(x > 1.e-6) {
 
    G4double x10 = 1.0 + x;
    G4double grej  = 1.0/(x10*x10);
    if( 0.0 < spin ) {
      G4double x2 = 0.5*electron_mass_c2*deltaKinEnergy/(mass*mass);
      grej *= (1.0 + magMoment2*(x2 - f1/f)/(1.0 + x2));
    }
    if(grej > 1.1) {
      G4cout << "### G4AtimaEnergyLossModel WARNING: grej= " << grej
             << "  " << dp->GetDefinition()->GetParticleName()
             << " Ekin(MeV)= " <<  kineticEnergy
             << " delEkin(MeV)= " << deltaKinEnergy
             << G4endl;
    }
    if(rndmEngineMod->flat() > grej) { return; }
  }
 
  G4ThreeVector deltaDirection;
 
  if(UseAngularGeneratorFlag()) {
 
    const G4Material* mat =  couple->GetMaterial();
    G4int Z = SelectRandomAtomNumber(mat);
 
    deltaDirection = 
      GetAngularDistribution()->SampleDirection(dp, deltaKinEnergy, Z, mat);
 
  } else {
 
    G4double deltaMomentum =
      std::sqrt(deltaKinEnergy * (deltaKinEnergy + 2.0*electron_mass_c2));
    G4double cost = deltaKinEnergy * (totEnergy + electron_mass_c2) /
      (deltaMomentum * dp->GetTotalMomentum());
    if(cost > 1.0) { cost = 1.0; }
    G4double sint = std::sqrt((1.0 - cost)*(1.0 + cost));
 
    G4double phi = twopi*rndmEngineMod->flat();
 
    deltaDirection.set(sint*cos(phi),sint*sin(phi), cost) ;
    deltaDirection.rotateUz(dp->GetMomentumDirection());
  }  
  /*
    G4cout << "### G4AtimaEnergyLossModel " 
           << dp->GetDefinition()->GetParticleName()
           << " Ekin(MeV)= " <<  kineticEnergy
           << " delEkin(MeV)= " << deltaKinEnergy
           << " tmin(MeV)= " << minKinEnergy
           << " tmax(MeV)= " << maxKinEnergy
           << " dir= " << dp->GetMomentumDirection()
           << " dirDelta= " << deltaDirection
           << G4endl;
  */
  // create G4DynamicParticle object for delta ray
  auto delta = new G4DynamicParticle(theElectron,deltaDirection,deltaKinEnergy);
 
  vdp->push_back(delta);
 
  // Change kinematics of primary particle
  kineticEnergy -= deltaKinEnergy;
  G4ThreeVector finalP = dp->GetMomentum() - delta->GetMomentum();
  finalP               = finalP.unit();
  
  fParticleChange->SetProposedKineticEnergy(kineticEnergy);
  fParticleChange->SetProposedMomentumDirection(finalP);
}

SetChargeSquareRatio()

void G4AtimaEnergyLossModel::SetChargeSquareRatio ( G4double val )

inlineprotected

Definition at line 214 of file G4AtimaEnergyLossModel.hh.

{
  chargeSquare = val;
}

---

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

• G4AtimaEnergyLossModel.hh
• G4AtimaEnergyLossModel.cc