#include <G4OpRayleigh.hh>

Inheritance diagram for G4OpRayleigh:

Collaboration diagram for G4OpRayleigh:

Public Member Functions
	G4OpRayleigh (const G4String &processName="OpRayleigh", G4ProcessType type=fOptical)

	~G4OpRayleigh ()

G4bool	IsApplicable (const G4ParticleDefinition &aParticleType)

void	BuildPhysicsTable (const G4ParticleDefinition &aParticleType)

G4double	GetMeanFreePath (const G4Track &aTrack, G4double, G4ForceCondition *)

G4VParticleChange *	PostStepDoIt (const G4Track &aTrack, const G4Step &aStep)

G4PhysicsTable *	GetPhysicsTable () const

void	DumpPhysicsTable () const

Public Member Functions inherited from G4VDiscreteProcess
	G4VDiscreteProcess (const G4String &, G4ProcessType aType=fNotDefined)

	G4VDiscreteProcess (G4VDiscreteProcess &)

virtual	~G4VDiscreteProcess ()

virtual G4double	PostStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition)

virtual G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double, G4double, G4double &, G4GPILSelection *)

virtual G4double	AtRestGetPhysicalInteractionLength (const G4Track &, G4ForceCondition *)

virtual G4VParticleChange *	AtRestDoIt (const G4Track &, const G4Step &)

virtual G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &)

Public Member Functions inherited from G4VProcess
	G4VProcess (const G4String &aName="NoName", G4ProcessType aType=fNotDefined)

	G4VProcess (const G4VProcess &right)

virtual	~G4VProcess ()

G4int	operator== (const G4VProcess &right) const

G4int	operator!= (const G4VProcess &right) const

G4double	GetCurrentInteractionLength () const

void	SetPILfactor (G4double value)

G4double	GetPILfactor () const

G4double	AlongStepGPIL (const G4Track &track, G4double previousStepSize, G4double currentMinimumStep, G4double &proposedSafety, G4GPILSelection *selection)

G4double	AtRestGPIL (const G4Track &track, G4ForceCondition *condition)

G4double	PostStepGPIL (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition)

virtual void	PreparePhysicsTable (const G4ParticleDefinition &)

virtual G4bool	StorePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)

virtual G4bool	RetrievePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)

const G4String &	GetPhysicsTableFileName (const G4ParticleDefinition *, const G4String &directory, const G4String &tableName, G4bool ascii=false)

const G4String &	GetProcessName () const

G4ProcessType	GetProcessType () const

void	SetProcessType (G4ProcessType)

G4int	GetProcessSubType () const

void	SetProcessSubType (G4int)

virtual void	StartTracking (G4Track *)

virtual void	EndTracking ()

virtual void	SetProcessManager (const G4ProcessManager *)

virtual const G4ProcessManager *	GetProcessManager ()

virtual void	ResetNumberOfInteractionLengthLeft ()

G4double	GetNumberOfInteractionLengthLeft () const

G4double	GetTotalNumberOfInteractionLengthTraversed () const

G4bool	isAtRestDoItIsEnabled () const

G4bool	isAlongStepDoItIsEnabled () const

G4bool	isPostStepDoItIsEnabled () const

virtual void	DumpInfo () const

void	SetVerboseLevel (G4int value)

G4int	GetVerboseLevel () const

virtual void	SetMasterProcess (G4VProcess *masterP)

const G4VProcess *	GetMasterProcess () const

virtual void	BuildWorkerPhysicsTable (const G4ParticleDefinition &part)

virtual void	PrepareWorkerPhysicsTable (const G4ParticleDefinition &)

Protected Attributes
G4PhysicsTable *	thePhysicsTable

Protected Attributes inherited from G4VProcess
const G4ProcessManager *	aProcessManager

G4VParticleChange *	pParticleChange

G4ParticleChange	aParticleChange

G4double	theNumberOfInteractionLengthLeft

G4double	currentInteractionLength

G4double	theInitialNumberOfInteractionLength

G4String	theProcessName

G4String	thePhysicsTableFileName

G4ProcessType	theProcessType

G4int	theProcessSubType

G4double	thePILfactor

G4bool	enableAtRestDoIt

G4bool	enableAlongStepDoIt

G4bool	enablePostStepDoIt

G4int	verboseLevel

Private Member Functions
	G4OpRayleigh (const G4OpRayleigh &right)

G4OpRayleigh &	operator= (const G4OpRayleigh &right)

G4PhysicsOrderedFreeVector *	CalculateRayleighMeanFreePaths (const G4Material *material) const

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)

Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double previousStepSize)

void	ClearNumberOfInteractionLengthLeft ()

Detailed Description

Definition at line 77 of file G4OpRayleigh.hh.

Constructor & Destructor Documentation

◆ G4OpRayleigh() [1/2]

G4OpRayleigh::G4OpRayleigh	(	const G4String &	processName = `"OpRayleigh"`,
		G4ProcessType	type = `fOptical`
	)

Definition at line 88 of file G4OpRayleigh.cc.

            : G4VDiscreteProcess(processName, type)
 {
         SetProcessSubType(fOpRayleigh);
 
         thePhysicsTable = NULL;
 
         if (verboseLevel>0) {
            G4cout << GetProcessName() << " is created " << G4endl;
         }
 }

Here is the call graph for this function:

◆ ~G4OpRayleigh()

G4OpRayleigh::~G4OpRayleigh ( )

Definition at line 108 of file G4OpRayleigh.cc.

 {
         if (thePhysicsTable) {
            thePhysicsTable->clearAndDestroy();
            delete thePhysicsTable;
         }
 }

Here is the call graph for this function:

◆ G4OpRayleigh() [2/2]

G4OpRayleigh::G4OpRayleigh ( const G4OpRayleigh & right )

private

Member Function Documentation

◆ BuildPhysicsTable()

void G4OpRayleigh::BuildPhysicsTable ( const G4ParticleDefinition & aParticleType )

virtual

Reimplemented from G4VProcess.

Definition at line 217 of file G4OpRayleigh.cc.

 {
   if (thePhysicsTable) {
      thePhysicsTable->clearAndDestroy();
      delete thePhysicsTable;
      thePhysicsTable = NULL;
   }
 
   const G4MaterialTable* theMaterialTable = G4Material::GetMaterialTable();
   const G4int numOfMaterials = G4Material::GetNumberOfMaterials();
 
   thePhysicsTable = new G4PhysicsTable( numOfMaterials );
   
   for( G4int iMaterial = 0; iMaterial < numOfMaterials; iMaterial++ )
   {
       G4Material* material = (*theMaterialTable)[iMaterial];
       G4MaterialPropertiesTable* materialProperties = 
                                        material->GetMaterialPropertiesTable();
       G4PhysicsOrderedFreeVector* rayleigh = NULL;
       if ( materialProperties != NULL ) {
          rayleigh = materialProperties->GetProperty( "RAYLEIGH" );
          if ( rayleigh == NULL ) rayleigh = 
                                    CalculateRayleighMeanFreePaths( material );
       }
       thePhysicsTable->insertAt( iMaterial, rayleigh );
   }
 }

Here is the call graph for this function:

◆ CalculateRayleighMeanFreePaths()

G4PhysicsOrderedFreeVector * G4OpRayleigh::CalculateRayleighMeanFreePaths ( const G4Material * material ) const

private

Calculates the mean free paths for a material as a function of photon energy

Parameters

[in] material information

Returns: the mean free path vector

Definition at line 269 of file G4OpRayleigh.cc.

 {
   G4MaterialPropertiesTable* materialProperties = 
                                        material->GetMaterialPropertiesTable();
 
   // Retrieve the beta_T or isothermal compressibility value. For backwards
   // compatibility use a constant if the material is "Water". If the material
   // doesn't have an ISOTHERMAL_COMPRESSIBILITY constant then return
   G4double betat;
   if ( material->GetName() == "Water" )
     betat = 7.658e-23*m3/MeV;
   else if(materialProperties->ConstPropertyExists("ISOTHERMAL_COMPRESSIBILITY"))
     betat = materialProperties->GetConstProperty("ISOTHERMAL_COMPRESSIBILITY");
   else
     return NULL;
 
   // If the material doesn't have a RINDEX property vector then return
   G4MaterialPropertyVector* rIndex = materialProperties->GetProperty("RINDEX");
   if ( rIndex == NULL ) return NULL;
 
   // Retrieve the optional scale factor, (this just scales the scattering length
   G4double scaleFactor = 1.0;
   if( materialProperties->ConstPropertyExists( "RS_SCALE_FACTOR" ) )
     scaleFactor= materialProperties->GetConstProperty("RS_SCALE_FACTOR" );
 
   // Retrieve the material temperature. For backwards compatibility use a 
   // constant if the material is "Water"
   G4double temperature;
   if( material->GetName() == "Water" )
     temperature = 283.15*kelvin; // Temperature of water is 10 degrees celsius
   else
     temperature = material->GetTemperature();
 
   G4PhysicsOrderedFreeVector* rayleighMeanFreePaths =
                                              new G4PhysicsOrderedFreeVector();
   // This calculates the meanFreePath via the Einstein-Smoluchowski formula
   const G4double c1 = scaleFactor * betat * temperature * k_Boltzmann / 
                       ( 6.0 * pi );
 
   for( size_t uRIndex = 0; uRIndex < rIndex->GetVectorLength(); uRIndex++ )
   {
      const G4double energy = rIndex->Energy( uRIndex );
      const G4double rIndexSquared = (*rIndex)[uRIndex] * (*rIndex)[uRIndex];
      const G4double xlambda = h_Planck * c_light / energy;
      const G4double c2 = std::pow(twopi/xlambda,4);
      const G4double c3 = 
                     std::pow(((rIndexSquared-1.0)*(rIndexSquared+2.0 )/3.0),2);
 
      const G4double meanFreePath = 1.0 / ( c1 * c2 * c3 );
 
      if( verboseLevel>0 )
        G4cout << energy << "MeV\t" << meanFreePath << "mm" << G4endl;
 
      rayleighMeanFreePaths->InsertValues( energy, meanFreePath );
   }
 
   return rayleighMeanFreePaths;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DumpPhysicsTable()

void G4OpRayleigh::DumpPhysicsTable ( ) const

inline

Definition at line 167 of file G4OpRayleigh.hh.

 {
         G4int PhysicsTableSize = thePhysicsTable->entries();
         G4PhysicsOrderedFreeVector *v;
 
         for (G4int i = 0 ; i < PhysicsTableSize ; i++ )
         {
                 v = (G4PhysicsOrderedFreeVector*)(*thePhysicsTable)[i];
                 v->DumpValues();
         }
 }

Here is the call graph for this function:

◆ GetMeanFreePath()

G4double G4OpRayleigh::GetMeanFreePath	(	const G4Track &	aTrack,
		G4double	,
		G4ForceCondition *
	)

virtual

Implements G4VDiscreteProcess.

Definition at line 248 of file G4OpRayleigh.cc.

 {
   const G4DynamicParticle* particle = aTrack.GetDynamicParticle();
   const G4double photonMomentum = particle->GetTotalMomentum();
   const G4Material* material = aTrack.GetMaterial();
 
   G4PhysicsOrderedFreeVector* rayleigh = 
                               static_cast<G4PhysicsOrderedFreeVector*>
                               ((*thePhysicsTable)(material->GetIndex()));
   
   G4double rsLength = DBL_MAX;
   if( rayleigh != NULL ) rsLength = rayleigh->Value( photonMomentum );
   return rsLength;
 }

Here is the call graph for this function:

◆ GetPhysicsTable()

G4PhysicsTable * G4OpRayleigh::GetPhysicsTable ( ) const

inline

Definition at line 180 of file G4OpRayleigh.hh.

 {
   return thePhysicsTable;
 }

◆ IsApplicable()

G4bool G4OpRayleigh::IsApplicable ( const G4ParticleDefinition & aParticleType )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 161 of file G4OpRayleigh.hh.

 {
   return ( &aParticleType == G4OpticalPhoton::OpticalPhoton() );
 }

Here is the call graph for this function:

◆ operator=()

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

private

◆ PostStepDoIt()

G4VParticleChange * G4OpRayleigh::PostStepDoIt	(	const G4Track &	aTrack,
		const G4Step &	aStep
	)

virtual

Reimplemented from G4VDiscreteProcess.

Definition at line 124 of file G4OpRayleigh.cc.

 {
         aParticleChange.Initialize(aTrack);
 
         const G4DynamicParticle* aParticle = aTrack.GetDynamicParticle();
 
         if (verboseLevel>0) {
                 G4cout << "Scattering Photon!" << G4endl;
                 G4cout << "Old Momentum Direction: "
                        << aParticle->GetMomentumDirection() << G4endl;
                 G4cout << "Old Polarization: "
                        << aParticle->GetPolarization() << G4endl;
         }
 
         G4double cosTheta;
         G4ThreeVector OldMomentumDirection, NewMomentumDirection;
         G4ThreeVector OldPolarization, NewPolarization;
 
         G4double rand, constant;
         G4double CosTheta, SinTheta, SinPhi, CosPhi, unit_x, unit_y, unit_z;
 
         do {
            // Try to simulate the scattered photon momentum direction
            // w.r.t. the initial photon momentum direction
 
            CosTheta = G4UniformRand();
            SinTheta = std::sqrt(1.-CosTheta*CosTheta);
            // consider for the angle 90-180 degrees
            if (G4UniformRand() < 0.5) CosTheta = -CosTheta;
 
            // simulate the phi angle
            rand = twopi*G4UniformRand();
            SinPhi = std::sin(rand);
            CosPhi = std::cos(rand);
 
            // start constructing the new momentum direction
        unit_x = SinTheta * CosPhi; 
        unit_y = SinTheta * SinPhi;  
        unit_z = CosTheta; 
        NewMomentumDirection.set (unit_x,unit_y,unit_z);
 
            // Rotate the new momentum direction into global reference system
            OldMomentumDirection = aParticle->GetMomentumDirection();
            OldMomentumDirection = OldMomentumDirection.unit();
            NewMomentumDirection.rotateUz(OldMomentumDirection);
            NewMomentumDirection = NewMomentumDirection.unit();
 
            // calculate the new polarization direction
            // The new polarization needs to be in the same plane as the new
            // momentum direction and the old polarization direction
            OldPolarization = aParticle->GetPolarization();
            constant = -NewMomentumDirection.dot(OldPolarization);
 
            NewPolarization = OldPolarization + constant*NewMomentumDirection;
            NewPolarization = NewPolarization.unit();
 
            // There is a corner case, where the Newmomentum direction
            // is the same as oldpolariztion direction:
            // random generate the azimuthal angle w.r.t. Newmomentum direction
            if (NewPolarization.mag() == 0.) {
               rand = G4UniformRand()*twopi;
               NewPolarization.set(std::cos(rand),std::sin(rand),0.);
               NewPolarization.rotateUz(NewMomentumDirection);
            } else {
               // There are two directions which are perpendicular
               // to the new momentum direction
               if (G4UniformRand() < 0.5) NewPolarization = -NewPolarization;
            }
       
        // simulate according to the distribution cos^2(theta)
            cosTheta = NewPolarization.dot(OldPolarization);
           // Loop checking, 13-Aug-2015, Peter Gumplinger
         } while (std::pow(cosTheta,2) < G4UniformRand());
 
         aParticleChange.ProposePolarization(NewPolarization);
         aParticleChange.ProposeMomentumDirection(NewMomentumDirection);
 
         if (verboseLevel>0) {
                 G4cout << "New Polarization: " 
                      << NewPolarization << G4endl;
                 G4cout << "Polarization Change: "
                      << *(aParticleChange.GetPolarization()) << G4endl;  
                 G4cout << "New Momentum Direction: " 
                      << NewMomentumDirection << G4endl;
                 G4cout << "Momentum Change: "
                      << *(aParticleChange.GetMomentumDirection()) << G4endl; 
         }
 
         return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
 }

Here is the call graph for this function:

Member Data Documentation

◆ thePhysicsTable

G4PhysicsTable* G4OpRayleigh::thePhysicsTable

protected

Definition at line 148 of file G4OpRayleigh.hh.

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

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4OpRayleigh() [1/2]

◆ ~G4OpRayleigh()

◆ G4OpRayleigh() [2/2]

Member Function Documentation

◆ BuildPhysicsTable()

◆ CalculateRayleighMeanFreePaths()

◆ DumpPhysicsTable()

◆ GetMeanFreePath()

◆ GetPhysicsTable()

◆ IsApplicable()

◆ operator=()

◆ PostStepDoIt()

Member Data Documentation

◆ thePhysicsTable