genie::SPPXSec Class Reference

Computes the cross section for an neutrino resonance SPP reaction. More...

#include <SPPXSec.h>

Inheritance diagram for genie::SPPXSec:

Collaboration diagram for genie::SPPXSec:

Public Member Functions
	SPPXSec ()
	SPPXSec (string param_set)
virtual	~SPPXSec ()
double	Integrate (const XSecAlgorithmI *model, const Interaction *i) const
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::XSecIntegratorI
virtual	~XSecIntegratorI ()
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)

Private Attributes
bool	fUsePauliBlocking
	account for Pauli blocking?

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::SPPXSecWithCache
	SPPXSecWithCache ()
	SPPXSecWithCache (string name)
	SPPXSecWithCache (string name, string config)
virtual	~SPPXSecWithCache ()
void	CacheResExcitationXSec (const Interaction *interaction) const
string	CacheBranchName (SppChannel_t spp_channel, InteractionType_t it, int nu) const
Protected Member Functions inherited from genie::XSecIntegratorI
	XSecIntegratorI ()
	XSecIntegratorI (string name)
	XSecIntegratorI (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::SPPXSecWithCache
bool	fUsingDisResJoin
double	fWcut
double	fEMax
const XSecAlgorithmI *	fSinglePionProductionXSecModel
BaryonResList	fResList
Protected Attributes inherited from genie::XSecIntegratorI
const IntegratorI *	fIntegrator
	GENIE numerical integrator.
string	fGSLIntgType
	name of GSL numerical integrator
double	fGSLRelTol
	required relative tolerance (error)
int	fGSLMaxEval
	GSL max evaluations.
int	fGSLMinEval
	GSL min evaluations. Ignored by some integrators.
unsigned int	fGSLMaxSizeOfSubintervals
	GSL maximum number of sub-intervals for 1D integrator.
unsigned int	fGSLRule
	GSL Gauss-Kronrod integration rule (only for GSL 1D adaptive type)
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 the cross section for an neutrino resonance SPP reaction.

     Before computing any SPP cross section this algorithm 
     computes and caches splines for neutrino resonance SPP  cross 
     sections. This improves the speed of the GENIE spline construction 
     phase if splines for multiple nuclear targets are to be computed
     (for case without Pauli-blocking).

     Is a concrete implementation of the XSecAlgorithmI interface.\n

Authors

Igor Kakorin kakor.nosp@m.in@j.nosp@m.inr.r.nosp@m.u, Joint Institute for Nuclear Research
Vadim Naumov <vnaum.nosp@m.ov@t.nosp@m.heor..nosp@m.jinr.nosp@m..ru >, Joint Institute for Nuclear Research
based on code of Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n November 12, 2019

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

For the full text of the license visit http://copyright.genie-mc.org
or see $GENIE/LICENSE

Definition at line 37 of file SPPXSec.h.

Constructor & Destructor Documentation

SPPXSec() [1/2]

SPPXSec::SPPXSec

(

)

Definition at line 49 of file SPPXSec.cxx.

                 :
SPPXSecWithCache("genie::SPPXSec")
{
 
}

References genie::SPPXSecWithCache::SPPXSecWithCache().

SPPXSec() [2/2]

SPPXSec::SPPXSec

(

string

param_set

)

Definition at line 55 of file SPPXSec.cxx.

                              :
SPPXSecWithCache("genie::SPPXSec", config)
{
 
}

References genie::SPPXSecWithCache::SPPXSecWithCache().

~SPPXSec()

SPPXSec::~SPPXSec ( )

virtual

Definition at line 61 of file SPPXSec.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void SPPXSec::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 205 of file SPPXSec.cxx.

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

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

Configure() [2/2]

void SPPXSec::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 211 of file SPPXSec.cxx.

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

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

Integrate()

double SPPXSec::Integrate ( const XSecAlgorithmI * model, const Interaction * i ) const

virtual

Implements genie::XSecIntegratorI.

Definition at line 66 of file SPPXSec.cxx.

{
  if(!model->ValidProcess(interaction) ) return 0.;
 
  //-- Get init state and process information
  const InitialState & init_state = interaction->InitState();
  const ProcessInfo &  proc_info  = interaction->ProcInfo();
  const Target &       target     = init_state.Tgt();
  
  const KPhaseSpace& kps = interaction->PhaseSpace();
  
  double Enu = init_state.ProbeE(kRfHitNucRest);
  
  //-- Get the requested SPP channel
  SppChannel_t spp_channel = SppChannel::FromInteraction(interaction);
 
  if (Enu < kps.Threshold_SPP_iso()) return 0.;
  
  fSinglePionProductionXSecModel = model;
 
  InteractionType_t it = proc_info.InteractionTypeId();
  int nucleon_pdgc = target.HitNucPdg();
  int nu_pdgc      = init_state.ProbePdg();
  string nc_nuc   = ((pdg::IsNeutrino(nu_pdgc)) ? ";v:" : ";vb:");
  
  // If the input interaction is off a nuclear target, then chek whether
  // the corresponding free nucleon cross section already exists at the
  // cross section spline list.
  // If yes, calculate the nuclear cross section based on that value.
  //
  XSecSplineList * xsl = XSecSplineList::Instance();
  if(init_state.Tgt().IsNucleus() && !xsl->IsEmpty() ) 
  {
    Interaction * in = new Interaction(*interaction);
    if(pdg::IsProton(nucleon_pdgc))  
      in->InitStatePtr()->TgtPtr()->SetId(kPdgTgtFreeP); 
    else 
      in->InitStatePtr()->TgtPtr()->SetId(kPdgTgtFreeN); 
    
    if(xsl->SplineExists(model,in)) 
    {
      const Spline * spl = xsl->GetSpline(model, in);
      double xsec = spl->Evaluate(Enu);
      SLOG("SPPXSec", pNOTICE)  
         << "XSec[Channel/" << SppChannel::AsString(spp_channel) << "/free] (Ev = " 
               << Enu << " GeV) = " << xsec/(1E-38 *cm2)<< " x 1E-38 cm^2";
      if(! interaction->TestBit(kIAssumeFreeNucleon) ) 
      {
        int NNucl = (SppChannel::InitStateNucleon(spp_channel) == kPdgProton) ? target.Z() : target.N();
        xsec *= NNucl;
      }
      delete in;
      return xsec;
    }
    delete in;
  }
 
  // There was no corresponding free nucleon spline saved in XSecSplineList that
  // could be used to speed up this calculation.
  // Check whether local caching of free nucleon cross sections is allowed.
  // If yes, store free nucleon cross sections at a cache branch and use those
  // at any subsequent call.
  //
  bool bare_xsec_pre_calc = RunOpt::Instance()->BareXSecPreCalc();
  if(bare_xsec_pre_calc && !fUsePauliBlocking) 
  {
     Cache * cache = Cache::Instance();
     string key = this->CacheBranchName(spp_channel, it, nu_pdgc);
     LOG("SPPXSec", pINFO) 
         << "Finding cache branch with key: " << key;
     CacheBranchFx * cache_branch =
         dynamic_cast<CacheBranchFx *> (cache->FindCacheBranch(key));
     if(!cache_branch) {
        LOG("SPPXSec", pWARN)  
           << "No cached ResSPP v-production data for input neutrino"
           << " (pdgc: " << nu_pdgc << ")";
        LOG("SPPXSec", pWARN)  
           << "Wait while computing/caching ResSPP production xsec first...";
 
        this->CacheResExcitationXSec(interaction); 
 
        LOG("SPPXSec", pINFO) << "Done caching resonance xsec data";
        LOG("SPPXSec", pINFO) 
               << "Finding newly created cache branch with key: " << key;
        cache_branch =
              dynamic_cast<CacheBranchFx *> (cache->FindCacheBranch(key));
        assert(cache_branch);
     }
     const CacheBranchFx & cbranch = (*cache_branch);
  
    //-- Get cached resonance neutrinoproduction xsec
    //   (If E>Emax, assume xsec = xsec(Emax) - but do not evaluate the
    //    cross section spline at the end of its energy range-)
    double rxsec = (Enu<fEMax-1) ? cbranch(Enu) : cbranch(fEMax-1);
 
               
    SLOG("SPPXSec", pNOTICE)
      << "XSec[Channel: " << SppChannel::AsString(spp_channel) << nc_nuc  << nu_pdgc
      << "/free]  (E="<< Enu << " GeV) = " << rxsec/(1E-38 *genie::units::cm2) << " x 1E-38 cm^2";
 
     if( interaction->TestBit(kIAssumeFreeNucleon) ) return rxsec;
 
     int NNucl = (pdg::IsProton(nucleon_pdgc)) ? target.Z() : target.N();
     rxsec*=NNucl; // nuclear xsec 
     return rxsec;
  } // disable local caching
 
  // Just go ahead and integrate the input differential cross section for the
  // specified interaction.  
  else 
  {
    LOG("SPPXSec", pINFO)
          << "*** Integrating d^3 XSec/dWdQ^2dCosTheta for Ch: "
          << SppChannel::AsString(spp_channel) << " at Ev = " << Enu;
    
    ROOT::Math::IBaseFunctionMultiDim * func= new utils::gsl::d3XSecMK_dWQ2CosTheta_E(model, interaction, fWcut);
    ROOT::Math::IntegrationMultiDim::Type ig_type = utils::gsl::IntegrationNDimTypeFromString(fGSLIntgType);
    ROOT::Math::IntegratorMultiDim ig(ig_type,0,fGSLRelTol,fGSLMaxEval);
    if (ig_type == ROOT::Math::IntegrationMultiDim::kADAPTIVE) 
    {
      ROOT::Math::AdaptiveIntegratorMultiDim * cast = dynamic_cast<ROOT::Math::AdaptiveIntegratorMultiDim*>( ig.GetIntegrator() );
      assert(cast);
      cast->SetMinPts(fGSLMinEval);
    }
    ig.SetFunction(*func);
    double kine_min[3] = { 0., 0., 0.};
    double kine_max[3] = { 1., 1., 1.};
    double xsec = ig.Integral(kine_min, kine_max)*(1E-38 * units::cm2);
    delete func;
      
    SLOG("SPPXSec", pNOTICE)
      << "XSec[Channel: " << SppChannel::AsString(spp_channel) << nc_nuc  << nu_pdgc
      << "]  (E="<< Enu << " GeV) = " << xsec << " x 1E-38 cm^2";
    return xsec;
  }
  return 0;
}

References genie::SppChannel::AsString(), genie::RunOpt::BareXSecPreCalc(), genie::SPPXSecWithCache::CacheBranchName(), genie::SPPXSecWithCache::CacheResExcitationXSec(), genie::units::cm2, genie::Spline::Evaluate(), genie::SPPXSecWithCache::fEMax, genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLMinEval, genie::XSecIntegratorI::fGSLRelTol, genie::Cache::FindCacheBranch(), genie::SppChannel::FromInteraction(), genie::SPPXSecWithCache::fSinglePionProductionXSecModel, func(), fUsePauliBlocking, genie::SPPXSecWithCache::fWcut, genie::XSecSplineList::GetSpline(), genie::Target::HitNucPdg(), genie::Interaction::InitState(), genie::SppChannel::InitStateNucleon(), genie::Interaction::InitStatePtr(), genie::Cache::Instance(), genie::RunOpt::Instance(), genie::XSecSplineList::Instance(), genie::utils::gsl::IntegrationNDimTypeFromString(), genie::ProcessInfo::InteractionTypeId(), genie::XSecSplineList::IsEmpty(), genie::pdg::IsNeutrino(), genie::Target::IsNucleus(), genie::pdg::IsProton(), genie::kIAssumeFreeNucleon, genie::kPdgProton, genie::kPdgTgtFreeN, genie::kPdgTgtFreeP, genie::kRfHitNucRest, LOG, genie::Target::N(), genie::Interaction::PhaseSpace(), pINFO, pNOTICE, genie::InitialState::ProbeE(), genie::InitialState::ProbePdg(), genie::Interaction::ProcInfo(), pWARN, genie::Target::SetId(), SLOG, genie::XSecSplineList::SplineExists(), genie::InitialState::Tgt(), genie::InitialState::TgtPtr(), genie::KPhaseSpace::Threshold_SPP_iso(), genie::XSecAlgorithmI::ValidProcess(), and genie::Target::Z().

LoadConfig()

void SPPXSec::LoadConfig ( void )

private

Definition at line 217 of file SPPXSec.cxx.

{
  
  bool good_conf = true ;
 
   // Get GSL integration type & relative tolerance
  GetParamDef( "gsl-integration-type", fGSLIntgType, string("adaptive") ) ;
  GetParamDef( "gsl-relative-tolerance", fGSLRelTol, 1e-5 ) ;
  GetParamDef( "gsl-max-eval", fGSLMaxEval, 1000000 );
  GetParamDef( "gsl-min-eval", fGSLMinEval, 7500 ) ;
  GetParam("UsePauliBlockingForRES", fUsePauliBlocking);
  GetParamDef("Wcut", fWcut, -1.);
  // Get upper Emax limit on cached free nucleon xsec spline, 
  // after this value it assume that xsec=xsec(Emax)
  GetParamDef( "ESplineMax", fEMax, 250. ) ;
 
  if ( fEMax < 20. ) {
 
    LOG("SPPXSec", pERROR) << "E max is required to be at least 20 GeV, you set " << fEMax << " GeV" ;
    good_conf = false ;
  }
 
  if ( ! good_conf ) {
    LOG("SPPXSec", pFATAL)
      << "Invalid configuration: Exiting" ;
    
    // From the FreeBSD Library Functions Manual
    //
    // EX_CONFIG (78)   Something was found in an unconfigured or miscon-
    //                  figured state.
    
    exit( 78 ) ;
    
  }
  
}

References e, genie::SPPXSecWithCache::fEMax, genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLMinEval, genie::XSecIntegratorI::fGSLRelTol, fUsePauliBlocking, genie::SPPXSecWithCache::fWcut, genie::Algorithm::GetParam(), genie::Algorithm::GetParamDef(), LOG, pERROR, and pFATAL.

Referenced by Configure(), and Configure().

Member Data Documentation

fUsePauliBlocking

bool genie::SPPXSec::fUsePauliBlocking

private

account for Pauli blocking?

Definition at line 55 of file SPPXSec.h.

Referenced by Integrate(), and LoadConfig().

---

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

• SPPXSec.h
• SPPXSec.cxx