G4OpticalPhysics Class Reference

#include <G4OpticalPhysics.hh>

Inheritance diagram for G4OpticalPhysics:

Public Member Functions
	G4OpticalPhysics (G4int verbose=0, const G4String &name="Optical")
virtual	~G4OpticalPhysics ()
void	Configure (G4OpticalProcessIndex, G4bool)
virtual G4Scintillation *	GetScintillationProcess ()
virtual G4Cerenkov *	GetCerenkovProcess ()
virtual G4OpWLS *	GetOpWLSProcess ()
virtual G4OpAbsorption *	GetOpAbsorptionProcess ()
virtual G4OpRayleigh *	GetOpRayleighProcess ()
virtual G4OpMieHG *	GetOpMieHGProcess ()
virtual G4OpBoundaryProcess *	GetOpBoundaryProcess ()
void	SetProcessVerbose (G4int, G4int)
void	SetMaxNumPhotonsPerStep (G4int)
void	SetMaxBetaChangePerStep (G4double)
void	SetScintillationYieldFactor (G4double)
void	SetScintillationExcitationRatio (G4double)
void	SetWLSTimeProfile (G4String)
void	SetScintillationByParticleType (G4bool)
void	AddScintillationSaturation (G4EmSaturation *)
void	SetTrackSecondariesFirst (G4OpticalProcessIndex, G4bool)
void	SetFiniteRiseTime (G4bool)
Public Member Functions inherited from G4VPhysicsConstructor
	G4VPhysicsConstructor (const G4String &="")
	G4VPhysicsConstructor (const G4String &name, G4int physics_type)
virtual	~G4VPhysicsConstructor ()
virtual void	ConstructParticle ()=0
virtual void	ConstructProcess ()=0
void	SetPhysicsName (const G4String &="")
const G4String &	GetPhysicsName () const
void	SetPhysicsType (G4int)
G4int	GetPhysicsType () const
void	SetVerboseLevel (G4int value)
G4int	GetVerboseLevel () const

Protected Member Functions
virtual void	ConstructParticle ()
virtual void	ConstructProcess ()
Protected Member Functions inherited from G4VPhysicsConstructor
G4bool	RegisterProcess (G4VProcess *process, G4ParticleDefinition *particle)

Additional Inherited Members
Protected Attributes inherited from G4VPhysicsConstructor
G4int	verboseLevel
G4String	namePhysics
G4int	typePhysics
G4ParticleTable *	theParticleTable
G4ParticleTable::G4PTblDicIterator *	theParticleIterator
G4PhysicsListHelper *	thePLHelper

Detailed Description

Definition at line 69 of file G4OpticalPhysics.hh.

Constructor & Destructor Documentation

G4OpticalPhysics()

G4OpticalPhysics::G4OpticalPhysics	(	G4int	verbose = 0,
		const G4String &	name = "Optical"
	)

Definition at line 53 of file G4OpticalPhysics.cc.

  : G4VPhysicsConstructor(name),
 
    wasActivated(false),
 
    fScintillationProcess(NULL),
    fCerenkovProcess(NULL),
    fOpWLSProcess(NULL),
    fOpAbsorptionProcess(NULL),
    fOpRayleighScatteringProcess(NULL),
    fOpMieHGScatteringProcess(NULL),
    fOpBoundaryProcess(NULL),
    fMaxNumPhotons(100),
    fMaxBetaChange(10.0),
    fYieldFactor(1.),
    fExcitationRatio(0.0),
    fProfile("delta"),
    fFiniteRiseTime(false),
    fScintillationByParticleType(false)
{
  verboseLevel = verbose;
  fMessenger = new G4OpticalPhysicsMessenger(this);
 
  for ( G4int i=0; i<kNoProcess; i++ ) {
    fProcesses.push_back(NULL);
    fProcessUse.push_back(true);
    fProcessVerbose.push_back(verbose);
    fProcessTrackSecondariesFirst.push_back(true);
  }
}

~G4OpticalPhysics()

G4OpticalPhysics::~G4OpticalPhysics ( )

virtual

Definition at line 86 of file G4OpticalPhysics.cc.

{
  delete fMessenger;
 
  if (wasActivated) {
 
     if (fScintillationProcess) delete fScintillationProcess;
     if (fCerenkovProcess) delete fCerenkovProcess;
     if (fOpWLSProcess) delete fOpWLSProcess;
 
     if (fOpAbsorptionProcess) delete fOpAbsorptionProcess;
     if (fOpRayleighScatteringProcess) delete fOpRayleighScatteringProcess;
     if (fOpMieHGScatteringProcess) delete fOpMieHGScatteringProcess;
     if (fOpBoundaryProcess) delete fOpBoundaryProcess;
 
  }
}

Member Function Documentation

AddScintillationSaturation()

void G4OpticalPhysics::AddScintillationSaturation

(

G4EmSaturation *

saturation

)

Adds Birks Saturation to the G4Scintillation Process

Definition at line 302 of file G4OpticalPhysics.cc.

{
/// Adds Birks Saturation to the G4Scintillation Process
 
  if(fScintillationProcess)
    fScintillationProcess->AddSaturation(saturation);
}

Configure()

void G4OpticalPhysics::Configure	(	G4OpticalProcessIndex	index,
		G4bool	isUse
	)

Definition at line 339 of file G4OpticalPhysics.cc.

{
  // Configure the physics constructor to use/not use a selected process.
  // This method can only be called in PreInit> phase (before execution of
  // ConstructProcess). The process is not added to particle's process manager
  // and so it cannot be re-activated later in Idle> phase with the command
  // /process/activate.
 
  if ( index >= kNoProcess ) return;
  if ( fProcessUse[index] == isUse ) return;
  fProcessUse[index] = isUse;
}

ConstructParticle()

void G4OpticalPhysics::ConstructParticle ( )

protectedvirtual

Instantiate particles.

Implements G4VPhysicsConstructor.

Definition at line 140 of file G4OpticalPhysics.cc.

{
/// Instantiate particles.
 
  // optical photon
  G4OpticalPhoton::OpticalPhotonDefinition();
}

ConstructProcess()

void G4OpticalPhysics::ConstructProcess ( )

protectedvirtual

Implements G4VPhysicsConstructor.

Definition at line 153 of file G4OpticalPhysics.cc.

{
// Construct optical processes.
 
  if (wasActivated) return;
 
  if(verboseLevel>0)
         G4cout <<"G4OpticalPhysics:: Add Optical Physics Processes"<< G4endl;
 
  // Add Optical Processes
 
  fProcesses[kAbsorption] = fOpAbsorptionProcess  = new G4OpAbsorption();
  fProcesses[kRayleigh] = fOpRayleighScatteringProcess = new G4OpRayleigh();
  fProcesses[kMieHG] = fOpMieHGScatteringProcess = new G4OpMieHG();
 
  fProcesses[kBoundary] = fOpBoundaryProcess = new G4OpBoundaryProcess();
 
  fProcesses[kWLS] = fOpWLSProcess = new G4OpWLS();
  fOpWLSProcess->UseTimeProfile(fProfile);
 
  G4ProcessManager * pManager = 0;
  pManager = G4OpticalPhoton::OpticalPhoton()->GetProcessManager();
 
  if (!pManager) {
     std::ostringstream o;
     o << "Optical Photon without a Process Manager";
     G4Exception("G4OpticalPhysics::ConstructProcess()","",
                  FatalException,o.str().c_str());
     return;
  }
 
  for ( G4int i=kAbsorption; i<=kWLS; i++ ) {
      if ( fProcessUse[i] ) {
         pManager->AddDiscreteProcess(fProcesses[i]);
      }
  }
 
  fProcesses[kScintillation] = fScintillationProcess = new G4Scintillation();
  fScintillationProcess->SetScintillationYieldFactor(fYieldFactor);
  fScintillationProcess->SetScintillationExcitationRatio(fExcitationRatio);
  fScintillationProcess->SetFiniteRiseTime(fFiniteRiseTime);
  fScintillationProcess->SetScintillationByParticleType(fScintillationByParticleType);
  fScintillationProcess->
       SetTrackSecondariesFirst(fProcessTrackSecondariesFirst[kScintillation]);
 
  // Use Birks Correction in the Scintillation process
 
  G4EmSaturation* emSaturation = G4LossTableManager::Instance()->EmSaturation();
  fScintillationProcess->AddSaturation(emSaturation);
 
  fProcesses[kCerenkov] = fCerenkovProcess = new G4Cerenkov();
  fCerenkovProcess->SetMaxNumPhotonsPerStep(fMaxNumPhotons);
  fCerenkovProcess->SetMaxBetaChangePerStep(fMaxBetaChange);
  fCerenkovProcess->
       SetTrackSecondariesFirst(fProcessTrackSecondariesFirst[kCerenkov]);
 
  theParticleIterator->reset();
 
  while( (*theParticleIterator)() ){
 
    G4ParticleDefinition* particle = theParticleIterator->value();
    G4String particleName = particle->GetParticleName();
 
    pManager = particle->GetProcessManager();
    if (!pManager) {
       std::ostringstream o;
       o << "Particle " << particleName << "without a Process Manager";
       G4Exception("G4OpticalPhysics::ConstructProcess()","",
                    FatalException,o.str().c_str());
       return;                 // else coverity complains for pManager use below        
    }
 
    if( fCerenkovProcess->IsApplicable(*particle) &&
        fProcessUse[kCerenkov] ) {
          pManager->AddProcess(fCerenkovProcess);
          pManager->SetProcessOrdering(fCerenkovProcess,idxPostStep);
    }
    if( fScintillationProcess->IsApplicable(*particle) &&
        fProcessUse[kScintillation] ){
          pManager->AddProcess(fScintillationProcess);
          pManager->SetProcessOrderingToLast(fScintillationProcess,idxAtRest);
          pManager->SetProcessOrderingToLast(fScintillationProcess,idxPostStep);
    }
 
  }
 
  // Add verbose
  for ( G4int i=0; i<kNoProcess; i++ ) {
    fProcesses[i]->SetVerboseLevel(fProcessVerbose[i]);
  }
 
  if (verboseLevel > 1) PrintStatistics();
  if (verboseLevel > 0)
    G4cout << "### " << namePhysics << " physics constructed." << G4endl;
 
  wasActivated = true;
 
}

GetCerenkovProcess()

virtual G4Cerenkov * G4OpticalPhysics::GetCerenkovProcess ( )

inlinevirtual

Definition at line 97 of file G4OpticalPhysics.hh.

                                       { return fCerenkovProcess; }

GetOpAbsorptionProcess()

virtual G4OpAbsorption * G4OpticalPhysics::GetOpAbsorptionProcess ( )

inlinevirtual

Definition at line 101 of file G4OpticalPhysics.hh.

                                       { return fOpAbsorptionProcess; }

GetOpBoundaryProcess()

virtual G4OpBoundaryProcess * G4OpticalPhysics::GetOpBoundaryProcess ( )

inlinevirtual

Definition at line 107 of file G4OpticalPhysics.hh.

                                       { return fOpBoundaryProcess; }

GetOpMieHGProcess()

virtual G4OpMieHG * G4OpticalPhysics::GetOpMieHGProcess ( )

inlinevirtual

Definition at line 105 of file G4OpticalPhysics.hh.

                                       { return fOpMieHGScatteringProcess; }

GetOpRayleighProcess()

virtual G4OpRayleigh * G4OpticalPhysics::GetOpRayleighProcess ( )

inlinevirtual

Definition at line 103 of file G4OpticalPhysics.hh.

                                       { return fOpRayleighScatteringProcess; }

GetOpWLSProcess()

virtual G4OpWLS * G4OpticalPhysics::GetOpWLSProcess ( )

inlinevirtual

Definition at line 99 of file G4OpticalPhysics.hh.

{ return fOpWLSProcess; }

GetScintillationProcess()

virtual G4Scintillation * G4OpticalPhysics::GetScintillationProcess ( )

inlinevirtual

Definition at line 95 of file G4OpticalPhysics.hh.

                                       { return fScintillationProcess; }

SetFiniteRiseTime()

void G4OpticalPhysics::SetFiniteRiseTime

(

G4bool

finiteRiseTime

)

Definition at line 332 of file G4OpticalPhysics.cc.

{
  fFiniteRiseTime = finiteRiseTime;
  if(fScintillationProcess)
    fScintillationProcess->SetFiniteRiseTime(finiteRiseTime);
} 

Referenced by G4OpticalPhysicsMessenger::SetNewValue().

SetMaxBetaChangePerStep()

void G4OpticalPhysics::SetMaxBetaChangePerStep

(

G4double

maxBetaChange

)

Limit step to the specified maximum change of beta of the parent particle

Definition at line 282 of file G4OpticalPhysics.cc.

{
/// Limit step to the specified maximum change of beta of the parent particle
 
  fMaxBetaChange = maxBetaChange;
 
  if(fCerenkovProcess)
    fCerenkovProcess->SetMaxBetaChangePerStep(maxBetaChange);
}

Referenced by G4OpticalPhysicsMessenger::SetNewValue().

SetMaxNumPhotonsPerStep()

void G4OpticalPhysics::SetMaxNumPhotonsPerStep

(

G4int

maxNumPhotons

)

Limit step to the specified maximum number of Cherenkov photons

Definition at line 272 of file G4OpticalPhysics.cc.

{
/// Limit step to the specified maximum number of Cherenkov photons
 
  fMaxNumPhotons = maxNumPhotons;
 
  if(fCerenkovProcess)
    fCerenkovProcess->SetMaxNumPhotonsPerStep(maxNumPhotons);
}

Referenced by G4OpticalPhysicsMessenger::SetNewValue().

SetProcessVerbose()

void G4OpticalPhysics::SetProcessVerbose	(	G4int	index,
		G4int	inputVerboseLevel
	)

Definition at line 352 of file G4OpticalPhysics.cc.

{
  // Set new verbose level to a selected process
 
  if ( index >= kNoProcess ) return;
  if ( fProcessVerbose[index] == inputVerboseLevel ) return;
 
  fProcessVerbose[index] = inputVerboseLevel;
 
  if ( fProcesses[index] ) fProcesses[index]->SetVerboseLevel(inputVerboseLevel);
}

SetScintillationByParticleType()

void G4OpticalPhysics::SetScintillationByParticleType

(

G4bool

scintillationByParticleType

)

Definition at line 310 of file G4OpticalPhysics.cc.

{
  fScintillationByParticleType = scintillationByParticleType;
 
  if (fScintillationProcess)
     fScintillationProcess->SetScintillationByParticleType(scintillationByParticleType);
}

Referenced by G4OpticalPhysicsMessenger::SetNewValue().

SetScintillationExcitationRatio()

void G4OpticalPhysics::SetScintillationExcitationRatio

(

G4double

excitationRatio

)

Set the scintillation excitation ratio

Definition at line 262 of file G4OpticalPhysics.cc.

{
/// Set the scintillation excitation ratio
 
  fExcitationRatio = excitationRatio;
 
  if(fScintillationProcess)
    fScintillationProcess->SetScintillationExcitationRatio(excitationRatio);
}

SetScintillationYieldFactor()

void G4OpticalPhysics::SetScintillationYieldFactor

(

G4double

yieldFactor

)

Set the scintillation yield factor

Definition at line 252 of file G4OpticalPhysics.cc.

{
/// Set the scintillation yield factor
 
  fYieldFactor = yieldFactor;
 
  if(fScintillationProcess)
    fScintillationProcess->SetScintillationYieldFactor(yieldFactor);
}

Referenced by G4OpticalPhysicsMessenger::SetNewValue().

SetTrackSecondariesFirst()

void G4OpticalPhysics::SetTrackSecondariesFirst	(	G4OpticalProcessIndex	index,
		G4bool	trackSecondariesFirst
	)

Definition at line 318 of file G4OpticalPhysics.cc.

{
  if ( index >= kNoProcess ) return;
  if ( fProcessTrackSecondariesFirst[index] == trackSecondariesFirst ) return;
  fProcessTrackSecondariesFirst[index] = trackSecondariesFirst;
 
  if(fCerenkovProcess && index == kCerenkov )
    fCerenkovProcess->SetTrackSecondariesFirst(trackSecondariesFirst);
 
  if(fScintillationProcess && index == kScintillation)
    fScintillationProcess->SetTrackSecondariesFirst(trackSecondariesFirst);
}

Referenced by ConstructProcess(), and G4OpticalPhysicsMessenger::SetNewValue().

SetWLSTimeProfile()

void G4OpticalPhysics::SetWLSTimeProfile

(

G4String

profile

)

Set the WLS time profile (delta or exponential)

Definition at line 292 of file G4OpticalPhysics.cc.

{
/// Set the WLS time profile (delta or exponential)
 
  fProfile = profile;
 
  if(fOpWLSProcess)
    fOpWLSProcess->UseTimeProfile(fProfile);
}

Referenced by G4OpticalPhysicsMessenger::SetNewValue().

---

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

• G4OpticalPhysics.hh
• G4OpticalPhysics.cc