#include <G4OpWLS.hh>

Inheritance 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

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

Static Public Member Functions
static void	UseTimeProfile (const G4String name)

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

Protected Attributes
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

Static Protected Attributes
static G4VWLSTimeGeneratorProfile *	WLSTimeGeneratorProfile = 0

Additional Inherited Members
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::G4OpWLS	(	const G4String &	processName = `"OpWLS"`,
		G4ProcessType	type = `fOptical`
	)

Definition at line 70 of file G4OpWLS.cc.

References fOpWLS, G4cout, G4endl, G4VProcess::GetProcessName(), G4VProcess::SetProcessSubType(), theIntegralTable, G4VProcess::verboseLevel, and WLSTimeGeneratorProfile.

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

G4OpWLS::~G4OpWLS ( )

Definition at line 88 of file G4OpWLS.cc.

References G4PhysicsTable::clearAndDestroy(), and theIntegralTable.

 {
   if (theIntegralTable != 0) {
     theIntegralTable->clearAndDestroy();
     delete theIntegralTable;
   }
 }

Member Function Documentation

void G4OpWLS::BuildPhysicsTable ( const G4ParticleDefinition & aParticleType )

virtual

Reimplemented from G4VProcess.

Definition at line 100 of file G4OpWLS.cc.

References theIntegralTable.

 {
     if (!theIntegralTable) BuildThePhysicsTable();
 }

void G4OpWLS::DumpPhysicsTable ( ) const

inline

Definition at line 164 of file G4OpWLS.hh.

References G4PhysicsOrderedFreeVector::DumpValues(), G4PhysicsTable::entries(), theIntegralTable, and test::v.

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

G4PhysicsTable * G4OpWLS::GetIntegralTable ( ) const

inline

Definition at line 158 of file G4OpWLS.hh.

References theIntegralTable.

 {
   return theIntegralTable;
 }

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

virtual

Implements G4VDiscreteProcess.

Definition at line 387 of file G4OpWLS.cc.

References DBL_MAX, G4Track::GetDynamicParticle(), G4Track::GetMaterial(), G4Material::GetMaterialPropertiesTable(), and G4DynamicParticle::GetTotalEnergy().

 {
   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;
 }

G4bool G4OpWLS::IsApplicable ( const G4ParticleDefinition & aParticleType )

inlinevirtual

Reimplemented from G4VProcess.

Definition at line 152 of file G4OpWLS.hh.

References G4OpticalPhoton::OpticalPhoton().

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

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

virtual

Reimplemented from G4VDiscreteProcess.

Definition at line 109 of file G4OpWLS.cc.

References G4ParticleChange::AddSecondary(), G4VProcess::aParticleChange, G4MaterialPropertiesTable::ConstPropertyExists(), CLHEP::Hep3Vector::cross(), fStopAndKill, G4cout, G4endl, G4Poisson(), G4UniformRand, G4VWLSTimeGeneratorProfile::GenerateTime(), G4Track::GetDynamicParticle(), G4PhysicsOrderedFreeVector::GetEnergy(), G4StepPoint::GetGlobalTime(), G4Material::GetIndex(), G4DynamicParticle::GetKineticEnergy(), G4Track::GetMaterial(), G4Material::GetMaterialPropertiesTable(), G4PhysicsOrderedFreeVector::GetMaxValue(), G4VParticleChange::GetNumberOfSecondaries(), G4StepPoint::GetPosition(), G4Step::GetPostStepPoint(), G4MaterialPropertiesTable::GetProperty(), G4Track::GetTouchableHandle(), G4Track::GetTrackID(), G4ParticleChange::Initialize(), ns, G4OpticalPhoton::OpticalPhoton(), G4VDiscreteProcess::PostStepDoIt(), G4VParticleChange::ProposeTrackStatus(), G4DynamicParticle::SetKineticEnergy(), G4VParticleChange::SetNumberOfSecondaries(), G4Track::SetParentID(), G4DynamicParticle::SetPolarization(), G4Track::SetTouchableHandle(), theIntegralTable, python.hepunit::twopi, CLHEP::Hep3Vector::unit(), G4VProcess::verboseLevel, WLSTimeGeneratorProfile, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

 {
   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);
 }

void G4OpWLS::UseTimeProfile ( const G4String name )

static

Definition at line 426 of file G4OpWLS.cc.

References FatalException, G4Exception(), and WLSTimeGeneratorProfile.

Referenced by F04OpticalPhysics::ConstructProcess(), WLSOpticalPhysics::ConstructProcess(), G4OpticalPhysics::ConstructProcess(), and G4OpticalPhysics::SetWLSTimeProfile().

 {
   G4AutoLock l(&wlsCmdHandlingMutex);
   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");
     }
 }