G4IonisParamMat Class Reference

#include <G4IonisParamMat.hh>

Public Member Functions
	G4IonisParamMat (const G4Material *)
	~G4IonisParamMat ()
G4IonisParamMat &	operator= (const G4IonisParamMat &)=delete
	G4IonisParamMat (const G4IonisParamMat &)=delete
G4double	GetMeanExcitationEnergy () const
void	SetMeanExcitationEnergy (G4double value)
G4double	FindMeanExcitationEnergy (const G4Material *) const
G4double	GetLogMeanExcEnergy () const
G4double *	GetShellCorrectionVector () const
G4double	GetTaul () const
G4double	GetPlasmaEnergy () const
G4double	GetAdjustmentFactor () const
G4double	GetCdensity () const
G4double	GetMdensity () const
G4double	GetAdensity () const
G4double	GetX0density () const
G4double	GetX1density () const
G4double	GetD0density () const
void	SetDensityEffectParameters (G4double cd, G4double md, G4double ad, G4double x0, G4double x1, G4double d0)
void	SetDensityEffectParameters (const G4Material *bmat)
void	ComputeDensityEffectOnFly (G4bool)
G4DensityEffectCalculator *	GetDensityEffectCalculator () const
G4double	DensityCorrection (G4double x) const
G4double	GetDensityCorrection (G4double x) const
G4double	GetF1fluct () const
G4double	GetF2fluct () const
G4double	GetEnergy1fluct () const
G4double	GetLogEnergy1fluct () const
G4double	GetEnergy2fluct () const
G4double	GetLogEnergy2fluct () const
G4double	GetEnergy0fluct () const
G4double	GetRateionexcfluct () const
G4double	GetZeffective () const
G4double	GetFermiEnergy () const
G4double	GetLFactor () const
G4double	GetInvA23 () const
void	SetBirksConstant (G4double value)
G4double	GetBirksConstant () const
void	SetMeanEnergyPerIonPair (G4double value)
G4double	GetMeanEnergyPerIonPair () const
void	SetOrtoPositroniumFraction (G4double value)
G4double	GetOrtoPositroniumFraction () const
G4bool	operator== (const G4IonisParamMat &) const =delete
G4bool	operator!= (const G4IonisParamMat &) const =delete

Static Public Member Functions
static G4DensityEffectData *	GetDensityEffectData ()

Detailed Description

Definition at line 48 of file G4IonisParamMat.hh.

Constructor & Destructor Documentation

G4IonisParamMat() [1/2]

G4IonisParamMat::G4IonisParamMat

(

const G4Material *

material

)

Definition at line 59 of file G4IonisParamMat.cc.

                                                           : fMaterial(material)
{
  fBirks = 0.;
  fMeanEnergyPerIon = 0.0;
  twoln10 = 2. * G4Pow::GetInstance()->logZ(10);
 
  // minimal set of default parameters for density effect
  fCdensity = 0.0;
  fD0density = 0.0;
  fAdjustmentFactor = 1.0;
  if (fDensityData == nullptr) {
    fDensityData = new G4DensityEffectData();
  }
  fDensityEffectCalc = nullptr;
 
  // compute parameters
  ComputeMeanParameters();
  ComputeDensityEffectParameters();
  ComputeFluctModel();
  ComputeIonParameters();
}

Referenced by G4IonisParamMat(), operator!=(), operator=(), operator==(), and SetDensityEffectParameters().

~G4IonisParamMat()

G4IonisParamMat::~G4IonisParamMat

(

)

Definition at line 83 of file G4IonisParamMat.cc.

{
  delete fDensityEffectCalc;
  delete[] fShellCorrectionVector;
  delete fDensityData;
  fDensityData = nullptr;
  fShellCorrectionVector = nullptr;
  fDensityEffectCalc = nullptr;
}

G4IonisParamMat() [2/2]

G4IonisParamMat::G4IonisParamMat ( const G4IonisParamMat & )

delete

Member Function Documentation

ComputeDensityEffectOnFly()

void G4IonisParamMat::ComputeDensityEffectOnFly

(

G4bool

val

)

Definition at line 519 of file G4IonisParamMat.cc.

{
  if (val) {
    if (nullptr == fDensityEffectCalc) {
      G4int n = 0;
      for (std::size_t i = 0; i < fMaterial->GetNumberOfElements(); ++i) {
        const G4int Z = fMaterial->GetElement((G4int)i)->GetZasInt();
        n += G4AtomicShells::GetNumberOfShells(Z);
      }
      // The last level is the conduction level.  If this is *not* a conductor,
      // make a dummy conductor level with zero electrons in it.
      fDensityEffectCalc = new G4DensityEffectCalculator(fMaterial, n);
    }
  }
  else {
    delete fDensityEffectCalc;
    fDensityEffectCalc = nullptr;
  }
}

DensityCorrection()

G4double G4IonisParamMat::DensityCorrection ( G4double x ) const

inline

Definition at line 92 of file G4IonisParamMat.hh.

  {
    return (nullptr == fDensityEffectCalc) ? GetDensityCorrection(x)
                                           : fDensityEffectCalc->ComputeDensityCorrection(x);
  }

Referenced by G4BetheBlochModel::ComputeDEDXPerVolume(), G4MollerBhabhaModel::ComputeDEDXPerVolume(), and G4MuBetheBlochModel::ComputeDEDXPerVolume().

FindMeanExcitationEnergy()

G4double G4IonisParamMat::FindMeanExcitationEnergy

(

const G4Material *

mat

)

const

Definition at line 541 of file G4IonisParamMat.cc.

{
  G4double res = 0.0;
  // data from density effect data
  if (fDensityData != nullptr) {
    G4int idx = fDensityData->GetIndex(mat->GetName());
    if (idx >= 0) {
      res = fDensityData->GetMeanIonisationPotential(idx);
    }
  }
 
  // The data on mean excitation energy for compaunds
  // from "Stopping Powers for Electrons and Positrons"
  // ICRU Report N#37, 1984  (energy in eV)
  // this value overwrites Density effect data
  G4String chFormula = mat->GetChemicalFormula();
  if (! chFormula.empty()) {
    static const size_t numberOfMolecula = 54;
    // clang-format off
    static const G4String name[numberOfMolecula] = {
      // gas 0 - 12
      "NH_3",       "C_4H_10",     "CO_2",      "C_2H_6",      "C_7H_16-Gas",
      // "G4_AMMONIA", "G4_BUTANE","G4_CARBON_DIOXIDE","G4_ETHANE", "G4_N-HEPTANE"
      "C_6H_14-Gas",   "CH_4",     "NO",        "N_2O",        "C_8H_18-Gas",      
      // "G4_N-HEXANE" , "G4_METHANE", "x", "G4_NITROUS_OXIDE", "G4_OCTANE"
      "C_5H_12-Gas",   "C_3H_8",   "H_2O-Gas",                        
      // "G4_N-PENTANE", "G4_PROPANE", "G4_WATER_VAPOR"
 
      // liquid 13 - 39
      "C_3H_6O",    "C_6H_5NH_2",  "C_6H_6",    "C_4H_9OH",    "CCl_4", 
      //"G4_ACETONE","G4_ANILINE","G4_BENZENE","G4_N-BUTYL_ALCOHOL","G4_CARBON_TETRACHLORIDE"
      "C_6H_5Cl",   "CHCl_3",      "C_6H_12",   "C_6H_4Cl_2",  "C_4Cl_2H_8O",
      //"G4_CHLOROBENZENE","G4_CHLOROFORM","G4_CYCLOHEXANE","G4_1,2-DICHLOROBENZENE",
      //"G4_DICHLORODIETHYL_ETHER"
      "C_2Cl_2H_4", "(C_2H_5)_2O", "C_2H_5OH",  "C_3H_5(OH)_3","C_7H_16",
      //"G4_1,2-DICHLOROETHANE","G4_DIETHYL_ETHER","G4_ETHYL_ALCOHOL","G4_GLYCEROL","G4_N-HEPTANE"
      "C_6H_14",    "CH_3OH",      "C_6H_5NO_2","C_5H_12",     "C_3H_7OH",
      //"G4_N-HEXANE","G4_METHANOL","G4_NITROBENZENE","G4_N-PENTANE","G4_N-PROPYL_ALCOHOL",
      "C_5H_5N",    "C_8H_8",      "C_2Cl_4",   "C_7H_8",      "C_2Cl_3H",
      //"G4_PYRIDINE","G4_POLYSTYRENE","G4_TETRACHLOROETHYLENE","G4_TOLUENE","G4_TRICHLOROETHYLENE"
      "H_2O",       "C_8H_10",             
      // "G4_WATER", "G4_XYLENE"
 
      // solid 40 - 53
      "C_5H_5N_5",  "C_5H_5N_5O",  "(C_6H_11NO)-nylon",  "C_25H_52",
      // "G4_ADENINE", "G4_GUANINE", "G4_NYLON-6-6", "G4_PARAFFIN"
      "(C_2H_4)-Polyethylene",     "(C_5H_8O_2)-Polymethil_Methacrylate",
      // "G4_ETHYLENE", "G4_PLEXIGLASS"
      "(C_8H_8)-Polystyrene",      "A-150-tissue",       "Al_2O_3",  "CaF_2",
      // "G4_POLYSTYRENE", "G4_A-150_TISSUE", "G4_ALUMINUM_OXIDE", "G4_CALCIUM_FLUORIDE"
      "LiF",        "Photo_Emulsion",  "(C_2F_4)-Teflon",  "SiO_2"
      // "G4_LITHIUM_FLUORIDE", "G4_PHOTO_EMULSION", "G4_TEFLON", "G4_SILICON_DIOXIDE"
    } ;
 
    static const G4double meanExcitation[numberOfMolecula] = {
 
      53.7,   48.3,  85.0,  45.4,  49.2,
      49.1,   41.7,  87.8,  84.9,  49.5,
      48.2,   47.1,  71.6,
 
      64.2,   66.2,  63.4,  59.9,  166.3,
      89.1,  156.0,  56.4, 106.5,  103.3, 
      111.9,   60.0,  62.9,  72.6,   54.4,  
      54.0,  67.6,   75.8,  53.6,   61.1,  
      66.2,  64.0,  159.2,  62.5,  148.1,  
      75.0,  61.8,
 
      71.4,  75.0,   63.9,  48.3,   57.4,
      74.0,  68.7,   65.1, 145.2,  166.,
      94.0, 331.0,   99.1, 139.2 
    };
    // clang-format on
 
    for (std::size_t i = 0; i < numberOfMolecula; ++i) {
      if (chFormula == name[i]) {
        res = meanExcitation[i] * CLHEP::eV;
        break;
      }
    }
  }
  return res;
}

GetAdensity()

G4double G4IonisParamMat::GetAdensity ( ) const

inline

Definition at line 71 of file G4IonisParamMat.hh.

{ return fAdensity; };

Referenced by SetDensityEffectParameters().

GetAdjustmentFactor()

G4double G4IonisParamMat::GetAdjustmentFactor ( ) const

inline

Definition at line 68 of file G4IonisParamMat.hh.

{ return fAdjustmentFactor; };

GetBirksConstant()

G4double G4IonisParamMat::GetBirksConstant ( ) const

inline

Definition at line 121 of file G4IonisParamMat.hh.

{ return fBirks; };

Referenced by G4EmSaturation::DumpBirksCoefficients(), and G4EmSaturation::VisibleEnergyDeposition().

GetCdensity()

G4double G4IonisParamMat::GetCdensity ( ) const

inline

Definition at line 69 of file G4IonisParamMat.hh.

{ return fCdensity; };

Referenced by SetDensityEffectParameters().

GetD0density()

G4double G4IonisParamMat::GetD0density ( ) const

inline

Definition at line 74 of file G4IonisParamMat.hh.

{ return fD0density; };

Referenced by SetDensityEffectParameters().

GetDensityCorrection()

G4double G4IonisParamMat::GetDensityCorrection

(

G4double

x

)

const

Definition at line 95 of file G4IonisParamMat.cc.

{
  // x = log10(beta*gamma)
  G4double y = 0.0;
  if (x < fX0density) {
    if (fD0density > 0.0) {
      y = fD0density * G4Exp(twoln10 * (x - fX0density));
    }
  }
  else if (x >= fX1density) {
    y = twoln10 * x - fCdensity;
  }
  else {
    y = twoln10 * x - fCdensity + fAdensity * G4Exp(G4Log(fX1density - x) * fMdensity);
  }
  return y;
}

Referenced by DensityCorrection().

GetDensityEffectCalculator()

G4DensityEffectCalculator * G4IonisParamMat::GetDensityEffectCalculator ( ) const

inline

Definition at line 85 of file G4IonisParamMat.hh.

  {
    return fDensityEffectCalc;
  }

GetDensityEffectData()

G4DensityEffectData * G4IonisParamMat::GetDensityEffectData ( )

static

Definition at line 158 of file G4IonisParamMat.cc.

                                                           {
  return fDensityData;
}

Referenced by G4NistMessenger::SetNewValue().

GetEnergy0fluct()

G4double G4IonisParamMat::GetEnergy0fluct ( ) const

inline

Definition at line 110 of file G4IonisParamMat.hh.

{ return fEnergy0fluct; };

GetEnergy1fluct()

G4double G4IonisParamMat::GetEnergy1fluct ( ) const

inline

Definition at line 106 of file G4IonisParamMat.hh.

{ return fEnergy1fluct; };

GetEnergy2fluct()

G4double G4IonisParamMat::GetEnergy2fluct ( ) const

inline

Definition at line 108 of file G4IonisParamMat.hh.

{ return fEnergy2fluct; };

GetF1fluct()

G4double G4IonisParamMat::GetF1fluct ( ) const

inline

Definition at line 104 of file G4IonisParamMat.hh.

{ return fF1fluct; };

Referenced by G4UrbanFluctuation::SampleGlandz().

GetF2fluct()

G4double G4IonisParamMat::GetF2fluct ( ) const

inline

Definition at line 105 of file G4IonisParamMat.hh.

{ return fF2fluct; };

GetFermiEnergy()

G4double G4IonisParamMat::GetFermiEnergy ( ) const

inline

Definition at line 115 of file G4IonisParamMat.hh.

{ return fFermiEnergy; };

Referenced by G4ionEffectiveCharge::EffectiveCharge().

GetInvA23()

G4double G4IonisParamMat::GetInvA23 ( ) const

inline

Definition at line 117 of file G4IonisParamMat.hh.

{ return fInvA23; };

Referenced by G4CoulombScattering::MinPrimaryEnergy(), G4WentzelOKandVIxSection::SetupKinematic(), and G4WentzelVIRelXSection::SetupKinematic().

GetLFactor()

G4double G4IonisParamMat::GetLFactor ( ) const

inline

Definition at line 116 of file G4IonisParamMat.hh.

{ return fLfactor; };

GetLogEnergy1fluct()

G4double G4IonisParamMat::GetLogEnergy1fluct ( ) const

inline

Definition at line 107 of file G4IonisParamMat.hh.

{ return fLogEnergy1fluct; };

GetLogEnergy2fluct()

G4double G4IonisParamMat::GetLogEnergy2fluct ( ) const

inline

Definition at line 109 of file G4IonisParamMat.hh.

{ return fLogEnergy2fluct; };

GetLogMeanExcEnergy()

G4double G4IonisParamMat::GetLogMeanExcEnergy ( ) const

inline

Definition at line 62 of file G4IonisParamMat.hh.

{ return fLogMeanExcEnergy; };

GetMdensity()

G4double G4IonisParamMat::GetMdensity ( ) const

inline

Definition at line 70 of file G4IonisParamMat.hh.

{ return fMdensity; };

Referenced by SetDensityEffectParameters().

GetMeanEnergyPerIonPair()

G4double G4IonisParamMat::GetMeanEnergyPerIonPair ( ) const

inline

Definition at line 125 of file G4IonisParamMat.hh.

{ return fMeanEnergyPerIon; };

Referenced by G4ElectronIonPair::DumpMeanEnergyPerIonPair(), G4ElectronIonPair::MeanNumberOfIonsAlongStep(), and G4AllisonPositronAtRestModel::SampleSecondaries().

GetMeanExcitationEnergy()

G4double G4IonisParamMat::GetMeanExcitationEnergy ( ) const

inline

Definition at line 57 of file G4IonisParamMat.hh.

{ return fMeanExcitationEnergy; };

Referenced by G4hImpactIonisation::BuildPhysicsTable(), G4BetheBlochModel::ComputeDEDXPerVolume(), G4MollerBhabhaModel::ComputeDEDXPerVolume(), G4MuBetheBlochModel::ComputeDEDXPerVolume(), G4tgbGeometryDumper::DumpMaterial(), G4GDMLWriteMaterials::MaterialWrite(), G4AtimaEnergyLossModel::MinEnergyCut(), G4BetheBlochModel::MinEnergyCut(), G4BraggModel::MinEnergyCut(), G4IonParametrisedLossModel::MinEnergyCut(), G4LindhardSorensenIonModel::MinEnergyCut(), G4mplIonisationWithDeltaModel::MinEnergyCut(), G4MuBetheBlochModel::MinEnergyCut(), G4Material::operator<<, and G4hImpactIonisation::PrintInfoDefinition().

GetOrtoPositroniumFraction()

G4double G4IonisParamMat::GetOrtoPositroniumFraction ( ) const

inline

Definition at line 129 of file G4IonisParamMat.hh.

{ return fOrtoPositroniumFraction; };

GetPlasmaEnergy()

G4double G4IonisParamMat::GetPlasmaEnergy ( ) const

inline

Definition at line 67 of file G4IonisParamMat.hh.

{ return fPlasmaEnergy; };

Referenced by G4ChannelingFastSimCrystalData::SetMaterialProperties().

GetRateionexcfluct()

G4double G4IonisParamMat::GetRateionexcfluct ( ) const

inline

Definition at line 111 of file G4IonisParamMat.hh.

{ return fRateionexcfluct; };

GetShellCorrectionVector()

G4double * G4IonisParamMat::GetShellCorrectionVector ( ) const

inline

Definition at line 63 of file G4IonisParamMat.hh.

{ return fShellCorrectionVector; };

GetTaul()

G4double G4IonisParamMat::GetTaul ( ) const

inline

Definition at line 64 of file G4IonisParamMat.hh.

{ return fTaul; };

GetX0density()

G4double G4IonisParamMat::GetX0density ( ) const

inline

Definition at line 72 of file G4IonisParamMat.hh.

{ return fX0density; };

Referenced by SetDensityEffectParameters().

GetX1density()

G4double G4IonisParamMat::GetX1density ( ) const

inline

Definition at line 73 of file G4IonisParamMat.hh.

{ return fX1density; };

Referenced by SetDensityEffectParameters().

GetZeffective()

G4double G4IonisParamMat::GetZeffective ( ) const

inline

Definition at line 114 of file G4IonisParamMat.hh.

{ return fZeff; };

Referenced by G4AtimaEnergyLossModel::ComputeDEDXPerVolume(), G4MollerBhabhaModel::ComputeDEDXPerVolume(), G4AtimaFluctuations::Dispersion(), G4IonFluctuations::Dispersion(), G4ionEffectiveCharge::EffectiveCharge(), G4eDPWAElasticDCS::InitSCPCorrection(), and G4GoudsmitSaundersonTable::InitSCPCorrection().

operator!=()

G4bool G4IonisParamMat::operator!= ( const G4IonisParamMat & ) const

delete

operator=()

G4IonisParamMat & G4IonisParamMat::operator= ( const G4IonisParamMat & )

delete

operator==()

G4bool G4IonisParamMat::operator== ( const G4IonisParamMat & ) const

delete

SetBirksConstant()

void G4IonisParamMat::SetBirksConstant ( G4double value )

inline

Definition at line 120 of file G4IonisParamMat.hh.

{ fBirks = value; };

SetDensityEffectParameters() [1/2]

void G4IonisParamMat::SetDensityEffectParameters

(

const G4Material *

bmat

)

Definition at line 499 of file G4IonisParamMat.cc.

{
  G4AutoLock l(&ionisMutex);
  const G4IonisParamMat* ipm = bmat->GetIonisation();
  fCdensity = ipm->GetCdensity();
  fMdensity = ipm->GetMdensity();
  fAdensity = ipm->GetAdensity();
  fX0density = ipm->GetX0density();
  fX1density = ipm->GetX1density();
  fD0density = ipm->GetD0density();
 
  G4double corr = G4Log(bmat->GetDensity() / fMaterial->GetDensity());
  fCdensity += corr;
  fX0density += corr / twoln10;
  fX1density += corr / twoln10;
  l.unlock();
}

SetDensityEffectParameters() [2/2]

void G4IonisParamMat::SetDensityEffectParameters	(	G4double	cd,
		G4double	md,
		G4double	ad,
		G4double	x0,
		G4double	x1,
		G4double	d0 )

Definition at line 483 of file G4IonisParamMat.cc.

{
  // no check on consistence of user parameters
  G4AutoLock l(&ionisMutex);
  fCdensity = cd;
  fMdensity = md;
  fAdensity = ad;
  fX0density = x0;
  fX1density = x1;
  fD0density = d0;
  l.unlock();
}

SetMeanEnergyPerIonPair()

void G4IonisParamMat::SetMeanEnergyPerIonPair ( G4double value )

inline

Definition at line 124 of file G4IonisParamMat.hh.

{ fMeanEnergyPerIon = value; };

Referenced by G4ElectronIonPair::FindG4MeanEnergyPerIonPair().

SetMeanExcitationEnergy()

void G4IonisParamMat::SetMeanExcitationEnergy

(

G4double

value

)

Definition at line 456 of file G4IonisParamMat.cc.

{
  if (value == fMeanExcitationEnergy || value <= 0.0) {
    return;
  }
  if (G4NistManager::Instance()->GetVerbose() > 1) {
    G4cout << "G4Material: Mean excitation energy is changed for " << fMaterial->GetName()
           << " Iold= " << fMeanExcitationEnergy / CLHEP::eV << "eV; Inew= " << value / eV << " eV;"
           << G4endl;
  }
 
  fMeanExcitationEnergy = value;
 
  // add corrections to density effect
  G4double newlog = G4Log(value);
  G4double corr = 2 * (newlog - fLogMeanExcEnergy);
  fCdensity += corr;
  fX0density += corr / twoln10;
  fX1density += corr / twoln10;
 
  // recompute parameters of fluctuation model
  fLogMeanExcEnergy = newlog;
  ComputeFluctModel();
}

Referenced by G4tgbMaterialMgr::FindOrBuildG4Material(), and G4GDMLReadMaterials::MaterialRead().

SetOrtoPositroniumFraction()

void G4IonisParamMat::SetOrtoPositroniumFraction ( G4double value )

inline

Definition at line 128 of file G4IonisParamMat.hh.

{ fOrtoPositroniumFraction = value; };

---

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

• G4IonisParamMat.hh
• G4IonisParamMat.cc