G4PenelopeRayleighModelMI Class Reference

#include <G4PenelopeRayleighModelMI.hh>

Inheritance diagram for G4PenelopeRayleighModelMI:

Public Member Functions
	G4PenelopeRayleighModelMI (const G4ParticleDefinition *p=nullptr, const G4String &processName="PenRayleighMI")
virtual	~G4PenelopeRayleighModelMI ()
void	Initialise (const G4ParticleDefinition *, const G4DataVector &) override
void	InitialiseLocal (const G4ParticleDefinition *, G4VEmModel *masterModel) override
G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A=0, G4double cut=0, G4double emax=DBL_MAX) override
G4double	CrossSectionPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0., G4double maxEnergy=DBL_MAX) override
void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4DynamicParticle *, G4double tmin, G4double maxEnergy) override
void	SetVerbosityLevel (G4int lev)
G4int	GetVerbosityLevel ()
void	DumpFormFactorTable (const G4Material *)
void	SetMIActive (G4bool val)
G4bool	IsMIActive ()
G4PenelopeRayleighModelMI &	operator= (const G4PenelopeRayleighModelMI &right)=delete
	G4PenelopeRayleighModelMI (const G4PenelopeRayleighModelMI &)=delete
Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)
virtual	~G4VEmModel ()
virtual void	InitialiseForMaterial (const G4ParticleDefinition *, const G4Material *)
virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)
virtual G4double	ComputeDEDXPerVolume (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=DBL_MAX)
virtual G4double	GetPartialCrossSection (const G4Material *, G4int level, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	ComputeCrossSectionPerShell (const G4ParticleDefinition *, G4int Z, G4int shellIdx, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
virtual G4double	ChargeSquareRatio (const G4Track &)
virtual G4double	GetChargeSquareRatio (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual G4double	GetParticleCharge (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual void	StartTracking (G4Track *)
virtual void	CorrectionsAlongStep (const G4MaterialCutsCouple *, const G4DynamicParticle *, const G4double &length, G4double &eloss)
virtual G4double	Value (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy)
virtual G4double	MinPrimaryEnergy (const G4Material *, const G4ParticleDefinition *, G4double cut=0.0)
virtual G4double	MinEnergyCut (const G4ParticleDefinition *, const G4MaterialCutsCouple *)
virtual void	SetupForMaterial (const G4ParticleDefinition *, const G4Material *, G4double kineticEnergy)
virtual void	DefineForRegion (const G4Region *)
virtual void	FillNumberOfSecondaries (G4int &numberOfTriplets, G4int &numberOfRecoil)
virtual void	ModelDescription (std::ostream &outFile) const
void	InitialiseElementSelectors (const G4ParticleDefinition *, const G4DataVector &)
std::vector< G4EmElementSelector * > *	GetElementSelectors ()
void	SetElementSelectors (std::vector< G4EmElementSelector * > *)
G4double	ComputeDEDX (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=DBL_MAX)
G4double	CrossSection (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4double	ComputeMeanFreePath (const G4ParticleDefinition *, G4double kineticEnergy, const G4Material *, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, const G4Element *, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	SelectRandomAtom (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	SelectTargetAtom (const G4MaterialCutsCouple *, const G4ParticleDefinition *, G4double kineticEnergy, G4double logKineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	SelectRandomAtom (const G4Material *, const G4ParticleDefinition *, G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)
const G4Element *	GetCurrentElement (const G4Material *mat=nullptr) const
G4int	SelectRandomAtomNumber (const G4Material *) const
const G4Isotope *	GetCurrentIsotope (const G4Element *elm=nullptr) const
G4int	SelectIsotopeNumber (const G4Element *) const
void	SetParticleChange (G4VParticleChange *, G4VEmFluctuationModel *f=nullptr)
void	SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)
G4ElementData *	GetElementData ()
G4PhysicsTable *	GetCrossSectionTable ()
G4VEmFluctuationModel *	GetModelOfFluctuations ()
G4VEmAngularDistribution *	GetAngularDistribution ()
G4VEmModel *	GetTripletModel ()
void	SetTripletModel (G4VEmModel *)
void	SetAngularDistribution (G4VEmAngularDistribution *)
G4double	HighEnergyLimit () const
G4double	LowEnergyLimit () const
G4double	HighEnergyActivationLimit () const
G4double	LowEnergyActivationLimit () const
G4double	PolarAngleLimit () const
G4double	SecondaryThreshold () const
G4bool	DeexcitationFlag () const
G4bool	ForceBuildTableFlag () const
G4bool	UseAngularGeneratorFlag () const
void	SetAngularGeneratorFlag (G4bool)
void	SetHighEnergyLimit (G4double)
void	SetLowEnergyLimit (G4double)
void	SetActivationHighEnergyLimit (G4double)
void	SetActivationLowEnergyLimit (G4double)
G4bool	IsActive (G4double kinEnergy) const
void	SetPolarAngleLimit (G4double)
void	SetSecondaryThreshold (G4double)
void	SetDeexcitationFlag (G4bool val)
void	SetForceBuildTable (G4bool val)
void	SetFluctuationFlag (G4bool val)
void	SetMasterThread (G4bool val)
G4bool	IsMaster () const
void	SetUseBaseMaterials (G4bool val)
G4bool	UseBaseMaterials () const
G4double	MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)
const G4String &	GetName () const
void	SetCurrentCouple (const G4MaterialCutsCouple *)
G4bool	IsLocked () const
void	SetLocked (G4bool)
void	SetLPMFlag (G4bool)
G4VEmModel &	operator= (const G4VEmModel &right)=delete
	G4VEmModel (const G4VEmModel &)=delete

Additional Inherited Members
Protected Member Functions inherited from G4VEmModel
G4ParticleChangeForLoss *	GetParticleChangeForLoss ()
G4ParticleChangeForGamma *	GetParticleChangeForGamma ()
virtual G4double	MaxSecondaryEnergy (const G4ParticleDefinition *, G4double kineticEnergy)
const G4MaterialCutsCouple *	CurrentCouple () const
void	SetCurrentElement (const G4Element *)
Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData = nullptr
G4VParticleChange *	pParticleChange = nullptr
G4PhysicsTable *	xSectionTable = nullptr
const G4Material *	pBaseMaterial = nullptr
const std::vector< G4double > *	theDensityFactor = nullptr
const std::vector< G4int > *	theDensityIdx = nullptr
G4double	inveplus
G4double	pFactor = 1.0
std::size_t	currentCoupleIndex = 0
std::size_t	basedCoupleIndex = 0
G4bool	lossFlucFlag = true

Detailed Description

Definition at line 71 of file G4PenelopeRayleighModelMI.hh.

Constructor & Destructor Documentation

G4PenelopeRayleighModelMI() [1/2]

G4PenelopeRayleighModelMI::G4PenelopeRayleighModelMI ( const G4ParticleDefinition * p = nullptr, const G4String & processName = "PenRayleighMI" )

explicit

Definition at line 72 of file G4PenelopeRayleighModelMI.cc.

                                                  :
  G4VEmModel(nam),
  fParticleChange(nullptr),fParticle(nullptr),fLogFormFactorTable(nullptr),fPMaxTable(nullptr),
  fSamplingTable(nullptr),fMolInterferenceData(nullptr),fAngularFunction(nullptr), fKnownMaterials(nullptr),
  fIsInitialised(false),fLocalTable(false),fIsMIActive(true) 
{
  fIntrinsicLowEnergyLimit = 100.0*eV;
  fIntrinsicHighEnergyLimit = 100.0*GeV;            
  //SetLowEnergyLimit(fIntrinsicLowEnergyLimit);
  SetHighEnergyLimit(fIntrinsicHighEnergyLimit);
  
  if (part) SetParticle(part);
  
  fVerboseLevel = 0;
  // Verbosity scale:
  // 0 = nothing
  // 1 = warning for energy non-conservation
  // 2 = details of energy budget
  // 3 = calculation of FF and CS, file openings, sampling of atoms
  // 4 = entering in methods
  
  //build the energy grid. It is the same for all materials
  G4double logenergy = G4Log(fIntrinsicLowEnergyLimit/2.);
  G4double logmaxenergy = G4Log(1.5*fIntrinsicHighEnergyLimit);
  //finer grid below 160 keV
  G4double logtransitionenergy = G4Log(160*keV);
  G4double logfactor1 = G4Log(10.)/250.;
  G4double logfactor2 = logfactor1*10;
  fLogEnergyGridPMax.push_back(logenergy);
  do {
    if (logenergy < logtransitionenergy)
      logenergy += logfactor1;
    else
      logenergy += logfactor2;
    fLogEnergyGridPMax.push_back(logenergy);
  } while (logenergy < logmaxenergy);   
}

~G4PenelopeRayleighModelMI()

G4PenelopeRayleighModelMI::~G4PenelopeRayleighModelMI ( )

virtual

Definition at line 113 of file G4PenelopeRayleighModelMI.cc.

{
  if (IsMaster() || fLocalTable) {
    
    for(G4int i=0; i<=fMaxZ; ++i) 
      {
    if(fLogAtomicCrossSection[i]) 
      { 
        delete fLogAtomicCrossSection[i];
        fLogAtomicCrossSection[i] = nullptr;
      }
    if(fAtomicFormFactor[i])
      {
        delete fAtomicFormFactor[i];
        fAtomicFormFactor[i] = nullptr;
      }
      }    
    if (fMolInterferenceData) {
      for (auto& item : (*fMolInterferenceData))
    if (item.second) delete item.second;
      delete fMolInterferenceData;
      fMolInterferenceData = nullptr;
    }    
    if (fKnownMaterials)
      {
    delete fKnownMaterials;
    fKnownMaterials = nullptr;
      }
    if (fAngularFunction)
      {
    delete fAngularFunction;
    fAngularFunction = nullptr;
      }
    ClearTables();    
  }
}

G4PenelopeRayleighModelMI() [2/2]

G4PenelopeRayleighModelMI::G4PenelopeRayleighModelMI ( const G4PenelopeRayleighModelMI & )

delete

Member Function Documentation

ComputeCrossSectionPerAtom()

G4double G4PenelopeRayleighModelMI::ComputeCrossSectionPerAtom ( const G4ParticleDefinition * , G4double kinEnergy, G4double Z, G4double A = 0, G4double cut = 0, G4double emax = DBL_MAX )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 319 of file G4PenelopeRayleighModelMI.cc.

{
  //Cross section of Rayleigh scattering in Penelope v2008 is calculated by the EPDL97
  //tabulation, Cuellen et al. (1997), with non-relativistic form factors from Hubbel
  //et al. J. Phys. Chem. Ref. Data 4 (1975) 471; Erratum ibid. 6 (1977) 615.
 
  if (fVerboseLevel > 3)
    G4cout << "Calling CrossSectionPerAtom() of G4PenelopeRayleighModelMI" << G4endl;
 
  G4int iZ = G4int(Z);
  if (!fLogAtomicCrossSection[iZ]) {
    //If we are here, it means that Initialize() was inkoved, but the MaterialTable was
    //not filled up. This can happen in a UnitTest or via G4EmCalculator
    if (fVerboseLevel > 0) {
      //Issue a G4Exception (warning) only in verbose mode
      G4ExceptionDescription ed;
      ed << "Unable to retrieve the cross section table for Z=" << iZ << G4endl;
      ed << "This can happen only in Unit Tests or via G4EmCalculator" << G4endl;
      G4Exception("G4PenelopeRayleighModelMI::ComputeCrossSectionPerAtom()",
          "em2040",JustWarning,ed);
    }
 
    //protect file reading via autolock
    G4AutoLock lock(&PenelopeRayleighModelMutex);
    ReadDataFile(iZ);
    lock.unlock();      
  }
 
  G4double cross = 0;
  G4PhysicsFreeVector* atom = fLogAtomicCrossSection[iZ];
  if (!atom) {
    G4ExceptionDescription ed;
    ed << "Unable to find Z=" << iZ << " in the atomic cross section table" << G4endl;
    G4Exception("G4PenelopeRayleighModelMI::ComputeCrossSectionPerAtom()",
        "em2041",FatalException,ed);
    return 0;
  }
 
  G4double logene = G4Log(energy);
  G4double logXS = atom->Value(logene);
  cross = G4Exp(logXS);
 
  if (fVerboseLevel > 2) {
    G4cout << "Rayleigh cross section at " << energy/keV << " keV for Z=" 
       << Z << " = " << cross/barn << " barn" << G4endl;
  }
  return cross;
}

CrossSectionPerVolume()

G4double G4PenelopeRayleighModelMI::CrossSectionPerVolume ( const G4Material * material, const G4ParticleDefinition * p, G4double kineticEnergy, G4double cutEnergy = 0., G4double maxEnergy = DBL_MAX )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 409 of file G4PenelopeRayleighModelMI.cc.

{
  //check if we are in a Unit Test (only for the first time)
  static G4bool amInAUnitTest = false;
  if (G4ProductionCutsTable::GetProductionCutsTable()->GetTableSize() == 0 && !amInAUnitTest)
    {
      amInAUnitTest = true;
      G4ExceptionDescription ed;
      ed << "The ProductionCuts table is empty " << G4endl;
      ed << "This should happen only in Unit Tests" << G4endl;
      G4Exception("G4PenelopeRayleighModelMI::CrossSectionPerVolume()",
          "em2019",JustWarning,ed);
    }
  //If the material does not have a MIFF, continue with the old-style calculation
  G4String matname = material->GetName();
  if (amInAUnitTest)
    {
      //No need to lock, as this is always called in a master
      const G4ElementVector* theElementVector = material->GetElementVector();
      //protect file reading via autolock
      for (std::size_t j=0;j<material->GetNumberOfElements();++j) {
    G4int iZ = theElementVector->at(j)->GetZasInt();
    if (!fLogAtomicCrossSection[iZ]) {
      ReadDataFile(iZ);
    }
      }     
      if (fIsMIActive)
    ReadMolInterferenceData(matname); 
      if (!fLogFormFactorTable->count(material))
    BuildFormFactorTable(material);
      if (!(fSamplingTable->count(material)))
    InitializeSamplingAlgorithm(material);
      if (!fPMaxTable->count(material))
    GetPMaxTable(material); 
    }
  G4bool useMIFF = fIsMIActive && (fMolInterferenceData->count(matname) || matname.find("MedMat") != std::string::npos);
  if (!useMIFF)
    {
      if (fVerboseLevel > 2)
    G4cout << "Rayleigh CS of: " << matname << " calculated through CSperAtom!" << G4endl;
      return G4VEmModel::CrossSectionPerVolume(material,p,energy);   
    }
 
  // If we are here, it means that we have to integrate the cross section
  if (fVerboseLevel > 2)
    G4cout << "Rayleigh CS of: " << matname 
       << " calculated through integration of the DCS" << G4endl;
 
  G4double cs = 0;
  
  //force null cross-section if below the low-energy edge of the table
  if (energy < LowEnergyLimit()) 
    return cs;
 
  //if the material is a CRYSTAL, forbid this process
  if (material->IsExtended() && material->GetName() != "CustomMat") {       
    G4ExtendedMaterial* extendedmaterial = (G4ExtendedMaterial*)material;
    G4CrystalExtension* crystalExtension = (G4CrystalExtension*)extendedmaterial->RetrieveExtension("crystal");
    if (crystalExtension != 0) {
      G4cout << "The material has a crystalline structure, a dedicated diffraction model is used!" << G4endl;
      return 0;
    }
  }
 
  //GET MATERIAL INFORMATION    
  G4double atomDensity = material->GetTotNbOfAtomsPerVolume();  
  std::size_t nElements = material->GetNumberOfElements();
  const G4ElementVector* elementVector = material->GetElementVector();
  const G4double* fractionVector = material->GetFractionVector();  
    
  //Stoichiometric factors
  std::vector<G4double> *StoichiometricFactors = new std::vector<G4double>;
  for (std::size_t i=0;i<nElements;++i) {
    G4double fraction = fractionVector[i];
    G4double atomicWeigth = (*elementVector)[i]->GetA()/(g/mole);
    StoichiometricFactors->push_back(fraction/atomicWeigth);
  }
  G4double MaxStoichiometricFactor = 0.;
  for (std::size_t i=0;i<nElements;++i) {
    if ((*StoichiometricFactors)[i] > MaxStoichiometricFactor)
      MaxStoichiometricFactor = (*StoichiometricFactors)[i];
  }
  for (std::size_t i=0;i<nElements;++i) {
    (*StoichiometricFactors)[i] /=  MaxStoichiometricFactor;
  }
 
  //Equivalent atoms per molecule
  G4double atPerMol = 0;
  for (std::size_t i=0;i<nElements;++i)
    atPerMol += (*StoichiometricFactors)[i];    
  G4double moleculeDensity = 0.;
  if (atPerMol) moleculeDensity = atomDensity/atPerMol;
  
  if (fVerboseLevel > 2)
    G4cout << "Material " << material->GetName() << " has " << atPerMol << " atoms "
       << "per molecule and " << moleculeDensity/(cm*cm*cm) << " molecule/cm3" << G4endl;
  
  //Equivalent molecular weight (dimensionless)
  G4double MolWeight = 0.;
  for (std::size_t i=0;i<nElements;++i)
    MolWeight += (*StoichiometricFactors)[i]*(*elementVector)[i]->GetA()/(g/mole);
  
  if (fVerboseLevel > 2)
    G4cout << "Molecular weight of " << matname << ": " << MolWeight << " g/mol" << G4endl; 
  
  G4double IntegrandFun[fNtheta];           
  for (G4int k=0; k<fNtheta; k++) {             
    G4double theta = fAngularFunction->Energy(k); //the x-value is called "Energy", but is an angle
    G4double F2 = GetFSquared(material,CalculateQSquared(theta,energy));    
    IntegrandFun[k] = (*fAngularFunction)[k]*F2;
  } 
 
  G4double constant = pi*classic_electr_radius*classic_electr_radius;   
  cs = constant*IntegrateFun(IntegrandFun,fNtheta,fDTheta); 
  
  //Now cs is the cross section per molecule, let's calculate the cross section per volume
  G4double csvolume = cs*moleculeDensity;  
  
  //print CS and mfp
  if (fVerboseLevel > 2)
    G4cout << "Rayleigh CS of " << matname << " at " << energy/keV 
       << " keV: " << cs/barn << " barn"
       << ", mean free path: " << 1./csvolume/mm << " mm" << G4endl;
 
  delete StoichiometricFactors;  
  //return CS           
  return csvolume;  
}

DumpFormFactorTable()

void G4PenelopeRayleighModelMI::DumpFormFactorTable

(

const G4Material *

mat

)

Definition at line 1674 of file G4PenelopeRayleighModelMI.cc.

{
  G4cout << "*****************************************************************" << G4endl;
  G4cout << "G4PenelopeRayleighModelMI: Form Factor Table for " << mat->GetName() << G4endl;
  //try to use the same format as Penelope-Fortran, namely Q (/m_e*c) and F
  G4cout <<  "Q/(m_e*c)                 F(Q)     " << G4endl;
  G4cout << "*****************************************************************" << G4endl;
  if (!fLogFormFactorTable->count(mat))
    BuildFormFactorTable(mat);
 
  G4PhysicsFreeVector* theVec = fLogFormFactorTable->find(mat)->second;
  for (std::size_t i=0;i<theVec->GetVectorLength();++i)
    {
      G4double logQ2 = theVec->GetLowEdgeEnergy(i);
      G4double Q = G4Exp(0.5*logQ2);
      G4double logF2 = (*theVec)[i];
      G4double F = G4Exp(0.5*logF2);
      G4cout << Q << "              " << F << G4endl;
    }
  //DONE
  return;
}

GetVerbosityLevel()

G4int G4PenelopeRayleighModelMI::GetVerbosityLevel ( )

inline

Definition at line 105 of file G4PenelopeRayleighModelMI.hh.

{return fVerboseLevel;};

Initialise()

void G4PenelopeRayleighModelMI::Initialise ( const G4ParticleDefinition * part, const G4DataVector &  )

overridevirtual

Implements G4VEmModel.

Definition at line 180 of file G4PenelopeRayleighModelMI.cc.

{
  if (fVerboseLevel > 3)
    G4cout << "Calling G4PenelopeRayleighModelMI::Initialise()" << G4endl;
  
  SetParticle(part);
 
  if (fVerboseLevel)
    G4cout << "# Molecular Interference is " << (fIsMIActive ? "ON" : "OFF") << " #" << G4endl;
  
  //Only the master model creates/fills/destroys the tables
  if (IsMaster() && part == fParticle) {
    //clear tables depending on materials, not the atomic ones
    ClearTables();
 
    //Use here the highest verbosity, from G4EmParameter or local
    G4int globVerb = G4EmParameters::Instance()->Verbose();
    if (globVerb > fVerboseLevel)
      {
    fVerboseLevel = globVerb;
    if (fVerboseLevel)
      G4cout << "Verbosity level of G4PenelopeRayleighModelMI set to " << fVerboseLevel << 
        " from G4EmParameters()" << G4endl;
      }
    if (fVerboseLevel > 3)
      G4cout << "Calling G4PenelopeRayleighModelMI::Initialise() [master]" << G4endl;
    
    //Load the list of known materials and the DCS integration grid
    if (fIsMIActive)
      {
    if (!fKnownMaterials)
      fKnownMaterials = new std::map<G4String,G4String>;
    if (!fKnownMaterials->size())
      LoadKnownMIFFMaterials();
    if (!fAngularFunction)
      {
        //Create and fill once
        fAngularFunction = new G4PhysicsFreeVector(fNtheta);    
        CalculateThetaAndAngFun(); //angular funtion for DCS integration
      }
      }
    if (fIsMIActive && !fMolInterferenceData)
      fMolInterferenceData = new std::map<G4String,G4PhysicsFreeVector*>; 
    if (!fLogFormFactorTable)
      fLogFormFactorTable = new std::map<const G4Material*,G4PhysicsFreeVector*>;    
    if (!fPMaxTable)
      fPMaxTable = new std::map<const G4Material*,G4PhysicsFreeVector*>;    
    if (!fSamplingTable)
      fSamplingTable = new std::map<const G4Material*,G4PenelopeSamplingData*>;
            
    //loop on the used materials              
    G4ProductionCutsTable* theCoupleTable = G4ProductionCutsTable::GetProductionCutsTable();
    
    for (G4int i=0;i<(G4int)theCoupleTable->GetTableSize();++i) {
      const G4Material* material =
    theCoupleTable->GetMaterialCutsCouple(i)->GetMaterial();
      const G4ElementVector* theElementVector = material->GetElementVector();
      
      for (std::size_t j=0;j<material->GetNumberOfElements();++j) {
    G4int iZ = theElementVector->at(j)->GetZasInt();
    //read data files only in the master
    if (!fLogAtomicCrossSection[iZ])
      ReadDataFile(iZ);
      }
      
      //1) Read MI form factors
      if (fIsMIActive && !fMolInterferenceData->count(material->GetName()))
    ReadMolInterferenceData(material->GetName()); 
      
      //2) If the table has not been built for the material, do it!
      if (!fLogFormFactorTable->count(material))
    BuildFormFactorTable(material);
      
      //3) retrieve or build the sampling table
      if (!(fSamplingTable->count(material)))
    InitializeSamplingAlgorithm(material);
      
      //4) retrieve or build the pMax data
      if (!fPMaxTable->count(material))
    GetPMaxTable(material); 
    }
    
    if (fVerboseLevel > 1) {
      G4cout << G4endl << "Penelope Rayleigh model v2008 is initialized" << G4endl
         << "Energy range: "
         << LowEnergyLimit() / keV << " keV - "
         << HighEnergyLimit() / GeV << " GeV"
         << G4endl;
    }    
  }
 
  if (fIsInitialised) 
    return;
  fParticleChange = GetParticleChangeForGamma();
  fIsInitialised = true;
}

InitialiseLocal()

void G4PenelopeRayleighModelMI::InitialiseLocal ( const G4ParticleDefinition * part, G4VEmModel * masterModel )

overridevirtual

Reimplemented from G4VEmModel.

Definition at line 280 of file G4PenelopeRayleighModelMI.cc.

{
  if (fVerboseLevel > 3)
    G4cout << "Calling  G4PenelopeRayleighModelMI::InitialiseLocal()" << G4endl;
  
  //Check that particle matches: one might have multiple master models 
  //(e.g. for e+ and e-)
  if (part == fParticle) {  
    
    //Get the const table pointers from the master to the workers
    const G4PenelopeRayleighModelMI* theModel =
      static_cast<G4PenelopeRayleighModelMI*> (masterModel);
    
    //Copy pointers to the data tables
    for(G4int i=0; i<=fMaxZ; ++i) 
      {
    fLogAtomicCrossSection[i] = theModel->fLogAtomicCrossSection[i];
    fAtomicFormFactor[i] = theModel->fAtomicFormFactor[i];
      }
    fMolInterferenceData = theModel->fMolInterferenceData;   
    fLogFormFactorTable = theModel->fLogFormFactorTable;
    fPMaxTable = theModel->fPMaxTable;
    fSamplingTable = theModel->fSamplingTable;
    fKnownMaterials = theModel->fKnownMaterials;
    fAngularFunction = theModel->fAngularFunction;
 
    //Copy the G4DataVector with the grid
    fLogQSquareGrid = theModel->fLogQSquareGrid;
    
    //Same verbosity for all workers, as the master
    fVerboseLevel = theModel->fVerboseLevel;    
  }  
  return;
}

IsMIActive()

G4bool G4PenelopeRayleighModelMI::IsMIActive ( )

inline

Definition at line 112 of file G4PenelopeRayleighModelMI.hh.

{return fIsMIActive;};

operator=()

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

delete

SampleSecondaries()

void G4PenelopeRayleighModelMI::SampleSecondaries ( std::vector< G4DynamicParticle * > * , const G4MaterialCutsCouple * couple, const G4DynamicParticle * aDynamicGamma, G4double tmin, G4double maxEnergy )

overridevirtual

Implements G4VEmModel.

Definition at line 710 of file G4PenelopeRayleighModelMI.cc.

{
  // Sampling of the Rayleigh final state (namely, scattering angle of the photon)
  // from the Penelope2008 model. The scattering angle is sampled from the atomic
  // cross section dOmega/d(cosTheta) from Born ("Atomic Phyisics", 1969), disregarding
  // anomalous scattering effects. The Form Factor F(Q) function which appears in the
  // analytical cross section is retrieved via the method GetFSquared(); atomic data
  // are tabulated for F(Q). Form factor for compounds is calculated according to
  // the additivity rule. The sampling from the F(Q) is made via a Rational Inverse
  // Transform with Aliasing (RITA) algorithm; RITA parameters are calculated once
  // for each material and managed by G4PenelopeSamplingData objects.
  // The sampling algorithm (rejection method) has efficiency 67% at low energy, and
  // increases with energy. For E=100 keV the efficiency is 100% and 86% for
  // hydrogen and uranium, respectively.
 
  if (fVerboseLevel > 3)
    G4cout << "Calling SamplingSecondaries() of G4PenelopeRayleighModelMI" << G4endl;
 
  G4double photonEnergy0 = aDynamicGamma->GetKineticEnergy();
 
  if (photonEnergy0 <= fIntrinsicLowEnergyLimit) {
    fParticleChange->ProposeTrackStatus(fStopAndKill);
    fParticleChange->SetProposedKineticEnergy(0.);
    fParticleChange->ProposeLocalEnergyDeposit(photonEnergy0);
    return;
  }
 
  G4ParticleMomentum photonDirection0 = aDynamicGamma->GetMomentumDirection();
  const G4Material* theMat = couple->GetMaterial();
 
  //1) Verify if tables are ready
  //Either Initialize() was not called, or we are in a slave and InitializeLocal() was
  //not invoked
  if (!fPMaxTable || !fSamplingTable || !fLogFormFactorTable) {    
    //create a **thread-local** version of the table. Used only for G4EmCalculator and
    //Unit Tests
    fLocalTable = true;
    if (!fLogFormFactorTable)
      fLogFormFactorTable = new std::map<const G4Material*,G4PhysicsFreeVector*>;
    if (!fPMaxTable)
      fPMaxTable = new std::map<const G4Material*,G4PhysicsFreeVector*>;
    if (!fSamplingTable)
      fSamplingTable = new std::map<const G4Material*,G4PenelopeSamplingData*>;
    if (fIsMIActive && !fMolInterferenceData)
      fMolInterferenceData = new std::map<G4String,G4PhysicsFreeVector*>; 
  }
 
  if (!fSamplingTable->count(theMat)) {
    //If we are here, it means that Initialize() was inkoved, but the MaterialTable was
    //not filled up. This can happen in a UnitTest
    if (fVerboseLevel > 0) {
      //Issue a G4Exception (warning) only in verbose mode
      G4ExceptionDescription ed;
      ed << "Unable to find the fSamplingTable data for " <<
    theMat->GetName() << G4endl;
      ed << "This can happen only in Unit Tests" << G4endl;
      G4Exception("G4PenelopeRayleighModelMI::SampleSecondaries()",
          "em2019",JustWarning,ed);
    }
    const G4ElementVector* theElementVector = theMat->GetElementVector();
    //protect file reading via autolock
    G4AutoLock lock(&PenelopeRayleighModelMutex);
    for (std::size_t j=0;j<theMat->GetNumberOfElements();++j) {
      G4int iZ = theElementVector->at(j)->GetZasInt();
      if (!fLogAtomicCrossSection[iZ]) {
    lock.lock();
    ReadDataFile(iZ);
    lock.unlock();
      }
    }
    lock.lock();
 
    //1) If the table has not been built for the material, do it!
    if (!fLogFormFactorTable->count(theMat))
      BuildFormFactorTable(theMat);
    
    //2) retrieve or build the sampling table
    if (!(fSamplingTable->count(theMat)))
      InitializeSamplingAlgorithm(theMat);
    
    //3) retrieve or build the pMax data
    if (!fPMaxTable->count(theMat))
      GetPMaxTable(theMat);
    
    lock.unlock();
  }
    
  //Ok, restart the job
  G4PenelopeSamplingData* theDataTable = fSamplingTable->find(theMat)->second;
  G4PhysicsFreeVector* thePMax = fPMaxTable->find(theMat)->second;
  G4double cosTheta = 1.0;
 
  //OK, ready to go!
  G4double qmax = 2.0*photonEnergy0/electron_mass_c2; //this is non-dimensional now
 
  if (qmax < 1e-10) { //very low momentum transfer
    G4bool loopAgain=false;
    do {
      loopAgain = false;
      cosTheta = 1.0-2.0*G4UniformRand();
      G4double G = 0.5*(1+cosTheta*cosTheta);
      if (G4UniformRand()>G)
    loopAgain = true;
    } while(loopAgain);
  }
  else { //larger momentum transfer
    std::size_t nData = theDataTable->GetNumberOfStoredPoints();
    G4double LastQ2inTheTable = theDataTable->GetX(nData-1);
    G4double q2max = std::min(qmax*qmax,LastQ2inTheTable);
 
    G4bool loopAgain = false;
    G4double MaxPValue = thePMax->Value(photonEnergy0);
    G4double xx=0;
 
    //Sampling by rejection method. The rejection function is
    //G = 0.5*(1+cos^2(theta))
    do {
      loopAgain = false;
      G4double RandomMax = G4UniformRand()*MaxPValue;
      xx = theDataTable->SampleValue(RandomMax);
 
      //xx is a random value of q^2 in (0,q2max),sampled according to
      //F(Q^2) via the RITA algorithm
      if (xx > q2max)
    loopAgain = true;
      cosTheta = 1.0-2.0*xx/q2max;
      G4double G = 0.5*(1+cosTheta*cosTheta);
      if (G4UniformRand()>G)
    loopAgain = true;
    } while(loopAgain);
  }
 
  G4double sinTheta = std::sqrt(1-cosTheta*cosTheta);
 
  //Scattered photon angles. ( Z - axis along the parent photon)
  G4double phi = twopi * G4UniformRand() ;
  G4double dirX = sinTheta*std::cos(phi);
  G4double dirY = sinTheta*std::sin(phi);
  G4double dirZ = cosTheta;
 
  //Update G4VParticleChange for the scattered photon
  G4ThreeVector photonDirection1(dirX, dirY, dirZ);
 
  photonDirection1.rotateUz(photonDirection0);
  fParticleChange->ProposeMomentumDirection(photonDirection1) ;
  fParticleChange->SetProposedKineticEnergy(photonEnergy0) ;
 
  return;
}

SetMIActive()

void G4PenelopeRayleighModelMI::SetMIActive ( G4bool val )

inline

Definition at line 111 of file G4PenelopeRayleighModelMI.hh.

{fIsMIActive = val;};

SetVerbosityLevel()

void G4PenelopeRayleighModelMI::SetVerbosityLevel ( G4int lev )

inline

Definition at line 104 of file G4PenelopeRayleighModelMI.hh.

{fVerboseLevel = lev;};

---

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

• G4PenelopeRayleighModelMI.hh
• G4PenelopeRayleighModelMI.cc