G4OpticalParameters Class Reference

#include <G4OpticalParameters.hh>

Public Member Functions
void	Dump () const
G4int	GetAbsorptionVerboseLevel () const
G4bool	GetBoundaryInvokeSD () const
G4int	GetBoundaryVerboseLevel () const
G4double	GetCerenkovMaxBetaChange () const
G4int	GetCerenkovMaxPhotonsPerStep () const
G4bool	GetCerenkovStackPhotons () const
G4bool	GetCerenkovTrackSecondariesFirst () const
G4int	GetCerenkovVerboseLevel () const
G4int	GetMieVerboseLevel () const
G4bool	GetProcessActivation (const G4String &) const
G4int	GetRayleighVerboseLevel () const
G4bool	GetScintByParticleType () const
G4bool	GetScintEnhancedTimeConstants () const
G4bool	GetScintFiniteRiseTime () const
G4bool	GetScintStackPhotons () const
G4bool	GetScintTrackInfo () const
G4bool	GetScintTrackSecondariesFirst () const
G4int	GetScintVerboseLevel () const
G4int	GetVerboseLevel () const
G4String	GetWLS2TimeProfile () const
G4int	GetWLS2VerboseLevel () const
G4String	GetWLSTimeProfile () const
G4int	GetWLSVerboseLevel () const
void	SetAbsorptionVerboseLevel (G4int)
void	SetBoundaryInvokeSD (G4bool)
void	SetBoundaryVerboseLevel (G4int)
void	SetCerenkovMaxBetaChange (G4double)
void	SetCerenkovMaxPhotonsPerStep (G4int)
void	SetCerenkovStackPhotons (G4bool)
void	SetCerenkovTrackSecondariesFirst (G4bool)
void	SetCerenkovVerboseLevel (G4int)
void	SetDefaults ()
void	SetMieVerboseLevel (G4int)
void	SetProcessActivation (const G4String &, G4bool)
void	SetRayleighVerboseLevel (G4int)
void	SetScintByParticleType (G4bool)
void	SetScintEnhancedTimeConstants (G4bool)
void	SetScintFiniteRiseTime (G4bool)
void	SetScintStackPhotons (G4bool)
void	SetScintTrackInfo (G4bool)
void	SetScintTrackSecondariesFirst (G4bool)
void	SetScintVerboseLevel (G4int)
void	SetVerboseLevel (G4int)
void	SetWLS2TimeProfile (const G4String &)
void	SetWLS2VerboseLevel (G4int)
void	SetWLSTimeProfile (const G4String &)
void	SetWLSVerboseLevel (G4int)
void	StreamInfo (std::ostream &os) const
	~G4OpticalParameters ()

Static Public Member Functions
static G4OpticalParameters *	Instance ()

Private Member Functions
	G4OpticalParameters ()
void	Initialise ()
G4bool	IsLocked () const
void	PrintWarning (G4ExceptionDescription &ed) const

Private Attributes
G4int	absorptionVerboseLevel
G4bool	boundaryInvokeSD
G4int	boundaryVerboseLevel
G4double	cerenkovMaxBetaChange
G4int	cerenkovMaxPhotons
G4bool	cerenkovStackPhotons
G4bool	cerenkovTrackSecondariesFirst
G4int	cerenkovVerboseLevel
G4StateManager *	fStateManager
G4int	mieVerboseLevel
std::map< G4String, G4bool >	processActivation
G4int	rayleighVerboseLevel
G4bool	scintByParticleType
G4bool	scintFiniteRiseTime
G4bool	scintStackPhotons
	option to allow stacking of secondary Scintillation photons More...
G4bool	scintTrackInfo
G4bool	scintTrackSecondariesFirst
G4int	scintVerboseLevel
G4OpticalParametersMessenger *	theMessenger
G4int	verboseLevel
G4String	wls2TimeProfileName
G4int	wls2VerboseLevel
G4String	wlsTimeProfileName
G4int	wlsVerboseLevel

Static Private Attributes
static G4OpticalParameters *	theInstance = nullptr

Friends
std::ostream &	operator<< (std::ostream &os, const G4OpticalParameters &)

Detailed Description

Definition at line 104 of file G4OpticalParameters.hh.

Constructor & Destructor Documentation

~G4OpticalParameters()

G4OpticalParameters::~G4OpticalParameters

(

)

Definition at line 80 of file G4OpticalParameters.cc.

{ delete theMessenger; }

References theMessenger.

G4OpticalParameters()

G4OpticalParameters::G4OpticalParameters ( )

private

Definition at line 84 of file G4OpticalParameters.cc.

{
  theMessenger = new G4OpticalParametersMessenger(this);
  Initialise();
 
  fStateManager = G4StateManager::GetStateManager();
}

References fStateManager, G4StateManager::GetStateManager(), Initialise(), and theMessenger.

Member Function Documentation

Dump()

void G4OpticalParameters::Dump

(

)

const

Definition at line 534 of file G4OpticalParameters.cc.

{
#ifdef G4MULTITHREADED
  G4MUTEXLOCK(&opticalParametersMutex);
#endif
  StreamInfo(G4cout);
#ifdef G4MULTITHREADED
  G4MUTEXUNLOCK(&opticalParametersMutex);
#endif
}

References G4cout, G4MUTEXLOCK, G4MUTEXUNLOCK, and StreamInfo().

Referenced by G4OpticalPhysics::PrintStatistics(), and G4OpticalParametersMessenger::SetNewValue().

GetAbsorptionVerboseLevel()

G4int G4OpticalParameters::GetAbsorptionVerboseLevel

(

)

const

Definition at line 440 of file G4OpticalParameters.cc.

{
  return absorptionVerboseLevel;
}

References absorptionVerboseLevel.

GetBoundaryInvokeSD()

G4bool G4OpticalParameters::GetBoundaryInvokeSD

(

)

const

Definition at line 426 of file G4OpticalParameters.cc.

{
  return boundaryInvokeSD;
}

References boundaryInvokeSD.

Referenced by G4OpBoundaryProcess::Initialise().

GetBoundaryVerboseLevel()

G4int G4OpticalParameters::GetBoundaryVerboseLevel

(

)

const

Definition at line 412 of file G4OpticalParameters.cc.

{
  return boundaryVerboseLevel;
}

References boundaryVerboseLevel.

Referenced by G4OpBoundaryProcess::Initialise().

GetCerenkovMaxBetaChange()

G4double G4OpticalParameters::GetCerenkovMaxBetaChange

(

)

const

Definition at line 247 of file G4OpticalParameters.cc.

{
  return cerenkovMaxBetaChange;
}

References cerenkovMaxBetaChange.

Referenced by G4Cerenkov::Initialise(), and G4Cerenkov::ProcessDescription().

GetCerenkovMaxPhotonsPerStep()

G4int G4OpticalParameters::GetCerenkovMaxPhotonsPerStep

(

)

const

Definition at line 233 of file G4OpticalParameters.cc.

{
  return cerenkovMaxPhotons;
}

References cerenkovMaxPhotons.

Referenced by G4Cerenkov::Initialise(), G4Cerenkov::ProcessDescription(), and G4OpticalParametersMessenger::SetNewValue().

GetCerenkovStackPhotons()

G4bool G4OpticalParameters::GetCerenkovStackPhotons

(

)

const

Definition at line 205 of file G4OpticalParameters.cc.

{
  return cerenkovStackPhotons;
}

References cerenkovStackPhotons.

Referenced by G4Cerenkov::Initialise(), and G4Cerenkov::ProcessDescription().

GetCerenkovTrackSecondariesFirst()

G4bool G4OpticalParameters::GetCerenkovTrackSecondariesFirst

(

)

const

Definition at line 261 of file G4OpticalParameters.cc.

{
  return cerenkovTrackSecondariesFirst;
}

References cerenkovTrackSecondariesFirst.

Referenced by G4Cerenkov::Initialise(), and G4Cerenkov::ProcessDescription().

GetCerenkovVerboseLevel()

G4int G4OpticalParameters::GetCerenkovVerboseLevel

(

)

const

Definition at line 219 of file G4OpticalParameters.cc.

{
  return cerenkovVerboseLevel;
}

References cerenkovVerboseLevel.

Referenced by G4Cerenkov::Initialise(), and G4Cerenkov::ProcessDescription().

GetMieVerboseLevel()

G4int G4OpticalParameters::GetMieVerboseLevel

(

)

const

Definition at line 468 of file G4OpticalParameters.cc.

{
  return mieVerboseLevel;
}

References mieVerboseLevel.

GetProcessActivation()

G4bool G4OpticalParameters::GetProcessActivation

(

const G4String &

process

)

const

Definition at line 191 of file G4OpticalParameters.cc.

{
  return processActivation.find(process)->second;
}

References processActivation.

Referenced by StreamInfo().

GetRayleighVerboseLevel()

G4int G4OpticalParameters::GetRayleighVerboseLevel

(

)

const

Definition at line 454 of file G4OpticalParameters.cc.

{
  return rayleighVerboseLevel;
}

References rayleighVerboseLevel.

GetScintByParticleType()

G4bool G4OpticalParameters::GetScintByParticleType

(

)

const

Definition at line 275 of file G4OpticalParameters.cc.

{
  return scintByParticleType;
}

References scintByParticleType.

Referenced by G4Scintillation::Initialise(), and G4Scintillation::ProcessDescription().

GetScintEnhancedTimeConstants()

G4bool G4OpticalParameters::GetScintEnhancedTimeConstants

(

)

const

GetScintFiniteRiseTime()

G4bool G4OpticalParameters::GetScintFiniteRiseTime

(

)

const

Definition at line 314 of file G4OpticalParameters.cc.

{
  return scintFiniteRiseTime;
}

References scintFiniteRiseTime.

Referenced by G4Scintillation::Initialise(), and G4Scintillation::ProcessDescription().

GetScintStackPhotons()

G4bool G4OpticalParameters::GetScintStackPhotons

(

)

const

Definition at line 328 of file G4OpticalParameters.cc.

{
  return scintStackPhotons;
}

References scintStackPhotons.

Referenced by G4Scintillation::Initialise(), and G4Scintillation::ProcessDescription().

GetScintTrackInfo()

G4bool G4OpticalParameters::GetScintTrackInfo

(

)

const

Definition at line 289 of file G4OpticalParameters.cc.

{ return scintTrackInfo; }

References scintTrackInfo.

Referenced by G4Scintillation::Initialise(), and G4Scintillation::ProcessDescription().

GetScintTrackSecondariesFirst()

G4bool G4OpticalParameters::GetScintTrackSecondariesFirst

(

)

const

Definition at line 300 of file G4OpticalParameters.cc.

{
  return scintTrackSecondariesFirst;
}

References scintTrackSecondariesFirst.

Referenced by G4Scintillation::Initialise(), and G4Scintillation::ProcessDescription().

GetScintVerboseLevel()

G4int G4OpticalParameters::GetScintVerboseLevel

(

)

const

Definition at line 342 of file G4OpticalParameters.cc.

{
  return scintVerboseLevel;
}

References scintVerboseLevel.

Referenced by G4Scintillation::Initialise(), and G4Scintillation::ProcessDescription().

GetVerboseLevel()

G4int G4OpticalParameters::GetVerboseLevel

(

)

const

Definition at line 159 of file G4OpticalParameters.cc.

{ return verboseLevel; }

References verboseLevel.

GetWLS2TimeProfile()

G4String G4OpticalParameters::GetWLS2TimeProfile

(

)

const

Definition at line 384 of file G4OpticalParameters.cc.

{
  return wls2TimeProfileName;
}

References wls2TimeProfileName.

Referenced by G4OpWLS2::Initialise().

GetWLS2VerboseLevel()

G4int G4OpticalParameters::GetWLS2VerboseLevel

(

)

const

Definition at line 398 of file G4OpticalParameters.cc.

{
  return wls2VerboseLevel;
}

References wls2VerboseLevel.

Referenced by G4OpWLS2::Initialise().

GetWLSTimeProfile()

G4String G4OpticalParameters::GetWLSTimeProfile

(

)

const

Definition at line 356 of file G4OpticalParameters.cc.

{
  return wlsTimeProfileName;
}

References wlsTimeProfileName.

Referenced by G4OpWLS::Initialise().

GetWLSVerboseLevel()

G4int G4OpticalParameters::GetWLSVerboseLevel

(

)

const

Definition at line 370 of file G4OpticalParameters.cc.

{
  return wlsVerboseLevel;
}

References wlsVerboseLevel.

Referenced by G4OpWLS::Initialise().

Initialise()

void G4OpticalParameters::Initialise ( )

private

Definition at line 100 of file G4OpticalParameters.cc.

{
  verboseLevel = 0;
 
  cerenkovStackPhotons          = true;
  cerenkovTrackSecondariesFirst = true;
  cerenkovVerboseLevel          = 0;
  cerenkovMaxPhotons            = 100;
  cerenkovMaxBetaChange         = 10.;
 
  scintByParticleType        = false;
  scintTrackInfo             = false;
  scintStackPhotons          = true;
  scintFiniteRiseTime        = false;
  scintTrackSecondariesFirst = true;
  scintVerboseLevel          = 0;
 
  wlsTimeProfileName = "delta";
  wlsVerboseLevel    = 0;
 
  wls2TimeProfileName = "delta";
  wls2VerboseLevel    = 0;
 
  absorptionVerboseLevel = 0;
 
  rayleighVerboseLevel = 0;
 
  mieVerboseLevel = 0;
 
  boundaryInvokeSD     = false;
  boundaryVerboseLevel = 0;
 
  processActivation["OpRayleigh"]    = true;
  processActivation["OpBoundary"]    = true;
  processActivation["OpMieHG"]       = true;
  processActivation["OpAbsorption"]  = true;
  processActivation["OpWLS"]         = true;
  processActivation["OpWLS2"]        = true;
  processActivation["Cerenkov"]      = true;
  processActivation["Scintillation"] = true;
}

References absorptionVerboseLevel, boundaryInvokeSD, boundaryVerboseLevel, cerenkovMaxBetaChange, cerenkovMaxPhotons, cerenkovStackPhotons, cerenkovTrackSecondariesFirst, cerenkovVerboseLevel, mieVerboseLevel, processActivation, rayleighVerboseLevel, scintByParticleType, scintFiniteRiseTime, scintStackPhotons, scintTrackInfo, scintTrackSecondariesFirst, scintVerboseLevel, verboseLevel, wls2TimeProfileName, wls2VerboseLevel, wlsTimeProfileName, and wlsVerboseLevel.

Referenced by G4OpticalParameters(), and SetDefaults().

Instance()

G4OpticalParameters * G4OpticalParameters::Instance ( void  )

static

Definition at line 59 of file G4OpticalParameters.cc.

{
  if(nullptr == theInstance)
  {
#ifdef G4MULTITHREADED
    G4MUTEXLOCK(&opticalParametersMutex);
    if(nullptr == theInstance)
    {
#endif
      static G4OpticalParameters manager;
      theInstance = &manager;
#ifdef G4MULTITHREADED
    }
    G4MUTEXUNLOCK(&opticalParametersMutex);
#endif
  }
  return theInstance;
}

References G4MUTEXLOCK, G4MUTEXUNLOCK, and theInstance.

Referenced by G4OpticalPhysics::ConstructProcess(), G4OpticalPhysics::G4OpticalPhysics(), G4Cerenkov::Initialise(), G4Scintillation::Initialise(), G4OpAbsorption::Initialise(), G4OpBoundaryProcess::Initialise(), G4OpMieHG::Initialise(), G4OpRayleigh::Initialise(), G4OpWLS::Initialise(), G4OpWLS2::Initialise(), G4OpticalPhysics::PrintStatistics(), G4Scintillation::ProcessDescription(), G4Cerenkov::ProcessDescription(), G4Scintillation::SetFiniteRiseTime(), G4OpBoundaryProcess::SetInvokeSD(), G4Cerenkov::SetMaxBetaChangePerStep(), G4Cerenkov::SetMaxNumPhotonsPerStep(), G4Scintillation::SetScintillationByParticleType(), G4Scintillation::SetScintillationTrackInfo(), G4Cerenkov::SetStackPhotons(), G4Scintillation::SetStackPhotons(), G4Cerenkov::SetTrackSecondariesFirst(), G4Scintillation::SetTrackSecondariesFirst(), G4Cerenkov::SetVerboseLevel(), G4Scintillation::SetVerboseLevel(), G4OpAbsorption::SetVerboseLevel(), G4OpBoundaryProcess::SetVerboseLevel(), G4OpMieHG::SetVerboseLevel(), G4OpRayleigh::SetVerboseLevel(), G4OpWLS::SetVerboseLevel(), G4OpWLS2::SetVerboseLevel(), G4OpWLS::UseTimeProfile(), and G4OpWLS2::UseTimeProfile().

IsLocked()

G4bool G4OpticalParameters::IsLocked ( ) const

private

Definition at line 551 of file G4OpticalParameters.cc.

{
  return (!G4Threading::IsMasterThread() ||
          (fStateManager->GetCurrentState() != G4State_PreInit &&
           fStateManager->GetCurrentState() != G4State_Init &&
           fStateManager->GetCurrentState() != G4State_Idle));
}

References fStateManager, G4State_Idle, G4State_Init, G4State_PreInit, G4StateManager::GetCurrentState(), and G4Threading::IsMasterThread().

Referenced by SetAbsorptionVerboseLevel(), SetBoundaryInvokeSD(), SetBoundaryVerboseLevel(), SetCerenkovMaxBetaChange(), SetCerenkovMaxPhotonsPerStep(), SetCerenkovStackPhotons(), SetCerenkovTrackSecondariesFirst(), SetCerenkovVerboseLevel(), SetDefaults(), SetMieVerboseLevel(), SetProcessActivation(), SetRayleighVerboseLevel(), SetScintByParticleType(), SetScintFiniteRiseTime(), SetScintStackPhotons(), SetScintTrackInfo(), SetScintTrackSecondariesFirst(), SetScintVerboseLevel(), SetVerboseLevel(), SetWLS2TimeProfile(), SetWLS2VerboseLevel(), SetWLSTimeProfile(), and SetWLSVerboseLevel().

PrintWarning()

void G4OpticalParameters::PrintWarning ( G4ExceptionDescription &  ed ) const

private

Definition at line 473 of file G4OpticalParameters.cc.

{
  G4Exception("G4EmParameters", "Optical0020", JustWarning, ed);
}

References G4Exception(), and JustWarning.

SetAbsorptionVerboseLevel()

void G4OpticalParameters::SetAbsorptionVerboseLevel

(

G4int

val

)

Definition at line 431 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  absorptionVerboseLevel = val;
}

References absorptionVerboseLevel, and IsLocked().

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4OpAbsorption::SetVerboseLevel().

SetBoundaryInvokeSD()

void G4OpticalParameters::SetBoundaryInvokeSD

(

G4bool

val

)

Definition at line 417 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  boundaryInvokeSD = val;
}

References boundaryInvokeSD, and IsLocked().

Referenced by G4OpBoundaryProcess::SetInvokeSD(), and G4OpticalParametersMessenger::SetNewValue().

SetBoundaryVerboseLevel()

void G4OpticalParameters::SetBoundaryVerboseLevel

(

G4int

val

)

Definition at line 403 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  boundaryVerboseLevel = val;
}

References boundaryVerboseLevel, and IsLocked().

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4OpBoundaryProcess::SetVerboseLevel().

SetCerenkovMaxBetaChange()

void G4OpticalParameters::SetCerenkovMaxBetaChange

(

G4double

val

)

Definition at line 238 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  cerenkovMaxBetaChange = val;
}

References cerenkovMaxBetaChange, and IsLocked().

Referenced by G4Cerenkov::SetMaxBetaChangePerStep(), and G4OpticalParametersMessenger::SetNewValue().

SetCerenkovMaxPhotonsPerStep()

void G4OpticalParameters::SetCerenkovMaxPhotonsPerStep

(

G4int

val

)

Definition at line 224 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  cerenkovMaxPhotons = val;
}

References cerenkovMaxPhotons, and IsLocked().

Referenced by G4Cerenkov::SetMaxNumPhotonsPerStep(), and G4OpticalParametersMessenger::SetNewValue().

SetCerenkovStackPhotons()

void G4OpticalParameters::SetCerenkovStackPhotons

(

G4bool

val

)

Definition at line 196 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  cerenkovStackPhotons = val;
}

References cerenkovStackPhotons, and IsLocked().

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4Cerenkov::SetStackPhotons().

SetCerenkovTrackSecondariesFirst()

void G4OpticalParameters::SetCerenkovTrackSecondariesFirst

(

G4bool

val

)

Definition at line 252 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  cerenkovTrackSecondariesFirst = val;
}

References cerenkovTrackSecondariesFirst, and IsLocked().

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4Cerenkov::SetTrackSecondariesFirst().

SetCerenkovVerboseLevel()

void G4OpticalParameters::SetCerenkovVerboseLevel

(

G4int

val

)

Definition at line 210 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  cerenkovVerboseLevel = val;
}

References cerenkovVerboseLevel, and IsLocked().

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4Cerenkov::SetVerboseLevel().

SetDefaults()

void G4OpticalParameters::SetDefaults

(

)

Definition at line 92 of file G4OpticalParameters.cc.

{
  if(!IsLocked())
  {
    Initialise();
  }
}

References Initialise(), and IsLocked().

SetMieVerboseLevel()

void G4OpticalParameters::SetMieVerboseLevel

(

G4int

val

)

Definition at line 459 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  mieVerboseLevel = val;
}

References IsLocked(), and mieVerboseLevel.

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4OpMieHG::SetVerboseLevel().

SetProcessActivation()

void G4OpticalParameters::SetProcessActivation	(	const G4String &	process,
		G4bool	val
	)

Definition at line 161 of file G4OpticalParameters.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(IsLocked())
  {
    return;
  }
  if(processActivation[process] == val)
    return;
 
  // processActivation keys defined at initialisation
  if(processActivation.find(process) != processActivation.end())
  {
    processActivation[process] = val;
  }
  else
  {
    G4ExceptionDescription ed;
    ed << "Process name " << process << " out of bounds.";
    G4Exception("G4OpticalParameters::SetProcessActivation()", "Optical013",
                FatalException, ed);
  }
}

References FatalException, G4Exception(), IsLocked(), and processActivation.

Referenced by G4OpticalParametersMessenger::SetNewValue().

SetRayleighVerboseLevel()

void G4OpticalParameters::SetRayleighVerboseLevel

(

G4int

val

)

Definition at line 445 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  rayleighVerboseLevel = val;
}

References IsLocked(), and rayleighVerboseLevel.

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4OpRayleigh::SetVerboseLevel().

SetScintByParticleType()

void G4OpticalParameters::SetScintByParticleType

(

G4bool

val

)

Definition at line 266 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  scintByParticleType = val;
}

References IsLocked(), and scintByParticleType.

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4Scintillation::SetScintillationByParticleType().

SetScintEnhancedTimeConstants()

void G4OpticalParameters::SetScintEnhancedTimeConstants

(

G4bool

)

SetScintFiniteRiseTime()

void G4OpticalParameters::SetScintFiniteRiseTime

(

G4bool

val

)

Definition at line 305 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  scintFiniteRiseTime = val;
}

References IsLocked(), and scintFiniteRiseTime.

Referenced by G4Scintillation::SetFiniteRiseTime(), and G4OpticalParametersMessenger::SetNewValue().

SetScintStackPhotons()

void G4OpticalParameters::SetScintStackPhotons

(

G4bool

val

)

Definition at line 319 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  scintStackPhotons = val;
}

References IsLocked(), and scintStackPhotons.

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4Scintillation::SetStackPhotons().

SetScintTrackInfo()

void G4OpticalParameters::SetScintTrackInfo

(

G4bool

val

)

Definition at line 280 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  scintTrackInfo = val;
}

References IsLocked(), and scintTrackInfo.

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4Scintillation::SetScintillationTrackInfo().

SetScintTrackSecondariesFirst()

void G4OpticalParameters::SetScintTrackSecondariesFirst

(

G4bool

val

)

Definition at line 291 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  scintTrackSecondariesFirst = val;
}

References IsLocked(), and scintTrackSecondariesFirst.

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4Scintillation::SetTrackSecondariesFirst().

SetScintVerboseLevel()

void G4OpticalParameters::SetScintVerboseLevel

(

G4int

val

)

Definition at line 333 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  scintVerboseLevel = val;
}

References IsLocked(), and scintVerboseLevel.

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4Scintillation::SetVerboseLevel().

SetVerboseLevel()

void G4OpticalParameters::SetVerboseLevel

(

G4int

val

)

Definition at line 142 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  verboseLevel = val;
  SetCerenkovVerboseLevel(verboseLevel);
  SetScintVerboseLevel(verboseLevel);
  SetRayleighVerboseLevel(verboseLevel);
  SetAbsorptionVerboseLevel(verboseLevel);
  SetMieVerboseLevel(verboseLevel);
  SetBoundaryVerboseLevel(verboseLevel);
  SetWLSVerboseLevel(verboseLevel);
  SetWLS2VerboseLevel(verboseLevel);
}

References IsLocked(), SetAbsorptionVerboseLevel(), SetBoundaryVerboseLevel(), SetCerenkovVerboseLevel(), SetMieVerboseLevel(), SetRayleighVerboseLevel(), SetScintVerboseLevel(), SetWLS2VerboseLevel(), SetWLSVerboseLevel(), and verboseLevel.

Referenced by G4OpticalPhysics::G4OpticalPhysics(), and G4OpticalParametersMessenger::SetNewValue().

SetWLS2TimeProfile()

void G4OpticalParameters::SetWLS2TimeProfile

(

const G4String &

val

)

Definition at line 375 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  wls2TimeProfileName = val;
}

References IsLocked(), and wls2TimeProfileName.

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4OpWLS2::UseTimeProfile().

SetWLS2VerboseLevel()

void G4OpticalParameters::SetWLS2VerboseLevel

(

G4int

val

)

Definition at line 389 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  wls2VerboseLevel = val;
}

References IsLocked(), and wls2VerboseLevel.

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4OpWLS2::SetVerboseLevel().

SetWLSTimeProfile()

void G4OpticalParameters::SetWLSTimeProfile

(

const G4String &

val

)

Definition at line 347 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  wlsTimeProfileName = val;
}

References IsLocked(), and wlsTimeProfileName.

Referenced by G4OpticalParametersMessenger::SetNewValue(), and G4OpWLS::UseTimeProfile().

SetWLSVerboseLevel()

void G4OpticalParameters::SetWLSVerboseLevel

(

G4int

val

)

Definition at line 361 of file G4OpticalParameters.cc.

{
  if(IsLocked())
  {
    return;
  }
  wlsVerboseLevel = val;
}

References IsLocked(), and wlsVerboseLevel.

Referenced by G4OpticalParametersMessenger::SetNewValue(), SetVerboseLevel(), and G4OpWLS::SetVerboseLevel().

StreamInfo()

void G4OpticalParameters::StreamInfo

(

std::ostream &

os

)

const

Definition at line 478 of file G4OpticalParameters.cc.

{
  G4int prec = os.precision(5);
  os
    << "======================================================================="
    << "\n";
  os
    << "======                         Optical Physics Parameters      ========"
    << "\n";
  os
    << "======================================================================="
    << "\n";
 
  os << " Cerenkov process active:               "
     << GetProcessActivation("Cerenkov") << "\n";
  os << " Cerenkov maximum photons per step:     " << cerenkovMaxPhotons
     << "\n";
  os << " Cerenkov maximum beta change per step: " << cerenkovMaxBetaChange
     << " %\n";
  os << " Cerenkov stack photons:                " << cerenkovStackPhotons
     << "\n";
  os << " Cerenkov track secondaries first:      "
     << cerenkovTrackSecondariesFirst << "\n";
  os << " Scintillation process active:          "
     << GetProcessActivation("Scintillation") << "\n";
  os << " Scintillation finite rise time:        " << scintFiniteRiseTime
     << "\n";
  os << " Scintillation by particle type:        " << scintByParticleType
     << "\n";
  os << " Scintillation record track info:       " << scintTrackInfo << "\n";
  os << " Scintillation stack photons:           " << scintStackPhotons << "\n";
  os << " Scintillation track secondaries first: " << scintTrackSecondariesFirst
     << "\n";
  os << " WLS process active:                    "
     << GetProcessActivation("OpWLS") << "\n";
  os << " WLS time profile name:                 " << wlsTimeProfileName
     << "\n";
  os << " WLS2 process active:                   "
     << GetProcessActivation("OpWLS2") << "\n";
  os << " WLS2 time profile name:                " << wls2TimeProfileName
     << "\n";
  os << " Boundary process active:               "
     << GetProcessActivation("OpBoundary") << "\n";
  os << " Boundary invoke sensitive detector:    " << boundaryInvokeSD << "\n";
  os << " Rayleigh process active:               "
     << GetProcessActivation("OpRayleigh") << "\n";
  os << " MieHG process active:                  "
     << GetProcessActivation("OpMieHG") << "\n";
  os << " Absorption process active:             "
     << GetProcessActivation("OpAbsorption") << "\n";
  os
    << "======================================================================="
    << "\n";
  os.precision(prec);
}

References boundaryInvokeSD, cerenkovMaxBetaChange, cerenkovMaxPhotons, cerenkovStackPhotons, cerenkovTrackSecondariesFirst, GetProcessActivation(), CLHEP::prec, scintByParticleType, scintFiniteRiseTime, scintStackPhotons, scintTrackInfo, scintTrackSecondariesFirst, wls2TimeProfileName, and wlsTimeProfileName.

Referenced by Dump().

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const G4OpticalParameters &  par  )

friend

Definition at line 545 of file G4OpticalParameters.cc.

{
  par.StreamInfo(os);
  return os;
}

Field Documentation

absorptionVerboseLevel

G4int G4OpticalParameters::absorptionVerboseLevel

private

Definition at line 236 of file G4OpticalParameters.hh.

Referenced by GetAbsorptionVerboseLevel(), Initialise(), and SetAbsorptionVerboseLevel().

boundaryInvokeSD

G4bool G4OpticalParameters::boundaryInvokeSD

private

boundary G4OpBoundaryProcess to call InvokeSD method

Definition at line 246 of file G4OpticalParameters.hh.

Referenced by GetBoundaryInvokeSD(), Initialise(), SetBoundaryInvokeSD(), and StreamInfo().

boundaryVerboseLevel

G4int G4OpticalParameters::boundaryVerboseLevel

private

Definition at line 247 of file G4OpticalParameters.hh.

Referenced by GetBoundaryVerboseLevel(), Initialise(), and SetBoundaryVerboseLevel().

cerenkovMaxBetaChange

G4double G4OpticalParameters::cerenkovMaxBetaChange

private

Definition at line 203 of file G4OpticalParameters.hh.

Referenced by GetCerenkovMaxBetaChange(), Initialise(), SetCerenkovMaxBetaChange(), and StreamInfo().

cerenkovMaxPhotons

G4int G4OpticalParameters::cerenkovMaxPhotons

private

Definition at line 202 of file G4OpticalParameters.hh.

Referenced by GetCerenkovMaxPhotonsPerStep(), Initialise(), SetCerenkovMaxPhotonsPerStep(), and StreamInfo().

cerenkovStackPhotons

G4bool G4OpticalParameters::cerenkovStackPhotons

private

Definition at line 199 of file G4OpticalParameters.hh.

Referenced by GetCerenkovStackPhotons(), Initialise(), SetCerenkovStackPhotons(), and StreamInfo().

cerenkovTrackSecondariesFirst

G4bool G4OpticalParameters::cerenkovTrackSecondariesFirst

private

Definition at line 200 of file G4OpticalParameters.hh.

Referenced by GetCerenkovTrackSecondariesFirst(), Initialise(), SetCerenkovTrackSecondariesFirst(), and StreamInfo().

cerenkovVerboseLevel

G4int G4OpticalParameters::cerenkovVerboseLevel

private

Definition at line 201 of file G4OpticalParameters.hh.

Referenced by GetCerenkovVerboseLevel(), Initialise(), and SetCerenkovVerboseLevel().

fStateManager

G4StateManager* G4OpticalParameters::fStateManager

private

Definition at line 191 of file G4OpticalParameters.hh.

Referenced by G4OpticalParameters(), and IsLocked().

mieVerboseLevel

G4int G4OpticalParameters::mieVerboseLevel

private

Definition at line 242 of file G4OpticalParameters.hh.

Referenced by GetMieVerboseLevel(), Initialise(), and SetMieVerboseLevel().

processActivation

std::map<G4String, G4bool> G4OpticalParameters::processActivation

private

Definition at line 196 of file G4OpticalParameters.hh.

Referenced by GetProcessActivation(), Initialise(), and SetProcessActivation().

rayleighVerboseLevel

G4int G4OpticalParameters::rayleighVerboseLevel

private

Definition at line 239 of file G4OpticalParameters.hh.

Referenced by GetRayleighVerboseLevel(), Initialise(), and SetRayleighVerboseLevel().

scintByParticleType

G4bool G4OpticalParameters::scintByParticleType

private

option to allow for the light yield to be a function of particle type and deposited energy in case of non-linear light emission in scintillators

Definition at line 215 of file G4OpticalParameters.hh.

Referenced by GetScintByParticleType(), Initialise(), SetScintByParticleType(), and StreamInfo().

scintFiniteRiseTime

G4bool G4OpticalParameters::scintFiniteRiseTime

private

option to set a finite rise-time; Note: the G4Scintillation process expects the user to have set the constant material property SCINTILLATIONRISETIME{1,2,3}

Definition at line 210 of file G4OpticalParameters.hh.

Referenced by GetScintFiniteRiseTime(), Initialise(), SetScintFiniteRiseTime(), and StreamInfo().

scintStackPhotons

G4bool G4OpticalParameters::scintStackPhotons

private

option to allow stacking of secondary Scintillation photons

Definition at line 222 of file G4OpticalParameters.hh.

Referenced by GetScintStackPhotons(), Initialise(), SetScintStackPhotons(), and StreamInfo().

scintTrackInfo

G4bool G4OpticalParameters::scintTrackInfo

private

option to allow for G4ScintillationTrackInformation to be attached to a scintillation photon's track

Definition at line 219 of file G4OpticalParameters.hh.

Referenced by GetScintTrackInfo(), Initialise(), SetScintTrackInfo(), and StreamInfo().

scintTrackSecondariesFirst

G4bool G4OpticalParameters::scintTrackSecondariesFirst

private

Definition at line 225 of file G4OpticalParameters.hh.

Referenced by GetScintTrackSecondariesFirst(), Initialise(), SetScintTrackSecondariesFirst(), and StreamInfo().

scintVerboseLevel

G4int G4OpticalParameters::scintVerboseLevel

private

Definition at line 224 of file G4OpticalParameters.hh.

Referenced by GetScintVerboseLevel(), Initialise(), and SetScintVerboseLevel().

theInstance

G4OpticalParameters * G4OpticalParameters::theInstance = nullptr

staticprivate

Definition at line 188 of file G4OpticalParameters.hh.

Referenced by Instance().

theMessenger

G4OpticalParametersMessenger* G4OpticalParameters::theMessenger

private

Definition at line 190 of file G4OpticalParameters.hh.

Referenced by G4OpticalParameters(), and ~G4OpticalParameters().

verboseLevel

G4int G4OpticalParameters::verboseLevel

private

Definition at line 193 of file G4OpticalParameters.hh.

Referenced by GetVerboseLevel(), Initialise(), and SetVerboseLevel().

wls2TimeProfileName

G4String G4OpticalParameters::wls2TimeProfileName

private

Definition at line 232 of file G4OpticalParameters.hh.

Referenced by GetWLS2TimeProfile(), Initialise(), SetWLS2TimeProfile(), and StreamInfo().

wls2VerboseLevel

G4int G4OpticalParameters::wls2VerboseLevel

private

Definition at line 233 of file G4OpticalParameters.hh.

Referenced by GetWLS2VerboseLevel(), Initialise(), and SetWLS2VerboseLevel().

wlsTimeProfileName

G4String G4OpticalParameters::wlsTimeProfileName

private

Definition at line 228 of file G4OpticalParameters.hh.

Referenced by GetWLSTimeProfile(), Initialise(), SetWLSTimeProfile(), and StreamInfo().

wlsVerboseLevel

G4int G4OpticalParameters::wlsVerboseLevel

private

Definition at line 229 of file G4OpticalParameters.hh.

Referenced by GetWLSVerboseLevel(), Initialise(), and SetWLSVerboseLevel().

---

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

• source/processes/electromagnetic/utils/include/G4OpticalParameters.hh
• source/processes/electromagnetic/utils/src/G4OpticalParameters.cc