python.G4Optimizations Namespace Reference

Functions
def	enableFrozenShowersFCalOnly (flags)
def	disableFrozenShowersFCalOnly (flags)
def	enableBeamPipeKill (flags)
def	disableBeamPipeKill (flags)
def	enableTightMuonStepping (flags)
def	disableTightMuonStepping (flags)
def	enableMuonFieldOnlyInCalo (flags)
def	disableMuonFieldOnlyInCalo (flags)
def	enablePhotonRussianRoulette (flags)
def	disablePhotonRussianRoulette (flags)
def	enableNeutronRussianRoulette (flags)
def	disableNeutronRussianRoulette (flags)
def	enableEMRangeCuts (flags)
def	disableEMRangeCuts (flags)
def	enableG4GammaGeneralProcess (flags)
def	disableG4GammaGeneralProcess (flags)
def	enableWoodcockTracking (flags)
def	disableWoodcockTracking (flags)
def	enableG4Optimizations (flags)
def	disableG4Optimizations (flags)
def	WoodcockTrackingInEMEC (flags)
def	WoodcockTrackingInEMECPara (flags)
def	PostIncludeTweakPhysicsRegionsCfg (flags, cfg)

Function Documentation

disableBeamPipeKill()

def python.G4Optimizations.disableBeamPipeKill

(

flags

)

Definition at line 21 of file G4Optimizations.py.

def disableBeamPipeKill(flags):
    flags.Sim.BeamPipeCut = 100.0
    flags.Sim.BeamPipeSimMode = BeamPipeSimMode.Normal
 
 

disableEMRangeCuts()

def python.G4Optimizations.disableEMRangeCuts

(

flags

)

Definition at line 71 of file G4Optimizations.py.

def disableEMRangeCuts(flags):
    commands = flags.Sim.G4Commands
    commands.remove("/process/em/applyCuts true")
    flags.Sim.G4Commands = commands
 
 

disableFrozenShowersFCalOnly()

def python.G4Optimizations.disableFrozenShowersFCalOnly

(

flags

)

Turns off GFlash shower parametrization for FCAL

Definition at line 11 of file G4Optimizations.py.

def disableFrozenShowersFCalOnly(flags):
    """Turns off GFlash shower parametrization for FCAL"""
    flags.Sim.LArParameterization = LArParameterization.NoFrozenShowers
 
 

disableG4GammaGeneralProcess()

def python.G4Optimizations.disableG4GammaGeneralProcess

(

flags

)

Disables G4GammaGeneralProcess AND Woodcock tracking

Definition at line 83 of file G4Optimizations.py.

def disableG4GammaGeneralProcess(flags):
    """Disables G4GammaGeneralProcess AND Woodcock tracking"""
    commands = flags.Sim.G4Commands
    commands.remove("/process/em/UseGeneralProcess true")
    commands.remove("/process/em/useWoodcockTracking EMEC") # Woodcock tracking requires G4GammaGeneralProcess
    flags.Sim.G4Commands = commands
    optionalUserActions = flags.Sim.OptionalUserActionList
    optionalUserActions.remove("G4UserActions.G4UserActionsConfig.FixG4CreatorProcessToolCfg")
    flags.Sim.OptionalUserActionList = optionalUserActions
 
 

disableG4Optimizations()

def python.G4Optimizations.disableG4Optimizations

(

flags

)

Ensure all G4Optimizations are disabled - useful for debugging 

Definition at line 157 of file G4Optimizations.py.

def disableG4Optimizations(flags):
    """ Ensure all G4Optimizations are disabled - useful for debugging """
    disableMuonFieldOnlyInCalo(flags)
    disablePhotonRussianRoulette(flags)
    disableNeutronRussianRoulette(flags)
    disableEMRangeCuts(flags)
    disableG4GammaGeneralProcess(flags)
    disableWoodcockTracking(flags)
    disableBeamPipeKill(flags)
    disableFrozenShowersFCalOnly(flags)
 
 

disableMuonFieldOnlyInCalo()

def python.G4Optimizations.disableMuonFieldOnlyInCalo

(

flags

)

Definition at line 39 of file G4Optimizations.py.

def disableMuonFieldOnlyInCalo(flags):
    flags.Sim.MuonFieldOnlyInCalo = False
 
 

disableNeutronRussianRoulette()

def python.G4Optimizations.disableNeutronRussianRoulette

(

flags

)

Definition at line 61 of file G4Optimizations.py.

def disableNeutronRussianRoulette(flags):
    flags.Sim.NRRThreshold = False
    flags.Sim.NRRWeight = False
 
 

disablePhotonRussianRoulette()

def python.G4Optimizations.disablePhotonRussianRoulette

(

flags

)

Definition at line 49 of file G4Optimizations.py.

def disablePhotonRussianRoulette(flags):
    flags.Sim.PRRThreshold = False
    flags.Sim.PRRWeight = False
 
 

disableTightMuonStepping()

def python.G4Optimizations.disableTightMuonStepping

(

flags

)

Definition at line 30 of file G4Optimizations.py.

def disableTightMuonStepping(flags):
    flags.Sim.TightMuonStepping = False
 
 

disableWoodcockTracking()

def python.G4Optimizations.disableWoodcockTracking

(

flags

)

Definition at line 104 of file G4Optimizations.py.

def disableWoodcockTracking(flags):
    commands = flags.Sim.G4Commands
    commands.remove("/process/em/useWoodcockTracking EMEC")
    flags.Sim.G4Commands = commands
    if "/process/em/UseGeneralProcess true" not in flags.Sim.G4Commands:
        optionalUserActions = flags.Sim.OptionalUserActionList
        optionalUserActions.remove("G4UserActions.G4UserActionsConfig.FixG4CreatorProcessToolCfg")
        flags.Sim.OptionalUserActionList = optionalUserActions
 
 

enableBeamPipeKill()

def python.G4Optimizations.enableBeamPipeKill

(

flags

)

Definition at line 16 of file G4Optimizations.py.

def enableBeamPipeKill(flags):
    flags.Sim.BeamPipeCut = 0.
    flags.Sim.BeamPipeSimMode = BeamPipeSimMode.FastSim
 
 

enableEMRangeCuts()

def python.G4Optimizations.enableEMRangeCuts

(

flags

)

Turn on range cuts for gamma processes (conv, phot, compt)

Definition at line 66 of file G4Optimizations.py.

def enableEMRangeCuts(flags):
    """Turn on range cuts for gamma processes (conv, phot, compt)"""
    flags.Sim.G4Commands += ['/process/em/applyCuts true']
 
 

enableFrozenShowersFCalOnly()

def python.G4Optimizations.enableFrozenShowersFCalOnly

(

flags

)

Turns on GFlash shower parametrization for FCAL

Definition at line 5 of file G4Optimizations.py.

def enableFrozenShowersFCalOnly(flags):
    """Turns on GFlash shower parametrization for FCAL"""
    flags.Sim.LArParameterization = LArParameterization.FrozenShowersFCalOnly
    flags.Sim.CalibrationRun = CalibrationRun.Off
 
 

enableG4GammaGeneralProcess()

def python.G4Optimizations.enableG4GammaGeneralProcess

(

flags

)

Activate the G4GammaGeneralProcess and the UserAction required

Definition at line 77 of file G4Optimizations.py.

def enableG4GammaGeneralProcess(flags):
    """Activate the G4GammaGeneralProcess and the UserAction required"""
    flags.Sim.G4Commands+=["/process/em/UseGeneralProcess true"]
    flags.Sim.OptionalUserActionList += ['G4UserActions.G4UserActionsConfig.FixG4CreatorProcessToolCfg']
 
 

enableG4Optimizations()

def python.G4Optimizations.enableG4Optimizations

(

flags

)

Enable G4 optimizations

Definition at line 114 of file G4Optimizations.py.

def enableG4Optimizations(flags):
    """Enable G4 optimizations"""
 
    # Activate magnetic field switch off in central LAr calorimeter
    #  More info: https://its.cern.ch/jira/browse/ATLPHYSVAL-773
    enableMuonFieldOnlyInCalo(flags)
 
    # Photon Russian Roulette
    # "Fast simulation" killing low energy photons with some probability.
    #  More info: https://its.cern.ch/jira/browse/ATLASSIM-4096
    enablePhotonRussianRoulette(flags)
 
    # Neutron Russian Roulette
    # "Fast simulation" killing low energy neutrons with some probability.
    #  More info: its.cern.ch/jira/browse/ATLASSIM-3924
    enableNeutronRussianRoulette(flags)
 
    # EM Range Cuts
    # Turn on range cuts for gamma processes (conv, phot, compt)
    # More info: https://its.cern.ch/jira/browse/ATLASSIM-3956
    enableEMRangeCuts(flags)
 
    # G4GammaGeneralProcess
    # Activate the G4GammaGeneralProcess and the UserAction required
    # to fix the creator process of secondary tracks.
    enableG4GammaGeneralProcess(flags)
 
    # Energy Loss fluctuation OFF
    # Switch off the Energy loss fluctuation process
    # More info: https://its.cern.ch/jira/browse/ATLASSIM-6995
    # Main physics validation: https://its.cern.ch/jira/browse/ATLPHYSVAL-1009
    # Follow-up validation for Muons:  https://its.cern.ch/jira/browse/ATLPHYSVAL-1022
    # Follow-up validation for Egamma: https://its.cern.ch/jira/browse/ATLPHYSVAL-1030
    # This optimization is on hold for mc23e - for discrepancies seen in the
    # follow-up validations by EgammaCP group.
    # It will be evaluated for future campaigns.
    # flags.Sim.G4Commands+=["/process/eLoss/fluct false"]
 
    # Activate the Woodcock Tracking in the EMEC
    # More info: https://its.cern.ch/jira/browse/ATLASSIM-5079
    enableWoodcockTracking(flags)
 
 

enableMuonFieldOnlyInCalo()

def python.G4Optimizations.enableMuonFieldOnlyInCalo

(

flags

)

Activate magnetic field switch off in central LAr calorimeter

Definition at line 34 of file G4Optimizations.py.

def enableMuonFieldOnlyInCalo(flags):
    """Activate magnetic field switch off in central LAr calorimeter"""
    flags.Sim.MuonFieldOnlyInCalo = True
 
 

enableNeutronRussianRoulette()

def python.G4Optimizations.enableNeutronRussianRoulette

(

flags

)

Activate Neutron Russian Roulette: Fast simulation" killing low energy neutrons with some probability.

Definition at line 54 of file G4Optimizations.py.

def enableNeutronRussianRoulette(flags):
    """Activate Neutron Russian Roulette: Fast simulation" killing low energy neutrons with some probability."""
    flags.Sim.NRRThreshold = 2.  # MeV
    flags.Sim.NRRWeight = 10.
    flags.Sim.CalibrationRun = CalibrationRun.Off
 
 

enablePhotonRussianRoulette()

def python.G4Optimizations.enablePhotonRussianRoulette

(

flags

)

Activate Photon Russian Roulette: Fast simulation" killing low energy photons with some probability.

Definition at line 43 of file G4Optimizations.py.

def enablePhotonRussianRoulette(flags):
    """Activate Photon Russian Roulette: Fast simulation" killing low energy photons with some probability."""
    flags.Sim.PRRThreshold = 0.5  # MeV
    flags.Sim.PRRWeight = 10.
 
 

enableTightMuonStepping()

def python.G4Optimizations.enableTightMuonStepping

(

flags

)

Definition at line 26 of file G4Optimizations.py.

def enableTightMuonStepping(flags):
    flags.Sim.TightMuonStepping = True
 
 

enableWoodcockTracking()

def python.G4Optimizations.enableWoodcockTracking

(

flags

)

Activate the Woodcock Tracking in the EMEC

Definition at line 94 of file G4Optimizations.py.

def enableWoodcockTracking(flags):
    """Activate the Woodcock Tracking in the EMEC"""
    flags.Sim.G4Commands += ['/process/em/useWoodcockTracking EMEC']
    # Please note that the Woodcock tracking enables the
    # G4GammaGeneralProcess therefore the FixG4CreatorProcessTool must
    # be added if it's not done before
    if "G4UserActions.G4UserActionsConfig.FixG4CreatorProcessToolCfg" not in flags.Sim.OptionalUserActionList:
        flags.Sim.OptionalUserActionList += ['G4UserActions.G4UserActionsConfig.FixG4CreatorProcessToolCfg']
 
 

PostIncludeTweakPhysicsRegionsCfg()

def python.G4Optimizations.PostIncludeTweakPhysicsRegionsCfg	(		flags,
			cfg
	)

Definition at line 187 of file G4Optimizations.py.

def PostIncludeTweakPhysicsRegionsCfg(flags, cfg):
    # This postInclude drops BeamPipe::SectionF198 and
    # BeamPipe::SectionF199 from the DeadMaterial G4Region, to avoid a
    # clash with the BeampipeFwdCut G4Region.
    from AthenaConfiguration.ComponentAccumulator import ConfigurationError
    detConTool = None
    try:
        detConTool = cfg.getPublicTool('G4AtlasDetectorConstructionTool')
    except ConfigurationError:
        pass
    if detConTool is None:
        return
    detConTool.RegionCreators['DeadMaterialPhysicsRegionTool'].VolumeList.remove('BeamPipe::SectionF198')
    detConTool.RegionCreators['DeadMaterialPhysicsRegionTool'].VolumeList.remove('BeamPipe::SectionF199')

WoodcockTrackingInEMEC()

def python.G4Optimizations.WoodcockTrackingInEMEC

(

flags

)

Definition at line 169 of file G4Optimizations.py.

def WoodcockTrackingInEMEC(flags):
    # Use Woodcock Tracking in the EMEC rather than the EMECPara
    # G4Region. This preInclude should be added at the end of the list
    # of preIncludes.
    commands = flags.Sim.G4Commands
    commands.remove("/process/em/useWoodcockTracking EMECPara")
    flags.Sim.G4Commands = commands + ["/process/em/useWoodcockTracking EMEC"]
 
 

WoodcockTrackingInEMECPara()

def python.G4Optimizations.WoodcockTrackingInEMECPara

(

flags

)

Definition at line 178 of file G4Optimizations.py.

def WoodcockTrackingInEMECPara(flags):
    # Use Woodcock Tracking in the EMECPara rather than the EMEC
    # G4Region. This preInclude should be added at the end of the list
    # of preIncludes.
    commands = flags.Sim.G4Commands
    commands.remove("/process/em/useWoodcockTracking EMEC")
    flags.Sim.G4Commands = commands + ["/process/em/useWoodcockTracking EMECPara"]