G4EmSaturation Class Reference

#include <G4EmSaturation.hh>

Public Member Functions
void	DumpBirksCoefficients ()
void	DumpG4BirksCoefficients ()
G4double	FindG4BirksCoefficient (const G4Material *)
	G4EmSaturation (const G4EmSaturation &)=delete
	G4EmSaturation (G4int verb)
void	InitialiseG4Saturation ()
G4EmSaturation &	operator= (const G4EmSaturation &right)=delete
void	SetVerbose (G4int)
virtual G4double	VisibleEnergyDeposition (const G4ParticleDefinition *, const G4MaterialCutsCouple *, G4double length, G4double edepTotal, G4double edepNIEL=0.0) const
G4double	VisibleEnergyDepositionAtAStep (const G4Step *) const
virtual	~G4EmSaturation ()

Private Member Functions
void	InitialiseBirksCoefficient (const G4Material *)
void	InitialiseG4materials ()

Private Attributes
const G4ParticleDefinition *	electron
G4int	nG4Birks
G4NistManager *	nist
G4int	nWarnings
const G4ParticleDefinition *	proton
G4int	verbose

Static Private Attributes
static std::vector< G4double >	effCharges
static std::vector< G4double >	g4MatData
static std::vector< G4String >	g4MatNames
static std::vector< G4double >	massFactors
static size_t	nMaterials = 0

Detailed Description

Definition at line 69 of file G4EmSaturation.hh.

Constructor & Destructor Documentation

G4EmSaturation() [1/2]

G4EmSaturation::G4EmSaturation ( G4int  verb )

explicit

Definition at line 62 of file G4EmSaturation.cc.

{
  verbose = verb;
  nWarnings = nG4Birks = 0;
 
  electron = nullptr;
  proton   = nullptr;
  nist     = G4NistManager::Instance();
  InitialiseG4Saturation();
}

References electron, InitialiseG4Saturation(), G4NistManager::Instance(), nG4Birks, nist, nWarnings, proton, and verbose.

~G4EmSaturation()

G4EmSaturation::~G4EmSaturation ( )

virtual

Definition at line 75 of file G4EmSaturation.cc.

{}

G4EmSaturation() [2/2]

G4EmSaturation::G4EmSaturation ( const G4EmSaturation &  )

delete

Member Function Documentation

DumpBirksCoefficients()

void G4EmSaturation::DumpBirksCoefficients

(

)

Definition at line 238 of file G4EmSaturation.cc.

{
  G4cout << "### Birks coefficients used in run time" << G4endl;
  const G4MaterialTable* mtable = G4Material::GetMaterialTable();
  for(size_t i=0; i<nMaterials; ++i) {
    const G4Material* mat = (*mtable)[i];
    G4double br = mat->GetIonisation()->GetBirksConstant();
    if(br > 0.0) {
      G4cout << "   " << mat->GetName() << "     " 
         << br*MeV/mm << " mm/MeV" << "     "
         << br*mat->GetDensity()*MeV*cm2/g 
         << " g/cm^2/MeV  massFactor=  " << massFactors[i]  
         << " effCharge= " << effCharges[i] << G4endl;
    }
  }
}

References cm2, effCharges, g, G4cout, G4endl, G4IonisParamMat::GetBirksConstant(), G4Material::GetDensity(), G4Material::GetIonisation(), G4Material::GetMaterialTable(), G4Material::GetName(), massFactors, MeV, mm, and nMaterials.

Referenced by InitialiseG4Saturation().

DumpG4BirksCoefficients()

void G4EmSaturation::DumpG4BirksCoefficients

(

)

Definition at line 257 of file G4EmSaturation.cc.

{
  if(nG4Birks > 0) {
    G4cout << "### Birks coefficients for Geant4 materials" << G4endl;
    for(G4int i=0; i<nG4Birks; ++i) {
      G4cout << "   " << g4MatNames[i] << "   " 
             << g4MatData[i]*MeV/mm << " mm/MeV" << G4endl;
    }
  }
}

References G4cout, G4endl, g4MatData, g4MatNames, MeV, mm, and nG4Birks.

FindG4BirksCoefficient()

G4double G4EmSaturation::FindG4BirksCoefficient

(

const G4Material *

mat

)

Definition at line 161 of file G4EmSaturation.cc.

{
  if(0 == nG4Birks) {  InitialiseG4materials(); }
 
  G4String name = mat->GetName();
  // is this material in the vector?
  
  for(G4int j=0; j<nG4Birks; ++j) {
    if(name == g4MatNames[j]) {
      if(verbose > 0) 
        G4cout << "### G4EmSaturation::FindG4BirksCoefficient for "
               << name << " is " << g4MatData[j]*MeV/mm << " mm/MeV "
               << G4endl;
      return g4MatData[j];
    }
  }
  return 0.0;
}

References G4cout, G4endl, g4MatData, g4MatNames, G4Material::GetName(), InitialiseG4materials(), MeV, mm, G4InuclParticleNames::name(), nG4Birks, and verbose.

InitialiseBirksCoefficient()

void G4EmSaturation::InitialiseBirksCoefficient ( const G4Material *  mat )

private

Definition at line 182 of file G4EmSaturation.cc.

{
  // electron and proton should exist in any case
  if(nullptr == electron) {
    electron = G4ParticleTable::GetParticleTable()->FindParticle("e-");
    proton = G4ParticleTable::GetParticleTable()->FindParticle("proton");
    if(nullptr == electron) {
      G4Exception("G4EmSaturation::InitialiseBirksCoefficient", "em0001",
          FatalException, "electron should exist");
    }
  }
 
  G4double curBirks = mat->GetIonisation()->GetBirksConstant();
 
  G4String name = mat->GetName();
 
  // material has no Birks coeffitient defined
  // seach in the Geant4 list
  if(curBirks == 0.0) {
    for(G4int j=0; j<nG4Birks; ++j) {
      if(name == g4MatNames[j]) {
        mat->GetIonisation()->SetBirksConstant(g4MatData[j]);
        curBirks = g4MatData[j];
        break;
      }
    }
  }
 
  if(curBirks == 0.0) { return; }
 
  // compute mean mass ratio
  G4double curRatio = 0.0;
  G4double curChargeSq = 0.0;
  G4double norm = 0.0;
  const G4ElementVector* theElementVector = mat->GetElementVector();
  const G4double* theAtomNumDensityVector = mat->GetVecNbOfAtomsPerVolume();
  size_t nelm = mat->GetNumberOfElements();
  for (size_t i=0; i<nelm; ++i) {
    const G4Element* elm = (*theElementVector)[i];
    G4double Z = elm->GetZ();
    G4double w = Z*Z*theAtomNumDensityVector[i];
    curRatio += w/nist->GetAtomicMassAmu(G4int(Z));
    curChargeSq = Z*Z*w;
    norm += w;
  }
  curRatio *= proton_mass_c2/norm;
  curChargeSq /= norm;
 
  // store results
  G4int idx = mat->GetIndex();
  massFactors[idx] = curRatio;
  effCharges[idx] = curChargeSq;
}

References effCharges, electron, FatalException, G4ParticleTable::FindParticle(), G4Exception(), g4MatData, g4MatNames, G4NistManager::GetAtomicMassAmu(), G4IonisParamMat::GetBirksConstant(), G4Material::GetElementVector(), G4Material::GetIndex(), G4Material::GetIonisation(), G4Material::GetName(), G4Material::GetNumberOfElements(), G4ParticleTable::GetParticleTable(), G4Material::GetVecNbOfAtomsPerVolume(), G4Element::GetZ(), massFactors, G4InuclParticleNames::name(), nG4Birks, nist, proton, source.hepunit::proton_mass_c2, G4IonisParamMat::SetBirksConstant(), and Z.

Referenced by InitialiseG4Saturation().

InitialiseG4materials()

void G4EmSaturation::InitialiseG4materials ( )

private

Definition at line 270 of file G4EmSaturation.cc.

{
  nG4Birks = 4;
  g4MatData.reserve(nG4Birks);
 
  // M.Hirschberg et al., IEEE Trans. Nuc. Sci. 39 (1992) 511
  // SCSN-38 kB = 0.00842 g/cm^2/MeV; rho = 1.06 g/cm^3
  g4MatNames.push_back("G4_POLYSTYRENE");
  g4MatData.push_back(0.07943*mm/MeV);
 
  // C.Fabjan (private communication)
  // kB = 0.006 g/cm^2/MeV; rho = 7.13 g/cm^3
  g4MatNames.push_back("G4_BGO");
  g4MatData.push_back(0.008415*mm/MeV);
 
  // A.Ribon analysis of publications
  // Scallettar et al., Phys. Rev. A25 (1982) 2419.
  // NIM A 523 (2004) 275. 
  // kB = 0.022 g/cm^2/MeV; rho = 1.396 g/cm^3; 
  // ATLAS Efield = 10 kV/cm provide the strongest effect
  // kB = 0.1576*mm/MeV
  // A. Kiryunin and P.Strizenec "Geant4 hadronic 
  // working group meeting " kB = 0.041/9.13 g/cm^2/MeV  
  g4MatNames.push_back("G4_lAr");
  g4MatData.push_back(0.032*mm/MeV);
 
  //G4_BARIUM_FLUORIDE
  //G4_CESIUM_IODIDE
  //G4_GEL_PHOTO_EMULSION
  //G4_PHOTO_EMULSION
  //G4_PLASTIC_SC_VINYLTOLUENE
  //G4_SODIUM_IODIDE
  //G4_STILBENE
  //G4_lAr
 
  //G4_PbWO4 - CMS value
  g4MatNames.push_back("G4_PbWO4");
  g4MatData.push_back(0.0333333*mm/MeV);
 
  //G4_Lucite
 
}

References g4MatData, g4MatNames, MeV, mm, and nG4Birks.

Referenced by FindG4BirksCoefficient(), and InitialiseG4Saturation().

InitialiseG4Saturation()

void G4EmSaturation::InitialiseG4Saturation

(

)

Definition at line 144 of file G4EmSaturation.cc.

{
  if(nMaterials == G4Material::GetNumberOfMaterials()) { return; }
  nMaterials = G4Material::GetNumberOfMaterials();
  massFactors.resize(nMaterials, 1.0);
  effCharges.resize(nMaterials, 1.0);
 
  if(0 == nG4Birks) {  InitialiseG4materials(); }
 
  for(size_t i=0; i<nMaterials; ++i) {
    InitialiseBirksCoefficient((*G4Material::GetMaterialTable())[i]);
  }
  if(verbose > 0) { DumpBirksCoefficients(); }
}

References DumpBirksCoefficients(), effCharges, G4Material::GetMaterialTable(), G4Material::GetNumberOfMaterials(), InitialiseBirksCoefficient(), InitialiseG4materials(), massFactors, nG4Birks, nMaterials, and verbose.

Referenced by G4EmSaturation().

operator=()

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

delete

SetVerbose()

void G4EmSaturation::SetVerbose ( G4int  val )

inline

Definition at line 132 of file G4EmSaturation.hh.

{
  verbose = val;
}

References verbose.

VisibleEnergyDeposition()

G4double G4EmSaturation::VisibleEnergyDeposition ( const G4ParticleDefinition *  p, const G4MaterialCutsCouple *  couple, G4double  length, G4double  edepTotal, G4double  edepNIEL = 0.0  ) const

virtual

Definition at line 80 of file G4EmSaturation.cc.

{
  // no energy deposition
  if(edep <= 0.0) { return 0.0; }
 
  // zero step length may happens only if step limiter process
  // is applied, in that case saturation should not be applied
  if(length <= 0.0) { return edep; }
 
  G4double evis = edep;
  G4double bfactor = couple->GetMaterial()->GetIonisation()->GetBirksConstant();
 
  if(bfactor > 0.0) { 
 
    // atomic relaxations for gamma incident
    if(22 ==  p->GetPDGEncoding()) {
      //G4cout << "%% gamma edep= " << edep/keV << " keV " << G4endl; 
      evis /= (1.0 + bfactor*edep/
        G4LossTableManager::Instance()->GetRange(electron,edep,couple));
 
      // energy loss
    } else {
 
      // protections
      G4double nloss = std::max(niel, 0.0);
      G4double eloss = edep - nloss;
 
      // neutrons and neutral hadrons
      if(0.0 == p->GetPDGCharge() || eloss < 0.0) {
        nloss = edep;
        eloss = 0.0;
      } else {
 
    // continues energy loss
    eloss /= (1.0 + bfactor*eloss/length); 
      }
      // non-ionizing energy loss
      if(nloss > 0.0) {
        G4int idx = couple->GetMaterial()->GetIndex();
        G4double escaled = nloss*massFactors[idx];
    /*        
        G4cout << "%% p edep= " << nloss/keV << " keV  Escaled= " 
               << escaled << " MeV  in " << couple->GetMaterial()->GetName()
               << "  " << p->GetParticleName() 
               << G4endl;
    G4cout << proton->GetParticleName() << G4endl;
    */
        G4double range = G4LossTableManager::Instance()
          ->GetRange(proton,escaled,couple)/effCharges[idx]; 
        nloss /= (1.0 + bfactor*nloss/range);
      }
      evis = eloss + nloss;
    }
  }
  return evis;
}

References effCharges, electron, G4IonisParamMat::GetBirksConstant(), G4Material::GetIndex(), G4Material::GetIonisation(), G4MaterialCutsCouple::GetMaterial(), G4ParticleDefinition::GetPDGCharge(), G4ParticleDefinition::GetPDGEncoding(), G4LossTableManager::GetRange(), G4LossTableManager::Instance(), massFactors, G4INCL::Math::max(), and proton.

Referenced by VisibleEnergyDepositionAtAStep().

VisibleEnergyDepositionAtAStep()

G4double G4EmSaturation::VisibleEnergyDepositionAtAStep ( const G4Step *  step ) const

inline

Definition at line 139 of file G4EmSaturation.hh.

{
  return VisibleEnergyDeposition(step->GetTrack()->GetParticleDefinition(),
                                 step->GetTrack()->GetMaterialCutsCouple(),
                 step->GetStepLength(),
                                 step->GetTotalEnergyDeposit(),
                                 step->GetNonIonizingEnergyDeposit());
}

References G4Track::GetMaterialCutsCouple(), G4Step::GetNonIonizingEnergyDeposit(), G4Track::GetParticleDefinition(), G4Step::GetStepLength(), G4Step::GetTotalEnergyDeposit(), G4Step::GetTrack(), and VisibleEnergyDeposition().

Referenced by G4Scintillation::PostStepDoIt().

Field Documentation

effCharges

std::vector< G4double > G4EmSaturation::effCharges

staticprivate

Definition at line 123 of file G4EmSaturation.hh.

Referenced by DumpBirksCoefficients(), InitialiseBirksCoefficient(), InitialiseG4Saturation(), and VisibleEnergyDeposition().

electron

const G4ParticleDefinition* G4EmSaturation::electron

private

Definition at line 111 of file G4EmSaturation.hh.

Referenced by G4EmSaturation(), InitialiseBirksCoefficient(), and VisibleEnergyDeposition().

g4MatData

std::vector< G4double > G4EmSaturation::g4MatData

staticprivate

Definition at line 126 of file G4EmSaturation.hh.

Referenced by DumpG4BirksCoefficients(), FindG4BirksCoefficient(), InitialiseBirksCoefficient(), and InitialiseG4materials().

g4MatNames

std::vector< G4String > G4EmSaturation::g4MatNames

staticprivate

Definition at line 127 of file G4EmSaturation.hh.

Referenced by DumpG4BirksCoefficients(), FindG4BirksCoefficient(), InitialiseBirksCoefficient(), and InitialiseG4materials().

massFactors

std::vector< G4double > G4EmSaturation::massFactors

staticprivate

Definition at line 122 of file G4EmSaturation.hh.

Referenced by DumpBirksCoefficients(), InitialiseBirksCoefficient(), InitialiseG4Saturation(), and VisibleEnergyDeposition().

nG4Birks

G4int G4EmSaturation::nG4Birks

private

Definition at line 116 of file G4EmSaturation.hh.

Referenced by DumpG4BirksCoefficients(), FindG4BirksCoefficient(), G4EmSaturation(), InitialiseBirksCoefficient(), InitialiseG4materials(), and InitialiseG4Saturation().

nist

G4NistManager* G4EmSaturation::nist

private

Definition at line 113 of file G4EmSaturation.hh.

Referenced by G4EmSaturation(), and InitialiseBirksCoefficient().

nMaterials

size_t G4EmSaturation::nMaterials = 0

staticprivate

Definition at line 119 of file G4EmSaturation.hh.

Referenced by DumpBirksCoefficients(), and InitialiseG4Saturation().

nWarnings

G4int G4EmSaturation::nWarnings

private

Definition at line 117 of file G4EmSaturation.hh.

Referenced by G4EmSaturation().

proton

const G4ParticleDefinition* G4EmSaturation::proton

private

Definition at line 112 of file G4EmSaturation.hh.

Referenced by G4EmSaturation(), InitialiseBirksCoefficient(), and VisibleEnergyDeposition().

verbose

G4int G4EmSaturation::verbose

private

Definition at line 115 of file G4EmSaturation.hh.

Referenced by FindG4BirksCoefficient(), G4EmSaturation(), InitialiseG4Saturation(), and SetVerbose().

---

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

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