G4ElectronIonPair Class Reference

#include <G4ElectronIonPair.hh>

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

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

~G4ElectronIonPair()

G4ElectronIonPair::~G4ElectronIonPair ( )

virtualdefault

G4ElectronIonPair() [2/2]

G4ElectronIonPair::G4ElectronIonPair ( const G4ElectronIonPair & )

delete

Member Function Documentation

DumpG4MeanEnergyPerIonPair()

void G4ElectronIonPair::DumpG4MeanEnergyPerIonPair

(

)

const

Definition at line 188 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;
    }
  }
}

DumpMeanEnergyPerIonPair()

void G4ElectronIonPair::DumpMeanEnergyPerIonPair

(

)

const

Definition at line 168 of file G4ElectronIonPair.cc.

{
  std::size_t nmat = G4Material::GetNumberOfMaterials();
  const G4MaterialTable* mtable = G4Material::GetMaterialTable();
  if(nmat > 0) {
    G4cout << "### G4ElectronIonPair: mean energy per ion pair available:" 
       << G4endl;
    for(std::size_t 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;
      }
    }
  }
}

FindG4MeanEnergyPerIonPair()

G4double G4ElectronIonPair::FindG4MeanEnergyPerIonPair

(

const G4Material *

mat

)

const

Definition at line 145 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;
}

Referenced by MeanNumberOfIonsAlongStep().

MeanNumberOfIonsAlongStep() [1/2]

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

Definition at line 73 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;
}

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

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

SampleIonsAlongStep()

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

(

const G4Step *

step

)

Definition at line 106 of file G4ElectronIonPair.cc.

{
  std::vector<G4ThreeVector>* v = nullptr;
 
  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;
}

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

Referenced by SampleIonsAlongStep().

SetVerbose()

void G4ElectronIonPair::SetVerbose ( G4int val )

inline

Definition at line 164 of file G4ElectronIonPair.hh.

{
  verbose = val;
}

Referenced by G4LossTableManager::ResetParameters().

---

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

• G4ElectronIonPair.hh
• G4ElectronIonPair.cc