#include <G4LivermoreRayleighModel.hh>

Inheritance diagram for G4LivermoreRayleighModel:

Collaboration diagram for G4LivermoreRayleighModel:

Public Member Functions
	G4LivermoreRayleighModel ()

virtual	~G4LivermoreRayleighModel ()

virtual void	Initialise (const G4ParticleDefinition *, const G4DataVector &)

virtual void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel)

virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)

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

virtual void	SampleSecondaries (std::vector< G4DynamicParticle > , const G4MaterialCutsCouple , const G4DynamicParticle , G4double tmin, G4double maxEnergy)

void	SetLowEnergyThreshold (G4double)

Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)

virtual	~G4VEmModel ()

virtual void	InitialiseForMaterial (const G4ParticleDefinition , const G4Material )

virtual G4double	ComputeDEDXPerVolume (const G4Material , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=DBL_MAX)

virtual G4double	CrossSectionPerVolume (const G4Material , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

virtual G4double	GetPartialCrossSection (const G4Material , G4int, const G4ParticleDefinition , G4double)

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 , G4double &eloss, G4double &niel, G4double length)

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

G4int	SelectIsotopeNumber (const G4Element *)

const G4Element *	SelectRandomAtom (const G4MaterialCutsCouple , const G4ParticleDefinition , G4double kineticEnergy, 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)

G4int	SelectRandomAtomNumber (const G4Material *)

void	SetParticleChange (G4VParticleChange , G4VEmFluctuationModel f=0)

void	SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)

G4ElementData *	GetElementData ()

G4PhysicsTable *	GetCrossSectionTable ()

G4VEmFluctuationModel *	GetModelOfFluctuations ()

G4VEmAngularDistribution *	GetAngularDistribution ()

void	SetAngularDistribution (G4VEmAngularDistribution *)

G4double	HighEnergyLimit () const

G4double	LowEnergyLimit () const

G4double	HighEnergyActivationLimit () const

G4double	LowEnergyActivationLimit () const

G4double	PolarAngleLimit () const

G4double	SecondaryThreshold () const

G4bool	LPMFlag () 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)

void	SetPolarAngleLimit (G4double)

void	SetSecondaryThreshold (G4double)

void	SetLPMFlag (G4bool val)

void	SetDeexcitationFlag (G4bool val)

void	SetForceBuildTable (G4bool val)

void	SetMasterThread (G4bool val)

G4bool	IsMaster () const

G4double	MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)

const G4String &	GetName () const

void	SetCurrentCouple (const G4MaterialCutsCouple *)

const G4Element *	GetCurrentElement () const

const G4Isotope *	GetCurrentIsotope () const

G4bool	IsLocked () const

void	SetLocked (G4bool)

Private Member Functions
void	ReadData (size_t Z, const char *path=0)

G4LivermoreRayleighModel &	operator= (const G4LivermoreRayleighModel &right)

	G4LivermoreRayleighModel (const G4LivermoreRayleighModel &)

Private Attributes
G4bool	isInitialised

G4int	verboseLevel

G4double	lowEnergyLimit

G4ParticleChangeForGamma *	fParticleChange

Static Private Attributes
static G4int	maxZ = 100

static G4LPhysicsFreeVector *	dataCS [101] = {0}

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

G4VParticleChange *	pParticleChange

G4PhysicsTable *	xSectionTable

const std::vector< G4double > *	theDensityFactor

const std::vector< G4int > *	theDensityIdx

size_t	idxTable

Static Protected Attributes inherited from G4VEmModel
static const G4double	inveplus = 1.0/CLHEP::eplus

Detailed Description

Definition at line 39 of file G4LivermoreRayleighModel.hh.

Constructor & Destructor Documentation

◆ G4LivermoreRayleighModel() [1/2]

G4LivermoreRayleighModel::G4LivermoreRayleighModel ( )

Definition at line 43 of file G4LivermoreRayleighModel.cc.

   :G4VEmModel("LivermoreRayleigh"),isInitialised(false)
 {
   fParticleChange = 0;
   lowEnergyLimit  = 10 * eV; 
   
   SetAngularDistribution(new G4RayleighAngularGenerator());
   
   verboseLevel= 0;
   // Verbosity scale for debugging purposes:
   // 0 = nothing 
   // 1 = calculation of cross sections, file openings...
   // 2 = entering in methods
 
   if(verboseLevel > 0) 
   {
     G4cout << "G4LivermoreRayleighModel is constructed " << G4endl;
   }
 
 }

Here is the call graph for this function:

◆ ~G4LivermoreRayleighModel()

G4LivermoreRayleighModel::~G4LivermoreRayleighModel ( )

virtual

Definition at line 66 of file G4LivermoreRayleighModel.cc.

 {
   if(IsMaster()) {
     for(G4int i=0; i<maxZ; ++i) {
       if(dataCS[i]) { 
     delete dataCS[i];
     dataCS[i] = 0;
       }
     }
   }
 }

Here is the call graph for this function:

◆ G4LivermoreRayleighModel() [2/2]

G4LivermoreRayleighModel::G4LivermoreRayleighModel ( const G4LivermoreRayleighModel & )

private

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

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

virtual

Reimplemented from G4VEmModel.

Definition at line 193 of file G4LivermoreRayleighModel.cc.

 {
   if (verboseLevel > 1) 
   {
     G4cout << "G4LivermoreRayleighModel::ComputeCrossSectionPerAtom()" 
        << G4endl;
   }
 
   if(GammaEnergy < lowEnergyLimit) { return 0.0; }
   
   G4double xs = 0.0;
   
   G4int intZ = G4lrint(Z);
 
   if(intZ < 1 || intZ > maxZ) { return xs; }
 
   G4LPhysicsFreeVector* pv = dataCS[intZ];
 
   // if element was not initialised
   // do initialisation safely for MT mode
   if(!pv) { 
     InitialiseForElement(0, intZ);
     pv = dataCS[intZ];
     if(!pv) { return xs; }
   }
 
   G4int n = pv->GetVectorLength() - 1;
   G4double e = GammaEnergy/MeV;
   if(e >= pv->Energy(n)) {
     xs = (*pv)[n]/(e*e);  
   } else if(e >= pv->Energy(0)) {
     xs = pv->Value(e)/(e*e);  
   }
 
   if(verboseLevel > 0)
   {
     G4cout  <<  "****** DEBUG: tcs value for Z=" << Z << " at energy (MeV)=" 
         << e << G4endl;
     G4cout  <<  "  cs (Geant4 internal unit)=" << xs << G4endl;
     G4cout  <<  "    -> first E*E*cs value in CS data file (iu) =" << (*pv)[0] 
         << G4endl;
     G4cout  <<  "    -> last  E*E*cs value in CS data file (iu) =" << (*pv)[n] 
         << G4endl;
     G4cout  <<  "*********************************************************" 
         << G4endl;
   }
   return xs;
 }

Here is the call graph for this function:

◆ Initialise()

void G4LivermoreRayleighModel::Initialise	(	const G4ParticleDefinition *	particle,
		const G4DataVector &	cuts
	)

virtual

Implements G4VEmModel.

Definition at line 80 of file G4LivermoreRayleighModel.cc.

 {
   if (verboseLevel > 1) 
   {
     G4cout << "Calling Initialise() of G4LivermoreRayleighModel." << G4endl
        << "Energy range: "
        << LowEnergyLimit() / eV << " eV - "
        << HighEnergyLimit() / GeV << " GeV"
        << G4endl;
   }
 
   if(IsMaster()) {
 
     // Initialise element selector
     InitialiseElementSelectors(particle, cuts);
 
     // Access to elements
     char* path = getenv("G4LEDATA");
     G4ProductionCutsTable* theCoupleTable =
       G4ProductionCutsTable::GetProductionCutsTable();
     G4int numOfCouples = theCoupleTable->GetTableSize();
   
     for(G4int i=0; i<numOfCouples; ++i) 
       {
     const G4MaterialCutsCouple* couple = 
       theCoupleTable->GetMaterialCutsCouple(i);
     const G4Material* material = couple->GetMaterial();
     const G4ElementVector* theElementVector = material->GetElementVector();
     G4int nelm = material->GetNumberOfElements();
     
     for (G4int j=0; j<nelm; ++j) 
       {
         G4int Z = G4lrint((*theElementVector)[j]->GetZ());
         if(Z < 1)          { Z = 1; }
         else if(Z > maxZ)  { Z = maxZ; }
         if( (!dataCS[Z]) ) { ReadData(Z, path); }
       }
       }
   }
 
   if(isInitialised) { return; }
   fParticleChange = GetParticleChangeForGamma();
   isInitialised = true;
 
 }

Here is the call graph for this function:

◆ InitialiseForElement()

void G4LivermoreRayleighModel::InitialiseForElement	(	const G4ParticleDefinition *	,
		G4int	Z
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 289 of file G4LivermoreRayleighModel.cc.

 {
   G4AutoLock l(&LivermoreRayleighModelMutex);
   //  G4cout << "G4LivermoreRayleighModel::InitialiseForElement Z= " 
   //   << Z << G4endl;
   if(!dataCS[Z]) { ReadData(Z); }
   l.unlock();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitialiseLocal()

void G4LivermoreRayleighModel::InitialiseLocal	(	const G4ParticleDefinition *	,
		G4VEmModel *	masterModel
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 129 of file G4LivermoreRayleighModel.cc.

 {
   SetElementSelectors(masterModel->GetElementSelectors());
 }

Here is the call graph for this function:

◆ operator=()

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

private

◆ ReadData()

void G4LivermoreRayleighModel::ReadData	(	size_t	Z,
		const char *	path = `0`
	)

private

Definition at line 137 of file G4LivermoreRayleighModel.cc.

 {
   if (verboseLevel > 1) 
   {
     G4cout << "Calling ReadData() of G4LivermoreRayleighModel" 
        << G4endl;
   }
 
   if(dataCS[Z]) { return; }
   
   const char* datadir = path;
 
   if(!datadir) 
   {
     datadir = getenv("G4LEDATA");
     if(!datadir) 
     {
       G4Exception("G4LivermoreRayleighModelModel::ReadData()","em0006",
           FatalException,
           "Environment variable G4LEDATA not defined");
       return;
     }
   }
 
   //
   
   dataCS[Z] = new G4LPhysicsFreeVector();
   
   // Activation of spline interpolation
   //dataCS[Z] ->SetSpline(true);
   
   std::ostringstream ostCS;
   ostCS << datadir << "/livermore/rayl/re-cs-" << Z <<".dat";
   std::ifstream finCS(ostCS.str().c_str());
   
   if( !finCS .is_open() ) 
   {
     G4ExceptionDescription ed;
     ed << "G4LivermoreRayleighModel data file <" << ostCS.str().c_str()
        << "> is not opened!" << G4endl;
     G4Exception("G4LivermoreRayleighModel::ReadData()","em0003",FatalException,
         ed,"G4LEDATA version should be G4EMLOW6.27 or later.");
     return;
   } 
   else 
   {
     if(verboseLevel > 3) { 
       G4cout << "File " << ostCS.str() 
          << " is opened by G4LivermoreRayleighModel" << G4endl;
     }
     dataCS[Z]->Retrieve(finCS, true);
   } 
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SampleSecondaries()

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

virtual

Implements G4VEmModel.

Definition at line 248 of file G4LivermoreRayleighModel.cc.

 {
   if (verboseLevel > 1) {
     G4cout << "Calling SampleSecondaries() of G4LivermoreRayleighModel" 
        << G4endl;
   }
   G4double photonEnergy0 = aDynamicGamma->GetKineticEnergy();
 
   // absorption of low-energy gamma  
   if (photonEnergy0 <= lowEnergyLimit)
     {
       fParticleChange->ProposeTrackStatus(fStopAndKill);
       fParticleChange->SetProposedKineticEnergy(0.);
       fParticleChange->ProposeLocalEnergyDeposit(photonEnergy0);
       return ;
     }
 
   // Select randomly one element in the current material
   const G4ParticleDefinition* particle =  aDynamicGamma->GetDefinition();
   const G4Element* elm = SelectRandomAtom(couple,particle,photonEnergy0);
   G4int Z = G4lrint(elm->GetZ());
 
   // Sample the angle of the scattered photon
   
   G4ThreeVector photonDirection = 
     GetAngularDistribution()->SampleDirection(aDynamicGamma, 
                           photonEnergy0, 
                           Z, couple->GetMaterial());
   fParticleChange->ProposeMomentumDirection(photonDirection);
 }

Here is the call graph for this function:

◆ SetLowEnergyThreshold()

void G4LivermoreRayleighModel::SetLowEnergyThreshold ( G4double val )

inline

Definition at line 90 of file G4LivermoreRayleighModel.hh.

 {
   lowEnergyLimit = val;
 }

Member Data Documentation

◆ dataCS

G4LPhysicsFreeVector * G4LivermoreRayleighModel::dataCS = {0}

staticprivate

Definition at line 84 of file G4LivermoreRayleighModel.hh.

◆ fParticleChange

G4ParticleChangeForGamma* G4LivermoreRayleighModel::fParticleChange

private

Definition at line 86 of file G4LivermoreRayleighModel.hh.

◆ isInitialised

G4bool G4LivermoreRayleighModel::isInitialised

private

Definition at line 78 of file G4LivermoreRayleighModel.hh.

◆ lowEnergyLimit

G4double G4LivermoreRayleighModel::lowEnergyLimit

private

Definition at line 81 of file G4LivermoreRayleighModel.hh.

◆ maxZ

G4int G4LivermoreRayleighModel::maxZ = 100

staticprivate

Definition at line 83 of file G4LivermoreRayleighModel.hh.

◆ verboseLevel

G4int G4LivermoreRayleighModel::verboseLevel

private

Definition at line 79 of file G4LivermoreRayleighModel.hh.

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4LivermoreRayleighModel() [1/2]

◆ ~G4LivermoreRayleighModel()

◆ G4LivermoreRayleighModel() [2/2]

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

◆ Initialise()

◆ InitialiseForElement()

◆ InitialiseLocal()

◆ operator=()

◆ ReadData()

◆ SampleSecondaries()

◆ SetLowEnergyThreshold()

Member Data Documentation

◆ dataCS

◆ fParticleChange

◆ isInitialised

◆ lowEnergyLimit

◆ maxZ

◆ verboseLevel