G4eCoulombScatteringModel Class Reference

#include <G4eCoulombScatteringModel.hh>

Inheritance diagram for G4eCoulombScatteringModel:

Public Member Functions
	G4eCoulombScatteringModel (G4bool combined=true)
	~G4eCoulombScatteringModel () override
void	Initialise (const G4ParticleDefinition *, const G4DataVector &) override
void	InitialiseLocal (const G4ParticleDefinition *, G4VEmModel *masterModel) override
G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A, G4double cut, G4double emax) override
void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double tmin, G4double maxEnergy) override
G4double	MinPrimaryEnergy (const G4Material *, const G4ParticleDefinition *, G4double) final
void	SetLowEnergyThreshold (G4double val)
void	SetRecoilThreshold (G4double eth)
void	SetFixedCut (G4double)
G4double	GetFixedCut () const
G4eCoulombScatteringModel &	operator= (const G4eCoulombScatteringModel &right)=delete
	G4eCoulombScatteringModel (const G4eCoulombScatteringModel &)=delete
Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)
virtual	~G4VEmModel ()
virtual void	Initialise (const G4ParticleDefinition *, const G4DataVector &)=0
virtual void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double tmin=0.0, G4double tmax=DBL_MAX)=0
virtual void	InitialiseLocal (const G4ParticleDefinition *, G4VEmModel *masterModel)
virtual void	InitialiseForMaterial (const G4ParticleDefinition *, const G4Material *)
virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)
virtual G4double	ComputeDEDXPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=DBL_MAX)
virtual G4double	CrossSectionPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
virtual G4double	GetPartialCrossSection (const G4Material *, G4int level, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A=0., G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
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 G4double	GetChargeSquareRatio (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual G4double	GetParticleCharge (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual void	StartTracking (G4Track *)
virtual void	CorrectionsAlongStep (const G4MaterialCutsCouple *, const G4DynamicParticle *, const G4double &length, G4double &eloss)
virtual G4double	Value (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	MinPrimaryEnergy (const G4Material *, const G4ParticleDefinition *, G4double cut=0.0)
virtual G4double	MinEnergyCut (const G4ParticleDefinition *, const G4MaterialCutsCouple *)
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	LPMFlag () 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	SetLPMFlag (G4bool val)
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)
G4VEmModel &	operator= (const G4VEmModel &right)=delete
	G4VEmModel (const G4VEmModel &)=delete

Protected Member Functions
void	DefineMaterial (const G4MaterialCutsCouple *)
void	SetupParticle (const G4ParticleDefinition *)
Protected Member Functions inherited from G4VEmModel
G4ParticleChangeForLoss *	GetParticleChangeForLoss ()
G4ParticleChangeForGamma *	GetParticleChangeForGamma ()
virtual G4double	MaxSecondaryEnergy (const G4ParticleDefinition *, G4double kineticEnergy)
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
size_t	currentCoupleIndex = 0
size_t	basedCoupleIndex = 0
G4bool	lossFlucFlag = true

Detailed Description

Definition at line 77 of file G4eCoulombScatteringModel.hh.

Constructor & Destructor Documentation

G4eCoulombScatteringModel() [1/2]

G4eCoulombScatteringModel::G4eCoulombScatteringModel ( G4bool  combined = true )

explicit

Definition at line 68 of file G4eCoulombScatteringModel.cc.

  : G4VEmModel("eCoulombScattering"),
    cosThetaMin(1.0),
    cosThetaMax(-1.0),
    isCombined(combined)
{
  fParticleChange = nullptr;
  fNistManager = G4NistManager::Instance();
  theIonTable  = G4ParticleTable::GetParticleTable()->GetIonTable();
  theProton    = G4Proton::Proton();
  currentMaterial = nullptr; 
  fixedCut = -1.0;
 
  pCuts = nullptr;
 
  recoilThreshold = 0.0; // by default does not work
 
  particle = nullptr;
  currentCouple = nullptr;
 
  wokvi = new G4WentzelOKandVIxSection(isCombined);
 
  currentMaterialIndex = 0;
  mass = CLHEP::proton_mass_c2;
  elecRatio = 0.0;
}

~G4eCoulombScatteringModel()

G4eCoulombScatteringModel::~G4eCoulombScatteringModel ( )

override

Definition at line 97 of file G4eCoulombScatteringModel.cc.

{
  delete wokvi;
}

G4eCoulombScatteringModel() [2/2]

G4eCoulombScatteringModel::G4eCoulombScatteringModel ( const G4eCoulombScatteringModel &  )

delete

Member Function Documentation

ComputeCrossSectionPerAtom()

G4double G4eCoulombScatteringModel::ComputeCrossSectionPerAtom ( const G4ParticleDefinition *  p, G4double  kinEnergy, G4double  Z, G4double  A, G4double  cut, G4double  emax  )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 173 of file G4eCoulombScatteringModel.cc.

{
  /*
  G4cout << "### G4eCoulombScatteringModel::ComputeCrossSectionPerAtom  for " 
     << p->GetParticleName()<<" Z= "<<Z<<" e(MeV)= "<< kinEnergy/MeV 
     << G4endl; 
  */
  G4double cross = 0.0;
  elecRatio = 0.0;
  if(p != particle) { SetupParticle(p); }
 
  // cross section is set to zero to avoid problems in sample secondary
  if(kinEnergy <= 0.0) { return cross; }
  DefineMaterial(CurrentCouple());
  G4double costmin = wokvi->SetupKinematic(kinEnergy, currentMaterial);
 
  //G4cout << "cosThetaMax= "<<cosThetaMax<<" costmin= "<<costmin<< G4endl;
 
  if(cosThetaMax < costmin) {
    G4int iz = G4lrint(Z);
    G4double cut = (0.0 < fixedCut) ? fixedCut : cutEnergy;
    costmin = wokvi->SetupTarget(iz, cut);
    //G4cout << "SetupTarget: Z= " << iz << "  cut= " << cut << "  "
    //     << costmin << G4endl;
    G4double costmax = (1 == iz && particle == theProton && cosThetaMax < 0.0)
      ? 0.0 : cosThetaMax; 
    if(costmin > costmax) {
      cross = wokvi->ComputeNuclearCrossSection(costmin, costmax)
        + wokvi->ComputeElectronCrossSection(costmin, costmax);
    }
    /*    
    if(p->GetParticleName() == "e-") 
    G4cout << "Z= " << Z << " e(MeV)= " << kinEnergy/MeV 
       << " cross(b)= " << cross/barn << " 1-costmin= " << 1-costmin
       << " 1-costmax= " << 1-costmax 
       << " 1-cosThetaMax= " << 1-cosThetaMax
       << "  " << currentMaterial->GetName()
       << G4endl;
    */
  }
  //G4cout << "====== cross= " << cross << G4endl;
  return cross;  
}

DefineMaterial()

void G4eCoulombScatteringModel::DefineMaterial ( const G4MaterialCutsCouple *  cup )

inlineprotected

Definition at line 160 of file G4eCoulombScatteringModel.hh.

{ 
  if(cup != currentCouple) {
    currentCouple = cup;
    currentMaterial = cup->GetMaterial();
    currentMaterialIndex = currentCouple->GetIndex(); 
  }
}

Referenced by ComputeCrossSectionPerAtom(), and SampleSecondaries().

GetFixedCut()

G4double G4eCoulombScatteringModel::GetFixedCut ( ) const

inline

Definition at line 198 of file G4eCoulombScatteringModel.hh.

{
  return fixedCut;
}

Initialise()

void G4eCoulombScatteringModel::Initialise ( const G4ParticleDefinition *  part, const G4DataVector &  cuts  )

overridevirtual

Implements G4VEmModel.

Definition at line 104 of file G4eCoulombScatteringModel.cc.

{
  SetupParticle(part);
  currentCouple = nullptr;
 
  // defined theta limit between single and multiple scattering 
  if(isCombined) {
    cosThetaMin = 1.0;
    G4double tet = PolarAngleLimit();
    if(tet >= pi)      { cosThetaMin = -1.0; }
    else if(tet > 0.0) { cosThetaMin = cos(tet); }
  }
 
  wokvi->Initialise(part, cosThetaMin);
  pCuts = &cuts;
  /*
  G4cout << "G4eCoulombScatteringModel::Initialise for " 
     << part->GetParticleName() << " 1-cos(TetMin)= " << 1.0 - cosThetaMin 
     << " 1-cos(TetMax)= " << 1. - cosThetaMax << G4endl;
  G4cout << "cut[0]= " << (*pCuts)[0] << G4endl;
  */
  if(nullptr == fParticleChange) {
    fParticleChange = GetParticleChangeForGamma();
  }
  if(IsMaster() && mass < GeV && part->GetParticleName() != "GenericIon") {
    InitialiseElementSelectors(part, cuts);
  }
}

InitialiseLocal()

void G4eCoulombScatteringModel::InitialiseLocal ( const G4ParticleDefinition *  , G4VEmModel *  masterModel  )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 136 of file G4eCoulombScatteringModel.cc.

{
  SetElementSelectors(masterModel->GetElementSelectors());
}

MinPrimaryEnergy()

G4double G4eCoulombScatteringModel::MinPrimaryEnergy ( const G4Material *  material, const G4ParticleDefinition *  part, G4double    )

finalvirtual

Reimplemented from G4VEmModel.

Definition at line 145 of file G4eCoulombScatteringModel.cc.

{
  SetupParticle(part);
 
  // define cut using cuts for proton
  G4double cut = 
    std::max(recoilThreshold, (*pCuts)[CurrentCouple()->GetIndex()]);
 
  // find out lightest element
  const G4ElementVector* theElementVector = material->GetElementVector();
  std::size_t nelm = material->GetNumberOfElements();
 
  // select lightest element
  G4int Z = 300;
  for (std::size_t j=0; j<nelm; ++j) {
    Z = std::min(Z,(*theElementVector)[j]->GetZasInt());
  }
  G4int A = G4lrint(fNistManager->GetAtomicMassAmu(Z));
  G4double targetMass = G4NucleiProperties::GetNuclearMass(A, Z);
  G4double t = std::max(cut, 0.5*(cut + sqrt(2*cut*targetMass)));
 
  return t;
}

operator=()

G4eCoulombScatteringModel & G4eCoulombScatteringModel::operator= ( const G4eCoulombScatteringModel &  right )

delete

SampleSecondaries()

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

overridevirtual

Implements G4VEmModel.

Definition at line 223 of file G4eCoulombScatteringModel.cc.

{
  G4double kinEnergy = dp->GetKineticEnergy();
  SetupParticle(dp->GetDefinition());
  DefineMaterial(couple);
  /*
  G4cout << "G4eCoulombScatteringModel::SampleSecondaries e(MeV)= " 
     << kinEnergy << "  " << particle->GetParticleName() 
     << " cut= " << cutEnergy<< G4endl;
  */
  // Choose nucleus
  G4double cut = (0.0 < fixedCut) ? fixedCut : cutEnergy;
 
  wokvi->SetupKinematic(kinEnergy, currentMaterial);
 
  const G4Element* currentElement = SelectTargetAtom(couple,particle,kinEnergy,
                                       dp->GetLogKineticEnergy(),cut,kinEnergy);
  G4int iz = currentElement->GetZasInt();
 
  G4double costmin = wokvi->SetupTarget(iz, cut);
  G4double costmax = (1 == iz && particle == theProton && cosThetaMax < 0.0) 
    ? 0.0 :  cosThetaMax; 
  if(costmin <= costmax) { return; }
 
  G4double cross = wokvi->ComputeNuclearCrossSection(costmin, costmax);
  G4double ecross = wokvi->ComputeElectronCrossSection(costmin, costmax);
  G4double ratio = ecross/(cross + ecross);
 
  G4int ia = SelectIsotopeNumber(currentElement);
  G4double targetMass = G4NucleiProperties::GetNuclearMass(ia, iz);
  wokvi->SetTargetMass(targetMass);
 
  G4ThreeVector newDirection = 
    wokvi->SampleSingleScattering(costmin, costmax, ratio);
  G4double cost = newDirection.z();
    /*
      G4cout << "SampleSec: e(MeV)= " << kinEnergy/MeV   
             << " 1-costmin= " << 1-costmin
             << " 1-costmax= " << 1-costmax
             << " 1-cost= " << 1-cost
             << " ratio= " << ratio
             << G4endl;
    */
  G4ThreeVector direction = dp->GetMomentumDirection(); 
  newDirection.rotateUz(direction);   
 
  fParticleChange->ProposeMomentumDirection(newDirection);   
 
  // recoil sampling assuming a small recoil
  // and first order correction to primary 4-momentum
  G4double mom2 = wokvi->GetMomentumSquare();
  G4double trec = mom2*(1.0 - cost)
    /(targetMass + (mass + kinEnergy)*(1.0 - cost));
 
  // the check likely not needed
  trec = std::min(trec, kinEnergy);
  G4double finalT = kinEnergy - trec; 
  G4double edep = 0.0;
    /*
    G4cout<<"G4eCoulombScatteringModel: finalT= "<<finalT<<" Trec= "
      <<trec << " Z= " << iz << " A= " << ia
      << " tcut(keV)= " << (*pCuts)[currentMaterialIndex]/keV << G4endl;
    */
  G4double tcut = recoilThreshold;
  if(pCuts) { tcut= std::max(tcut,(*pCuts)[currentMaterialIndex]); }
 
  if(trec > tcut) {
    G4ParticleDefinition* ion = theIonTable->GetIon(iz, ia, 0);
    G4ThreeVector dir = (direction*sqrt(mom2) - 
             newDirection*sqrt(finalT*(2*mass + finalT))).unit();
    auto newdp = new G4DynamicParticle(ion, dir, trec);
    fvect->push_back(newdp);
  } else {
    edep = trec;
    fParticleChange->ProposeNonIonizingEnergyDeposit(edep);
  }
 
    // finelize primary energy and energy balance
    // this threshold may be applied only because for low-enegry
    // e+e- msc model is applied
  if(finalT < 0.0) { 
    edep += finalT;  
    finalT = 0.0;
  } 
  edep = std::max(edep, 0.0);
  fParticleChange->SetProposedKineticEnergy(finalT);
  fParticleChange->ProposeLocalEnergyDeposit(edep);
}

SetFixedCut()

void G4eCoulombScatteringModel::SetFixedCut ( G4double  val )

inline

Definition at line 191 of file G4eCoulombScatteringModel.hh.

{
  fixedCut = val;
}

SetLowEnergyThreshold()

void G4eCoulombScatteringModel::SetLowEnergyThreshold ( G4double  val )

inline

SetRecoilThreshold()

void G4eCoulombScatteringModel::SetRecoilThreshold ( G4double  eth )

inline

Definition at line 184 of file G4eCoulombScatteringModel.hh.

{
  recoilThreshold = eth;
}

SetupParticle()

void G4eCoulombScatteringModel::SetupParticle ( const G4ParticleDefinition *  p )

inlineprotected

Definition at line 172 of file G4eCoulombScatteringModel.hh.

{
  // Initialise mass and charge
  if(p != particle) {
    particle = p;
    mass = particle->GetPDGMass();
    wokvi->SetupParticle(p);
  }
}

Referenced by ComputeCrossSectionPerAtom(), Initialise(), MinPrimaryEnergy(), and SampleSecondaries().

---

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

• G4eCoulombScatteringModel.hh
• G4eCoulombScatteringModel.cc