genie::KNOTunedQPMDISPXSec Class Reference

Computes DIS differential cross sections. Is a concrete implementation of the XSecAlgorithmI interface. More...

#include <KNOTunedQPMDISPXSec.h>

Inheritance diagram for genie::KNOTunedQPMDISPXSec:

Collaboration diagram for genie::KNOTunedQPMDISPXSec:

Public Member Functions
	KNOTunedQPMDISPXSec ()
	KNOTunedQPMDISPXSec (string config)
virtual	~KNOTunedQPMDISPXSec ()
double	XSec (const Interaction *i, KinePhaseSpace_t k) const
	Compute the cross section for the input interaction.
double	Integral (const Interaction *i) const
bool	ValidProcess (const Interaction *i) const
	Can this cross section algorithm handle the input process?
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::XSecAlgorithmI
virtual	~XSecAlgorithmI ()
virtual bool	ValidKinematics (const Interaction *i) const
	Is the input kinematical point a physically allowed one?
Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()
virtual void	FindConfig (void)
virtual const Registry &	GetConfig (void) const
Registry *	GetOwnedConfig (void)
virtual const AlgId &	Id (void) const
	Get algorithm ID.
virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status.
virtual bool	AllowReconfig (void) const
virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm.
virtual void	SetId (const AlgId &id)
	Set algorithm ID.
virtual void	SetId (string name, string config)
const Algorithm *	SubAlg (const RgKey &registry_key) const
void	AdoptConfig (void)
void	AdoptSubstructure (void)
virtual void	Print (ostream &stream) const
	Print algorithm info.

Private Member Functions
void	LoadConfig (void)
double	DISRESJoinSuppressionFactor (const Interaction *in) const

Private Attributes
const AGKYLowW2019 *	fHadronizationModel
	hadronic multip. model
const QPMDISPXSec *	fDISModel
const XSecIntegratorI *	fXSecIntegrator
	diff. xsec integrator
bool	fUseCache
	cache reduction factors used in joining scheme
double	fWcut
	apply DIS/RES joining scheme < Wcut
double	fNRBEMScale
	apply NRB EM Scale factor

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)
static string	BuildParamVectSizeKey (const std::string &comm_name)
static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)
static string	BuildParamMatRowSizeKey (const std::string &comm_name)
static string	BuildParamMatColSizeKey (const std::string &comm_name)
Protected Member Functions inherited from genie::XSecAlgorithmI
	XSecAlgorithmI ()
	XSecAlgorithmI (string name)
	XSecAlgorithmI (string name, string config)
Protected Member Functions inherited from genie::Algorithm
	Algorithm ()
	Algorithm (string name)
	Algorithm (string name, string config)
void	Initialize (void)
void	DeleteConfig (void)
void	DeleteSubstructure (void)
Registry *	ExtractLocalConfig (const Registry &in) const
Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.
template<class T>
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const
template<class T>
bool	GetParamDef (const RgKey &name, T &p, const T &def) const
template<class T>
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters.
int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
template<class T>
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters.
template<class T>
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const
int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership
int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership
int	MergeTopRegistry (const Registry &r)
int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships.
Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig
bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...)
AlgId	fID
	algorithm name and configuration set
vector< Registry * >	fConfVect
vector< bool >	fOwnerships
	ownership for every registry in fConfVect
AlgStatus_t	fStatus
	algorithm execution status
AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool)

Detailed Description

Computes DIS differential cross sections. Is a concrete implementation of the XSecAlgorithmI interface.

References:\n E.A.Paschos and J.Y.Yu, Phys.Rev.D 65.03300

Author

Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n May 05, 2004

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org

Definition at line 32 of file KNOTunedQPMDISPXSec.h.

Constructor & Destructor Documentation

KNOTunedQPMDISPXSec() [1/2]

KNOTunedQPMDISPXSec::KNOTunedQPMDISPXSec

(

)

Definition at line 48 of file KNOTunedQPMDISPXSec.cxx.

                                         :
XSecAlgorithmI("genie::KNOTunedQPMDISPXSec") { ; }

References genie::XSecAlgorithmI::XSecAlgorithmI().

KNOTunedQPMDISPXSec() [2/2]

KNOTunedQPMDISPXSec::KNOTunedQPMDISPXSec

(

string

config

)

Definition at line 51 of file KNOTunedQPMDISPXSec.cxx.

                                                      :
XSecAlgorithmI("genie::KNOTunedQPMDISPXSec", config) { ; }

References genie::XSecAlgorithmI::XSecAlgorithmI().

~KNOTunedQPMDISPXSec()

KNOTunedQPMDISPXSec::~KNOTunedQPMDISPXSec ( )

virtual

Definition at line 54 of file KNOTunedQPMDISPXSec.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void KNOTunedQPMDISPXSec::Configure ( const Registry & config )

virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Definition at line 215 of file KNOTunedQPMDISPXSec.cxx.

{
  Algorithm::Configure(config);
  this->LoadConfig();
}

References genie::Algorithm::Configure(), and LoadConfig().

Configure() [2/2]

void KNOTunedQPMDISPXSec::Configure ( string config )

virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Reimplemented from genie::Algorithm.

Definition at line 221 of file KNOTunedQPMDISPXSec.cxx.

{
  Algorithm::Configure(config);
 
  this->LoadConfig();
}

References genie::Algorithm::Configure(), and LoadConfig().

DISRESJoinSuppressionFactor()

double KNOTunedQPMDISPXSec::DISRESJoinSuppressionFactor ( const Interaction * in ) const

private

Definition at line 96 of file KNOTunedQPMDISPXSec.cxx.

{
// Computes suppression factors for the DIS xsec under the used DIS/RES join
// scheme. Since this is a 'low-level' algorithm that is being called many
// times per generated event or computed cross section spline, the suppression
// factors would be cached to avoid calling the hadronization model too often.
//
  double R=0, Ro=0;
 
  const double Wmin = kNeutronMass + kPionMass + 1E-3;
 
  const InitialState & ist = in->InitState();
  const ProcessInfo &  pi  = in->ProcInfo();
  const bool is_EM = pi.IsEM();
  
  double E    = ist.ProbeE(kRfHitNucRest);
  double Mnuc = ist.Tgt().HitNucMass();
  double x    = in->Kine().x();
  double y    = in->Kine().y();
  double Wo   = utils::kinematics::XYtoW(E,Mnuc,x,y);
 
  TH1D * mprob = 0;
 
  if(!fUseCache) {
    // ** Compute the reduction factor at each call - no caching
    //
    mprob = fHadronizationModel->MultiplicityProb(in,"+LowMultSuppr");
    R = 1;
    if(mprob) {
       R = mprob->Integral("width");
       delete mprob;
    }
  }
  else {
 
    // ** Precompute/cache the reduction factors and then use the
    // ** cache to evaluate these factors
 
    // Access the cache branch. The branch key is formed as:
    // algid/DIS-RES-Join/nu-pdg:N;hit-nuc-pdg:N/inttype
    Cache * cache = Cache::Instance();
    string algkey = this->Id().Key() + "/DIS-RES-Join";
 
    ostringstream ikey;
    ikey << "nu-pdgc:" << ist.ProbePdg()
         << ";hit-nuc-pdg:"<< ist.Tgt().HitNucPdg() << "/"
         << pi.InteractionTypeAsString();
 
    string key = cache->CacheBranchKey(algkey, ikey.str());
 
    CacheBranchFx * cbr =
          dynamic_cast<CacheBranchFx *> (cache->FindCacheBranch(key));
 
    // If it does't exist then create a new one
    // and cache DIS xsec suppression factors
    bool non_zero=false;
    if(!cbr) {
      LOG("DISXSec", pNOTICE)
                        << "\n ** Creating cache branch - key = " << key;
 
      cbr = new CacheBranchFx("DIS Suppr. Factors in DIS/RES Join Scheme");
      Interaction interaction(*in);
 
      const int kN   = 300;
      double WminSpl = Wmin;
      double WmaxSpl = fWcut + 0.1; // well into the area where scaling factor = 1
      double dW      = (WmaxSpl-WminSpl)/(kN-1);
 
      for(int i=0; i<kN; i++) {
        double W = WminSpl+i*dW;
        interaction.KinePtr()->SetW(W);
        mprob = fHadronizationModel->MultiplicityProb(&interaction,"+LowMultSuppr");
        R = 1;
        if(mprob) {
           R = mprob->Integral("width");
           delete mprob;
        }
        // make sure that it takes enough samples where it is non-zero:
        // modify the step and the sample counter once I've hit the first
        // non-zero value
        if(!non_zero && R>0) {
          non_zero=true;
          WminSpl=W;
          i = 0;
          dW = (WmaxSpl-WminSpl)/(kN-1);
        }
        LOG("DISXSec", pNOTICE)
            << "Cached DIS XSec Suppr. factor (@ W=" << W << ") = " << R;
 
        cbr->AddValues(W,R);
      }
      cbr->CreateSpline();
 
      cache->AddCacheBranch(key, cbr);
      assert(cbr);
    } // cache data
 
    // get the reduction factor from the cache branch
    if(Wo > Wmin && Wo < fWcut) {
       const CacheBranchFx & cache_branch = (*cbr);
       R = cache_branch(Wo);
    }
  }
 
  // Now return the suppression factor
  if      (Wo > Wmin && Wo < fWcut) {
    Ro = R;
    if ( is_EM ) Ro *= fNRBEMScale ; // Additional scaling
  }
  else if (Wo <= Wmin)              Ro = 0.0;
  else                              Ro = 1.0;
 
  LOG("DISXSec", pDEBUG)
      << "DIS/RES Join: DIS xsec suppr. (W=" << Wo << ") = " << Ro;
 
  return Ro;
}

References genie::Cache::AddCacheBranch(), genie::CacheBranchFx::AddValues(), genie::Cache::CacheBranchKey(), genie::CacheBranchFx::CreateSpline(), fHadronizationModel, genie::Cache::FindCacheBranch(), fNRBEMScale, fUseCache, fWcut, genie::Target::HitNucMass(), genie::Target::HitNucPdg(), genie::Algorithm::Id(), genie::Interaction::InitState(), genie::Cache::Instance(), genie::ProcessInfo::InteractionTypeAsString(), genie::ProcessInfo::IsEM(), genie::AlgId::Key(), genie::Interaction::Kine(), genie::Interaction::KinePtr(), genie::constants::kNeutronMass, genie::constants::kPionMass, genie::kRfHitNucRest, LOG, pDEBUG, pNOTICE, genie::InitialState::ProbeE(), genie::InitialState::ProbePdg(), genie::Interaction::ProcInfo(), genie::Kinematics::SetW(), genie::InitialState::Tgt(), genie::Kinematics::x(), genie::utils::kinematics::XYtoW(), and genie::Kinematics::y().

Referenced by XSec().

Integral()

double KNOTunedQPMDISPXSec::Integral ( const Interaction * i ) const

virtual

Integrate the model over the kinematic phase space available to the input interaction (kinematical cuts can be included)

Implements genie::XSecAlgorithmI.

Definition at line 85 of file KNOTunedQPMDISPXSec.cxx.

{
  double xsec = fXSecIntegrator->Integrate(this,interaction);
  return xsec;
}

References fXSecIntegrator.

LoadConfig()

void KNOTunedQPMDISPXSec::LoadConfig ( void )

private

Definition at line 228 of file KNOTunedQPMDISPXSec.cxx.

{
 
  fHadronizationModel = nullptr ;
 
  fHadronizationModel =
    dynamic_cast<const AGKYLowW2019 *> (this->SubAlg("Hadronizer"));
  assert(fHadronizationModel);
 
  GetParam( "Wcut", fWcut ) ;
  GetParam( "NRB-EM-XSecScale", fNRBEMScale );
 
  if ( fWcut <= 0. ) {
 
        LOG("KNOTunedQPMDISPXSec", pFATAL)
        << "Input configuration value for Wcut is not physical: Exiting" ;
 
      // From the FreeBSD Library Functions Manual
      //
      // EX_CONFIG (78)   Something was found in an unconfigured or miscon-
      //                  figured state.
 
    exit( 78 ) ;
 
  }
 
  // load the pure E.A.Paschos and J.Y.Yu model
  fDISModel = nullptr ;
  fDISModel = dynamic_cast<const QPMDISPXSec *>(this->SubAlg("DISModel") ) ;
  assert( fDISModel ) ;
 
  //-- load the differential cross section integrator
  fXSecIntegrator =
      dynamic_cast<const XSecIntegratorI *> (this->SubAlg("XSec-Integrator"));
  assert(fXSecIntegrator);
 
  // Caching the reduction factors used in the DIS/RES joing scheme?
  // In normal event generation (1 config -> many calls) it is worth caching
  // these suppression factors.
  // Depending on the way this algorithm is used during event reweighting,
  // precomputing (for all W's) & caching these factors might not be efficient.
  // Here we provide the option to turn the caching off at run-time (default: on)
 
  bool cache_enabled = RunOpt::Instance()->BareXSecPreCalc();
 
  GetParamDef( "UseCache", fUseCache, true ) ;
  fUseCache = fUseCache && cache_enabled;
 
 
  }

References genie::RunOpt::BareXSecPreCalc(), fDISModel, fHadronizationModel, fNRBEMScale, fUseCache, fWcut, fXSecIntegrator, genie::Algorithm::GetParam(), genie::Algorithm::GetParamDef(), genie::RunOpt::Instance(), LOG, pFATAL, and genie::Algorithm::SubAlg().

Referenced by Configure(), and Configure().

ValidProcess()

bool KNOTunedQPMDISPXSec::ValidProcess ( const Interaction * i ) const

virtual

Can this cross section algorithm handle the input process?

Implements genie::XSecAlgorithmI.

Definition at line 91 of file KNOTunedQPMDISPXSec.cxx.

{
        return fDISModel -> ValidProcess(interaction) ;
}

References fDISModel, and ValidProcess().

Referenced by ValidProcess().

XSec()

double KNOTunedQPMDISPXSec::XSec ( const Interaction * i, KinePhaseSpace_t k ) const

virtual

Compute the cross section for the input interaction.

Implements genie::XSecAlgorithmI.

Definition at line 59 of file KNOTunedQPMDISPXSec.cxx.

{
 
  double xsec = fDISModel -> XSec(interaction, kps) ;
 
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
  LOG("DISPXSec", pINFO)
        << "d2xsec/dxdy[FreeN] (E= " << E
                      << ", x= " << x << ", y= " << y << ") = " << xsec;
#endif
 
  double R = this->DISRESJoinSuppressionFactor(interaction);
 
  xsec*=R;
 
#ifdef __GENIE_LOW_LEVEL_MESG_ENABLED__
     LOG("DISPXSec", pINFO) << "D/R Join scheme - suppression factor R = " << R;;
     LOG("DISPXSec", pINFO) << "d2xsec/dxdy[FreeN, D/R Join] " << xsec;
#endif
 
  xsec = TMath::Max(0., xsec ) ;
 
  return xsec;
}

References DISRESJoinSuppressionFactor(), fDISModel, LOG, pINFO, and XSec().

Referenced by XSec().

Member Data Documentation

fDISModel

const QPMDISPXSec* genie::KNOTunedQPMDISPXSec::fDISModel

private

Definition at line 54 of file KNOTunedQPMDISPXSec.h.

Referenced by LoadConfig(), ValidProcess(), and XSec().

fHadronizationModel

const AGKYLowW2019* genie::KNOTunedQPMDISPXSec::fHadronizationModel

private

hadronic multip. model

Definition at line 53 of file KNOTunedQPMDISPXSec.h.

Referenced by DISRESJoinSuppressionFactor(), and LoadConfig().

fNRBEMScale

double genie::KNOTunedQPMDISPXSec::fNRBEMScale

private

apply NRB EM Scale factor

Definition at line 59 of file KNOTunedQPMDISPXSec.h.

Referenced by DISRESJoinSuppressionFactor(), and LoadConfig().

fUseCache

bool genie::KNOTunedQPMDISPXSec::fUseCache

private

cache reduction factors used in joining scheme

Definition at line 57 of file KNOTunedQPMDISPXSec.h.

Referenced by DISRESJoinSuppressionFactor(), and LoadConfig().

fWcut

double genie::KNOTunedQPMDISPXSec::fWcut

private

apply DIS/RES joining scheme < Wcut

Definition at line 58 of file KNOTunedQPMDISPXSec.h.

Referenced by DISRESJoinSuppressionFactor(), and LoadConfig().

fXSecIntegrator

const XSecIntegratorI* genie::KNOTunedQPMDISPXSec::fXSecIntegrator

private

diff. xsec integrator

Definition at line 55 of file KNOTunedQPMDISPXSec.h.

Referenced by Integral(), and LoadConfig().

---

The documentation for this class was generated from the following files:

• KNOTunedQPMDISPXSec.h
• KNOTunedQPMDISPXSec.cxx