G4VAtomDeexcitation Class Reference

#include <G4VAtomDeexcitation.hh>

Inheritance diagram for G4VAtomDeexcitation:

Collaboration diagram for G4VAtomDeexcitation:

Public Member Functions
	G4VAtomDeexcitation (const G4String &modname="Deexcitation")
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	SetAugerCascade (G4bool)
G4bool	IsAugerCascadeActive () const
void	SetPIXE (G4bool)
G4bool	IsPIXEActive () const
const G4String &	GetName () 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)

Private Member Functions
	G4VAtomDeexcitation (G4VAtomDeexcitation &)
G4VAtomDeexcitation &	operator= (const G4VAtomDeexcitation &right)

Private Attributes
G4EmParameters *	theParameters
const G4ParticleDefinition *	gamma
G4ProductionCutsTable *	theCoupleTable
G4int	verbose
G4String	name
G4bool	isActive
G4bool	flagAuger
G4bool	flagAugerCascade
G4bool	flagPIXE
G4bool	ignoreCuts
std::vector< G4bool >	activeZ
std::vector< G4bool >	activeDeexcitationMedia
std::vector< G4bool >	activeAugerMedia
std::vector< G4bool >	activePIXEMedia
std::vector< G4String >	activeRegions
std::vector< G4bool >	deRegions
std::vector< G4bool >	AugerRegions
std::vector< G4bool >	PIXERegions
std::vector< G4DynamicParticle * >	vdyn

Static Private Attributes
static G4int	pixeIDg = -1
static G4int	pixeIDe = -1

Detailed Description

Definition at line 64 of file G4VAtomDeexcitation.hh.

Constructor & Destructor Documentation

G4VAtomDeexcitation() [1/2]

G4VAtomDeexcitation::G4VAtomDeexcitation

(

const G4String &

modname = "Deexcitation"

)

Definition at line 70 of file G4VAtomDeexcitation.cc.

  : verbose(1), name(modname), isActive(false), 
    flagAuger(false),flagAugerCascade(false), 
    flagPIXE(false), ignoreCuts(false)
{
  theParameters = G4EmParameters::Instance();
  vdyn.reserve(5);
  theCoupleTable = nullptr;
  G4String gg = "gammaPIXE";
  G4String ee = "e-PIXE";
  if(pixeIDg < 0) { pixeIDg = G4PhysicsModelCatalog::Register(gg); }
  if(pixeIDe < 0) { pixeIDe = G4PhysicsModelCatalog::Register(ee); }
  gamma = G4Gamma::Gamma();
}

Here is the call graph for this function:

~G4VAtomDeexcitation()

G4VAtomDeexcitation::~G4VAtomDeexcitation ( )

virtual

Definition at line 87 of file G4VAtomDeexcitation.cc.

{}

G4VAtomDeexcitation() [2/2]

G4VAtomDeexcitation::G4VAtomDeexcitation ( G4VAtomDeexcitation &  )

private

Member Function Documentation

AlongStepDeexcitation()

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

Definition at line 227 of file G4VAtomDeexcitation.cc.

{
  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];
  if(ignoreCuts) { gCut = 0.0; }
  G4double eCut = DBL_MAX;
  if(CheckAugerActiveRegion(coupleIndex)) { 
    eCut = (*theCoupleTable->GetEnergyCutsVector(1))[coupleIndex];
    if(ignoreCuts) { eCut = 0.0; }    
  }

  //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;
                  }
                }
              }
              // Loop checking, 03-Aug-2015, Vladimir Ivanchenko
            } while (stot < 1.0);
          }
        }
      }
    } 
  }
  return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

CheckAugerActiveRegion()

G4bool G4VAtomDeexcitation::CheckAugerActiveRegion ( G4int  coupleIndex )

inline

Definition at line 267 of file G4VAtomDeexcitation.hh.

{

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

Here is the caller graph for this function:

CheckDeexcitationActiveRegion()

G4bool G4VAtomDeexcitation::CheckDeexcitationActiveRegion ( G4int  coupleIndex )

inline

Definition at line 261 of file G4VAtomDeexcitation.hh.

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

Here is the caller graph for this function:

ComputeShellIonisationCrossSectionPerAtom()

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

pure virtual

Implemented in G4UAtomicDeexcitation.

Here is the caller graph for this function:

GenerateParticles() [1/2]

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

inline

Definition at line 274 of file G4VAtomDeexcitation.hh.

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

Here is the call graph for this function:

Here is the caller graph for this function:

GenerateParticles() [2/2]

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

pure virtual

Implemented in G4UAtomicDeexcitation.

GetAtomicShell()

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

pure virtual

Implemented in G4UAtomicDeexcitation.

Here is the caller graph for this function:

GetListOfActiveAtoms()

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

inline

Definition at line 245 of file G4VAtomDeexcitation.hh.

{
  return activeZ;
}

GetName()

const G4String & G4VAtomDeexcitation::GetName ( void  ) const

inline

Definition at line 239 of file G4VAtomDeexcitation.hh.

{
  return name;
}

Here is the caller graph for this function:

GetShellIonisationCrossSectionPerAtom()

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

pure virtual

Implemented in G4UAtomicDeexcitation.

Here is the caller graph for this function:

GetVerboseLevel()

G4int G4VAtomDeexcitation::GetVerboseLevel ( ) const

inline

Definition at line 255 of file G4VAtomDeexcitation.hh.

{
  return verbose;
}

InitialiseAtomicDeexcitation()

void G4VAtomDeexcitation::InitialiseAtomicDeexcitation

(

)

Definition at line 92 of file G4VAtomDeexcitation.cc.

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

  // needed for unit tests
  G4int nn = std::max(numOfCouples, 1);
  activeDeexcitationMedia.resize(nn, false);
  activeAugerMedia.resize(nn, false);
  activePIXEMedia.resize(nn, false);
  activeZ.resize(93, false);

  // initialisation of flags and options
  isActive   = theParameters->Fluo();
  flagAuger  = theParameters->Auger();
  flagAugerCascade = theParameters->AugerCascade();
  flagPIXE   = theParameters->Pixe();
  ignoreCuts = theParameters->DeexcitationIgnoreCut();

  // 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 = deRegions.size();
  }

  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);
    if(reg && 0 < numOfCouples) {
      const G4ProductionCuts* rpcuts = reg->GetProductionCuts();
      if(0 < verbose) {
        G4cout << "          " << activeRegions[j] << G4endl;  
      }
      for(G4int 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];
        }
      }
    }
  }
  G4int nelm = G4Element::GetNumberOfElements();
  //G4cout << nelm << G4endl;
  for(G4int k=0; k<nelm; ++k) {
    G4int Z = G4lrint((*(G4Element::GetElementTable()))[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: " 
           << theParameters->PIXECrossSectionModel()
           << G4endl;  
    G4cout << "### ===  PIXE model for e+-:     " 
           << theParameters->PIXEElectronCrossSectionModel()
           << G4endl;  
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

InitialiseForExtraAtom()

virtual void G4VAtomDeexcitation::InitialiseForExtraAtom ( G4int  Z )

pure virtual

Implemented in G4UAtomicDeexcitation.

InitialiseForNewRun()

virtual void G4VAtomDeexcitation::InitialiseForNewRun ( )

pure virtual

Implemented in G4UAtomicDeexcitation.

Here is the caller graph for this function:

IsAugerActive()

G4bool G4VAtomDeexcitation::IsAugerActive ( ) const

inline

Definition at line 210 of file G4VAtomDeexcitation.hh.

{
  return flagAuger;
}

Here is the caller graph for this function:

IsAugerCascadeActive()

G4bool G4VAtomDeexcitation::IsAugerCascadeActive ( ) const

inline

Definition at line 222 of file G4VAtomDeexcitation.hh.

{
  return flagAugerCascade;
}

Here is the caller graph for this function:

IsFluoActive()

G4bool G4VAtomDeexcitation::IsFluoActive ( ) const

inline

Definition at line 198 of file G4VAtomDeexcitation.hh.

{
  return isActive;
}

Here is the caller graph for this function:

IsPIXEActive()

G4bool G4VAtomDeexcitation::IsPIXEActive ( ) const

inline

Definition at line 234 of file G4VAtomDeexcitation.hh.

{
  return flagPIXE;
}

Here is the caller graph for this function:

operator=()

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

private

SetAuger()

void G4VAtomDeexcitation::SetAuger ( G4bool  val )

inline

Definition at line 203 of file G4VAtomDeexcitation.hh.

{
  flagAuger = val;
  if(val) { isActive = true; }
  theParameters->SetAuger(val);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetAugerCascade()

void G4VAtomDeexcitation::SetAugerCascade ( G4bool  val )

inline

Definition at line 215 of file G4VAtomDeexcitation.hh.

{
  flagAugerCascade = val;
  if(val) { isActive = true; }
  theParameters->SetAugerCascade(val);
}

Here is the call graph for this function:

SetDeexcitationActiveRegion()

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

Definition at line 177 of file G4VAtomDeexcitation.cc.

{
  // no PIXE in parallel world
  if(rname == "DefaultRegionForParallelWorld") { return; }

  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);

  // if de-excitation defined fo rthe world volume 
  // it should be active everywhere
  if(ss == "DefaultRegionForTheWorld") {
    G4RegionStore* regions = G4RegionStore::GetInstance();
    G4int nn = regions->size();
    for(G4int i=0; i<nn; ++i) {
      SetDeexcitationActiveRegion((*regions)[i]->GetName(), valDeexcitation,
                                  valAuger, valPIXE);
                                  
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetFluo()

void G4VAtomDeexcitation::SetFluo ( G4bool  val )

inline

Definition at line 192 of file G4VAtomDeexcitation.hh.

{
  isActive = val;
  theParameters->SetFluo(val);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetPIXE()

void G4VAtomDeexcitation::SetPIXE ( G4bool  val )

inline

Definition at line 227 of file G4VAtomDeexcitation.hh.

{
  flagPIXE = val;
  if(val) { isActive = true; }
  theParameters->SetPixe(val);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetVerboseLevel()

void G4VAtomDeexcitation::SetVerboseLevel ( G4int  val )

inline

Definition at line 250 of file G4VAtomDeexcitation.hh.

{
  verbose = val;
}

Here is the caller graph for this function:

Member Data Documentation

activeAugerMedia

std::vector<G4bool> G4VAtomDeexcitation::activeAugerMedia

private

Definition at line 180 of file G4VAtomDeexcitation.hh.

activeDeexcitationMedia

std::vector<G4bool> G4VAtomDeexcitation::activeDeexcitationMedia

private

Definition at line 179 of file G4VAtomDeexcitation.hh.

activePIXEMedia

std::vector<G4bool> G4VAtomDeexcitation::activePIXEMedia

private

Definition at line 181 of file G4VAtomDeexcitation.hh.

activeRegions

std::vector<G4String> G4VAtomDeexcitation::activeRegions

private

Definition at line 182 of file G4VAtomDeexcitation.hh.

activeZ

std::vector<G4bool> G4VAtomDeexcitation::activeZ

private

Definition at line 178 of file G4VAtomDeexcitation.hh.

AugerRegions

std::vector<G4bool> G4VAtomDeexcitation::AugerRegions

private

Definition at line 184 of file G4VAtomDeexcitation.hh.

deRegions

std::vector<G4bool> G4VAtomDeexcitation::deRegions

private

Definition at line 183 of file G4VAtomDeexcitation.hh.

flagAuger

G4bool G4VAtomDeexcitation::flagAuger

private

Definition at line 174 of file G4VAtomDeexcitation.hh.

flagAugerCascade

G4bool G4VAtomDeexcitation::flagAugerCascade

private

Definition at line 175 of file G4VAtomDeexcitation.hh.

flagPIXE

G4bool G4VAtomDeexcitation::flagPIXE

private

Definition at line 176 of file G4VAtomDeexcitation.hh.

gamma

const G4ParticleDefinition* G4VAtomDeexcitation::gamma

private

Definition at line 168 of file G4VAtomDeexcitation.hh.

ignoreCuts

G4bool G4VAtomDeexcitation::ignoreCuts

private

Definition at line 177 of file G4VAtomDeexcitation.hh.

isActive

G4bool G4VAtomDeexcitation::isActive

private

Definition at line 173 of file G4VAtomDeexcitation.hh.

name

G4String G4VAtomDeexcitation::name

private

Definition at line 172 of file G4VAtomDeexcitation.hh.

pixeIDe

G4int G4VAtomDeexcitation::pixeIDe = -1

staticprivate

Definition at line 189 of file G4VAtomDeexcitation.hh.

pixeIDg

G4int G4VAtomDeexcitation::pixeIDg = -1

staticprivate

Definition at line 188 of file G4VAtomDeexcitation.hh.

PIXERegions

std::vector<G4bool> G4VAtomDeexcitation::PIXERegions

private

Definition at line 185 of file G4VAtomDeexcitation.hh.

theCoupleTable

G4ProductionCutsTable* G4VAtomDeexcitation::theCoupleTable

private

Definition at line 170 of file G4VAtomDeexcitation.hh.

theParameters

G4EmParameters* G4VAtomDeexcitation::theParameters

private

Definition at line 167 of file G4VAtomDeexcitation.hh.

vdyn

std::vector<G4DynamicParticle*> G4VAtomDeexcitation::vdyn

private

Definition at line 186 of file G4VAtomDeexcitation.hh.

verbose

G4int G4VAtomDeexcitation::verbose

private

Definition at line 171 of file G4VAtomDeexcitation.hh.

---

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

• G4VAtomDeexcitation.hh
• G4VAtomDeexcitation.cc