Intranuke2018.h

Go to the documentation of this file.

//____________________________________________________________________________
/*!

\class    genie::Intranuke

\brief    The INTRANUKE intranuclear hadron transport MC.
          Is a concrete implementation of the EventRecordVisitorI interface.

\ref      R.Merenyi et al., Phys.Rev.D45 (1992)
          R.D.Ransome, Nucl.Phys.B 139 (2005)

          Current INTRANUKE development is led by S.Dytman and H.Gallagher.
          The original INTRANUKE cascade MC was developed (in fortran) for the
          NeuGEN MC by R.Edgecock, G.F.Pearce, W.A.Mann, R.Merenyi and others.

\author   Steve Dytman <dytman+@pitt.edu>, Pittsburgh University
          Aaron Meyer <asm58@pitt.edu>, Pittsburgh University
          Alex Bell, Pittsburgh University
          Hugh Gallagher <gallag@minos.phy.tufts.edu>, Tufts University
          Costas Andreopoulos <c.andreopoulos \at cern.ch> STFC, Rutherford Lab

\created  September 20, 2005

\cpright  Copyright (c) 2003-2024, The GENIE Collaboration
          For the full text of the license visit http://copyright.genie-mc.org

*/
//____________________________________________________________________________

#ifndef _INTRANUKE_2018_H_
#define _INTRANUKE_2018_H_

#include <TGenPhaseSpace.h>

#include "Physics/NuclearState/NuclearModelI.h"

#include "Framework/Algorithm/AlgFactory.h"
#include "Framework/EventGen/EventRecordVisitorI.h"
#include "Framework/Conventions/GMode.h"
#include "Physics/HadronTransport/INukeMode.h"
#include "Physics/HadronTransport/INukeHadroFates2018.h"

class TLorentzVector;
class TVector3;

namespace genie {

class GHepParticle;
class INukeHadroData2018;
class PDGCodeList;
class HNIntranuke2018;
class HAIntranuke2018;

class Intranuke2018 : public EventRecordVisitorI {

friend class IntranukeTester;

public :
  Intranuke2018();
  Intranuke2018(string name);
  Intranuke2018(string name, string config);
 ~Intranuke2018();

  // implement the EventRecordVisitorI interface
  virtual void ProcessEventRecord(GHepRecord * event_rec) const;

  // override the Algorithm::Configure methods to load configuration
  // data to protected data members
  virtual void Configure (const Registry & config);
  virtual void Configure (string param_set);

  virtual string GetINukeMode() const {return "XX2018";};
  virtual string GetGenINukeMode() const {return "XX";};

  // Setters used in reweighting
  inline void SetRemnA( int A ) { fRemnA = A; }
  inline void SetRemnZ( int Z ) { fRemnZ = Z; }

  inline double GetRemnA() const { return fRemnA; }
  inline double GetRemnZ() const { return fRemnZ; }

  inline double GetR0() const { return fR0; }
  inline double GetNR() const { return fNR; }

  inline double GetDelRPion() const { return fDelRPion; }
  inline double GetDelRNucleon() const { return fDelRNucleon; }

  inline double GetNucRmvE() const { return fNucRmvE; }
  inline double GetHadStep() const { return fHadStep; }

  inline bool GetUseOset() const { return fUseOset; }
  inline bool GetAltOset() const { return fAltOset; }
  inline bool GetXsecNNCorr() const { return fXsecNNCorr; }

protected:

  // methods for loading configuration
  virtual void LoadConfig (void)=0;

  // general methods for the cascade mc structure
  void   TransportHadrons   (GHepRecord * ev) const;
  void   GenerateVertex     (GHepRecord * ev) const;
  bool   NeedsRescattering  (const GHepParticle* p) const;
  bool   CanRescatter       (const GHepParticle* p) const;
  bool   IsInNucleus        (const GHepParticle* p) const;
  void   SetTrackingRadius  (const GHepParticle* p) const;
  double GenerateStep       (GHepRecord* ev, GHepParticle* p) const;

  // virtual functions for individual modes
  virtual void SimulateHadronicFinalState(GHepRecord* ev, GHepParticle* p) const = 0;
  virtual int HandleCompoundNucleus(GHepRecord* ev, GHepParticle* p, int mom) const = 0;

  // utility objects & params
  mutable double         fTrackingRadius;///< tracking radius for the nucleus in the current event
  mutable TGenPhaseSpace fGenPhaseSpace; ///< a phase space generator
  INukeHadroData2018 *       fHadroData2018;     ///< a collection of h+N,h+A data & calculations
  AlgFactory *           fAlgf;          ///< algorithm factory instance
  const NuclearModelI *  fNuclmodel;     ///< nuclear model used to generate fermi momentum
  mutable int            fRemnA;         ///< remnant nucleus A
  mutable int            fRemnZ;         ///< remnant nucleus Z
  mutable TLorentzVector fRemnP4;        ///< P4 of remnant system
  mutable GEvGenMode_t   fGMode;         ///< event generation mode (lepton+A, hadron+A, ...)

  // configuration parameters
  double       fR0;           ///< effective nuclear size param
  double       fNR;           ///< param multiplying the nuclear radius, determining how far to track hadrons beyond the "nuclear boundary"
  double       fNucRmvE;      ///< binding energy to subtract from cascade nucleons
  double       fDelRPion;     ///< factor by which Pion Compton wavelength gets multiplied to become nuclear size enhancement
  double       fDelRNucleon;  ///< factor by which Nucleon Compton wavelength gets multiplied to become nuclear size enhancement
  double       fHadStep;      ///< step size for intranuclear hadron transport
  double       fNucAbsFac;    ///< absorption xsec correction factor (hN Mode)
  double       fNucCEXFac;    ///< charge exchange xsec correction factor (hN Mode)
  double       fEPreEq;       ///< threshold for pre-equilibrium reaction
  double       fFermiFac;     ///< testing parameter to modify fermi momentum
  double       fFermiMomentum;     ///< whether or not particle collision is pauli blocked
  bool         fDoFermi;      ///< whether or not to do fermi mom.
  bool         fDoMassDiff;   ///< whether or not to do mass diff. mode
  bool         fDoCompoundNucleus; ///< whether or not to do compound nucleus considerations
  bool         fUseOset;      ///< Oset model for low energy pion in hN
  bool         fAltOset;      ///< NuWro's table-based implementation (not recommended)
  bool         fXsecNNCorr;   ///< use nuclear medium correction for NN cross section

  double       fChPionMFPScale;       ///< tweaking factors for tuning
  double       fNeutralPionMFPScale;
  double       fPionFracCExScale;
  double       fPionFracInelScale;
  double       fChPionFracAbsScale;
  double       fNeutralPionFracAbsScale;
  double       fPionFracPiProdScale;
  double       fNucleonMFPScale;
  double       fNucleonFracCExScale;
  double       fNucleonFracInelScale;
  double       fNucleonFracAbsScale;
  double       fNucleonFracPiProdScale;

};

}      // genie namespace

#endif // _INTRANUKE_2018_H_