ttj_MiNNLO.py

Go to the documentation of this file.

# Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
 
from ... import Logging
from ..powheg_V2 import PowhegV2
from ..external import ExternalMadSpin
import os
import glob
 

logger = Logging.logging.getLogger("PowhegControl")
 
 
# Dictionary to convert the PowhegControl decay mode names to the appropriate
# decay mode numbers understood by Powheg
#
# The PowhegControl decay modes with MadSpin in their name use MadSpin to
# generate the top decays, the others use Powheg
_decay_mode_lookup = {
    "t t~ > all [MadSpin]" : "00000", # switch off decays in Powheg and let MadSpin handle them!
    "t t~ > all": "22222",
    "t t~ > b j j b~ j j": "00022",
    "t t~ > b l+ vl b~ l- vl~": "22200",
    "t t~ > b emu+ vemu b~ emu- vemu~": "22000",
    "t t~ > semileptonic": "11111",
    "t t~ > undecayed" : "00000",
}
 
 
class ttj_MiNNLO(PowhegV2):
    """! Default Powheg configuration for top pair production plus one jet with MiNNLO.
 
    Create a configurable object with all applicable Powheg options.
 
    @author Timothee Theveneaux-Pelzer  <tpelzer@cern.ch>
    """
 
    def __init__(self, base_directory, **kwargs):
        """! Constructor: all process options are set here.
 
        @param base_directory: path to PowhegBox code.
        @param kwargs          dictionary of arguments from Generate_tf.
        """
        
        # this is very hacky - needed to handle problems with error handling in some fortran codes
        errors = super(ttj_MiNNLO, self).openloops_error()
        # list of message patterns to be treated as warnings
        warnings = ["WARNING in get_lnlnQ_wgts"]
        warnings += super(ttj_MiNNLO, self).hoppet_warning()
        infos = super(ttj_MiNNLO, self).hoppet_info()
        
        super(ttj_MiNNLO, self).__init__(base_directory, "ttJ_MiNNLO", warning_output=warnings, info_output=infos, error_output=errors, **kwargs)
 
        # defining ttjMiNNLOPATH environment variable to bypass file path problems in fortran code
        # this is definitly a hack, see discussion in AGENE-2055
        os.environ['ttjMiNNLOPATH'] = os.path.dirname(os.path.dirname(self.executable))
        logger.info("ttjMiNNLOPATH defined as = {0}".format(os.getenv('ttjMiNNLOPATH')))
 
        # Add algorithms to the sequence
        self.add_algorithm(ExternalMadSpin(process="generate p p > t t~ j [QCD]"))
 
        # Add parameter validation functions
        self.validation_functions.append("validate_decays")
 
        
        self.allowed_decay_modes = sorted(_decay_mode_lookup.keys())
 
        # Add all keywords for this process, overriding defaults if required
        self.add_keyword("alphaem")
        self.add_keyword("alphas_from_pdf", 1) # if 1, uses alphas from PDF evolution tool (e.g. lhapdf or hoppet)
        self.add_keyword("bcut")
        self.add_keyword("bornktmin", 0.6) # 0.6 from powheg.input example for this process (default is 0.)
        self.add_keyword("bornonly")
        self.add_keyword("bornsuppfact", -1)
        self.add_keyword("bornzerodamp")
        self.add_keyword("bottommass",0)
        self.add_keyword("bottomthr")
        self.add_keyword("bottomthrpdf")
        self.add_keyword("charmthr")
        self.add_keyword("charmthrpdf")
        self.add_keyword("check_bad_st1")
        self.add_keyword("check_bad_st2")
        self.add_keyword("CKM_Vcb")
        self.add_keyword("CKM_Vcd")
        self.add_keyword("CKM_Vcs")
        self.add_keyword("CKM_Vtb")
        self.add_keyword("CKM_Vtd")
        self.add_keyword("CKM_Vts")
        self.add_keyword("CKM_Vub")
        self.add_keyword("CKM_Vud")
        self.add_keyword("CKM_Vus")
        self.add_keyword("clobberlhe")
        self.add_keyword('collremnsamp"')
        self.add_keyword("colltest")
        self.add_keyword("compute_rwgt")
        self.add_keyword("doublefsr")
        self.add_keyword("elbranching")
        self.add_keyword("facscfact", self.default_scales[0])
        self.add_keyword("fastbtlbound")
        self.add_keyword("fixedscale", 0) # keep to zero to use dynamical scale for overall two powers of alphas
        self.add_keyword("ffltest")
        self.add_keyword("flg_debug")
        self.add_keyword("foldcsi", 2)
        self.add_keyword("foldphi", 2)
        self.add_keyword("foldy", 2)
        self.add_keyword("fullrwgt")
        self.add_keyword("fullrwgtmode")
        self.add_keyword("ggproc")
        self.add_keyword("gqbproc")
        self.add_keyword("hdamp")
        self.add_keyword("hfact")
        self.add_keyword("icsimax", 3)
        self.add_keyword("ih1")
        self.add_keyword("ih2")
        self.add_keyword("itmx1")
        self.add_keyword("itmx2", 4)
        self.add_keyword("iupperfsr")
        self.add_keyword("iupperisr")
        self.add_keyword("iymax", 3)
        self.add_keyword("jacsing")
        self.add_keyword("kappaQ", 0.5) # should be set =< 0.5d0 for ttbar)
        self.add_keyword("largecorrfact")
        self.add_keyword("largeptscales", 0) # [ 0 - m_tt (invariant mass of top-quark pair) 1 - pT_tt (transverse momentum of top-quark pair)  2 - H_T^tt (sum of transverse masses of the top quarks)]
        self.add_keyword("lhans1", self.default_PDFs)
        self.add_keyword("lhans2", self.default_PDFs)
        self.add_keyword("lhfm/bmass")
        self.add_keyword("lhfm/cmass")
        self.add_keyword("lhfm/emass")
        self.add_keyword("lhfm/mumass")
        self.add_keyword("lhfm/taumass")
        self.add_keyword("manyseeds")
        self.add_keyword("masswindow_high")
        self.add_keyword("masswindow_low")
        self.add_keyword("minlo", 1)
        self.add_keyword("minnlo", 1)
        self.add_keyword("modlog_p", -1)
        self.add_keyword("ncall1", 10000000)
        self.add_keyword("ncall1rm")
        self.add_keyword("ncall2", 20000000)
        self.add_keyword("ncall2rm")
        self.add_keyword("nubound", 5000000)
        self.add_keyword("bwcutoff",50)
        self.add_keyword("par_2gsupp")
        self.add_keyword("par_diexp")
        self.add_keyword("par_dijexp")
        self.add_keyword("par_fsrtinycsi")
        self.add_keyword("par_fsrtinyy")
        self.add_keyword("par_isrtinycsi")
        self.add_keyword("par_isrtinyy")
        self.add_keyword("parallelstage")
        self.add_keyword("pdfreweight")
        self.add_keyword("psgen")
        self.add_keyword("ptmin_jet", 20.0)
        self.add_keyword("ptsqmin")
        self.add_keyword("ptsupp")
        self.add_keyword("qgproc")
        self.add_keyword("qqbproc")
        self.add_keyword("qqpproc")
        self.add_keyword("qqproc")
        self.add_keyword("Q0", 2.0)
        self.add_keyword("R_jet")
        self.add_keyword("radregion")
        self.add_keyword("rand1")
        self.add_keyword("rand2")
        self.add_keyword("renscfact", self.default_scales[1])
        self.add_keyword("runningscale")
        self.add_keyword("rwl_add")
        self.add_keyword("rwl_file")
        self.add_keyword("rwl_format_rwgt")
        self.add_keyword("rwl_group_events")
        self.add_keyword("semileptonic", hidden=True)
        self.add_keyword("smartsig")
        self.add_keyword("softtest")
        self.add_keyword("sthw2")
        self.add_keyword("storeinfo_rwgt")
        self.add_keyword("testplots")
        self.add_keyword("testsuda")
        self.add_keyword("topdecaymode", self.allowed_decay_modes[1], name="decay_mode") # default decay is inclusive, by Powheg
        self.add_keyword("topmass")
        self.add_keyword("topwidth")
        self.add_keyword("ubsigmadetails")
        self.add_keyword("use-old-grid")
        self.add_keyword("use-old-ubound")
        self.add_keyword("use_OLP_Interface",1)
        self.add_keyword("whichscale", 4) # set scale of overall two powers of alphas if fixedscale=0
        self.add_keyword("withdamp",0)
        self.add_keyword("withnegweights")
        self.add_keyword("withsubtr")
        self.add_keyword("Wmass")
        self.add_keyword("Wwidth")
        self.add_keyword("xupbound", 6)
        self.add_keyword("zerowidth")
        self.add_keyword("Zmass")
        self.add_keyword("Zwidth")
 
    def validate_decays(self):
        """! Validate semileptonic and topdecaymode keywords."""
        self.expose()  # convenience call to simplify syntax
        if self.decay_mode not in self.allowed_decay_modes:
            error_message = "Decay mode '{given}' not recognised, valid choices are: '{choices}'!".format(given=self.decay_mode, choices="', '".join(self.allowed_decay_modes))
            logger.warning(error_message)
            raise ValueError(error_message)
 
        # Check if MadSpin decays are requested.
        # Accordingly, MadSpin will run or not run.
        if "MadSpin" in self.decay_mode:
            self.externals["MadSpin"].parameters_by_keyword("powheg_top_decays_enabled")[0].value = False
            self.externals["MadSpin"].parameters_by_keyword("MadSpin_nFlavours")[0].value = 5
 
        # Calculate appropriate decay mode numbers
        self.parameters_by_keyword("topdecaymode")[0].value = _decay_mode_lookup[self.decay_mode]
        if self.decay_mode == "t t~ > semileptonic":
            # Parameter semileptonic must be set to 1 to actually get semileptonic decays, because the topdecaymode=11111 also allows fully hadronic decays (with one up and one charm quark)
            self.parameters_by_keyword("semileptonic")[0].value = 1
 
    def stage_is_completed(self, stage):
        """! Specialised version for this process, which has different grids file patterns than other V2 processes."""
        if stage == 1:
            required_files = ["pwg*xg*.dat"]
        elif stage == 2:
            required_files = ["pwg-????-stat.dat", "pwg-st2-????-stat.dat", "pwggrid*.dat"]
        elif stage == 3:
            required_files = ["pwg-st3-????-stat.dat", "pwgubound*.dat"]
        else:
            return False
 
        # Check that required files have been found
        for required_file in required_files:
            if not glob.glob(required_file):
                return False
        return True