BDM Resonant Scattering

README.md

@@ -1,21 +1,20 @@
 # The GENIE Event Generator
 
-
 <table style="border-collapse: collapse; border: none;">
   <tr>
     <td style="border: none; padding-right: 12px; vertical-align: top;">
       <img src="./data/logo/genie_logo.png" alt="GENIE logo" width="300px">
     </td>
     <td style="border: none; padding: 0;">
       <p>
-        The GENIE Generator is a <b>leading simulation tool used by nearly all modern neutrino experiments</b>. 
-        It features a <b>modular framework</b> with <b>state-of-the-art physics</b> for neutrino and charged-lepton interactions, 
-        and several BSM channels. It incorporates results from GENIE’s global data analysis and includes multiple tuned models. 
-        GENIE supports all neutrino types, targets, and energy scales from MeV to PeV, 
+        The GENIE Generator is a <b>leading simulation tool used by nearly all modern neutrino experiments</b>.
+        It features a <b>modular framework</b> with <b>state-of-the-art physics</b> for neutrino and charged-lepton interactions,
+        and several BSM channels. It incorporates results from GENIE’s global data analysis and includes multiple tuned models.
+        GENIE supports all neutrino types, targets, and energy scales from MeV to PeV,
         and provides tools for flux handling, geometry, event generation, and reweighting.
       </p>
       <p>
-        For more information, visit 
+        For more information, visit
         <a href="http://www.genie-mc.org" target="_blank">http://genie-mc.org</a> |
         <a href="https://genie-mc.github.io" target="_blank">https://genie-mc.github.io</a>.
       </p>
@@ -27,7 +26,7 @@
 
 Luis Alvarez-Ruso (*IFIC*), Costas Andreopoulos (*Liverpool*), Adi Ashkenazi (*Tel Aviv*), Joshua Barrow (*Minnesota*), Steve Dytman (*Pittsburgh*), Hugh Gallagher (*Tufts*), Alfonso Andres Garcia Soto (*IFIC*), Steven Gardiner (*Fermilab*), Matan Goldenberg (*Tel Aviv*), Robert Hatcher (*Fermilab*), Or Hen (*MIT*), Igor Kakorin (*JINR*), Konstantin Kuzmin (*ITEP and JINR*), Liang Liu (*Fermilab*), Xianguo Lu (*Warwick*), Anselmo Meregaglia (*Bordeaux, CNRS/IN2P3*), Vadim Naumov (*JINR*), Afroditi Papadopoulou (*Argonne*), Gabriel Perdue (*Fermilab*), Komninos-John Plows (*Oxford*), Marco Roda (*Liverpool*), Alon Sportes (*Tel Aviv*), Júlia Tena Vidal (*Tel Aviv*), Jeremy Wolcott (*Tufts*), Qiyu Yan (*UCAS and Warwick*)
 
-**Past authors:** Christopher Barry (*Liverpool*), Steve Dennis (*Liverpool*), Walter Giele (*Fermilab*), Timothy Hobbs (*Fermilab*), Libo Jiang (*Pittsburgh*), Rhiannon Jones (*Liverpool*), Weijun Li (*Oxford*), Donna Naples (*Pittsburgh*), Beth Slater (*Liverpool*), Noah Steinberg (*Fermilab*), Vladyslav Syrotenko (*Tufts*), Julia Yarba (*Fermilab*) 
+**Past authors:** Christopher Barry (*Liverpool*), Steve Dennis (*Liverpool*), Walter Giele (*Fermilab*), Timothy Hobbs (*Fermilab*), Libo Jiang (*Pittsburgh*), Rhiannon Jones (*Liverpool*), Weijun Li (*Oxford*), Donna Naples (*Pittsburgh*), Beth Slater (*Liverpool*), Noah Steinberg (*Fermilab*), Vladyslav Syrotenko (*Tufts*), Julia Yarba (*Fermilab*)
 
 For more details on the GENIE collaboration please visit [this page](https://genie-mc.github.io/collaboration.html).
 
@@ -54,7 +53,7 @@ DOIs for recent releases of the GENIE Event Generator are listed below:
 
 ## Physics & User manual
 
-For installation and usage information, as well as information on the GENIE framework, event generator modules and tuning, 
+For installation and usage information, as well as information on the GENIE framework, event generator modules and tuning,
 see the [latest version of the GENIE Physics & User Manual](https://www.overleaf.com/read/rqmbqzzvsvmb#5ab475), originally published as arXiv:1510.05494.
 
 ## Public releases and physics tunes
@@ -63,7 +62,7 @@ For a list of public releases and a summary information, see [this page](https:/
 A list of model configurations and tunes supported in each release is maintained [here](https://genie-mc.github.io/tunes.html).
 Details on the naming conventions for releases, model configurations and tunes can be found [here](https://genie-mc.github.io/naming_conventions.html).
 
-[Recent publications and talks](https://genie-mc.github.io/pub.html) 
+[Recent publications and talks](https://genie-mc.github.io/pub.html)
 by GENIE authors highlight key modeling advances and results from our global analysis of scattering data.
 
 ## Contribution guidelines

config/CommonParam.xml

@@ -276,18 +276,21 @@ Or changing the name of this parameter set
         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
         Set the coupling of dark matter to nucleons
     -->
-    <param type="double" name="ZpCoupling"> 0.1 </param>
+
+    <param type="double" name="ZpCoupling"> 1.0 </param>
     <param type="double" name="DarkLeftCharge"> 1.0 </param>
-    <param type="double" name="DarkRightCharge"> 1.0 </param>
+    <param type="double" name="DarkRightCharge"> -1.0 </param>
     <param type="double" name="DarkScalarCharge"> 1.0 </param>
+
     <param type="double" name="UpLeftCharge"> 1.0 </param>
-    <param type="double" name="UpRightCharge"> 1.0 </param>
+    <param type="double" name="UpRightCharge"> -1.0 </param>
     <param type="double" name="DownLeftCharge"> 1.0 </param>
-    <param type="double" name="DownRightCharge"> 1.0 </param>
+    <param type="double" name="DownRightCharge"> -1.0 </param>
     <param type="double" name="StrangeLeftCharge"> 1.0 </param>
-    <param type="double" name="StrangeRightCharge"> 1.0 </param>
+    <param type="double" name="StrangeRightCharge"> -1.0 </param>
     <param type="double" name="CharmLeftCharge"> 1.0 </param>
-    <param type="double" name="CharmRightCharge"> 1.0 </param>
+    <param type="double" name="CharmRightCharge"> -1.0 </param>
+
     <param type="double" name="ElectronLeftCharge"> 1.0 </param>
     <param type="double" name="ElectronRightCharge"> 1.0 </param>
     <param type="double" name="DMEL-Mp"> 1.441 </param>

config/DMRESHadronicSystemGenerator.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<alg_conf>
+
+<!--
+Configuration sets for the RESHadronSystemGenerator EventRecordVisitorI
+
+Configurable Parameters:
+.......................................................................................................
+Name             Type     Optional   Comment               Default
+.......................................................................................................
+Decayer          alg      No
+-->
+
+  <param_set name="Default">
+     <param type="alg" name="Decayer">             genie::UnstableParticleDecayer/BeforeHadronTransport  </param>
+<!--
+     <param type="alg" name="PreTransportDecayer"> genie::UnstableParticleDecayer/BeforeHadronTransport  </param>
+-->
+  </param_set>
+
+</alg_conf>

config/DMRESInteractionListGenerator.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+Configuration for the RESInteractionListGenerator InteractionListGeneratorI
+
+Configurable Parameters:
+..........................................................................................................................
+Name                        Type    Opt  Comment                                               Default
+..........................................................................................................................
+ResonanceNameList           string  No   list of resonances to be taken into account           CommonParam[Resonances]
+is-DM                       bool    Yes  set true for DM list                                  false
+-->
+
+<alg_conf>
+
+  <param_set name="Default">
+    <param type="string" name="CommonParam"> Resonances </param>
+  </param_set>
+
+   <param_set name="DM-Default">
+     <param type="bool" name="is-DM"> true </param>
+  </param_set>
+
+</alg_conf>

config/DMRESKinematicsGenerator.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<alg_conf>
+
+<!--
+Configuration for the RESKinematicsGenerator EventRecordVisitorI
+
+Algorithm Configurable Parameters:
+.......................................................................................................................
+Name                     Type    Opt   Comment                                   Default
+.......................................................................................................................
+UniformOverPhaseSpace    bool    Yes   kinematics uniformly over allowd phase space  false
+                                       wgt = (phase_space_volume)*(diff_xsec)/(xsec)
+MaxXSec-SafetyFactor     double  Yes   multiplies max xsec in rejection method       1.25
+MaxXSec-DiffTolerance    double  Yes   max allowed 200*(xsec-xsecmax)/(xsec+xsecmax) 999999 (disable)
+                                       if xsec>xsecmax
+Cache-MinEnergy          double  Yes   minimum energy for which max xsec is cached   1.00
+-->
+
+  <param_set name="Default">
+    <param type="string" name="CommonParam">  NonResBackground    </param>
+  </param_set>
+
+
+  <param_set name="RES">
+
+     <param type="double" name="MaxXSec-SafetyFactor">   1.400                               </param>
+     <param type="double" name="Cache-MinEnergy">        0.500                               </param>
+  </param_set>
+
+  <param_set name="SPP">
+     <param type="double" name="MaxXSec-SafetyFactor">   1.400                               </param>
+  </param_set>
+
+</alg_conf>

config/DMRESOutgoingDarkGenerator.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<alg_conf>
+
+<!--
+Configuration for the DMRESPrimaryLeptonGenerator EventRecordVisitorI
+
+Configurable Parameters:
+.......................................................................................................................
+Name                     Type    Opt   Comment                                       Default
+.......................................................................................................................
+-->
+
+  <param_set name="Default">
+    <param type="string" name="CommonParam"> Lepton </param>
+
+  </param_set>
+
+</alg_conf>

config/DMRESPXSec.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+
+<!--
+Configuration for the Rein-Sehgal RES excitation d^xsec / dQ^2 dW xsec algorithm
+for Dark Matter
+
+Configurable Parameters:
+......................................................................................................................................
+Name                        Type Optional Comment                                                        Default
+......................................................................................................................................
+RES-CC-XSecScale            double  No    XSec rescaling factor
+RES-NC-XSecScale            double  No    Xsec rescaling factor
+RES-EM-XSecScale            double  No    Xsec rescaling factor
+RES-Zeta                    double  No    FKR's Z parameter
+RES-Omega                   double  No    FKR's Omega parameter
+RES-Ma                      double  No    RES axial mass
+RES-Mv                      double  No    RES vector mass
+WeinbergAngle               double  No    Weinberg Angle                                                  CommonParam[WeakInt]
+CKM-Vud                     double  No    Magnitude of ud-element of CKM-matrix                           CommonParam[CKM]
+BreitWeignerWeight          bool    Yes   Weight xsec with breit-wigner?                                  true
+BreitWignerNorm             bool    Yes   Normalize breit-wigner?                                         true
+UseNuTauScalingFactors      bool    Yes   Load/Use NEUGEN reduction factor splines for nutaus             true
+UseDRJoinScheme             bool    No    Use DIS/RES joining scheme?                                     CommonParam[NonResBackground]
+Wcut                        double  No    Param used in DIS/RES joining                                   CommonParam[NonResBackground]
+MaxNWidthForN2Res           double  Yes   x in limiting allowed W phase space for n=2 res according to    2.0
+                                          W < min{ Wmin(physical), MassRes + x * WidthRes }
+MaxNWidthForN0Res           double  Yes   As above for n=0 resonances                                     6.0
+MaxNWidthForGNres           double  Yes   As above for the remaining resonances                           4.0
+RFG-UseParametrization      bool    No    use parametrization for Fermi momentum and binging energy       CommonParam[FermiGas]
+
+FermiMomentumTable          string  No    Table of Fermi momentum (kF) constants for various nuclei       CommonParam[FermiGas]
+XSec-Integrator             alg     No
+-->
+
+<alg_conf>
+<param_set name="Velocity0">
+    <param type="string" name="CommonParam"> WeakInt,NonResBackground,CKM,FermiGas,BoostedDarkMatter </param>
+
+    <param type="alg"  name="XSec-Integrator">  genie::DMRESXSecFast/Default    </param>
+
+    <param type="int" name="velocity-mode">   0         </param>
+    <param type="double" name="RES-DM-XSecScale"> 1.000 </param>
+    <param type="double" name="RES-Omega"> 1.05  </param>
+    <param type="double" name="RES-Zeta">  0.76338 </param> <!-- 0.75 -->
+    <param type="double" name="RES-Ma"> 1.120 </param>
+    <param type="double" name="RES-Mv"> 0.840 </param>
+</param_set>
+
+<param_set name="Velocity2">
+    <param type="string" name="CommonParam"> WeakInt,NonResBackground,CKM,FermiGas,BoostedDarkMatter </param>
+
+    <param type="alg"  name="XSec-Integrator">  genie::DMRESXSecFast/Default    </param>
+
+    <param type="int" name="velocity-mode">   2         </param>
+    <param type="double" name="RES-DM-XSecScale"> 1.000 </param>
+    <param type="double" name="RES-Omega"> 1.05  </param>
+    <param type="double" name="RES-Zeta">  0.76338 </param> <!-- 0.75 -->
+    <param type="double" name="RES-Ma"> 1.120 </param>
+    <param type="double" name="RES-Mv"> 0.840 </param>
+
+</param_set>
+
+</alg_conf>

config/DMRESXSec.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<alg_conf>
+
+  <!--
+  Configuration for the DMRESXSec cross section algorithm
+  -->
+
+
+  <param_set name="Default">
+    <param type="string" name ="CommonParam">           Resonances  </param>
+    <param type="double" name ="ESplineMax">                   500  </param>
+    <param type="string" name ="gsl-integration-type">     adaptive </param>
+    <param type="int"    name ="gsl-max-eval">           1000000000 </param>
+    <param type="double" name ="gsl-relative-tolerance">      1e-9  </param>
+<!-- NC Scattering uses no Pauli Blocking-->
+    <param type="bool"   name="UsePauliBlockingForRES">  false  </param>
+  </param_set>
+</alg_conf>

config/DMRESXSecFast.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<alg_conf>
+
+  <!--
+  Configuration for the DMRESXSecFast cross section algorithm
+  -->
+
+
+  <param_set name="Default">
+    <param type="string" name ="CommonParam">           Resonances  </param>
+    <param type="double" name ="ESplineMax">                   500  </param>
+    <param type="string" name ="gsl-integration-type">     adaptive </param>
+    <param type="int"    name ="gsl-max-eval">           1000000000 </param>
+    <param type="double" name ="gsl-relative-tolerance">      1e-9  </param>
+<!-- NC Scattering uses no Pauli Blocking-->
+    <param type="bool"   name="UsePauliBlockingForRES">  false  </param>
+  </param_set>
+</alg_conf>

config/EventGenerator.xml

@@ -114,7 +114,6 @@ XSecModel                   alg     Yes  Cross section model used at the thread
      <param type="alg"    name="ILstGen">    genie::DMDISInteractionListGenerator/DM-Default       </param>
   </param_set>
 
-
  <!--
   EvtLib / EventLibraryInterface
  -->
@@ -689,6 +688,22 @@ XSecModel                   alg     Yes  Cross section model used at the thread
      <param type="alg"    name="ILstGen">    genie::DMEInteractionListGenerator/DME  </param>
   </param_set>
 
+  <param_set name="DMRES">
+     <param type="string" name="VldContext"> </param>
+     <param type="int"    name="NModules">   10                                                    </param>
+     <param type="alg"    name="Module-0">   genie::InitialStateAppender/Default                   </param>
+     <param type="alg"    name="Module-1">   genie::VertexGenerator/Default                        </param>
+     <param type="alg"    name="Module-2">   genie::FermiMover/Default                             </param>
+     <param type="alg"    name="Module-3">   genie::DMRESKinematicsGenerator/RES                   </param>
+     <param type="alg"    name="Module-4">   genie::DMRESOutgoingDarkGenerator/Default              </param>
+     <param type="alg"    name="Module-5">   genie::DMRESHadronicSystemGenerator/Default             </param>
+     <param type="alg"    name="Module-6">   genie::NucDeExcitationSim/Default                     </param>
+     <param type="alg"    name="Module-7">   genie::HadronTransporter/Default                      </param>
+     <param type="alg"    name="Module-8">   genie::NucBindEnergyAggregator/Default                </param>
+     <param type="alg"    name="Module-9">   genie::UnstableParticleDecayer/AfterHadronTransport   </param>
+     <param type="alg"    name="ILstGen">    genie::DMRESInteractionListGenerator/DM-Default       </param>
+  </param_set>
+
   <!-- Inverse Beta Decay Event Generator -->
   <param_set name="IBD">
       <param type="string" name="VldContext"> </param>
@@ -847,7 +862,7 @@ XSecModel                   alg     Yes  Cross section model used at the thread
   </param_set>
 
   <!-- Beam-produced Heavy Neutral Lepton simulation -->
-  
+
   <param_set name="BeamHNL">
      <param type="string" name="VldContext"> </param>
      <param type="int"    name="NModules">   4                                                    </param>
@@ -858,7 +873,7 @@ XSecModel                   alg     Yes  Cross section model used at the thread
      <param type="alg"    name="ILstGen">    genie::DummyHNLInteractionListGenerator/Default      </param>
   </param_set>
 
-  
+
   <param_set name="NORM">
      <param type="string" name="VldContext"> </param>
      <param type="int"    name="NModules">   3                                                   </param>
@@ -868,5 +883,5 @@ XSecModel                   alg     Yes  Cross section model used at the thread
      <param type="alg"    name="ILstGen">    genie::NormInteractionListGenerator/Default         </param>
      <param type="alg"    name="XSecModel@genie::EventGenerator/NORM">  genie::NormXSec/Default  </param>
   </param_set>
-  
+
 </alg_conf>