Helpers.py

Go to the documentation of this file.

#!/usr/bin/env python

import GaudiKernel.SystemOfUnits as units
from GenTools.GenToolsConf import GtPositionerTool
from GenTools.GenToolsConf import GtTransformTool
from GenDecay.GenDecayConf import GtDecayerator

class Decay:

    '''
    A GenTools "helper" module to configure for a radioactive decay
    chain.  
    '''

    
    def __init__(self,
                 name = 'decay',
                 volume = '/dd/Structure/AD/far-oil1',
                 decay = None,
                 positioner = None,
                 transformer = None
                 ):
        '''
        Construct a Decay helper.

        First argument is the name of this Decay and must be specified for mutiple particle event simulation.

        Coustom configured tools can
         can be done after construction
        using the data members:

        .decay
        .positioner
        .transformer
        
        The GtGenerator alg is available from the .generatorAlg member.

        They can be accessed for additional, direct configuration.

        If the Volume property for the positioner and transformer is
        not yet set, it will be set to the value of "volume"

        '''
        
        if decay == None:
            self.decay = GtDecayerator(name,
                                       ParentNuclide = "U238",
                                       ParentAbundance = 5e16, 
                                       SecularEquilibrium = True,
                                       CorrelationTime = 1*units.second)
            #self.decay.OutputLevel = 2
                  
        if positioner == None:
            positioner = GtPositionerTool(name+"Positioner",
                                         Strategy = 'FullVolume',
                                         Mode = 'Uniform')

        positioner.Volume = volume
        
        if transformer == None:
            transformer = GtTransformTool(name+"Transformer")

        transformer.Volume = volume 

        self.positioner = positioner
        self.transformer = transformer

        return

    def setVolume(self,volumename):
        self.positioner.Volume = volumename
        self.transformer.Volume = volumename
        return

    def tools(self):
        return [self.decay,self.positioner,self.transformer]

    pass # end Decay


def configure(argv=[]):
    '''
    Configure for use as a Job Option Module
    '''

    from optparse import OptionParser

    nuclide='U-238'

    parser = OptionParser(usage=configure.__doc__)
    parser.add_option('-n','--nuclide',default='U-238',type='string',
                      help='Set name of nuclide (def: "U-238")')
    parser.add_option('-t','--correlation-time',default=1,
                      type='float',
                      help='Decay correlation time in seconds (def: 1)')
    parser.add_option('-a','--abundance',default=5.0e16, type='float',
                      help='Abundance = concentration*grams*N_a/A (def=5.0e16)')
    parser.add_option('-e','--secular-equilibrium',default=True,
                      help='Assume secular equilibrium for uncorrelated decays (def=True)')

    parser.disable_interspersed_args()
    opts,args = parser.parse_args(args=argv)
    opts.correlation_time *= units.second

    import GenTools
    helper = Decay()
    helper.decay.CorrelationTime = opts.correlation_time
    helper.decay.ParentNuclide = opts.nuclide
    helper.decay.ParentAbundance = opts.abundance
    helper.decay.SecularEquilibrium = opts.secular_equilibrium
    #helper.OutputLevel = 2
    gtc = GenTools.Configure(genname="GenDecay",helper=helper)

    #GenTools.Dumper()

    return