G4ElectronIonPair Class Reference

#include <G4ElectronIonPair.hh>

Public Member Functions
void	DumpG4MeanEnergyPerIonPair () const
void	DumpMeanEnergyPerIonPair () const
G4double	FindG4MeanEnergyPerIonPair (const G4Material *) const
	G4ElectronIonPair (const G4ElectronIonPair &)=delete
	G4ElectronIonPair (G4int verb)
G4double	MeanNumberOfIonsAlongStep (const G4ParticleDefinition *, const G4Material *, G4double edepTotal, G4double edepNIEL=0.0)
G4double	MeanNumberOfIonsAlongStep (const G4Step *)
G4ElectronIonPair &	operator= (const G4ElectronIonPair &right)=delete
G4int	ResidualeChargePostStep (const G4ParticleDefinition *, const G4TrackVector *secondary=nullptr, G4int processSubType=-1) const
G4int	ResidualeChargePostStep (const G4Step *) const
std::vector< G4ThreeVector > *	SampleIonsAlongStep (const G4Step *)
G4int	SampleNumberOfIonsAlongStep (const G4Step *)
void	SetVerbose (G4int)
virtual	~G4ElectronIonPair ()

Private Member Functions
G4double	FindMeanEnergyPerIonPair (const G4Material *) const
void	Initialise ()

Private Attributes
const G4Material *	curMaterial
G4double	curMeanEnergy
std::vector< G4double >	g4MatData
std::vector< G4String >	g4MatNames
G4double	invFanoFactor
G4int	nMaterials
G4int	verbose

Detailed Description

Definition at line 71 of file G4ElectronIonPair.hh.

Constructor & Destructor Documentation

G4ElectronIonPair() [1/2]

G4ElectronIonPair::G4ElectronIonPair ( G4int  verb )

explicit

Definition at line 57 of file G4ElectronIonPair.cc.

{
  verbose = verb;
  curMaterial = nullptr;
  curMeanEnergy = 0.0;
  nMaterials = 0;
  invFanoFactor = 1.0/0.2;
  Initialise();
}

References curMaterial, curMeanEnergy, Initialise(), invFanoFactor, nMaterials, and verbose.

~G4ElectronIonPair()

G4ElectronIonPair::~G4ElectronIonPair ( )

virtual

Definition at line 69 of file G4ElectronIonPair.cc.

{}

G4ElectronIonPair() [2/2]

G4ElectronIonPair::G4ElectronIonPair ( const G4ElectronIonPair &  )

delete

Member Function Documentation

DumpG4MeanEnergyPerIonPair()

void G4ElectronIonPair::DumpG4MeanEnergyPerIonPair

(

)

const

Definition at line 189 of file G4ElectronIonPair.cc.

{
  if(nMaterials > 0) {
    G4cout << "### G4ElectronIonPair: mean energy per ion pair "
       << " for Geant4 materials" << G4endl;
    for(G4int i=0; i<nMaterials; ++i) {
      G4cout << "   " << g4MatNames[i] << "    Epair= " 
         << g4MatData[i]/eV << " eV" << G4endl;
    }
  }
}

References eV, G4cout, G4endl, g4MatData, g4MatNames, and nMaterials.

DumpMeanEnergyPerIonPair()

void G4ElectronIonPair::DumpMeanEnergyPerIonPair

(

)

const

Definition at line 169 of file G4ElectronIonPair.cc.

{
  G4int nmat = G4Material::GetNumberOfMaterials();
  const G4MaterialTable* mtable = G4Material::GetMaterialTable();
  if(nmat > 0) {
    G4cout << "### G4ElectronIonPair: mean energy per ion pair available:" 
       << G4endl;
    for(G4int i=0; i<nmat; ++i) {
      const G4Material* mat = (*mtable)[i];
      G4double x = mat->GetIonisation()->GetMeanEnergyPerIonPair();
      if(x > 0.0) {
    G4cout << "   " << mat->GetName() << "   Epair=  " 
           << x/eV << " eV" << G4endl;
      }
    }
  }
}

References eV, G4cout, G4endl, G4Material::GetIonisation(), G4Material::GetMaterialTable(), G4IonisParamMat::GetMeanEnergyPerIonPair(), G4Material::GetName(), and G4Material::GetNumberOfMaterials().

FindG4MeanEnergyPerIonPair()

G4double G4ElectronIonPair::FindG4MeanEnergyPerIonPair

(

const G4Material *

mat

)

const

Definition at line 146 of file G4ElectronIonPair.cc.

{
  G4String name = mat->GetName();
  G4double res  = 0.0;
 
  // is this material in the vector?  
  for(G4int j=0; j<nMaterials; j++) {
    if(name == g4MatNames[j]) {
      res = g4MatData[j];
      mat->GetIonisation()->SetMeanEnergyPerIonPair(res);
      if(verbose > 0) {
    G4cout << "### G4ElectronIonPair::FindG4MeanEnergyPerIonPair for "
           << name << " Epair= " << res/eV << " eV is set"
           << G4endl;
      }
      break;
    }
  }
  return res;
}

References eV, G4cout, G4endl, g4MatData, g4MatNames, G4Material::GetIonisation(), G4Material::GetName(), G4InuclParticleNames::name(), nMaterials, G4IonisParamMat::SetMeanEnergyPerIonPair(), and verbose.

Referenced by MeanNumberOfIonsAlongStep().

FindMeanEnergyPerIonPair()

G4double G4ElectronIonPair::FindMeanEnergyPerIonPair ( const G4Material *  ) const

private

Initialise()

void G4ElectronIonPair::Initialise ( )

private

Definition at line 203 of file G4ElectronIonPair.cc.

{
  // ICRU Report 31, 1979
  g4MatNames.push_back("G4_Si");
  g4MatData.push_back(3.62*eV);
 
  g4MatNames.push_back("G4_Ge");
  g4MatData.push_back(2.97*eV);
 
  g4MatNames.push_back("G4_He");
  g4MatData.push_back(44.4*eV);
 
  g4MatNames.push_back("G4_N");
  g4MatData.push_back(36.4*eV);
 
  g4MatNames.push_back("G4_O");
  g4MatData.push_back(32.3*eV);
 
  g4MatNames.push_back("G4_Ne");
  g4MatData.push_back(36.8*eV);
 
  g4MatNames.push_back("G4_Ar");
  g4MatData.push_back(26.34*eV);
 
  g4MatNames.push_back("G4_Kr");
  g4MatData.push_back(24.1*eV);
 
  g4MatNames.push_back("G4_Xe");
  g4MatData.push_back(21.6*eV);
 
  g4MatNames.push_back("G4_lAr");
  g4MatData.push_back(23.6*eV);
 
  g4MatNames.push_back("G4_lKr");
  g4MatData.push_back(20.5*eV);
 
  g4MatNames.push_back("G4_lXe");
  g4MatData.push_back(15.6*eV);
 
  g4MatNames.push_back("G4_AIR");
  g4MatData.push_back(35.1*eV);
 
  nMaterials = g4MatData.size();
}

References eV, g4MatData, g4MatNames, and nMaterials.

Referenced by G4ElectronIonPair().

MeanNumberOfIonsAlongStep() [1/2]

G4double G4ElectronIonPair::MeanNumberOfIonsAlongStep	(	const G4ParticleDefinition *	part,
		const G4Material *	material,
		G4double	edepTotal,
		G4double	edepNIEL = 0.0
	)

Definition at line 74 of file G4ElectronIonPair.cc.

{
  G4double nion = 0.0;
 
  // NIEL does not provide ionisation clusters
  if(edep > niel) {
 
    // neutral particles do not produce ionisation along step
    if(part->GetPDGCharge() != 0.0) {
 
      // select material
      if(material != curMaterial) {
    curMaterial = material;
    curMeanEnergy = material->GetIonisation()->GetMeanEnergyPerIonPair();
 
    // if mean energy is not defined then look into G4 DB
    if(0.0 == curMeanEnergy) {
      curMeanEnergy = FindG4MeanEnergyPerIonPair(material);
    } 
      }
      if(curMeanEnergy > 0.0) { nion = (edep - niel)/curMeanEnergy; }
    }
  }
  return nion;
}

References curMaterial, curMeanEnergy, FindG4MeanEnergyPerIonPair(), G4ParticleDefinition::GetPDGCharge(), and eplot::material.

Referenced by MeanNumberOfIonsAlongStep(), and SampleNumberOfIonsAlongStep().

MeanNumberOfIonsAlongStep() [2/2]

G4double G4ElectronIonPair::MeanNumberOfIonsAlongStep ( const G4Step *  step )

inline

Definition at line 136 of file G4ElectronIonPair.hh.

{
  return MeanNumberOfIonsAlongStep(step->GetTrack()->GetParticleDefinition(),
                   step->GetPreStepPoint()->GetMaterial(),
                   step->GetTotalEnergyDeposit(),
                   step->GetNonIonizingEnergyDeposit());
}

References G4StepPoint::GetMaterial(), G4Step::GetNonIonizingEnergyDeposit(), G4Track::GetParticleDefinition(), G4Step::GetPreStepPoint(), G4Step::GetTotalEnergyDeposit(), G4Step::GetTrack(), and MeanNumberOfIonsAlongStep().

operator=()

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

delete

ResidualeChargePostStep() [1/2]

G4int G4ElectronIonPair::ResidualeChargePostStep	(	const G4ParticleDefinition *	,
		const G4TrackVector *	secondary = nullptr,
		G4int	processSubType = -1
	)		const

Definition at line 133 of file G4ElectronIonPair.cc.

{
  G4int nholes = 0;
 
  if(2 == subType || 12 == subType || 13 == subType) { nholes = 1; }
  return nholes;
}

Referenced by ResidualeChargePostStep().

ResidualeChargePostStep() [2/2]

G4int G4ElectronIonPair::ResidualeChargePostStep ( const G4Step *  step ) const

inline

Definition at line 154 of file G4ElectronIonPair.hh.

{
  G4int subtype = -1;
  const G4VProcess* proc = step->GetPostStepPoint()->GetProcessDefinedStep();
  if(proc) { subtype = proc->GetProcessSubType(); }
  return ResidualeChargePostStep(step->GetTrack()->GetParticleDefinition(),
                 step->GetSecondary(),
                 subtype);
}

References G4Track::GetParticleDefinition(), G4Step::GetPostStepPoint(), G4StepPoint::GetProcessDefinedStep(), G4VProcess::GetProcessSubType(), G4Step::GetSecondary(), G4Step::GetTrack(), and ResidualeChargePostStep().

SampleIonsAlongStep()

std::vector< G4ThreeVector > * G4ElectronIonPair::SampleIonsAlongStep

(

const G4Step *

step

)

Definition at line 107 of file G4ElectronIonPair.cc.

{
  std::vector<G4ThreeVector>* v = 0;
 
  G4int nion = SampleNumberOfIonsAlongStep(step);
 
  // sample ionisation along step
  if(nion > 0) {
 
    v = new std::vector<G4ThreeVector>;
    G4ThreeVector prePos = step->GetPreStepPoint()->GetPosition();
    G4ThreeVector deltaPos = step->GetPostStepPoint()->GetPosition() - prePos;  
    for(G4int i=0; i<nion; ++i) {
      v->push_back( prePos + deltaPos*G4UniformRand() );
    }
    if(verbose > 1 ) { 
      G4cout << "### G4ElectronIonPair::SampleIonisationPoints: "
         << v->size() << "  ion pairs are added" << G4endl;
    }
  }
  return v;
}

References G4cout, G4endl, G4UniformRand, G4StepPoint::GetPosition(), G4Step::GetPostStepPoint(), G4Step::GetPreStepPoint(), SampleNumberOfIonsAlongStep(), and verbose.

SampleNumberOfIonsAlongStep()

G4int G4ElectronIonPair::SampleNumberOfIonsAlongStep ( const G4Step *  step )

inline

Definition at line 145 of file G4ElectronIonPair.hh.

{
  // use gamma distribution with mean value n=meanion and 
  // dispersion D=meanion/invFanoFactor
  G4double meanion = MeanNumberOfIonsAlongStep(step);
  return G4lrint(G4RandGamma::shoot(meanion*invFanoFactor,invFanoFactor));
} 

References G4lrint(), invFanoFactor, MeanNumberOfIonsAlongStep(), and G4INCL::DeJongSpin::shoot().

Referenced by SampleIonsAlongStep().

SetVerbose()

void G4ElectronIonPair::SetVerbose ( G4int  val )

inline

Definition at line 164 of file G4ElectronIonPair.hh.

{
  verbose = val;
}

References verbose.

Referenced by G4LossTableManager::ResetParameters().

Field Documentation

curMaterial

const G4Material* G4ElectronIonPair::curMaterial

private

Definition at line 122 of file G4ElectronIonPair.hh.

Referenced by G4ElectronIonPair(), and MeanNumberOfIonsAlongStep().

curMeanEnergy

G4double G4ElectronIonPair::curMeanEnergy

private

Definition at line 123 of file G4ElectronIonPair.hh.

Referenced by G4ElectronIonPair(), and MeanNumberOfIonsAlongStep().

g4MatData

std::vector<G4double> G4ElectronIonPair::g4MatData

private

Definition at line 131 of file G4ElectronIonPair.hh.

Referenced by DumpG4MeanEnergyPerIonPair(), FindG4MeanEnergyPerIonPair(), and Initialise().

g4MatNames

std::vector<G4String> G4ElectronIonPair::g4MatNames

private

Definition at line 132 of file G4ElectronIonPair.hh.

Referenced by DumpG4MeanEnergyPerIonPair(), FindG4MeanEnergyPerIonPair(), and Initialise().

invFanoFactor

G4double G4ElectronIonPair::invFanoFactor

private

Definition at line 125 of file G4ElectronIonPair.hh.

Referenced by G4ElectronIonPair(), and SampleNumberOfIonsAlongStep().

nMaterials

G4int G4ElectronIonPair::nMaterials

private

Definition at line 128 of file G4ElectronIonPair.hh.

Referenced by DumpG4MeanEnergyPerIonPair(), FindG4MeanEnergyPerIonPair(), G4ElectronIonPair(), and Initialise().

verbose

G4int G4ElectronIonPair::verbose

private

Definition at line 127 of file G4ElectronIonPair.hh.

Referenced by FindG4MeanEnergyPerIonPair(), G4ElectronIonPair(), SampleIonsAlongStep(), and SetVerbose().

---

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

• source/processes/electromagnetic/utils/include/G4ElectronIonPair.hh
• source/processes/electromagnetic/utils/src/G4ElectronIonPair.cc