G4VAtomDeexcitation Class Reference

#include <G4VAtomDeexcitation.hh>

Inheritance diagram for G4VAtomDeexcitation:

Public Member Functions
	G4VAtomDeexcitation (const G4String &modname="Deexcitation", const G4String &pixename="")
virtual	~G4VAtomDeexcitation ()
void	InitialiseAtomicDeexcitation ()
virtual void	InitialiseForNewRun ()=0
virtual void	InitialiseForExtraAtom (G4int Z)=0
void	SetDeexcitationActiveRegion (const G4String &rname, G4bool valDeexcitation, G4bool valAuger, G4bool valPIXE)
void	SetFluo (G4bool)
G4bool	IsFluoActive () const
void	SetAuger (G4bool)
G4bool	IsAugerActive () const
void	SetPIXE (G4bool)
G4bool	IsPIXEActive () const
const G4String &	GetName () const
void	SetPIXECrossSectionModel (const G4String &)
const G4String &	PIXECrossSectionModel () const
void	SetPIXEElectronCrossSectionModel (const G4String &)
const G4String &	PIXEElectronCrossSectionModel () const
const std::vector< G4bool > &	GetListOfActiveAtoms () const
void	SetVerboseLevel (G4int)
G4int	GetVerboseLevel () const
G4bool	CheckDeexcitationActiveRegion (G4int coupleIndex)
G4bool	CheckAugerActiveRegion (G4int coupleIndex)
virtual const G4AtomicShell *	GetAtomicShell (G4int Z, G4AtomicShellEnumerator shell)=0
void	GenerateParticles (std::vector< G4DynamicParticle * > *secVect, const G4AtomicShell *, G4int Z, G4int coupleIndex)
virtual void	GenerateParticles (std::vector< G4DynamicParticle * > *secVect, const G4AtomicShell *, G4int Z, G4double gammaCut, G4double eCut)=0
virtual G4double	GetShellIonisationCrossSectionPerAtom (const G4ParticleDefinition *, G4int Z, G4AtomicShellEnumerator shell, G4double kinE, const G4Material *mat=0)=0
virtual G4double	ComputeShellIonisationCrossSectionPerAtom (const G4ParticleDefinition *, G4int Z, G4AtomicShellEnumerator shell, G4double kinE, const G4Material *mat=0)=0
void	AlongStepDeexcitation (std::vector< G4Track * > &tracks, const G4Step &step, G4double &eLoss, G4int coupleIndex)

Detailed Description

Definition at line 63 of file G4VAtomDeexcitation.hh.

Constructor & Destructor Documentation

G4VAtomDeexcitation::G4VAtomDeexcitation	(	const G4String &	modname = "Deexcitation",
		const G4String &	pixename = ""
	)

Definition at line 70 of file G4VAtomDeexcitation.cc.

References G4Gamma::Gamma(), and G4PhysicsModelCatalog::Register().

  : lowestKinEnergy(keV), verbose(1), name(modname), namePIXE(pname), 
    nameElectronPIXE(""), isActive(false), flagAuger(false), flagPIXE(false)
{
  vdyn.reserve(5);
  theCoupleTable = 0;
  G4String gg = "gammaPIXE";
  G4String ee = "e-PIXE";
  if(pixeIDg < 0) { pixeIDg = G4PhysicsModelCatalog::Register(gg); }
  if(pixeIDe < 0) { pixeIDe = G4PhysicsModelCatalog::Register(ee); }
  gamma = G4Gamma::Gamma();
}

G4VAtomDeexcitation::~G4VAtomDeexcitation ( )

virtual

Definition at line 86 of file G4VAtomDeexcitation.cc.

{}

Member Function Documentation

void G4VAtomDeexcitation::AlongStepDeexcitation	(	std::vector< G4Track * > &	tracks,
		const G4Step &	step,
		G4double &	eLoss,
		G4int	coupleIndex
	)

Definition at line 208 of file G4VAtomDeexcitation.cc.

References G4InuclSpecialFunctions::bindingEnergy(), G4AtomicShell::BindingEnergy(), CheckAugerActiveRegion(), DBL_MAX, G4lrint(), G4UniformRand, GenerateParticles(), GetAtomicShell(), G4Track::GetDefinition(), G4DynamicParticle::GetDefinition(), G4Material::GetElementVector(), G4ProductionCutsTable::GetEnergyCutsVector(), G4StepPoint::GetGlobalTime(), G4StepPoint::GetKineticEnergy(), G4DynamicParticle::GetKineticEnergy(), G4StepPoint::GetMaterial(), G4Material::GetNumberOfElements(), G4StepPoint::GetPosition(), G4Step::GetPostStepPoint(), G4Step::GetPreStepPoint(), GetShellIonisationCrossSectionPerAtom(), G4Step::GetStepLength(), G4Step::GetTrack(), G4Material::GetVecNbOfAtomsPerVolume(), eplot::material, G4INCL::Math::min(), and G4Track::SetCreatorModelIndex().

Referenced by G4VEnergyLossProcess::AlongStepDoIt().

{
  G4double truelength = step.GetStepLength();
  if(!flagPIXE && !activePIXEMedia[coupleIndex]) { return; }
  if(eLossMax <= 0.0 || truelength <= 0.0)       { return; }

  // step parameters
  const G4StepPoint* preStep = step.GetPreStepPoint();
  G4ThreeVector prePos = preStep->GetPosition();
  G4ThreeVector delta = step.GetPostStepPoint()->GetPosition() - prePos;
  G4double preTime = preStep->GetGlobalTime();
  G4double dt = step.GetPostStepPoint()->GetGlobalTime() - preTime;

  // particle parameters
  const G4Track* track = step.GetTrack();
  const G4ParticleDefinition* part = track->GetDefinition();
  G4double ekin = preStep->GetKineticEnergy(); 

  // media parameters
  G4double gCut = (*theCoupleTable->GetEnergyCutsVector(0))[coupleIndex];
  G4double eCut = DBL_MAX;
  if(CheckAugerActiveRegion(coupleIndex)) { 
    eCut = (*theCoupleTable->GetEnergyCutsVector(1))[coupleIndex];
  }

  //G4cout<<"!Sample PIXE gCut(MeV)= "<<gCut<<"  eCut(MeV)= "<<eCut
  //    <<" Ekin(MeV)= " << ekin/MeV << G4endl;

  const G4Material* material = preStep->GetMaterial();
  const G4ElementVector* theElementVector = material->GetElementVector();
  const G4double* theAtomNumDensityVector = 
    material->GetVecNbOfAtomsPerVolume();
  G4int nelm = material->GetNumberOfElements();

  // loop over deexcitations
  for(G4int i=0; i<nelm; ++i) {
    G4int Z = G4lrint((*theElementVector)[i]->GetZ());
    if(activeZ[Z] && Z < 93) {  
      G4int nshells = 
    std::min(9,(*theElementVector)[i]->GetNbOfAtomicShells());
      G4double rho = truelength*theAtomNumDensityVector[i];
      //G4cout<<"   Z "<< Z <<" is active  x(mm)= " << truelength/mm << G4endl;
      for(G4int ii=0; ii<nshells; ++ii) {
    G4AtomicShellEnumerator as = G4AtomicShellEnumerator(ii);
    const G4AtomicShell* shell = GetAtomicShell(Z, as);
    G4double bindingEnergy = shell->BindingEnergy();

    if(gCut > bindingEnergy) { break; }

    if(eLossMax > bindingEnergy) { 
      G4double sig = rho*
        GetShellIonisationCrossSectionPerAtom(part, Z, as, ekin, material);

      // mfp is mean free path in units of step size
      if(sig > 0.0) {
        G4double mfp = 1.0/sig;
        G4double stot = 0.0;
        //G4cout << " Shell " << ii << " mfp(mm)= " << mfp/mm << G4endl;
        // sample ionisation points
        do {
          stot -= mfp*std::log(G4UniformRand());
          if( stot > 1.0 || eLossMax < bindingEnergy) { break; }
          // sample deexcitation
          vdyn.clear();
          GenerateParticles(&vdyn, shell, Z, gCut, eCut); 
          G4int nsec = vdyn.size();
          if(nsec > 0) {
        G4ThreeVector r = prePos  + stot*delta;
        G4double time   = preTime + stot*dt;
        for(G4int j=0; j<nsec; ++j) {
          G4DynamicParticle* dp = vdyn[j];
          G4double e = dp->GetKineticEnergy();

          // save new secondary if there is enough energy
          if(eLossMax >= e) {
            eLossMax -= e;          
            G4Track* t = new G4Track(dp, time, r);

            // defined secondary type
                    if(dp->GetDefinition() == gamma) { 
              t->SetCreatorModelIndex(pixeIDg);
            } else {
              t->SetCreatorModelIndex(pixeIDe);
            }

            tracks.push_back(t);
          } else {
            delete dp;
          }
        }
          }
        } while (stot < 1.0);
      }
    }
      }
    } 
  }
  return;
}

G4bool G4VAtomDeexcitation::CheckAugerActiveRegion ( G4int  coupleIndex )

inline

Definition at line 282 of file G4VAtomDeexcitation.hh.

Referenced by AlongStepDeexcitation(), and GenerateParticles().

{

  return (flagAuger || activeAugerMedia[coupleIndex]);
}

G4bool G4VAtomDeexcitation::CheckDeexcitationActiveRegion ( G4int  coupleIndex )

inline

Definition at line 276 of file G4VAtomDeexcitation.hh.

Referenced by G4LivermorePolarizedPhotoElectricModel::SampleSecondaries(), G4LivermoreComptonModifiedModel::SampleSecondaries(), G4LivermorePhotoElectricModel::SampleSecondaries(), G4LivermoreComptonModel::SampleSecondaries(), G4KleinNishinaModel::SampleSecondaries(), G4PenelopePhotoElectricModel::SampleSecondaries(), G4PEEffectFluoModel::SampleSecondaries(), G4PenelopeComptonModel::SampleSecondaries(), G4PenelopeIonisationModel::SampleSecondaries(), and G4LowEPComptonModel::SampleSecondaries().

{
  return (isActive || activeDeexcitationMedia[coupleIndex]);
}

virtual G4double G4VAtomDeexcitation::ComputeShellIonisationCrossSectionPerAtom ( const G4ParticleDefinition *  , G4int  Z, G4AtomicShellEnumerator  shell, G4double  kinE, const G4Material *  mat = 0  )

pure virtual

Implemented in G4UAtomicDeexcitation.

Referenced by G4EmCalculator::ComputeShellIonisationCrossSectionPerAtom().

void G4VAtomDeexcitation::GenerateParticles ( std::vector< G4DynamicParticle * > *  secVect, const G4AtomicShell *  as, G4int  Z, G4int  coupleIndex  )

inline

Definition at line 289 of file G4VAtomDeexcitation.hh.

References CheckAugerActiveRegion(), DBL_MAX, and G4ProductionCutsTable::GetEnergyCutsVector().

Referenced by AlongStepDeexcitation(), G4NuclearDecayChannel::DecayIt(), G4LivermorePolarizedPhotoElectricModel::SampleSecondaries(), G4DNARuddIonisationExtendedModel::SampleSecondaries(), G4DNARuddIonisationModel::SampleSecondaries(), G4DNABornIonisationModel::SampleSecondaries(), G4LivermoreComptonModifiedModel::SampleSecondaries(), G4LivermorePhotoElectricModel::SampleSecondaries(), G4LivermoreComptonModel::SampleSecondaries(), G4KleinNishinaModel::SampleSecondaries(), G4PenelopePhotoElectricModel::SampleSecondaries(), G4MicroElecInelasticModel::SampleSecondaries(), G4MuElecInelasticModel::SampleSecondaries(), G4PEEffectFluoModel::SampleSecondaries(), G4PenelopeComptonModel::SampleSecondaries(), G4PenelopeIonisationModel::SampleSecondaries(), and G4LowEPComptonModel::SampleSecondaries().

{
  G4double gCut = DBL_MAX;
  if (theCoupleTable) {
    gCut = (*(theCoupleTable->GetEnergyCutsVector(0)))[idx];
  }
  if(gCut < as->BindingEnergy()) {
    G4double eCut = DBL_MAX;
    if(CheckAugerActiveRegion(idx)) {
      if (theCoupleTable) {
    eCut = (*(theCoupleTable->GetEnergyCutsVector(1)))[idx];
      }
    }
    GenerateParticles(v, as, Z, gCut, eCut);
  }
}

virtual void G4VAtomDeexcitation::GenerateParticles ( std::vector< G4DynamicParticle * > *  secVect, const G4AtomicShell *  , G4int  Z, G4double  gammaCut, G4double  eCut  )

pure virtual

Implemented in G4UAtomicDeexcitation.

virtual const G4AtomicShell* G4VAtomDeexcitation::GetAtomicShell ( G4int  Z, G4AtomicShellEnumerator  shell  )

pure virtual

Implemented in G4UAtomicDeexcitation.

Referenced by AlongStepDeexcitation(), G4NuclearDecayChannel::DecayIt(), G4LivermorePolarizedPhotoElectricModel::SampleSecondaries(), G4DNARuddIonisationExtendedModel::SampleSecondaries(), G4DNARuddIonisationModel::SampleSecondaries(), G4DNABornIonisationModel::SampleSecondaries(), G4LivermoreComptonModifiedModel::SampleSecondaries(), G4LivermorePhotoElectricModel::SampleSecondaries(), G4LivermoreComptonModel::SampleSecondaries(), G4KleinNishinaModel::SampleSecondaries(), G4MicroElecInelasticModel::SampleSecondaries(), G4MuElecInelasticModel::SampleSecondaries(), G4PEEffectFluoModel::SampleSecondaries(), and G4LowEPComptonModel::SampleSecondaries().

const std::vector< G4bool > & G4VAtomDeexcitation::GetListOfActiveAtoms ( ) const

inline

Definition at line 260 of file G4VAtomDeexcitation.hh.

{
  return activeZ;
}

const G4String & G4VAtomDeexcitation::GetName ( void  ) const

inline

Definition at line 230 of file G4VAtomDeexcitation.hh.

{
  return name;
}

virtual G4double G4VAtomDeexcitation::GetShellIonisationCrossSectionPerAtom ( const G4ParticleDefinition *  , G4int  Z, G4AtomicShellEnumerator  shell, G4double  kinE, const G4Material *  mat = 0  )

pure virtual

Implemented in G4UAtomicDeexcitation.

Referenced by AlongStepDeexcitation(), and G4EmCalculator::GetShellIonisationCrossSectionPerAtom().

G4int G4VAtomDeexcitation::GetVerboseLevel ( ) const

inline

Definition at line 270 of file G4VAtomDeexcitation.hh.

{
  return verbose;
}

void G4VAtomDeexcitation::InitialiseAtomicDeexcitation

(

)

Definition at line 91 of file G4VAtomDeexcitation.cc.

References G4cout, G4endl, G4lrint(), G4Material::GetElementVector(), G4RegionStore::GetInstance(), G4MaterialCutsCouple::GetMaterial(), G4ProductionCutsTable::GetMaterialCutsCouple(), G4Material::GetNumberOfElements(), G4MaterialCutsCouple::GetProductionCuts(), G4Region::GetProductionCuts(), G4ProductionCutsTable::GetProductionCutsTable(), G4RegionStore::GetRegion(), G4ProductionCutsTable::GetTableSize(), InitialiseForNewRun(), IsPIXEActive(), and SetDeexcitationActiveRegion().

Referenced by G4LossTableManager::BuildPhysicsTable(), G4RadioactiveDecay::BuildPhysicsTable(), and G4LossTableManager::LocalPhysicsTables().

{
  // Define list of couples
  theCoupleTable = G4ProductionCutsTable::GetProductionCutsTable();
  size_t numOfCouples = theCoupleTable->GetTableSize();

  // needed for unit tests
  if(0 == numOfCouples) { numOfCouples = 1; }

  activeDeexcitationMedia.resize(numOfCouples, false);
  activeAugerMedia.resize(numOfCouples, false);
  activePIXEMedia.resize(numOfCouples, false);
  activeZ.resize(93, false);

  // check if deexcitation is active for the given run
  if( !isActive ) { return; }

  // Define list of regions
  size_t nRegions = deRegions.size();

  if(0 == nRegions) {
    SetDeexcitationActiveRegion("World",isActive,flagAuger,flagPIXE);
    nRegions = 1;
  }

  if(0 < verbose) {
    G4cout << G4endl;
    G4cout << "### ===  Deexcitation model " << name 
       << " is activated for " << nRegions;
    if(1 == nRegions) { G4cout << " region:" << G4endl; }
    else              { G4cout << " regions:" << G4endl;}
  }

  // Identify active media
  G4RegionStore* regionStore = G4RegionStore::GetInstance();
  for(size_t j=0; j<nRegions; ++j) {
    const G4Region* reg = regionStore->GetRegion(activeRegions[j], false);
    const G4ProductionCuts* rpcuts = reg->GetProductionCuts();
    if(0 < verbose) {
      G4cout << "          " << activeRegions[j] << G4endl;  
    }
  
    for(size_t i=0; i<numOfCouples; ++i) {
      const G4MaterialCutsCouple* couple =
    theCoupleTable->GetMaterialCutsCouple(i);
      if (couple->GetProductionCuts() == rpcuts) {
    activeDeexcitationMedia[i] = deRegions[j];
    activeAugerMedia[i] = AugerRegions[j];
    activePIXEMedia[i] = PIXERegions[j];
    const G4Material* mat = couple->GetMaterial();
    const G4ElementVector* theElementVector = 
      mat->GetElementVector();
    G4int nelm = mat->GetNumberOfElements();
    if(deRegions[j]) {
      for(G4int k=0; k<nelm; ++k) {
        G4int Z = G4lrint(((*theElementVector)[k])->GetZ());
        if(Z > 5 && Z < 93) { 
          activeZ[Z] = true;
          //G4cout << "!!! Active de-excitation Z= " << Z << G4endl;  
        }
      }
    }
      }
    }
  }

  // Initialise derived class
  InitialiseForNewRun();

  if(0 < verbose && flagPIXE) {
    G4cout << "### ===  PIXE model for hadrons: " << namePIXE
       << "  " <<  IsPIXEActive()
       << G4endl;  
    G4cout << "### ===  PIXE model for e+-:     " << nameElectronPIXE
       << "  " <<  IsPIXEActive()
       << G4endl;  
  }
}

virtual void G4VAtomDeexcitation::InitialiseForExtraAtom ( G4int  Z )

pure virtual

Implemented in G4UAtomicDeexcitation.

virtual void G4VAtomDeexcitation::InitialiseForNewRun ( )

pure virtual

Implemented in G4UAtomicDeexcitation.

Referenced by InitialiseAtomicDeexcitation().

G4bool G4VAtomDeexcitation::IsAugerActive ( ) const

inline

Definition at line 214 of file G4VAtomDeexcitation.hh.

{
  return flagAuger;
}

G4bool G4VAtomDeexcitation::IsFluoActive ( ) const

inline

Definition at line 203 of file G4VAtomDeexcitation.hh.

Referenced by G4NuclearDecayChannel::DecayIt(), G4LivermorePolarizedPhotoElectricModel::Initialise(), G4LivermorePhotoElectricModel::Initialise(), and G4UAtomicDeexcitation::InitialiseForNewRun().

{
  return isActive;
}

G4bool G4VAtomDeexcitation::IsPIXEActive ( ) const

inline

Definition at line 225 of file G4VAtomDeexcitation.hh.

Referenced by G4VEnergyLossProcess::BuildPhysicsTable(), InitialiseAtomicDeexcitation(), and G4UAtomicDeexcitation::InitialiseForNewRun().

{
  return flagPIXE;
}

const G4String & G4VAtomDeexcitation::PIXECrossSectionModel ( ) const

inline

Definition at line 248 of file G4VAtomDeexcitation.hh.

Referenced by G4UAtomicDeexcitation::InitialiseForNewRun().

{
  return namePIXE;
}

const G4String & G4VAtomDeexcitation::PIXEElectronCrossSectionModel ( ) const

inline

Definition at line 254 of file G4VAtomDeexcitation.hh.

Referenced by G4UAtomicDeexcitation::InitialiseForNewRun().

{
  return nameElectronPIXE;
}

void G4VAtomDeexcitation::SetAuger ( G4bool  val )

inline

Definition at line 208 of file G4VAtomDeexcitation.hh.

Referenced by G4EmProcessOptions::SetAuger().

{
  flagAuger = val;
  if(val) { isActive = true; }
}

void G4VAtomDeexcitation::SetDeexcitationActiveRegion	(	const G4String &	rname,
		G4bool	valDeexcitation,
		G4bool	valAuger,
		G4bool	valPIXE
	)

Definition at line 173 of file G4VAtomDeexcitation.cc.

References n.

Referenced by InitialiseAtomicDeexcitation(), and G4EmProcessOptions::SetDeexcitationActiveRegion().

{
  G4String ss = rname;
  //G4cout << "### G4VAtomDeexcitation::SetDeexcitationActiveRegion " << ss 
  //     << "  " << valDeexcitation << "  " << valAuger
  //     << "  " << valPIXE << G4endl;
  if(ss == "world" || ss == "World" || ss == "WORLD") {
    ss = "DefaultRegionForTheWorld";
  }
  size_t n = deRegions.size();
  if(n > 0) {
    for(size_t i=0; i<n; ++i) {
 
      // Region already exist
      if(ss == activeRegions[i]) {
    deRegions[i] = valDeexcitation;
    AugerRegions[i] = valAuger;
    PIXERegions[i] = valPIXE;
    return; 
      } 
    }
  }
  // New region
  activeRegions.push_back(ss);
  deRegions.push_back(valDeexcitation);
  AugerRegions.push_back(valAuger);
  PIXERegions.push_back(valPIXE);
}

void G4VAtomDeexcitation::SetFluo ( G4bool  val )

inline

Definition at line 198 of file G4VAtomDeexcitation.hh.

Referenced by G4EmLivermorePolarizedPhysics::ConstructProcess(), G4EmLowEPPhysics::ConstructProcess(), G4EmPenelopePhysics::ConstructProcess(), G4EmLivermorePhysics::ConstructProcess(), G4EmDNAPhysics::ConstructProcess(), PhysListEmStandardNR::ConstructProcess(), G4EmStandardPhysics_option3::ConstructProcess(), G4EmStandardPhysics_option4::ConstructProcess(), and G4EmProcessOptions::SetFluo().

{
  isActive = val;
}

void G4VAtomDeexcitation::SetPIXE ( G4bool  val )

inline

Definition at line 219 of file G4VAtomDeexcitation.hh.

Referenced by G4EmProcessOptions::SetPIXE().

{
  flagPIXE = val;
  if(val) { isActive = true; }
}

void G4VAtomDeexcitation::SetPIXECrossSectionModel ( const G4String &  n )

inline

Definition at line 236 of file G4VAtomDeexcitation.hh.

References n.

Referenced by G4UAtomicDeexcitation::InitialiseForNewRun(), and G4EmProcessOptions::SetPIXECrossSectionModel().

{
  namePIXE = n;
}

void G4VAtomDeexcitation::SetPIXEElectronCrossSectionModel ( const G4String &  n )

inline

Definition at line 242 of file G4VAtomDeexcitation.hh.

References n.

Referenced by G4UAtomicDeexcitation::InitialiseForNewRun(), and G4EmProcessOptions::SetPIXEElectronCrossSectionModel().

{
  nameElectronPIXE = n;
}

void G4VAtomDeexcitation::SetVerboseLevel ( G4int  val )

inline

Definition at line 265 of file G4VAtomDeexcitation.hh.

Referenced by G4LossTableManager::SetVerbose().

{
  verbose = val;
}

---

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

• G4VAtomDeexcitation.hh
• G4VAtomDeexcitation.cc