Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-04-19 09:09:42

0001 // -*- C++ -*-
0002 ///////////////////////////////////////////////////////////////////////////////
0003 // File: defines.h                                                           //
0004 // Description: header file for generic parameters definitions               //
0005 // This file is part of the SISCone project.                                 //
0006 // For more details, see http://projects.hepforge.org/siscone                //
0007 //                                                                           //
0008 // Copyright (c) 2006 Gavin Salam and Gregory Soyez                          //
0009 //                                                                           //
0010 // This program is free software; you can redistribute it and/or modify      //
0011 // it under the terms of the GNU General Public License as published by      //
0012 // the Free Software Foundation; either version 2 of the License, or         //
0013 // (at your option) any later version.                                       //
0014 //                                                                           //
0015 // This program is distributed in the hope that it will be useful,           //
0016 // but WITHOUT ANY WARRANTY; without even the implied warranty of            //
0017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             //
0018 // GNU General Public License for more details.                              //
0019 //                                                                           //
0020 // You should have received a copy of the GNU General Public License         //
0021 // along with this program; if not, write to the Free Software               //
0022 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA //
0023 //                                                                           //
0024 // $Revision::                                                              $//
0025 // $Date::                                                                  $//
0026 ///////////////////////////////////////////////////////////////////////////////
0027 
0028 //! \file defines.h
0029 #ifndef __DEFINES_H__
0030 #define __DEFINES_H__
0031 
0032 /// program name
0033 // we get "SISCone" by calling
0034 //  siscone::siscone_package_name
0035 // defined in siscone.h
0036 // Otherwise, config.h
0037 // It is also defined as "SISCONE_PACKAGE_NAME" in config.h but this method 
0038 // might lead to conflicts
0039 //#define PROGRAM   SISCONE_PACKAGE_NAME 
0040 
0041 // program version
0042 // we get it from
0043 //   siscone::siscone_version
0044 // defined in siscone.h
0045 // It is also defined as "SISCONE_VERSION" in config.h but this method 
0046 // might lead to conflicts
0047 
0048 /// perform final stability check using the quadtree
0049 /// With the following define enabled, the final check for stability
0050 /// is performed using the quadtree rather than the explicit list of 
0051 /// particles (see Cstable_cone::proceed_with_stability())
0052 //#define USE_QUADTREE_FOR_STABILITY_TEST
0053 
0054 
0055 /// threshold for recomoutation of the cone (see Cstable_cones::update_cone())
0056 /// When traversing cone candidates along the angular ordering,
0057 /// the momentum of the protojet candidate is computed incrementally
0058 /// from the particles that enter and leave the cone.
0059 /// When the cumulative change in "|px|+|py|" exceeds the cone "|px|+|py|"
0060 /// we explicitely recompute the cone contents
0061 #define PT_TSHOLD 1000.0
0062 
0063 
0064 /// The following parameter controls collinear safety. For the set of 
0065 /// particles used in the search of stable cones, we gather particles
0066 /// if their distance in eta and phi is smaller than EPSILON_COLLINEAR.
0067 ///
0068 /// NB: for things to behave sensibly one requires 
0069 ///        1e-15 << EPSILON_COCIRCULAR << EPSILON_COLLINEAR << 1
0070 ///
0071 /// among the scales that appear in practice (e.g. in deciding to use
0072 /// special strategies), we have EPSILON_COLLINEAR, EPSILON_COCIRCULAR,
0073 /// sqrt(EPSILON_COCIRCULAR) and EPSILON_COLLINEAR / EPSILON_COCIRCULAR.
0074 ///
0075 #define EPSILON_COLLINEAR 1e-8
0076 
0077 
0078 /// The following parameter controls cocircular situations.
0079 /// When consecutive particles in the ordered vicinity list are separated
0080 /// (in angle) by less that that limit, we consider that we face a situation
0081 /// of cocircularity.
0082 #define EPSILON_COCIRCULAR 1e-12
0083 
0084 
0085 /// The following define enables you to allow for identical protocones
0086 /// to be merged automatically after each split-merge step before
0087 /// anything else happens. Whether this happens depends on teh value
0088 /// of the merge_identical_protocones flag in Csplit_merge.
0089 ///
0090 /// It we allow such a merging and define allow 
0091 /// MERGE_IDENTICAL_PROTOCONES_DEFAULT_TRUE then the
0092 /// 'merge_identical_protocones' flag in Csplit_merge to be set to
0093 /// 'true'. It may be manually reset to false in which case the
0094 /// merging of identical protocones (protojets) will be turned off.
0095 ///
0096 /// Note that this merging identical protocones makes the algorithm
0097 /// infrared-unsafe, so it should be disabled except for testing
0098 /// purposes.
0099 //#define ALLOW_MERGE_IDENTICAL_PROTOCONES
0100 //#define MERGE_IDENTICAL_PROTOCONES_DEFAULT_TRUE
0101 
0102 
0103 /// if EPSILON_SPLITMERGE is defined then, during the split-merge
0104 /// step, when two jets are found with PTs that are identical to
0105 /// within a relative difference of EPSILON_SPLITMERGE they are
0106 /// compared element-by-element to see where the differences are, and
0107 /// one then uses pt1^2-pt2^2 = (pt1-pt2).(pt1+pt2) as an estimator of
0108 /// which is harder. NB: in unfortunate cases, this can take the split
0109 /// merge step up to N n * ln N time, though on normal events there
0110 /// don't seem to have been any major problems yet.
0111 #define EPSILON_SPLITMERGE 1e-12
0112 
0113 /// definition of 2*M_PI which is useful a bit everyhere!
0114 const double twopi = 6.283185307179586476925286766559005768394;
0115 
0116 /// debugging information
0117 //#define DEBUG_STABLE_CONES   ///< debug messages in stable cones search
0118 //#define DEBUG_SPLIT_MERGE    ///< debug messages in split-merge
0119 //#define DEBUG                ///< all debug messages !
0120 
0121 // in case all debug massages allowed, allow them in practice !
0122 #ifdef DEBUG
0123 #define DEBUG_STABLE_CONES
0124 #define DEBUG_SPLIT_MERGE
0125 #endif
0126 
0127 #endif  //  __DEFINES_H__
0128