G4EmSaturation Class Reference

#include <G4EmSaturation.hh>

Collaboration diagram for G4EmSaturation:

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

Private Member Functions
G4EmSaturation &	operator= (const G4EmSaturation &right)
	G4EmSaturation (const G4EmSaturation &)
G4double	FindBirksCoefficient (const G4Material *)
void	InitialiseBirksCoefficient (const G4Material *)
void	InitialiseG4materials ()

Private Attributes
const G4ParticleDefinition *	electron
const G4ParticleDefinition *	proton
G4LossTableManager *	manager
G4NistManager *	nist
const G4Material *	curMaterial
G4double	curBirks
G4double	curRatio
G4double	curChargeSq
G4int	verbose
G4int	nMaterials
G4int	nG4Birks
G4int	nWarnings
std::vector< const G4Material * >	matPointers
std::vector< G4String >	matNames
std::vector< G4double >	massFactors
std::vector< G4double >	effCharges
std::vector< G4double >	g4MatData
std::vector< G4String >	g4MatNames

Detailed Description

Definition at line 72 of file G4EmSaturation.hh.

Constructor & Destructor Documentation

G4EmSaturation() [1/2]

G4EmSaturation::G4EmSaturation

(

G4int

verb

)

Definition at line 57 of file G4EmSaturation.cc.

  : manager(nullptr)
{
  verbose = verb;

  curMaterial = nullptr;
  curBirks    = 0.0;
  curRatio    = 1.0;
  curChargeSq = 1.0;
  nMaterials  = nWarnings = 0;

  electron = nullptr;
  proton   = nullptr;
  nist     = G4NistManager::Instance();

  InitialiseG4materials(); 
}

Here is the call graph for this function:

~G4EmSaturation()

G4EmSaturation::~G4EmSaturation ( )

virtual

Definition at line 77 of file G4EmSaturation.cc.

{}

G4EmSaturation() [2/2]

G4EmSaturation::G4EmSaturation ( const G4EmSaturation &  )

private

Member Function Documentation

DumpBirksCoefficients()

void G4EmSaturation::DumpBirksCoefficients

(

)

Definition at line 245 of file G4EmSaturation.cc.

{
  if(nMaterials > 0) {
    G4cout << "### Birks coeffitients used in run time" << G4endl;
    for(G4int i=0; i<nMaterials; ++i) {
      G4double br = matPointers[i]->GetIonisation()->GetBirksConstant();
      G4cout << "   " << matNames[i] << "     " 
             << br*MeV/mm << " mm/MeV" << "     "
             << br*matPointers[i]->GetDensity()*MeV*cm2/g 
             << " g/cm^2/MeV" 
             << G4endl;
    }
  }
}

Here is the call graph for this function:

DumpG4BirksCoefficients()

void G4EmSaturation::DumpG4BirksCoefficients

(

)

Definition at line 262 of file G4EmSaturation.cc.

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

Here is the caller graph for this function:

FindBirksCoefficient()

G4double G4EmSaturation::FindBirksCoefficient ( const G4Material *  mat )

inlineprivate

Definition at line 163 of file G4EmSaturation.hh.

{
  if(mat != curMaterial) { InitialiseBirksCoefficient(mat); }
  return curBirks;
}

Here is the call graph for this function:

Here is the caller graph for this function:

FindG4BirksCoefficient()

G4double G4EmSaturation::FindG4BirksCoefficient

(

const G4Material *

mat

)

Definition at line 141 of file G4EmSaturation.cc.

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

Here is the call graph for this function:

InitialiseBirksCoefficient()

void G4EmSaturation::InitialiseBirksCoefficient ( const G4Material *  mat )

private

Definition at line 160 of file G4EmSaturation.cc.

{
  // electron and proton should exist in any case
  if(!manager) {
    manager = G4LossTableManager::Instance();
    electron = G4ParticleTable::GetParticleTable()->FindParticle("e-");
    proton = G4ParticleTable::GetParticleTable()->FindParticle("proton");
  }

  curMaterial = mat;
  curBirks = 0.0;
  curRatio = 1.0;
  curChargeSq = 1.0;

  // seach in the run-time list
  for(G4int i=0; i<nMaterials; ++i) {
    if(mat == matPointers[i]) {
      curBirks = mat->GetIonisation()->GetBirksConstant();
      curRatio = massFactors[i];
      curChargeSq = effCharges[i];
      return;
    }
  }

  G4String name = mat->GetName();
  curBirks = mat->GetIonisation()->GetBirksConstant();

  // 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) {
    if(0 < nWarnings) {
      ++nWarnings;
      G4ExceptionDescription ed;
      ed << "Birks constants are not defined for material " << name 
         << " ! \n Define Birks constants for the material" 
         << " or not apply saturation.";
      G4Exception("G4EmSaturation::InitialiseBirksCoefficient", "em0088",
                  JustWarning, ed);
    }
    return;
  }

  // compute mean mass ratio
  curRatio = 0.0;
  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
  matPointers.push_back(mat);
  matNames.push_back(name);
  massFactors.push_back(curRatio);
  effCharges.push_back(curChargeSq);
  nMaterials++;
  if(verbose > 0) {
    G4cout << "### G4EmSaturation::FindBirksCoefficient Birks coefficient for "
           << name << "  " << curBirks*MeV/mm << " mm/MeV" << G4endl;
  }
  return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

InitialiseG4materials()

void G4EmSaturation::InitialiseG4materials ( )

private

Definition at line 275 of file G4EmSaturation.cc.

{
  // 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 
  g4MatNames.push_back("G4_lAr");
  g4MatData.push_back(0.1576*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
  //G4_Lucite

  nG4Birks = g4MatData.size();
}

Here is the caller graph for this function:

operator=()

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

private

SetVerbose()

void G4EmSaturation::SetVerbose ( G4int  val )

inline

Definition at line 142 of file G4EmSaturation.hh.

{
  verbose = val;
}

Here is the caller graph for this function:

VisibleEnergyDeposition()

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

virtual

Definition at line 82 of file G4EmSaturation.cc.

{
  if(edep <= 0.0) { return 0.0; }

  G4double evis = edep;
  G4double bfactor = FindBirksCoefficient(couple->GetMaterial());

  if(bfactor > 0.0) { 

    G4int pdgCode = p->GetPDGEncoding();
    // atomic relaxations for gamma incident
    if(22 == pdgCode && electron) {
      //G4cout << "%% gamma edep= " << edep/keV << " keV " <<manager << G4endl; 
      evis /= (1.0 + bfactor*edep/manager->GetRange(electron,edep,couple));

      // energy loss
    } else {

      // protections
      G4double nloss = niel;
      if(nloss < 0.0) { nloss = 0.0; }
      G4double eloss = edep - nloss;

      // neutrons and neutral hadrons
      if(0.0 == p->GetPDGCharge() || eloss < 0.0 || length <= 0.0) {
        nloss = edep;
        eloss = 0.0;
      }

      // continues energy loss
      if(eloss > 0.0) { eloss /= (1.0 + bfactor*eloss/length); }
 
      // non-ionizing energy loss
      if(nloss > 0.0 && proton) {
        G4double escaled = nloss*curRatio;
        /*
        G4cout << "%% p edep= " << nloss/keV << " keV  Escaled= " 
               << escaled << " MeV  in " << couple->GetMaterial()->GetName()
               << "  " << p->GetParticleName()
               << G4endl; 
        */
        G4double range = manager->GetRange(proton,escaled,couple)/curChargeSq; 
        nloss /= (1.0 + bfactor*nloss/range);
      }

      evis = eloss + nloss;
    }
  }
  
  return evis;
}

Here is the call graph for this function:

Here is the caller graph for this function:

VisibleEnergyDepositionAtAStep()

G4double G4EmSaturation::VisibleEnergyDepositionAtAStep ( const G4Step *  step )

inline

Definition at line 149 of file G4EmSaturation.hh.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

curBirks

G4double G4EmSaturation::curBirks

private

Definition at line 120 of file G4EmSaturation.hh.

curChargeSq

G4double G4EmSaturation::curChargeSq

private

Definition at line 122 of file G4EmSaturation.hh.

curMaterial

const G4Material* G4EmSaturation::curMaterial

private

Definition at line 119 of file G4EmSaturation.hh.

curRatio

G4double G4EmSaturation::curRatio

private

Definition at line 121 of file G4EmSaturation.hh.

effCharges

std::vector<G4double> G4EmSaturation::effCharges

private

Definition at line 133 of file G4EmSaturation.hh.

electron

const G4ParticleDefinition* G4EmSaturation::electron

private

Definition at line 113 of file G4EmSaturation.hh.

g4MatData

std::vector<G4double> G4EmSaturation::g4MatData

private

Definition at line 136 of file G4EmSaturation.hh.

g4MatNames

std::vector<G4String> G4EmSaturation::g4MatNames

private

Definition at line 137 of file G4EmSaturation.hh.

manager

G4LossTableManager* G4EmSaturation::manager

private

Definition at line 115 of file G4EmSaturation.hh.

massFactors

std::vector<G4double> G4EmSaturation::massFactors

private

Definition at line 132 of file G4EmSaturation.hh.

matNames

std::vector<G4String> G4EmSaturation::matNames

private

Definition at line 131 of file G4EmSaturation.hh.

matPointers

std::vector<const G4Material*> G4EmSaturation::matPointers

private

Definition at line 130 of file G4EmSaturation.hh.

nG4Birks

G4int G4EmSaturation::nG4Birks

private

Definition at line 126 of file G4EmSaturation.hh.

nist

G4NistManager* G4EmSaturation::nist

private

Definition at line 116 of file G4EmSaturation.hh.

nMaterials

G4int G4EmSaturation::nMaterials

private

Definition at line 125 of file G4EmSaturation.hh.

nWarnings

G4int G4EmSaturation::nWarnings

private

Definition at line 127 of file G4EmSaturation.hh.

proton

const G4ParticleDefinition* G4EmSaturation::proton

private

Definition at line 114 of file G4EmSaturation.hh.

verbose

G4int G4EmSaturation::verbose

private

Definition at line 124 of file G4EmSaturation.hh.

---

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

• G4EmSaturation.hh
• G4EmSaturation.cc