G4OpWLS Class Reference

#include <G4OpWLS.hh>

Inheritance diagram for G4OpWLS:

Public Member Functions
	G4OpWLS (const G4String &processName="OpWLS", G4ProcessType type=fOptical)
virtual	~G4OpWLS ()
virtual G4bool	IsApplicable (const G4ParticleDefinition &aParticleType) override
virtual void	BuildPhysicsTable (const G4ParticleDefinition &aParticleType) override
virtual G4double	GetMeanFreePath (const G4Track &aTrack, G4double, G4ForceCondition *) override
virtual G4VParticleChange *	PostStepDoIt (const G4Track &aTrack, const G4Step &aStep) override
virtual G4PhysicsTable *	GetIntegralTable () const
virtual void	DumpPhysicsTable () const
virtual void	UseTimeProfile (const G4String name)
virtual void	PreparePhysicsTable (const G4ParticleDefinition &) override
virtual void	Initialise ()
void	SetVerboseLevel (G4int)
Public Member Functions inherited from G4VDiscreteProcess
	G4VDiscreteProcess (const G4String &aName, G4ProcessType aType=fNotDefined)
	G4VDiscreteProcess (G4VDiscreteProcess &)
virtual	~G4VDiscreteProcess ()
G4VDiscreteProcess &	operator= (const G4VDiscreteProcess &)=delete
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 &)
virtual G4double	GetCrossSection (const G4double, const G4MaterialCutsCouple *)
virtual G4double	MinPrimaryEnergy (const G4ParticleDefinition *, const G4Material *)
Public Member Functions inherited from G4VProcess
	G4VProcess (const G4String &aName="NoName", G4ProcessType aType=fNotDefined)
	G4VProcess (const G4VProcess &right)
virtual	~G4VProcess ()
G4VProcess &	operator= (const G4VProcess &)=delete
G4bool	operator== (const G4VProcess &right) const
G4bool	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 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 const G4VProcess *	GetCreatorProcess () const
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
virtual void	ProcessDescription (std::ostream &outfile) 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 = nullptr
G4VParticleChange *	pParticleChange = nullptr
G4ParticleChange	aParticleChange
G4double	theNumberOfInteractionLengthLeft = -1.0
G4double	currentInteractionLength = -1.0
G4double	theInitialNumberOfInteractionLength = -1.0
G4String	theProcessName
G4String	thePhysicsTableFileName
G4ProcessType	theProcessType = fNotDefined
G4int	theProcessSubType = -1
G4double	thePILfactor = 1.0
G4int	verboseLevel = 0
G4bool	enableAtRestDoIt = true
G4bool	enableAlongStepDoIt = true
G4bool	enablePostStepDoIt = true

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)
Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double prevStepSize)
void	ClearNumberOfInteractionLengthLeft ()

Detailed Description

Definition at line 51 of file G4OpWLS.hh.

Constructor & Destructor Documentation

G4OpWLS()

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

explicit

Definition at line 54 of file G4OpWLS.cc.

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

~G4OpWLS()

G4OpWLS::~G4OpWLS ( )

virtual

Definition at line 67 of file G4OpWLS.cc.

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

Member Function Documentation

BuildPhysicsTable()

void G4OpWLS::BuildPhysicsTable ( const G4ParticleDefinition & aParticleType )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 216 of file G4OpWLS.cc.

{
  if(theIntegralTable)
  {
    theIntegralTable->clearAndDestroy();
    delete theIntegralTable;
    theIntegralTable = nullptr;
  }
 
  const G4MaterialTable* materialTable = G4Material::GetMaterialTable();
  std::size_t numOfMaterials           = G4Material::GetNumberOfMaterials();
  theIntegralTable                     = new G4PhysicsTable(numOfMaterials);
 
  // loop for materials
  for(std::size_t i = 0; i < numOfMaterials; ++i)
  {
    auto physVector = new G4PhysicsFreeVector();
 
    // Retrieve vector of WLS wavelength intensity for
    // the material from the material's optical properties table.
    G4MaterialPropertiesTable* MPT =
      (*materialTable)[i]->GetMaterialPropertiesTable();
    if(MPT)
    {
      G4MaterialPropertyVector* wlsVector = MPT->GetProperty(kWLSCOMPONENT);
      if(wlsVector)
      {
        // Retrieve the first intensity point in vector
        // of (photon energy, intensity) pairs
        G4double currentIN = (*wlsVector)[0];
        if(currentIN >= 0.0)
        {
          // Create first (photon energy)
          G4double currentPM  = wlsVector->Energy(0);
          G4double currentCII = 0.0;
          physVector->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(std::size_t j = 1; j < wlsVector->GetVectorLength(); ++j)
          {
            currentPM = wlsVector->Energy(j);
            currentIN = (*wlsVector)[j];
            currentCII =
              prevCII + 0.5 * (currentPM - prevPM) * (prevIN + currentIN);
 
            physVector->InsertValues(currentPM, currentCII);
 
            prevPM  = currentPM;
            prevCII = currentCII;
            prevIN  = currentIN;
          }
        }
      }
    }
    theIntegralTable->insertAt(i, physVector);
  }
}

DumpPhysicsTable()

void G4OpWLS::DumpPhysicsTable ( ) const

inlinevirtual

Definition at line 114 of file G4OpWLS.hh.

{
  std::size_t PhysicsTableSize = theIntegralTable->entries();
  G4PhysicsFreeVector* v;
 
  for(std::size_t i = 0; i < PhysicsTableSize; ++i)
  {
    v = (G4PhysicsFreeVector*) (*theIntegralTable)[i];
    v->DumpValues();
  }
}

GetIntegralTable()

G4PhysicsTable * G4OpWLS::GetIntegralTable ( ) const

inlinevirtual

Definition at line 109 of file G4OpWLS.hh.

{
  return theIntegralTable;
}

GetMeanFreePath()

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

overridevirtual

Implements G4VDiscreteProcess.

Definition at line 281 of file G4OpWLS.cc.

{
  G4double thePhotonEnergy = aTrack.GetDynamicParticle()->GetTotalEnergy();
  G4double attLength       = DBL_MAX;
  G4MaterialPropertiesTable* MPT =
    aTrack.GetMaterial()->GetMaterialPropertiesTable();
 
  if(MPT)
  {
    G4MaterialPropertyVector* attVector = MPT->GetProperty(kWLSABSLENGTH);
    if(attVector)
    {
      attLength = attVector->Value(thePhotonEnergy, idx_wls);
    }
  }
  return attLength;
}

Initialise()

void G4OpWLS::Initialise ( )

virtual

Definition at line 81 of file G4OpWLS.cc.

{
  G4OpticalParameters* params = G4OpticalParameters::Instance();
  SetVerboseLevel(params->GetWLSVerboseLevel());
  UseTimeProfile(params->GetWLSTimeProfile());
}

Referenced by G4OpWLS(), and PreparePhysicsTable().

IsApplicable()

G4bool G4OpWLS::IsApplicable ( const G4ParticleDefinition & aParticleType )

inlineoverridevirtual

Reimplemented from G4VProcess.

Definition at line 104 of file G4OpWLS.hh.

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

PostStepDoIt()

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

overridevirtual

Reimplemented from G4VDiscreteProcess.

Definition at line 89 of file G4OpWLS.cc.

{
  aParticleChange.Initialize(aTrack);
  aParticleChange.ProposeTrackStatus(fStopAndKill);
 
  if(verboseLevel > 1)
  {
    G4cout << "\n** G4OpWLS: Photon absorbed! **" << G4endl;
  }
 
  G4MaterialPropertiesTable* MPT =
    aTrack.GetMaterial()->GetMaterialPropertiesTable();
  if(!MPT)
  {
    return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
  }
 
  G4PhysicsFreeVector* WLSIntegral = nullptr;
  if(!MPT->GetProperty(kWLSCOMPONENT))
  {
    return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
  }
  else
  {
    // Retrieve the WLS Integral for this material
    WLSIntegral = (G4PhysicsFreeVector*) ((*theIntegralTable)
      (aTrack.GetMaterial()->GetIndex()));
  }
 
  G4double primaryEnergy = aTrack.GetDynamicParticle()->GetKineticEnergy();
  // No WLS photons are produced if the primary photon's energy is below
  // the lower bound of the WLS integral range
  if(primaryEnergy < WLSIntegral->GetMinValue())
  {
    return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
  }
 
  G4int NumPhotons = 1;
  if(MPT->ConstPropertyExists(kWLSMEANNUMBERPHOTONS))
  {
    G4double MeanNumberOfPhotons = MPT->GetConstProperty(kWLSMEANNUMBERPHOTONS);
    NumPhotons                   = G4int(G4Poisson(MeanNumberOfPhotons));
    if(NumPhotons <= 0)
    {
      // return unchanged particle and no secondaries
      aParticleChange.SetNumberOfSecondaries(0);
      return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
    }
  }
 
  G4double WLSTime = MPT->GetConstProperty(kWLSTIMECONSTANT);
  G4StepPoint* pPostStepPoint = aStep.GetPostStepPoint();
  std::vector<G4Track*> proposedSecondaries;
 
  // Max WLS Integral - force sampling of a WLS photon with energy below
  // the primary photon's energy
  G4double CIImax = (primaryEnergy > WLSIntegral->GetMaxEnergy()) ?
    WLSIntegral->GetMaxValue() : WLSIntegral->Value(primaryEnergy);
 
  for(G4int i = 0; i < NumPhotons; ++i)
  {
    // Determine photon energy
    G4double sampledEnergy = WLSIntegral->GetEnergy(G4UniformRand() * CIImax);
 
    // Make sure the energy of the secondary is less than that of the primary
    if(sampledEnergy > primaryEnergy)
    {
      G4ExceptionDescription ed;
      ed << "Sampled photon energy " << sampledEnergy << " is greater than "
         << "the primary photon energy " << primaryEnergy << G4endl;
      G4Exception("G4OpWLS::PostStepDoIt", "WSL01", FatalException, ed);
    }
    else if(verboseLevel > 1)
    {
      G4cout << "G4OpWLS: Created photon with energy: " << sampledEnergy
             << G4endl;
    }
 
    // 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);
    G4ParticleMomentum photonMomentum(sint * cosp, sint * sinp, cost);
 
    G4ThreeVector photonPolarization(cost * cosp, cost * sinp, -sint);
    G4ThreeVector perp = photonMomentum.cross(photonPolarization);
 
    phi                = twopi * G4UniformRand();
    sinp               = std::sin(phi);
    cosp               = std::cos(phi);
    photonPolarization = (cosp * photonPolarization + sinp * perp).unit();
 
    // Generate a new photon:
    auto sec_dp =
      new G4DynamicParticle(G4OpticalPhoton::OpticalPhoton(), photonMomentum);
    sec_dp->SetPolarization(photonPolarization);
    sec_dp->SetKineticEnergy(sampledEnergy);
 
    G4double secTime = pPostStepPoint->GetGlobalTime() +
                       WLSTimeGeneratorProfile->GenerateTime(WLSTime);
    G4ThreeVector secPos = pPostStepPoint->GetPosition();
    G4Track* secTrack    = new G4Track(sec_dp, secTime, secPos);
 
    secTrack->SetTouchableHandle(aTrack.GetTouchableHandle());
    secTrack->SetParentID(aTrack.GetTrackID());
 
    proposedSecondaries.push_back(secTrack);
  }
 
  aParticleChange.SetNumberOfSecondaries((G4int)proposedSecondaries.size());
  for(auto sec : proposedSecondaries)
  {
    aParticleChange.AddSecondary(sec);
  }
  if(verboseLevel > 1)
  {
    G4cout << "\n Exiting from G4OpWLS::DoIt -- NumberOfSecondaries = "
           << aParticleChange.GetNumberOfSecondaries() << G4endl;
  }
 
  return G4VDiscreteProcess::PostStepDoIt(aTrack, aStep);
}

PreparePhysicsTable()

void G4OpWLS::PreparePhysicsTable ( const G4ParticleDefinition & )

overridevirtual

Reimplemented from G4VProcess.

Definition at line 78 of file G4OpWLS.cc.

{ Initialise(); }

SetVerboseLevel()

void G4OpWLS::SetVerboseLevel

(

G4int

verbose

)

Definition at line 326 of file G4OpWLS.cc.

{
  verboseLevel = verbose;
  G4OpticalParameters::Instance()->SetWLSVerboseLevel(verboseLevel);
}

Referenced by Initialise().

UseTimeProfile()

void G4OpWLS::UseTimeProfile ( const G4String name )

virtual

Definition at line 301 of file G4OpWLS.cc.

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

Referenced by Initialise().

Member Data Documentation

theIntegralTable

G4PhysicsTable* G4OpWLS::theIntegralTable

protected

Definition at line 91 of file G4OpWLS.hh.

Referenced by BuildPhysicsTable(), DumpPhysicsTable(), G4OpWLS(), GetIntegralTable(), PostStepDoIt(), and ~G4OpWLS().

WLSTimeGeneratorProfile

G4VWLSTimeGeneratorProfile* G4OpWLS::WLSTimeGeneratorProfile

protected

Definition at line 90 of file G4OpWLS.hh.

Referenced by G4OpWLS(), PostStepDoIt(), UseTimeProfile(), and ~G4OpWLS().

---

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

• G4OpWLS.hh
• G4OpWLS.cc