#include <G4SeltzerBergerModel.hh>

Inheritance diagram for G4SeltzerBergerModel:

Public Member Functions
	G4SeltzerBergerModel (const G4ParticleDefinition *p=nullptr, const G4String &nam="eBremSB")

	~G4SeltzerBergerModel () override

void	Initialise (const G4ParticleDefinition *, const G4DataVector &) override

void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel) override

G4double	ComputeDEDXPerVolume (const G4Material , const G4ParticleDefinition , G4double ekin, G4double cutEnergy) override

G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double ekin, G4double zet, G4double, G4double cutEnergy, G4double maxEnergy=DBL_MAX) override

void	SampleSecondaries (std::vector< G4DynamicParticle * > , const G4MaterialCutsCouple , const G4DynamicParticle *, G4double cutEnergy, G4double maxEnergy) override

void	SetupForMaterial (const G4ParticleDefinition , const G4Material , G4double) override

G4double	MinPrimaryEnergy (const G4Material , const G4ParticleDefinition , G4double cutEnergy) override

void	SetBicubicInterpolationFlag (G4bool val)

G4SeltzerBergerModel &	operator= (const G4SeltzerBergerModel &right)=delete

	G4SeltzerBergerModel (const G4SeltzerBergerModel &)=delete

Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)

virtual	~G4VEmModel ()

virtual void	InitialiseForMaterial (const G4ParticleDefinition , const G4Material )

virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)

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	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	MinEnergyCut (const G4ParticleDefinition , const G4MaterialCutsCouple )

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)

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)

void	SetMasterThread (G4bool)

G4VEmModel &	operator= (const G4VEmModel &right)=delete

	G4VEmModel (const G4VEmModel &)=delete

Protected Attributes
G4ParticleChangeForLoss *	fParticleChange {nullptr}

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

Additional Inherited Members
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 *)

Detailed Description

Definition at line 69 of file G4SeltzerBergerModel.hh.

Constructor & Destructor Documentation

◆ G4SeltzerBergerModel() [1/2]

G4SeltzerBergerModel::G4SeltzerBergerModel	(	const G4ParticleDefinition *	p = nullptr,
		const G4String &	nam = "eBremSB" )

explicit

Definition at line 113 of file G4SeltzerBergerModel.cc.

  : G4VEmModel(nam), 
    fGammaParticle(G4Gamma::Gamma()),
    fLowestKinEnergy(1.0*CLHEP::keV)
{
  SetLowEnergyLimit(fLowestKinEnergy);
  SetAngularDistribution(new G4ModifiedTsai());
  if (fPrimaryParticle != p) { SetParticle(p); }
}

Referenced by G4PolarizedBremsstrahlungModel::G4PolarizedBremsstrahlungModel(), G4SeltzerBergerModel(), and operator=().

◆ ~G4SeltzerBergerModel()

G4SeltzerBergerModel::~G4SeltzerBergerModel ( )

override

Definition at line 124 of file G4SeltzerBergerModel.cc.

{
  // delete SB-DCS data per Z
  if (isInitializer) {
    for (std::size_t iz = 0; iz < gMaxZet; ++iz) {
      if (gSBDCSData[iz]) {
        delete gSBDCSData[iz];
        gSBDCSData[iz] = nullptr;
      }
    }
    if (gSBSamplingTable) {
      delete gSBSamplingTable;
      gSBSamplingTable = nullptr;
    }
  }
}

◆ G4SeltzerBergerModel() [2/2]

G4SeltzerBergerModel::G4SeltzerBergerModel ( const G4SeltzerBergerModel & )

delete

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

G4double G4SeltzerBergerModel::ComputeCrossSectionPerAtom	(	const G4ParticleDefinition *	p,
		G4double	ekin,
		G4double	zet,
		G4double	,
		G4double	cutEnergy,
		G4double	maxEnergy = DBL_MAX )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 343 of file G4SeltzerBergerModel.cc.

{
  G4double crossSection = 0.0;
  if (nullptr == fPrimaryParticle) {
    SetParticle(p);
  }
  if (kineticEnergy <= fLowestKinEnergy) {
    return crossSection;
  }
  // min/max kinetic energy limits of the DCS integration:
  const G4double tmin = std::min(cut, kineticEnergy);
  const G4double tmax = std::min(maxEnergy, kineticEnergy);
  // zero restricted x-section if e- kinetic energy is below gamma cut
  if (tmin >= tmax) {
    return crossSection;
  }
  fCurrentIZ = std::min(G4lrint(Z), gMaxZet);
  // integrate numerically (dependent part of) the DCS between the kin. limits:
  // a. integrate between tmin and kineticEnergy of the e-
  crossSection = ComputeXSectionPerAtom(tmin);
  // allow partial integration: only if maxEnergy < kineticEnergy
  // b. integrate between tmax and kineticEnergy (tmax=maxEnergy in this case)
  // (so the result in this case is the integral of DCS between tmin and
  // maxEnergy)
  if (tmax < kineticEnergy) {
    crossSection -= ComputeXSectionPerAtom(tmax);
  }
  // multiply with the constant factors: 16\alpha r_0^2/3 Z^2
  crossSection *= Z*Z*gBremFactor;
  return std::max(crossSection, 0.);
}

◆ ComputeDEDXPerVolume()

G4double G4SeltzerBergerModel::ComputeDEDXPerVolume	(	const G4Material *	material,
		const G4ParticleDefinition *	p,
		G4double	ekin,
		G4double	cutEnergy )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 262 of file G4SeltzerBergerModel.cc.

{
  G4double dedx = 0.0;
  if (nullptr == fPrimaryParticle) {
    SetParticle(p);
  }
  if (kineticEnergy <= fLowestKinEnergy) {
    return dedx;
  }
  // maximum value of the dE/dx integral (the minimum is 0 of course)
  G4double tmax = std::min(cutEnergy, kineticEnergy);
  if (tmax == 0.0) {
    return dedx;
  }
  // sets kinematical and material related variables
  SetupForMaterial(fPrimaryParticle, material, kineticEnergy);
  // get element compositions of the material
  const G4ElementVector* theElemVector = material->GetElementVector();
  const G4double* theAtomNumDensVector = material->GetAtomicNumDensityVector();
  const std::size_t numberOfElements = theElemVector->size();
  // loop over the elements of the material and compute their contributions to
  // the restricted dE/dx by numerical integration of the dependent part of DCS
  for (std::size_t ie = 0; ie < numberOfElements; ++ie) {
    G4VEmModel::SetCurrentElement((*theElemVector)[ie]);
    G4int Z = (*theElemVector)[ie]->GetZasInt();
    fCurrentIZ = std::min(Z, gMaxZet);
    dedx += (Z*Z)*theAtomNumDensVector[ie]*ComputeBremLoss(tmax);
  }
  // apply the constant factor C/Z = 16\alpha r_0^2/3
  dedx *= gBremFactor;
  return std::max(dedx, 0.);
}

◆ Initialise()

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

overridevirtual

Implements G4VEmModel.

Definition at line 141 of file G4SeltzerBergerModel.cc.

{
  // parameters in each thread
  if (fPrimaryParticle != p) {
    SetParticle(p);
  }
  fIsUseSamplingTables = G4EmParameters::Instance()->EnableSamplingTable();
  fCurrentIZ = 0;
 
  // initialise static tables for the Seltzer-Berger model
  std::call_once(applyOnce, [this]() { isInitializer = true; });
 
  if (isInitializer) {
    G4AutoLock l(&theSBMutex);
 
    // initialisation per element is done only once
    auto elemTable = G4Element::GetElementTable();
    for (auto const & elm : *elemTable) {
      G4int Z = std::max(1,std::min(elm->GetZasInt(), gMaxZet-1));
      // load SB-DCS data for this atomic number if it has not been loaded yet
      if (gSBDCSData[Z] == nullptr) ReadData(Z);
    }
 
    // init sampling tables if it was requested
    if (fIsUseSamplingTables) {
      if (nullptr == gSBSamplingTable) {
        gSBSamplingTable = new G4SBBremTable();
      }
      gSBSamplingTable->Initialize(std::max(fLowestKinEnergy, LowEnergyLimit()),
                                   HighEnergyLimit());
    }
    l.unlock();
  }
  // element selectors are initialized in the master thread
  if (IsMaster()) {
    InitialiseElementSelectors(p, cuts);
  }
  // initialisation in all threads
  if (nullptr == fParticleChange) { 
    fParticleChange = GetParticleChangeForLoss(); 
  }
  auto trmodel = GetTripletModel();
  if (nullptr != trmodel) {
    trmodel->Initialise(p, cuts);
    fIsScatOffElectron = true;
  }
}

Referenced by G4PolarizedBremsstrahlungModel::Initialise().

◆ InitialiseLocal()

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

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 190 of file G4SeltzerBergerModel.cc.

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

◆ MinPrimaryEnergy()

G4double G4SeltzerBergerModel::MinPrimaryEnergy	(	const G4Material *	,
		const G4ParticleDefinition *	,
		G4double	cutEnergy )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 238 of file G4SeltzerBergerModel.cc.

{
  return std::max(fLowestKinEnergy, cut);
}

◆ operator=()

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

delete

◆ SampleSecondaries()

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

overridevirtual

Implements G4VEmModel.

Definition at line 466 of file G4SeltzerBergerModel.cc.

{
  const G4double kinEnergy = dp->GetKineticEnergy();
  const G4double logKinEnergy = dp->GetLogKineticEnergy();
  const G4double tmin = std::min(cutEnergy, kinEnergy);
  const G4double tmax = std::min(maxEnergy, kinEnergy);
  if (tmin >= tmax) {
    return;
  }
  // set local variables and select target element
  SetupForMaterial(fPrimaryParticle, couple->GetMaterial(), kinEnergy);
  const G4Element* elm = SelectTargetAtom(couple, fPrimaryParticle, kinEnergy,
                                          logKinEnergy, tmin, tmax);
  fCurrentIZ = std::max(std::min(elm->GetZasInt(), gMaxZet-1), 1);
  //
  const G4double totMomentum = std::sqrt(kinEnergy*(kinEnergy + twoMass));
  /*
  G4cout << "G4SeltzerBergerModel::SampleSecondaries E(MeV)= "
         << kinEnergy/MeV
         << " Z= " << fCurrentIZ << " cut(MeV)= " << tmin/MeV
         << " emax(MeV)= " << tmax/MeV << " corr= " << fDensityCorr << G4endl;
  */
  // sample emitted photon energy either by rejection or from samplign tables
  const G4double gammaEnergy = !fIsUseSamplingTables
        ? SampleEnergyTransfer(kinEnergy, logKinEnergy, tmin, tmax)
        : gSBSamplingTable->SampleEnergyTransfer(kinEnergy, logKinEnergy, tmin, 
                     fDensityCorr, fCurrentIZ, couple->GetIndex(), fIsElectron);
  // should never happen under normal conditions but protect it
  if (gammaEnergy <= 0.) {
    return;
  }
  //
  // angles of the emitted gamma. ( Z - axis along the parent particle) use
  // general interface
  G4ThreeVector gamDir = GetAngularDistribution()->SampleDirection(dp,
     fPrimaryTotalEnergy-gammaEnergy, fCurrentIZ, couple->GetMaterial());
  // create G4DynamicParticle object for the emitted Gamma
  auto gamma = new G4DynamicParticle(fGammaParticle, gamDir, gammaEnergy);
  vdp->push_back(gamma);
  //
  // compute post-interaction kinematics of the primary e-/e+
  G4ThreeVector dir = 
    (totMomentum*dp->GetMomentumDirection() - gammaEnergy*gamDir).unit();
  const G4double finalE = kinEnergy - gammaEnergy;
  /*
  G4cout << "### G4SBModel: v= "
         << " Eg(MeV)= " << gammaEnergy
         << " Ee(MeV)= " << kineticEnergy
         << " DirE " << direction << " DirG " << gammaDirection
         << G4endl;
  */
  // if secondary gamma energy is higher than threshold(very high by default)
  // then stop tracking the primary particle and create new secondary e-/e+
  // instead of the primary
  if (gammaEnergy > SecondaryThreshold()) {
    fParticleChange->ProposeTrackStatus(fStopAndKill);
    fParticleChange->SetProposedKineticEnergy(0.0);
    auto el = new G4DynamicParticle(
              const_cast<G4ParticleDefinition*>(fPrimaryParticle), dir, finalE);
    vdp->push_back(el);
  } else { // continue tracking the primary e-/e+ otherwise
    fParticleChange->SetProposedMomentumDirection(dir);
    fParticleChange->SetProposedKineticEnergy(finalE);
  }
}

Referenced by G4PolarizedBremsstrahlungModel::SampleSecondaries().

◆ SetBicubicInterpolationFlag()

void G4SeltzerBergerModel::SetBicubicInterpolationFlag ( G4bool val )

inline

Definition at line 109 of file G4SeltzerBergerModel.hh.

110 { fIsUseBicubicInterpolation = val; };

◆ SetupForMaterial()

void G4SeltzerBergerModel::SetupForMaterial	(	const G4ParticleDefinition *	,
		const G4Material *	mat,
		G4double	kinEnergy )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 248 of file G4SeltzerBergerModel.cc.

{
  fDensityFactor = gMigdalConstant*mat->GetElectronDensity();
  // calculate threshold for density effect: k_p = sqrt(fDensityCorr)
  fPrimaryKinEnergy = kinEnergy;
  fPrimaryTotalEnergy = kinEnergy + CLHEP::electron_mass_c2;
  fDensityCorr = fDensityFactor*fPrimaryTotalEnergy*fPrimaryTotalEnergy;
}

Referenced by ComputeDEDXPerVolume(), and SampleSecondaries().

Member Data Documentation

◆ fParticleChange

G4ParticleChangeForLoss* G4SeltzerBergerModel::fParticleChange {nullptr}

protected

Definition at line 135 of file G4SeltzerBergerModel.hh.

135{nullptr};

Referenced by Initialise(), G4PolarizedBremsstrahlungModel::SampleSecondaries(), and SampleSecondaries().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4SeltzerBergerModel() [1/2]

◆ ~G4SeltzerBergerModel()

◆ G4SeltzerBergerModel() [2/2]

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

◆ ComputeDEDXPerVolume()

◆ Initialise()

◆ InitialiseLocal()

◆ MinPrimaryEnergy()

◆ operator=()

◆ SampleSecondaries()

◆ SetBicubicInterpolationFlag()

◆ SetupForMaterial()

Member Data Documentation

◆ fParticleChange