#include <G4OpWLS.hh>

Inheritance diagram for G4OpWLS:

Collaboration diagram for G4OpWLS:

Public Member Functions
	G4OpWLS (const G4String &processName="OpWLS", G4ProcessType type=fOptical)

	~G4OpWLS ()

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 *	GetIntegralTable () const

void	DumpPhysicsTable () const

void	UseTimeProfile (const G4String name)

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
G4VWLSTimeGeneratorProfile *	WLSTimeGeneratorProfile

G4PhysicsTable *	theIntegralTable

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
	G4OpWLS (const G4OpWLS &right)

G4OpWLS &	operator= (const G4OpWLS &right)

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 80 of file G4OpWLS.hh.

Constructor & Destructor Documentation

◆ G4OpWLS() [1/2]

G4OpWLS::G4OpWLS	(	const G4String &	processName = `"OpWLS"`,
		G4ProcessType	type = `fOptical`
	)

Definition at line 68 of file G4OpWLS.cc.

   : G4VDiscreteProcess(processName, type)
 {
   SetProcessSubType(fOpWLS);
 
   theIntegralTable = NULL;
 
   WLSTimeGeneratorProfile = 
           new G4WLSTimeGeneratorProfileDelta("WLSTimeGeneratorProfileDelta");
  
   if (verboseLevel>0) G4cout << GetProcessName() << " is created " << G4endl;
 }

Here is the call graph for this function:

◆ ~G4OpWLS()

G4OpWLS::~G4OpWLS ( )

Definition at line 85 of file G4OpWLS.cc.

 {
   if (theIntegralTable) {
     theIntegralTable->clearAndDestroy();
     delete theIntegralTable;
   }
   delete WLSTimeGeneratorProfile;
 }

Here is the call graph for this function:

◆ G4OpWLS() [2/2]

G4OpWLS::G4OpWLS ( const G4OpWLS & right )

private

Member Function Documentation

◆ BuildPhysicsTable()

void G4OpWLS::BuildPhysicsTable ( const G4ParticleDefinition & aParticleType )

virtual

Reimplemented from G4VProcess.

Definition at line 287 of file G4OpWLS.cc.

 {
   if (theIntegralTable) {
      theIntegralTable->clearAndDestroy();
      delete theIntegralTable;
      theIntegralTable = NULL;
   }
 
   const G4MaterialTable* theMaterialTable = 
     G4Material::GetMaterialTable();
   G4int numOfMaterials = G4Material::GetNumberOfMaterials();
   
   // create new physics table
   
   theIntegralTable = new G4PhysicsTable(numOfMaterials);
   
   // loop for materials
   
   for (G4int i=0 ; i < numOfMaterials; i++)
     {
       G4PhysicsOrderedFreeVector* aPhysicsOrderedFreeVector =
     new G4PhysicsOrderedFreeVector();
       
       // Retrieve vector of WLS wavelength intensity for
       // the material from the material's optical properties table.
       
       G4Material* aMaterial = (*theMaterialTable)[i];
 
       G4MaterialPropertiesTable* aMaterialPropertiesTable =
     aMaterial->GetMaterialPropertiesTable();
 
       if (aMaterialPropertiesTable) {
 
     G4MaterialPropertyVector* theWLSVector = 
       aMaterialPropertiesTable->GetProperty("WLSCOMPONENT");
 
     if (theWLSVector) {
       
       // Retrieve the first intensity point in vector
       // of (photon energy, intensity) pairs
       
       G4double currentIN = (*theWLSVector)[0];
       
       if (currentIN >= 0.0) {
 
         // Create first (photon energy) 
        
         G4double currentPM = theWLSVector->Energy(0);
         
         G4double currentCII = 0.0;
         
         aPhysicsOrderedFreeVector->
           InsertValues(currentPM , currentCII);
         
         // Set previous values to current ones prior to loop
         
         G4double prevPM  = currentPM;
         G4double prevCII = currentCII;
         G4double prevIN  = currentIN;
         
         // loop over all (photon energy, intensity)
         // pairs stored for this material
 
             for (size_t j = 1;
                  j < theWLSVector->GetVectorLength();
                  j++)       
           {
         currentPM = theWLSVector->Energy(j);
         currentIN = (*theWLSVector)[j];
         
         currentCII = 0.5 * (prevIN + currentIN);
         
         currentCII = prevCII +
           (currentPM - prevPM) * currentCII;
         
         aPhysicsOrderedFreeVector->
           InsertValues(currentPM, currentCII);
         
         prevPM  = currentPM;
         prevCII = currentCII;
         prevIN  = currentIN;
           }
       }
     }
       }
     // The WLS integral for a given material
     // will be inserted in the table according to the
     // position of the material in the material table.
 
     theIntegralTable->insertAt(i,aPhysicsOrderedFreeVector);
     }
 }

Here is the call graph for this function:

◆ DumpPhysicsTable()

void G4OpWLS::DumpPhysicsTable ( ) const

inline

Definition at line 159 of file G4OpWLS.hh.

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

Here is the call graph for this function:

◆ GetIntegralTable()

G4PhysicsTable * G4OpWLS::GetIntegralTable ( ) const

inline

Definition at line 153 of file G4OpWLS.hh.

 {
   return theIntegralTable;
 }

◆ GetMeanFreePath()

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

virtual

Implements G4VDiscreteProcess.

Definition at line 383 of file G4OpWLS.cc.

 {
   const G4DynamicParticle* aParticle = aTrack.GetDynamicParticle();
   const G4Material* aMaterial = aTrack.GetMaterial();
 
   G4double thePhotonEnergy = aParticle->GetTotalEnergy();
 
   G4MaterialPropertiesTable* aMaterialPropertyTable;
   G4MaterialPropertyVector* AttenuationLengthVector;
     
   G4double AttenuationLength = DBL_MAX;
 
   aMaterialPropertyTable = aMaterial->GetMaterialPropertiesTable();
 
   if ( aMaterialPropertyTable ) {
     AttenuationLengthVector = aMaterialPropertyTable->
       GetProperty("WLSABSLENGTH");
     if ( AttenuationLengthVector ){
       AttenuationLength = AttenuationLengthVector->
     Value(thePhotonEnergy);
     }
     else {
       //             G4cout << "No WLS absorption length specified" << G4endl;
     }
   }
   else {
     //           G4cout << "No WLS absortion length specified" << G4endl;
   }
   
   return AttenuationLength;
 }

Here is the call graph for this function:

◆ IsApplicable()

G4bool G4OpWLS::IsApplicable ( const G4ParticleDefinition & aParticleType )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 147 of file G4OpWLS.hh.

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

Here is the call graph for this function:

◆ operator=()

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

private

◆ PostStepDoIt()

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

virtual

Reimplemented from G4VDiscreteProcess.

Definition at line 102 of file G4OpWLS.cc.

 {
   aParticleChange.Initialize(aTrack);
   
   aParticleChange.ProposeTrackStatus(fStopAndKill);
 
   if (verboseLevel>0) {
     G4cout << "\n** Photon absorbed! **" << G4endl;
   }
   
   const G4Material* aMaterial = aTrack.GetMaterial();
 
   G4StepPoint* pPostStepPoint = aStep.GetPostStepPoint();
     
   G4MaterialPropertiesTable* aMaterialPropertiesTable =
     aMaterial->GetMaterialPropertiesTable();
   if (!aMaterialPropertiesTable)
     return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
 
   const G4MaterialPropertyVector* WLS_Intensity = 
     aMaterialPropertiesTable->GetProperty("WLSCOMPONENT"); 
 
   if (!WLS_Intensity)
     return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
 
   G4int NumPhotons = 1;
 
   if (aMaterialPropertiesTable->ConstPropertyExists("WLSMEANNUMBERPHOTONS")) {
 
      G4double MeanNumberOfPhotons = aMaterialPropertiesTable->
                                     GetConstProperty("WLSMEANNUMBERPHOTONS");
 
      NumPhotons = G4int(G4Poisson(MeanNumberOfPhotons));
 
      if (NumPhotons <= 0) {
 
         // return unchanged particle and no secondaries
 
         aParticleChange.SetNumberOfSecondaries(0);
 
         return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
 
      }
 
   }
 
   aParticleChange.SetNumberOfSecondaries(NumPhotons);
 
   G4double primaryEnergy = aTrack.GetDynamicParticle()->GetKineticEnergy();
 
   G4int materialIndex = aMaterial->GetIndex();
 
   // Retrieve the WLS Integral for this material
   // new G4PhysicsOrderedFreeVector allocated to hold CII's
 
   G4double WLSTime = 0.*ns;
   G4PhysicsOrderedFreeVector* WLSIntegral = 0;
 
   WLSTime   = aMaterialPropertiesTable->
     GetConstProperty("WLSTIMECONSTANT");
   WLSIntegral =
     (G4PhysicsOrderedFreeVector*)((*theIntegralTable)(materialIndex));
    
   // Max WLS Integral
   
   G4double CIImax = WLSIntegral->GetMaxValue();
  
   G4int NumberOfPhotons = NumPhotons;
  
   for (G4int i = 0; i < NumPhotons; i++) {
 
     G4double sampledEnergy;
     
     // Make sure the energy of the secondary is less than that of the primary
 
     for (G4int j = 1; j <= 100; j++) {
 
         // Determine photon energy
 
         G4double CIIvalue = G4UniformRand()*CIImax;
         sampledEnergy = WLSIntegral->GetEnergy(CIIvalue);
 
         if (verboseLevel>1) {
            G4cout << "sampledEnergy = " << sampledEnergy << G4endl;
            G4cout << "CIIvalue =      " << CIIvalue << G4endl;
         }
 
         if (sampledEnergy <= primaryEnergy) break;
     }
 
     // If no such energy can be sampled, return one less secondary, or none
 
     if (sampledEnergy > primaryEnergy) {
        if (verboseLevel>1)
        G4cout << " *** One less WLS photon will be returned ***" << G4endl;
        NumberOfPhotons--;
        aParticleChange.SetNumberOfSecondaries(NumberOfPhotons);
        if (NumberOfPhotons == 0) {
           if (verboseLevel>1)
           G4cout << " *** No WLS photon can be sampled for this primary ***"
                  << G4endl;
           // return unchanged particle and no secondaries
           return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
        }
        continue;
     }
 
     // Generate random photon direction
     
     G4double cost = 1. - 2.*G4UniformRand();
     G4double sint = std::sqrt((1.-cost)*(1.+cost));
 
     G4double phi = twopi*G4UniformRand();
     G4double sinp = std::sin(phi);
     G4double cosp = std::cos(phi);
     
     G4double px = sint*cosp;
     G4double py = sint*sinp;
     G4double pz = cost;
     
     // Create photon momentum direction vector
     
     G4ParticleMomentum photonMomentum(px, py, pz);
     
     // Determine polarization of new photon
     
     G4double sx = cost*cosp;
     G4double sy = cost*sinp;
     G4double sz = -sint;
     
     G4ThreeVector photonPolarization(sx, sy, sz);
     
     G4ThreeVector perp = photonMomentum.cross(photonPolarization);
     
     phi = twopi*G4UniformRand();
     sinp = std::sin(phi);
     cosp = std::cos(phi);
     
     photonPolarization = cosp * photonPolarization + sinp * perp;
     
     photonPolarization = photonPolarization.unit();
     
     // Generate a new photon:
     
     G4DynamicParticle* aWLSPhoton =
       new G4DynamicParticle(G4OpticalPhoton::OpticalPhoton(),
                 photonMomentum);
     aWLSPhoton->SetPolarization
       (photonPolarization.x(),
        photonPolarization.y(),
        photonPolarization.z());
     
     aWLSPhoton->SetKineticEnergy(sampledEnergy);
     
     // Generate new G4Track object:
     
     // Must give position of WLS optical photon
 
     G4double TimeDelay = WLSTimeGeneratorProfile->GenerateTime(WLSTime);
     G4double aSecondaryTime = (pPostStepPoint->GetGlobalTime()) + TimeDelay;
 
     G4ThreeVector aSecondaryPosition = pPostStepPoint->GetPosition();
 
     G4Track* aSecondaryTrack = 
       new G4Track(aWLSPhoton,aSecondaryTime,aSecondaryPosition);
    
     aSecondaryTrack->SetTouchableHandle(aTrack.GetTouchableHandle()); 
     // aSecondaryTrack->SetTouchableHandle((G4VTouchable*)0);
     
     aSecondaryTrack->SetParentID(aTrack.GetTrackID());
     
     aParticleChange.AddSecondary(aSecondaryTrack);
   }
 
   if (verboseLevel>0) {
     G4cout << "\n Exiting from G4OpWLS::DoIt -- NumberOfSecondaries = " 
        << aParticleChange.GetNumberOfSecondaries() << G4endl;  
   }
   
   return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
 }

Here is the call graph for this function:

◆ UseTimeProfile()

void G4OpWLS::UseTimeProfile ( const G4String name )

Definition at line 417 of file G4OpWLS.cc.

 {
   if (name == "delta")
     {
       delete WLSTimeGeneratorProfile;
       WLSTimeGeneratorProfile = 
              new G4WLSTimeGeneratorProfileDelta("delta");
     }
   else if (name == "exponential")
     {
       delete WLSTimeGeneratorProfile;
       WLSTimeGeneratorProfile =
              new G4WLSTimeGeneratorProfileExponential("exponential");
     }
   else
     {
       G4Exception("G4OpWLS::UseTimeProfile", "em0202",
                   FatalException,
                   "generator does not exist");
     }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ theIntegralTable

G4PhysicsTable* G4OpWLS::theIntegralTable

protected

Definition at line 138 of file G4OpWLS.hh.

◆ WLSTimeGeneratorProfile

G4VWLSTimeGeneratorProfile* G4OpWLS::WLSTimeGeneratorProfile

protected

Definition at line 137 of file G4OpWLS.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

◆ G4OpWLS() [1/2]

◆ ~G4OpWLS()

◆ G4OpWLS() [2/2]

Member Function Documentation

◆ BuildPhysicsTable()

◆ DumpPhysicsTable()

◆ GetIntegralTable()

◆ GetMeanFreePath()

◆ IsApplicable()

◆ operator=()

◆ PostStepDoIt()

◆ UseTimeProfile()

Member Data Documentation

◆ theIntegralTable

◆ WLSTimeGeneratorProfile