#include <G4PenelopePhotoElectricModel.hh>

Inheritance diagram for G4PenelopePhotoElectricModel:

Public Member Functions
	G4PenelopePhotoElectricModel (const G4ParticleDefinition *p=nullptr, const G4String &processName="PenPhotoElec")

virtual	~G4PenelopePhotoElectricModel ()

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

void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel) override

G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A=0, G4double cut=0, G4double emax=DBL_MAX) override

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

void	SetVerbosityLevel (G4int lev)

G4int	GetVerbosityLevel ()

std::size_t	GetNumberOfShellXS (G4int)

G4double	GetShellCrossSection (G4int Z, std::size_t shellID, G4double energy)

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

	G4PenelopePhotoElectricModel (const G4PenelopePhotoElectricModel &)=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 Attributes
G4ParticleChangeForGamma *	fParticleChange

const G4ParticleDefinition *	fParticle

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

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 58 of file G4PenelopePhotoElectricModel.hh.

Constructor & Destructor Documentation

◆ G4PenelopePhotoElectricModel() [1/2]

G4PenelopePhotoElectricModel::G4PenelopePhotoElectricModel	(	const G4ParticleDefinition *	p = `nullptr`,
		const G4String &	processName = `"PenPhotoElec"`
	)

explicit

Definition at line 70 of file G4PenelopePhotoElectricModel.cc.

  :G4VEmModel(nam),fParticleChange(nullptr),fParticle(nullptr),
   fAtomDeexcitation(nullptr),fIsInitialised(false),fLocalTable(false)
{
  fIntrinsicLowEnergyLimit = 100.0*eV;
  fIntrinsicHighEnergyLimit = 100.0*GeV;
  //  SetLowEnergyLimit(fIntrinsicLowEnergyLimit);
  SetHighEnergyLimit(fIntrinsicHighEnergyLimit);
  //
 
  if (part)
    SetParticle(part);
 
  fVerboseLevel= 0;
  // Verbosity scale:
  // 0 = nothing
  // 1 = warning for energy non-conservation
  // 2 = details of energy budget
  // 3 = calculation of cross sections, file openings, sampling of atoms
  // 4 = entering in methods
 
  //Mark this model as "applicable" for atomic deexcitation
  SetDeexcitationFlag(true);
 
  fTransitionManager = G4AtomicTransitionManager::Instance();
}

◆ ~G4PenelopePhotoElectricModel()

G4PenelopePhotoElectricModel::~G4PenelopePhotoElectricModel ( )

virtual

Definition at line 100 of file G4PenelopePhotoElectricModel.cc.

{
  if (IsMaster() || fLocalTable)
    {
      for(G4int i=0; i<=fMaxZ; ++i) 
    {
      if(fLogAtomicShellXS[i]) { 
        fLogAtomicShellXS[i]->clearAndDestroy();
        delete fLogAtomicShellXS[i];
        fLogAtomicShellXS[i] = nullptr;
      }
    }
    }
}

◆ G4PenelopePhotoElectricModel() [2/2]

G4PenelopePhotoElectricModel::G4PenelopePhotoElectricModel ( const G4PenelopePhotoElectricModel & )

delete

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

G4double G4PenelopePhotoElectricModel::ComputeCrossSectionPerAtom	(	const G4ParticleDefinition *	,
		G4double	kinEnergy,
		G4double	Z,
		G4double	A = `0`,
		G4double	cut = `0`,
		G4double	emax = `DBL_MAX`
	)

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 200 of file G4PenelopePhotoElectricModel.cc.

{
  //
  // Penelope model v2008
  //
  if (fVerboseLevel > 3)
    G4cout << "Calling ComputeCrossSectionPerAtom() of G4PenelopePhotoElectricModel" << G4endl;
 
  G4int iZ = G4int(Z);
 
  if (!fLogAtomicShellXS[iZ])
    {
      //If we are here, it means that Initialize() was inkoved, but the MaterialTable was
      //not filled up. This can happen in a UnitTest or via G4EmCalculator
      if (fVerboseLevel > 0)
    {
      //Issue a G4Exception (warning) only in verbose mode
      G4ExceptionDescription ed;
      ed << "Unable to retrieve the shell cross section table for Z=" << iZ << G4endl;
      ed << "This can happen only in Unit Tests or via G4EmCalculator" << G4endl;
      G4Exception("G4PenelopePhotoElectricModel::ComputeCrossSectionPerAtom()",
              "em2038",JustWarning,ed);
    }
      //protect file reading via autolock
      G4AutoLock lock(&PenelopePhotoElectricModelMutex);
      ReadDataFile(iZ);
      lock.unlock();
    }
 
  G4double cross = 0;
  G4PhysicsTable* theTable =  fLogAtomicShellXS[iZ];
  G4PhysicsFreeVector* totalXSLog = (G4PhysicsFreeVector*) (*theTable)[0];
 
   if (!totalXSLog)
     {
       G4Exception("G4PenelopePhotoElectricModel::ComputeCrossSectionPerAtom()",
           "em2039",FatalException,
           "Unable to retrieve the total cross section table");
       return 0;
     }
   G4double logene = G4Log(energy);
   G4double logXS = totalXSLog->Value(logene);
   cross = G4Exp(logXS);
 
  if (fVerboseLevel > 2)
    G4cout << "Photoelectric cross section at " << energy/MeV << " MeV for Z=" << Z <<
      " = " << cross/barn << " barn" << G4endl;
  return cross;
}

◆ GetNumberOfShellXS()

std::size_t G4PenelopePhotoElectricModel::GetNumberOfShellXS ( G4int Z )

Definition at line 618 of file G4PenelopePhotoElectricModel.cc.

{
  if (!IsMaster())
    //Should not be here!
    G4Exception("G4PenelopePhotoElectricModel::GetNumberOfShellXS()",
        "em0100",FatalException,"Worker thread in this method");
 
  //read data files
  if (!fLogAtomicShellXS[Z])
    ReadDataFile(Z);
  //now it should be ok
  if (!fLogAtomicShellXS[Z])
     {
       G4ExceptionDescription ed;
       ed << "Cannot find shell cross section data for Z=" << Z << G4endl;
       G4Exception("G4PenelopePhotoElectricModel::GetNumberOfShellXS()",
           "em2038",FatalException,ed);
     }
  //one vector is allocated for the _total_ cross section
  std::size_t nEntries = fLogAtomicShellXS[Z]->entries();
  return  (nEntries-1);
}

Referenced by GetShellCrossSection().

◆ GetShellCrossSection()

G4double G4PenelopePhotoElectricModel::GetShellCrossSection	(	G4int	Z,
		std::size_t	shellID,
		G4double	energy
	)

Definition at line 643 of file G4PenelopePhotoElectricModel.cc.

{
  //this forces also the loading of the data
  std::size_t entries = GetNumberOfShellXS(Z);
 
  if (shellID >= entries)
    {
      G4cout << "Element Z=" << Z << " has data for " << entries << " shells only" << G4endl;
      G4cout << "so shellID should be from 0 to " << entries-1 << G4endl;
      return 0;
    }
 
  G4PhysicsTable* theTable =  fLogAtomicShellXS[Z];
  //[0] is the total XS, shellID is in the element [shellID+1]
  G4PhysicsFreeVector* totalXSLog = (G4PhysicsFreeVector*) (*theTable)[shellID+1];
 
  if (!totalXSLog)
     {
       G4Exception("G4PenelopePhotoElectricModel::GetShellCrossSection()",
           "em2039",FatalException,
           "Unable to retrieve the total cross section table");
       return 0;
     }
   G4double logene = G4Log(energy);
   G4double logXS = totalXSLog->Value(logene);
   G4double cross = G4Exp(logXS);
   if (cross < 2e-40*cm2) cross = 0;
   return cross;
}

◆ GetVerbosityLevel()

G4int G4PenelopePhotoElectricModel::GetVerbosityLevel ( )

inline

Definition at line 84 of file G4PenelopePhotoElectricModel.hh.

84{return fVerboseLevel;};

◆ Initialise()

void G4PenelopePhotoElectricModel::Initialise	(	const G4ParticleDefinition *	particle,
		const G4DataVector &	cuts
	)

overridevirtual

Implements G4VEmModel.

Definition at line 117 of file G4PenelopePhotoElectricModel.cc.

{
  if (fVerboseLevel > 3)
    G4cout << "Calling  G4PenelopePhotoElectricModel::Initialise()" << G4endl;
 
  fAtomDeexcitation = G4LossTableManager::Instance()->AtomDeexcitation();
  //Issue warning if the AtomicDeexcitation has not been declared
  if (!fAtomDeexcitation)
    {
      G4cout << G4endl;
      G4cout << "WARNING from G4PenelopePhotoElectricModel " << G4endl;
      G4cout << "Atomic de-excitation module is not instantiated, so there will not be ";
      G4cout << "any fluorescence/Auger emission." << G4endl;
      G4cout << "Please make sure this is intended" << G4endl;
    }
 
  SetParticle(particle);
 
  //Only the master model creates/fills/destroys the tables
  if (IsMaster() && particle == fParticle)
    {
      G4ProductionCutsTable* theCoupleTable =
    G4ProductionCutsTable::GetProductionCutsTable();
 
      for (G4int i=0;i<(G4int)theCoupleTable->GetTableSize();++i)
    {
      const G4Material* material =
        theCoupleTable->GetMaterialCutsCouple(i)->GetMaterial();
      const G4ElementVector* theElementVector = material->GetElementVector();
 
      for (std::size_t j=0;j<material->GetNumberOfElements();++j)
        {
          G4int iZ = theElementVector->at(j)->GetZasInt();
          //read data files only in the master
          if (!fLogAtomicShellXS[iZ])
        ReadDataFile(iZ);
        }
    }
 
      InitialiseElementSelectors(particle,cuts);
 
      if (fVerboseLevel > 0) {
    G4cout << "Penelope Photo-Electric model v2008 is initialized " << G4endl
           << "Energy range: "
           << LowEnergyLimit() / MeV << " MeV - "
           << HighEnergyLimit() / GeV << " GeV";
      }
    }
 
  if(fIsInitialised) return;
  fParticleChange = GetParticleChangeForGamma();
  fIsInitialised = true;
 
}

◆ InitialiseLocal()

void G4PenelopePhotoElectricModel::InitialiseLocal	(	const G4ParticleDefinition *	part,
		G4VEmModel *	masterModel
	)

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 173 of file G4PenelopePhotoElectricModel.cc.

{
  if (fVerboseLevel > 3)
    G4cout << "Calling  G4PenelopePhotoElectricModel::InitialiseLocal()" << G4endl;
  //
  //Check that particle matches: one might have multiple master models (e.g.
  //for e+ and e-).
  //
  if (part == fParticle)
    {
      SetElementSelectors(masterModel->GetElementSelectors());
 
      //Get the const table pointers from the master to the workers
      const G4PenelopePhotoElectricModel* theModel =
    static_cast<G4PenelopePhotoElectricModel*> (masterModel);
      for(G4int i=0; i<=fMaxZ; ++i) 
    fLogAtomicShellXS[i] = theModel->fLogAtomicShellXS[i];
      //Same verbosity for all workers, as the master
      fVerboseLevel = theModel->fVerboseLevel;
    }
 
 return;
}

◆ operator=()

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

delete

◆ SampleSecondaries()

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

overridevirtual

Implements G4VEmModel.

Definition at line 256 of file G4PenelopePhotoElectricModel.cc.

{
  //
  // Photoelectric effect, Penelope model v2008
  //
  // The target atom and the target shell are sampled according to the Livermore
  // database
  //  D.E. Cullen et al., Report UCRL-50400 (1989)
  // The angular distribution of the electron in the final state is sampled
  // according to the Sauter distribution from
  //  F. Sauter, Ann. Phys. 11 (1931) 454
  // The energy of the final electron is given by the initial photon energy minus
  // the binding energy. Fluorescence de-excitation is subsequently produced
  // (to fill the vacancy) according to the general Geant4 G4DeexcitationManager:
  //  J. Stepanek, Comp. Phys. Comm. 1206 pp 1-1-9 (1997)
 
  if (fVerboseLevel > 3)
    G4cout << "Calling SamplingSecondaries() of G4PenelopePhotoElectricModel" << G4endl;
 
  G4double photonEnergy = aDynamicGamma->GetKineticEnergy();
 
  // always kill primary
  fParticleChange->ProposeTrackStatus(fStopAndKill);
  fParticleChange->SetProposedKineticEnergy(0.);
 
  if (photonEnergy <= fIntrinsicLowEnergyLimit)
    {
      fParticleChange->ProposeLocalEnergyDeposit(photonEnergy);
      return ;
    }
 
  G4ParticleMomentum photonDirection = aDynamicGamma->GetMomentumDirection();
 
  // Select randomly one element in the current material
  if (fVerboseLevel > 2)
    G4cout << "Going to select element in " << couple->GetMaterial()->GetName() << G4endl;
 
  // atom can be selected efficiently if element selectors are initialised
  const G4Element* anElement =
    SelectRandomAtom(couple,G4Gamma::GammaDefinition(),photonEnergy);
  G4int Z = anElement->GetZasInt();
  if (fVerboseLevel > 2)
    G4cout << "Selected " << anElement->GetName() << G4endl;
 
  // Select the ionised shell in the current atom according to shell cross sections
  //shellIndex = 0 --> K shell
  //             1-3 --> L shells
  //             4-8 --> M shells
  //             9 --> outer shells cumulatively
  //
  std::size_t shellIndex = SelectRandomShell(Z,photonEnergy);
 
  if (fVerboseLevel > 2)
    G4cout << "Selected shell " << shellIndex << " of element " << anElement->GetName() << G4endl;
 
  // Retrieve the corresponding identifier and binding energy of the selected shell
  const G4AtomicTransitionManager* transitionManager = G4AtomicTransitionManager::Instance();
 
  //The number of shell cross section possibly reported in the Penelope database
  //might be different from the number of shells in the G4AtomicTransitionManager
  //(namely, Penelope may contain more shell, especially for very light elements).
  //In order to avoid a warning message from the G4AtomicTransitionManager, I
  //add this protection. Results are anyway changed, because when G4AtomicTransitionManager
  //has a shellID>maxID, it sets the shellID to the last valid shell.
  std::size_t numberOfShells = (std::size_t) transitionManager->NumberOfShells(Z);
  if (shellIndex >= numberOfShells)
    shellIndex = numberOfShells-1;
 
  const G4AtomicShell* shell = fTransitionManager->Shell(Z,shellIndex);
  G4double bindingEnergy = shell->BindingEnergy();
 
  //Penelope considers only K, L and M shells. Cross sections of outer shells are
  //not included in the Penelope database. If SelectRandomShell() returns
  //shellIndex = 9, it means that an outer shell was ionized. In this case the
  //Penelope recipe is to set bindingEnergy = 0 (the energy is entirely assigned
  //to the electron) and to disregard fluorescence.
  if (shellIndex == 9)
    bindingEnergy = 0.*eV;
 
  G4double localEnergyDeposit = 0.0;
  G4double cosTheta = 1.0;
 
  // Primary outcoming electron
  G4double eKineticEnergy = photonEnergy - bindingEnergy;
 
  // There may be cases where the binding energy of the selected shell is > photon energy
  // In such cases do not generate secondaries
  if (eKineticEnergy > 0.)
    {
      // The electron is created
      // Direction sampled from the Sauter distribution
      cosTheta = SampleElectronDirection(eKineticEnergy);
      G4double sinTheta = std::sqrt(1-cosTheta*cosTheta);
      G4double phi = twopi * G4UniformRand() ;
      G4double dirx = sinTheta * std::cos(phi);
      G4double diry = sinTheta * std::sin(phi);
      G4double dirz = cosTheta ;
      G4ThreeVector electronDirection(dirx,diry,dirz); //electron direction
      electronDirection.rotateUz(photonDirection);
      G4DynamicParticle* electron = new G4DynamicParticle (G4Electron::Electron(),
                               electronDirection,
                               eKineticEnergy);
      fvect->push_back(electron);
    }
  else
    bindingEnergy = photonEnergy;
 
  G4double energyInFluorescence = 0; //testing purposes
  G4double energyInAuger = 0; //testing purposes
 
  //Now, take care of fluorescence, if required. According to the Penelope
  //recipe, I have to skip fluoresence completely if shellIndex == 9
  //(= sampling of a shell outer than K,L,M)
  if (fAtomDeexcitation && shellIndex<9)
    {
      G4int index = couple->GetIndex();
      if (fAtomDeexcitation->CheckDeexcitationActiveRegion(index))
    {
      std::size_t nBefore = fvect->size();
      fAtomDeexcitation->GenerateParticles(fvect,shell,Z,index);
      std::size_t nAfter = fvect->size();
 
      if (nAfter > nBefore) //actual production of fluorescence
        {
          for (std::size_t j=nBefore;j<nAfter;++j) //loop on products
        {
          G4double itsEnergy = ((*fvect)[j])->GetKineticEnergy();
          if (itsEnergy < bindingEnergy) // valid secondary, generate it
            {
              bindingEnergy -= itsEnergy;
              if (((*fvect)[j])->GetParticleDefinition() == G4Gamma::Definition())
            energyInFluorescence += itsEnergy;
              else if (((*fvect)[j])->GetParticleDefinition() == G4Electron::Definition())
            energyInAuger += itsEnergy;
            }
          else //invalid secondary: takes more than the available energy: delete it
            {
              delete (*fvect)[j];
              (*fvect)[j] = nullptr;
            }           
        }
        }
    }
    }
 
  //Residual energy is deposited locally
  localEnergyDeposit += bindingEnergy;
 
  if (localEnergyDeposit < 0) //Should not be: issue a G4Exception (warning)
    {
      G4Exception("G4PenelopePhotoElectricModel::SampleSecondaries()",
          "em2099",JustWarning,"WARNING: Negative local energy deposit");
      localEnergyDeposit = 0;
    }
 
  fParticleChange->ProposeLocalEnergyDeposit(localEnergyDeposit);
 
  if (fVerboseLevel > 1)
    {
      G4cout << "-----------------------------------------------------------" << G4endl;
      G4cout << "Energy balance from G4PenelopePhotoElectric" << G4endl;
      G4cout << "Selected shell: " << WriteTargetShell(shellIndex) << " of element " <<
    anElement->GetName() << G4endl;
      G4cout << "Incoming photon energy: " << photonEnergy/keV << " keV" << G4endl;
      G4cout << "-----------------------------------------------------------" << G4endl;
      if (eKineticEnergy)
    G4cout << "Outgoing electron " << eKineticEnergy/keV << " keV" << G4endl;
      if (energyInFluorescence)
    G4cout << "Fluorescence x-rays: " << energyInFluorescence/keV << " keV" << G4endl;
      if (energyInAuger)
    G4cout << "Auger electrons: " << energyInAuger/keV << " keV" << G4endl;
      G4cout << "Local energy deposit " << localEnergyDeposit/keV << " keV" << G4endl;
      G4cout << "Total final state: " <<
    (eKineticEnergy+energyInFluorescence+localEnergyDeposit+energyInAuger)/keV <<
    " keV" << G4endl;
      G4cout << "-----------------------------------------------------------" << G4endl;
    }
  if (fVerboseLevel > 0)
    {
      G4double energyDiff =
    std::fabs(eKineticEnergy+energyInFluorescence+localEnergyDeposit+energyInAuger-photonEnergy);
      if (energyDiff > 0.05*keV)
    {
      G4cout << "Warning from G4PenelopePhotoElectric: problem with energy conservation: " <<
        (eKineticEnergy+energyInFluorescence+localEnergyDeposit+energyInAuger)/keV
         << " keV (final) vs. " <<
        photonEnergy/keV << " keV (initial)" << G4endl;
      G4cout << "-----------------------------------------------------------" << G4endl;
      G4cout << "Energy balance from G4PenelopePhotoElectric" << G4endl;
      G4cout << "Selected shell: " << WriteTargetShell(shellIndex) << " of element " <<
        anElement->GetName() << G4endl;
      G4cout << "Incoming photon energy: " << photonEnergy/keV << " keV" << G4endl;
      G4cout << "-----------------------------------------------------------" << G4endl;
      if (eKineticEnergy)
        G4cout << "Outgoing electron " << eKineticEnergy/keV << " keV" << G4endl;
      if (energyInFluorescence)
        G4cout << "Fluorescence x-rays: " << energyInFluorescence/keV << " keV" << G4endl;
      if (energyInAuger)
        G4cout << "Auger electrons: " << energyInAuger/keV << " keV" << G4endl;
      G4cout << "Local energy deposit " << localEnergyDeposit/keV << " keV" << G4endl;
      G4cout << "Total final state: " <<
        (eKineticEnergy+energyInFluorescence+localEnergyDeposit+energyInAuger)/keV <<
        " keV" << G4endl;
      G4cout << "-----------------------------------------------------------" << G4endl;
    }
    }
}

◆ SetVerbosityLevel()

void G4PenelopePhotoElectricModel::SetVerbosityLevel ( G4int lev )

inline

Definition at line 83 of file G4PenelopePhotoElectricModel.hh.

83{fVerboseLevel = lev;};

Member Data Documentation

◆ fParticle

const G4ParticleDefinition* G4PenelopePhotoElectricModel::fParticle

protected

Definition at line 95 of file G4PenelopePhotoElectricModel.hh.

Referenced by Initialise(), and InitialiseLocal().

◆ fParticleChange

G4ParticleChangeForGamma* G4PenelopePhotoElectricModel::fParticleChange

protected

Definition at line 94 of file G4PenelopePhotoElectricModel.hh.

Referenced by Initialise(), 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

◆ G4PenelopePhotoElectricModel() [1/2]

◆ ~G4PenelopePhotoElectricModel()

◆ G4PenelopePhotoElectricModel() [2/2]

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

◆ GetNumberOfShellXS()

◆ GetShellCrossSection()

◆ GetVerbosityLevel()

◆ Initialise()

◆ InitialiseLocal()

◆ operator=()

◆ SampleSecondaries()

◆ SetVerbosityLevel()

Member Data Documentation

◆ fParticle

◆ fParticleChange