genie::AlamSimoAtharVacasSKXSec Class Reference

A cross-section integrator and GSL interface for the M. Rafi Alam, I. Ruiz Simo, M. Sajjad Athar and M.J. Vicente Vacas single-Kaon production model. Is a concrete implementation of the XSecIntegratorI interface. More...

#include <AlamSimoAtharVacasSKXSec.h>

Inheritance diagram for genie::AlamSimoAtharVacasSKXSec:

Collaboration diagram for genie::AlamSimoAtharVacasSKXSec:

Public Member Functions
	AlamSimoAtharVacasSKXSec ()
	AlamSimoAtharVacasSKXSec (string config)
virtual	~AlamSimoAtharVacasSKXSec ()
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.

Protected Attributes
bool	fSplitIntegral
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)

Private Member Functions
void	LoadConfig (void)

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::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.

Detailed Description

A cross-section integrator and GSL interface for the M. Rafi Alam, I. Ruiz Simo, M. Sajjad Athar and M.J. Vicente Vacas single-Kaon production model. Is a concrete implementation of the XSecIntegratorI interface.

Author

Chris Marshall and Martti Nirkko

Created:\n March 20, 2014

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 34 of file AlamSimoAtharVacasSKXSec.h.

Constructor & Destructor Documentation

AlamSimoAtharVacasSKXSec() [1/2]

AlamSimoAtharVacasSKXSec::AlamSimoAtharVacasSKXSec

(

)

Definition at line 40 of file AlamSimoAtharVacasSKXSec.cxx.

                                                   :
XSecIntegratorI("genie::AlamSimoAtharVacasSKXSec")
{
 
}

References genie::XSecIntegratorI::XSecIntegratorI().

AlamSimoAtharVacasSKXSec() [2/2]

AlamSimoAtharVacasSKXSec::AlamSimoAtharVacasSKXSec

(

string

config

)

Definition at line 46 of file AlamSimoAtharVacasSKXSec.cxx.

                                                                :
XSecIntegratorI("genie::AlamSimoAtharVacasSKXSec", config)
{
 
}

References genie::XSecIntegratorI::XSecIntegratorI().

~AlamSimoAtharVacasSKXSec()

AlamSimoAtharVacasSKXSec::~AlamSimoAtharVacasSKXSec ( )

virtual

Definition at line 52 of file AlamSimoAtharVacasSKXSec.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void AlamSimoAtharVacasSKXSec::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 145 of file AlamSimoAtharVacasSKXSec.cxx.

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

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

Configure() [2/2]

void AlamSimoAtharVacasSKXSec::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 151 of file AlamSimoAtharVacasSKXSec.cxx.

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

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

Integrate()

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

virtual

Implements genie::XSecIntegratorI.

Definition at line 57 of file AlamSimoAtharVacasSKXSec.cxx.

{
  LOG("SKXSec", pDEBUG) << "Integrating the Alam Simo Athar Vacas model";
 
  const InitialState & init_state = in -> InitState();
 
  if(! model->ValidProcess(in) ) return 0.;
 
  const KPhaseSpace & kps = in->PhaseSpace(); // only OK phase space for this
  if(!kps.IsAboveThreshold()) {
     LOG("SKXSec", pDEBUG)  << "*** Below energy threshold";
     return 0;
  }
 
  // 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.
  // Cross section for PP scales with number of protons, NP and NN scale
  // with number of neutrons
  int nucpdgc = init_state.Tgt().HitNucPdg();
  int NNucl   = (pdg::IsProton(nucpdgc)) ?
                   init_state.Tgt().Z() : init_state.Tgt().N();
  double Ev = init_state.ProbeE(kRfHitNucRest);
 
  XSecSplineList * xsl = XSecSplineList::Instance();
  if(init_state.Tgt().IsNucleus() && !xsl->IsEmpty() ) {
    Interaction * interaction = new Interaction(*in);
    Target * target = interaction->InitStatePtr()->TgtPtr();
    if(pdg::IsProton(nucpdgc)) { target->SetId(kPdgTgtFreeP); }
    else                       { target->SetId(kPdgTgtFreeN); }
    if(xsl->SplineExists(model,interaction)) {
      const Spline * spl = xsl->GetSpline(model, interaction);
      double xsec = spl->Evaluate(Ev);
      LOG("SKXSec", pINFO)
        << "From XSecSplineList: XSec[SK,free nucleon] (E = " << Ev << " GeV) = " << xsec;
      if(! interaction->TestBit(kIAssumeFreeNucleon) ) {
          xsec *= NNucl;
          LOG("SKXSec", pINFO)  << "XSec[SK] (E = " << Ev << " GeV) = " << xsec;
      }
      delete interaction;
      return xsec;
    }
    delete interaction;
  }
 
  // no free nucelon spline exists -- do the integration
 
  // Check this
  double Enu = init_state.ProbeE(kRfLab);
  int kpdg = in->ExclTag().StrangeHadronPdg();
  double mk   = PDGLibrary::Instance()->Find(kpdg)->Mass();
  double ml   = PDGLibrary::Instance()->Find(in->FSPrimLeptonPdg())->Mass();
 
  // integration bounds for T (kinetic energy)
  double zero    = 0.0;
  double tmax = Enu - mk - ml;
 
  LOG("SKXSec", pDEBUG)
       << "Lepton/Kaon KE integration range = [" << 0.0 << ", " << tmax << "]";
 
  Interaction * interaction = new Interaction(*in);
  interaction->SetBit(kISkipProcessChk);
  interaction->SetBit(kISkipKinematicChk);
 
  double xsec = 0;
 
  // do the integration over log(1-costheta) so it's not so sharply peaked
 
  ROOT::Math::IBaseFunctionMultiDim * func =
        new utils::gsl::d3Xsec_dTldTkdCosThetal(model, interaction);
  double kine_min[3] = { zero, zero, -20 }; // Tlep, Tkaon, cosine theta lep
  double kine_max[3] = { tmax, tmax,  0.69314718056 }; // Tlep, Tkaon, cosine theta lep
 
  ROOT::Math::IntegrationMultiDim::Type ig_type =
    utils::gsl::IntegrationNDimTypeFromString(fGSLIntgType);
 
  double abstol = 1; //We mostly care about relative tolerance.
  ROOT::Math::IntegratorMultiDim ig(*func, ig_type, abstol, fGSLRelTol, fGSLMaxEval);
 
  xsec = ig.Integral(kine_min, kine_max) * (1E-38 * units::cm2);
  delete func;
 
  delete interaction;
 
  return xsec;
}

References genie::units::cm2, genie::Spline::Evaluate(), genie::Interaction::ExclTag(), genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLRelTol, genie::PDGLibrary::Find(), genie::Interaction::FSPrimLeptonPdg(), func(), genie::XSecSplineList::GetSpline(), genie::Target::HitNucPdg(), genie::Interaction::InitStatePtr(), genie::PDGLibrary::Instance(), genie::XSecSplineList::Instance(), genie::utils::gsl::IntegrationNDimTypeFromString(), genie::KPhaseSpace::IsAboveThreshold(), genie::XSecSplineList::IsEmpty(), genie::Target::IsNucleus(), genie::pdg::IsProton(), genie::kIAssumeFreeNucleon, genie::kISkipKinematicChk, genie::kISkipProcessChk, genie::kPdgTgtFreeN, genie::kPdgTgtFreeP, genie::kRfHitNucRest, genie::kRfLab, LOG, genie::Target::N(), pDEBUG, genie::Interaction::PhaseSpace(), pINFO, genie::InitialState::ProbeE(), genie::Target::SetId(), genie::XSecSplineList::SplineExists(), genie::XclsTag::StrangeHadronPdg(), genie::InitialState::Tgt(), genie::InitialState::TgtPtr(), genie::XSecAlgorithmI::ValidProcess(), and genie::Target::Z().

LoadConfig()

void AlamSimoAtharVacasSKXSec::LoadConfig ( void )

private

Definition at line 157 of file AlamSimoAtharVacasSKXSec.cxx.

{
  // Get GSL integration type & relative tolerance
  this->GetParamDef("gsl-integration-type" ,  fGSLIntgType,   string("vegas") );
  this->GetParamDef("gsl-max-evals",          fGSLMaxEval,    20000);
  this->GetParamDef("gsl-relative-tolerance", fGSLRelTol,     0.01);
  this->GetParamDef("split-integral",         fSplitIntegral, true);
}

References genie::XSecIntegratorI::fGSLIntgType, genie::XSecIntegratorI::fGSLMaxEval, genie::XSecIntegratorI::fGSLRelTol, fSplitIntegral, and genie::Algorithm::GetParamDef().

Referenced by Configure(), and Configure().

Member Data Documentation

fSplitIntegral

bool genie::AlamSimoAtharVacasSKXSec::fSplitIntegral

protected

Definition at line 49 of file AlamSimoAtharVacasSKXSec.h.

Referenced by LoadConfig().

---

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

• AlamSimoAtharVacasSKXSec.h
• AlamSimoAtharVacasSKXSec.cxx