Computes the SuSAv2-QE model differential cross section. Uses precomputed hadron tensor tables. Is a concrete implementation of the XSecAlgorithmI interface. More...

#include <SuSAv2QELPXSec.h>

Inheritance diagram for genie::SuSAv2QELPXSec:

Public Member Functions
	SuSAv2QELPXSec ()

	SuSAv2QELPXSec (string config)

virtual	~SuSAv2QELPXSec ()

double	XSec (const Interaction *i, KinePhaseSpace_t k) const
	Compute the cross section for the input interaction. More...

double	Integral (const Interaction *i) const

bool	ValidProcess (const Interaction *i) const
	Can this cross section algorithm handle the input process? More...

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? More...

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

virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status. More...

virtual bool	AllowReconfig (void) const

virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm. More...

virtual void	SetId (const AlgId &id)
	Set algorithm ID. More...

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

Private Member Functions
void	LoadConfig (void)
	Load algorithm configuration. More...

Private Attributes
double	fXSecScale
	External scaling factor for this cross section. More...

const HadronTensorModelI *	fHadronTensorModel

string	fKFTable

double	fEbHe

double	fEbLi

double	fEbC

double	fEbO

double	fEbMg

double	fEbAr

double	fEbCa

double	fEbFe

double	fEbNi

double	fEbSn

double	fEbAu

double	fEbPb

const XSecIntegratorI *	fXSecIntegrator
	GSL numerical integrator. More...

const XSecAlgorithmI *	fFreeNucleonXSecAlg
	Alternate cross section model for free nucleon targets. More...

const QvalueShifter *	fQvalueShifter

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)

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

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

int	GetParamVectKeys (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 More...

int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership More...

int	MergeTopRegistry (const Registry &r)

int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships. More...

Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig

bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...) More...

AlgId	fID
	algorithm name and configuration set More...

vector< Registry * >	fConfVect

vector< bool >	fOwnerships
	ownership for every registry in fConfVect More...

AlgStatus_t	fStatus
	algorithm execution status More...

AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool) More...

Detailed Description

Computes the SuSAv2-QE model differential cross section. Uses precomputed hadron tensor tables. Is a concrete implementation of the XSecAlgorithmI interface.

Author: Steven Gardiner <gardiner fnal.gov> Fermi National Acclerator Laboratory

Stephen Dolan <stephen.joseph.dolan cern.ch> European Organization for Nuclear Research (CERN)

G::D. Megias et al., "Meson-exchange currents and quasielastic predictions for charged-current neutrino-12C scattering in the superscaling approach," PRD 91 (2015) 073004

November 2, 2018

Definition at line 40 of file SuSAv2QELPXSec.h.

Constructor & Destructor Documentation

SuSAv2QELPXSec::SuSAv2QELPXSec ( )

Definition at line 29 of file SuSAv2QELPXSec.cxx.

                                : XSecAlgorithmI("genie::SuSAv2QELPXSec")
 {
 }

SuSAv2QELPXSec::SuSAv2QELPXSec ( string config )

Definition at line 33 of file SuSAv2QELPXSec.cxx.

   : XSecAlgorithmI("genie::SuSAv2QELPXSec", config)
 {
 }

SuSAv2QELPXSec::~SuSAv2QELPXSec ( )

virtual

Definition at line 38 of file SuSAv2QELPXSec.cxx.

39 {

40 }

Member Function Documentation

void SuSAv2QELPXSec::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 280 of file SuSAv2QELPXSec.cxx.

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

void SuSAv2QELPXSec::Configure ( std::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 286 of file SuSAv2QELPXSec.cxx.

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

double SuSAv2QELPXSec::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 245 of file SuSAv2QELPXSec.cxx.

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

void SuSAv2QELPXSec::LoadConfig ( void )

private

Load algorithm configuration.

Definition at line 292 of file SuSAv2QELPXSec.cxx.

 {
   bool good_config = true ;
 
   // Cross section scaling factor
   GetParam( "QEL-CC-XSecScale", fXSecScale ) ;
 
   fHadronTensorModel = dynamic_cast< const SuSAv2QELHadronTensorModel* >(
     this->SubAlg("HadronTensorAlg") );
   assert( fHadronTensorModel );
 
   // Load XSec Integrator
   fXSecIntegrator = dynamic_cast<const XSecIntegratorI *>(
     this->SubAlg("XSec-Integrator") );
   assert( fXSecIntegrator );
 
   // Fermi momentum tables for scaling
   this->GetParam( "FermiMomentumTable", fKFTable);
 
   // Binding energy lookups for scaling
   this->GetParam( "RFG-NucRemovalE@Pdg=1000020040", fEbHe );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000030060", fEbLi );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000060120", fEbC  );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000080160", fEbO  );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000120240", fEbMg );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000180400", fEbAr );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000200400", fEbCa );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000260560", fEbFe );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000280580", fEbNi );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000501190", fEbSn );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000791970", fEbAu );
   this->GetParam( "RFG-NucRemovalE@Pdg=1000822080", fEbPb );
 
   // Read optional QvalueShifter:
   // Read optional QvalueShifter:                                                                                   
   fQvalueShifter = nullptr;                                                                                        
   if( GetConfig().Exists("QvalueShifterAlg") ) {            
     
     fQvalueShifter = dynamic_cast<const QvalueShifter *> ( this->SubAlg("QvalueShifterAlg") );      
 
     if( !fQvalueShifter ) {                                                      
 
       good_config = false ;                                                    
                                   
       LOG("SuSAv2QE", pERROR) << "The required QvalueShifterAlg is not valid. AlgID is : " 
                               << SubAlg("QvalueShifterAlg")->Id() ;    
     }                                                                                                               
   }  // if there is a requested QvalueShifteralgo                                                                                                                
   if( ! good_config ) {
     LOG("SuSAv2QE", pERROR) << "Configuration has failed.";
     exit(78) ;
   }
  
 
 }

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

virtual

Can this cross section algorithm handle the input process?

Implements genie::XSecAlgorithmI.

Definition at line 251 of file SuSAv2QELPXSec.cxx.

 {
   if ( interaction->TestBit(kISkipProcessChk) ) return true;
 
   const InitialState & init_state = interaction->InitState();
   const ProcessInfo &  proc_info  = interaction->ProcInfo();
 
   if ( !proc_info.IsQuasiElastic() ) return false;
 
   // The SuSAv2 calculation is only appropriate for complex nuclear targets,
   // not free nucleons.
   if ( !init_state.Tgt().IsNucleus() ) return false;
 
   int  nuc = init_state.Tgt().HitNucPdg();
   int  nu  = init_state.ProbePdg();
 
   bool isP   = pdg::IsProton(nuc);
   bool isN   = pdg::IsNeutron(nuc);
   bool isnu  = pdg::IsNeutrino(nu);
   bool isnub = pdg::IsAntiNeutrino(nu);
   bool is_chgl = pdg::IsChargedLepton(nu);
 
   bool prcok = ( proc_info.IsWeakCC() && ((isP && isnub) || (isN && isnu)) )
     || ( proc_info.IsEM() && is_chgl && (isP || isN) );
   if ( !prcok ) return false;
 
   return true;
 }

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

virtual

Compute the cross section for the input interaction.

Implements genie::XSecAlgorithmI.

Definition at line 42 of file SuSAv2QELPXSec.cxx.

 {
   if ( !this->ValidProcess(interaction) ) return 0.;
 
   // Get the hadron tensor for the selected nuclide. Check the probe PDG code
   // to know whether to use the tensor for CC neutrino scattering or for
   // electron scattering
   int target_pdg = interaction->InitState().Tgt().Pdg();
   int probe_pdg = interaction->InitState().ProbePdg();
   int tensor_pdg = target_pdg;
   int A_request = pdg::IonPdgCodeToA(target_pdg);
   bool need_to_scale = false;
 
   HadronTensorType_t tensor_type = kHT_Undefined;
   if ( pdg::IsNeutrino(probe_pdg) || pdg::IsAntiNeutrino(probe_pdg) ) {
     tensor_type = kHT_QE_Full;
   }
   else {
     // If the probe is not a neutrino, assume that it's an electron
     tensor_type = kHT_QE_EM;
   }
 
   double Eb_tgt=0;
   double Eb_ten=0;
 
   if ( A_request <= 4 ) {
     // Use carbon tensor for very light nuclei. This is not ideal . . .
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbHe; Eb_ten=fEbC;
   }
   else if (A_request < 9) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbLi; Eb_ten=fEbC;
   }
   else if (A_request >= 9 && A_request < 15) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbC; Eb_ten=fEbC;
   }
   else if(A_request >= 15 && A_request < 22) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbO; Eb_ten=fEbC;
   }
   else if(A_request >= 22 && A_request < 40) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbMg; Eb_ten=fEbC;
   }
   else if(A_request >= 40 && A_request < 56) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbAr; Eb_ten=fEbC;
   }
   else if(A_request >= 56 && A_request < 119) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbFe; Eb_ten=fEbC;
   }
   else if(A_request >= 119 && A_request < 206) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbSn; Eb_ten=fEbC;
   }
   else if(A_request >= 206) {
     tensor_pdg = kPdgTgtC12;
     Eb_tgt=fEbPb; Eb_ten=fEbC;
   }
 
   if (tensor_pdg != target_pdg) need_to_scale = true;
 
   // The SuSAv2-1p1h hadron tensors are defined using the same conventions
   // as the Valencia MEC (and SuSAv2-MEC) model, so we can use the same sort of tensor
   // object to describe them.
   const LabFrameHadronTensorI* tensor
     = dynamic_cast<const LabFrameHadronTensorI*>( fHadronTensorModel->GetTensor(tensor_pdg,
     tensor_type) );
 
   // If retrieving the tensor failed, complain and return zero
   if ( !tensor ) {
     LOG("SuSAv2QE", pWARN) << "Failed to load a hadronic tensor for the"
       " nuclide " << tensor_pdg;
     return 0.;
   }
 
   // Check that the input kinematical point is within the range
   // in which hadron tensors are known (for chosen target)
   double Ev    = interaction->InitState().ProbeE(kRfLab);
   double Tl    = interaction->Kine().GetKV(kKVTl);
   double costl = interaction->Kine().GetKV(kKVctl);
   double ml    = interaction->FSPrimLepton()->Mass();
   double Q0    = 0.;
   double Q3    = 0.;
 
   // SD: The Q-Value essentially corrects q0 to account for nuclear
   // binding energy in the Valencia model but this effect is already
   // in Guille's tensors so I'll set it to 0.
   // However, if I want to scale I need to account for the altered
   // binding energy. To first order I can use the Delta_Q_value for this
   double Delta_Q_value = Eb_tgt-Eb_ten;
 
   // Apply Qvalue relative shift if needed:
   if( fQvalueShifter ) {
     // We have the option to add an additional shift on top of the binding energy correction
     // The QvalueShifter, is a relative shift to the Q_value. 
     // The Q_value was already taken into account in the hadron tensor. Here we recalculate it
     // to get the right absolute shift. 
     double tensor_Q_value = genie::utils::mec::Qvalue(tensor_pdg,probe_pdg);
     double total_Q_value = tensor_Q_value + Delta_Q_value ; 
     double Q_value_shift = total_Q_value * fQvalueShifter -> Shift( interaction->InitState().Tgt() ) ; 
     Delta_Q_value += Q_value_shift ;
   }
 
   genie::utils::mec::Getq0q3FromTlCostl(Tl, costl, Ev, ml, Q0, Q3);
 
   double Q0min = tensor->q0Min();
   double Q0max = tensor->q0Max();
   double Q3min = tensor->qMagMin();
   double Q3max = tensor->qMagMax();
   if (Q0-Delta_Q_value < Q0min || Q0-Delta_Q_value > Q0max || Q3 < Q3min || Q3 > Q3max) {
     return 0.0;
   }
 
   // *** Enforce the global Q^2 cut (important for EM scattering) ***
   // Choose the appropriate minimum Q^2 value based on the interaction
   // mode (this is important for EM interactions since the differential
   // cross section blows up as Q^2 --> 0)
   double Q2min = genie::controls::kMinQ2Limit; // CC/NC limit
   if ( interaction->ProcInfo().IsEM() ) Q2min = genie::utils::kinematics
     ::electromagnetic::kMinQ2Limit; // EM limit
 
   // Neglect shift due to binding energy. The cut is on the actual
   // value of Q^2, not the effective one to use in the tensor contraction.
   double Q2 = Q3*Q3 - Q0*Q0;
   if ( Q2 < Q2min ) return 0.;
 
   // Compute the cross section using the hadron tensor
   double xsec = tensor->dSigma_dT_dCosTheta_rosenbluth(interaction, Delta_Q_value);
   LOG("SuSAv2QE", pDEBUG) << "XSec in cm2 / neutron is  " << xsec/(units::cm2);
 
   // Currently the SuSAv2 QE hadron tensors are given per active nucleon, but
   // the calculation above assumes they are per atom. Need to adjust for this.
   const ProcessInfo& proc_info = interaction->ProcInfo();
 
   // Neutron, proton, and mass numbers of the target
   const Target& tgt = interaction->InitState().Tgt();
   if ( proc_info.IsWeakCC() ) {
     if ( pdg::IsNeutrino(probe_pdg) ) xsec *= tgt.N();
     else if ( pdg::IsAntiNeutrino(probe_pdg) ) xsec *= tgt.Z();
     else {
       // We should never get here if ValidProcess() is working correctly
       LOG("SuSAv2QE", pERROR) << "Unrecognized probe " << probe_pdg
         << " encountered for a WeakCC process";
       xsec = 0.;
     }
   }
   else if ( proc_info.IsEM() || proc_info.IsWeakNC() ) {
     // For EM processes, scale by the number of nucleons of the same type
     // as the struck one. This ensures the correct ratio of initial-state
     // p vs. n when making splines. The nuclear cross section is obtained
     // by scaling by A/2 for an isoscalar target, so we can get the right
     // behavior for all targets by scaling by Z/2 or N/2 as appropriate.
     // Do the same for NC. TODO: double-check that this is the right
     // thing to do when we SuSAv2 NC hadronic tensors are added to GENIE.
     int hit_nuc_pdg = tgt.HitNucPdg();
     if ( pdg::IsProton(hit_nuc_pdg) ) xsec *= tgt.Z() / 2.;
     else if ( pdg::IsNeutron(hit_nuc_pdg) ) xsec *= tgt.N() / 2.;
     // We should never get here if ValidProcess() is working correctly
     else return 0.;
   }
   else {
     // We should never get here if ValidProcess() is working correctly
     LOG("SuSAv2QE", pERROR) << "Unrecognized process " << proc_info.AsString()
       << " encountered in SuSAv2QELPXSec::XSec()";
     xsec = 0.;
   }
 
   LOG("SuSAv2QE", pDEBUG) << "XSec in cm2 / atom is  " << xsec / units::cm2;
 
   // This scaling should be okay-ish for the total xsec, but it misses
   // the energy shift. To get this we should really just build releveant
   // hadron tensors but there may be some ways to approximate it.
   // For more details see Guille's thesis: https://idus.us.es/xmlui/handle/11441/74826
   if ( need_to_scale ) {
     FermiMomentumTablePool * kftp = FermiMomentumTablePool::Instance();
     const FermiMomentumTable * kft = kftp->GetTable(fKFTable);
     double KF_tgt = kft->FindClosestKF(target_pdg, kPdgProton);
     double KF_ten = kft->FindClosestKF(tensor_pdg, kPdgProton);
     LOG("SuSAv2QE", pDEBUG) << "KF_tgt = " << KF_tgt;
     LOG("SuSAv2QE", pDEBUG) << "KF_ten = " << KF_ten;
     double scaleFact = (KF_ten/KF_tgt); // A-scaling already applied in section above
     xsec *= scaleFact;
   }
 
   // Apply given overall scaling factor
   xsec *= fXSecScale;
 
   if ( kps != kPSTlctl ) {
     LOG("SuSAv2QE", pWARN)
       << "Doesn't support transformation from "
       << KinePhaseSpace::AsString(kPSTlctl) << " to "
       << KinePhaseSpace::AsString(kps);
     xsec = 0.;
   }
 
   return xsec;
 }

Member Data Documentation

double genie::SuSAv2QELPXSec::fEbAr

private

Definition at line 77 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbAu

private

Definition at line 82 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbC

private

Definition at line 74 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbCa

private

Definition at line 78 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbFe

private

Definition at line 79 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbHe

private

Definition at line 72 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbLi

private

Definition at line 73 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbMg

private

Definition at line 76 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbNi

private

Definition at line 80 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbO

private

Definition at line 75 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbPb

private

Definition at line 83 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fEbSn

private

Definition at line 81 of file SuSAv2QELPXSec.h.

const XSecAlgorithmI* genie::SuSAv2QELPXSec::fFreeNucleonXSecAlg

private

Alternate cross section model for free nucleon targets.

Definition at line 89 of file SuSAv2QELPXSec.h.

const HadronTensorModelI* genie::SuSAv2QELPXSec::fHadronTensorModel

private

Definition at line 66 of file SuSAv2QELPXSec.h.

string genie::SuSAv2QELPXSec::fKFTable

private

Definition at line 69 of file SuSAv2QELPXSec.h.

const QvalueShifter* genie::SuSAv2QELPXSec::fQvalueShifter

private

Definition at line 91 of file SuSAv2QELPXSec.h.

const XSecIntegratorI* genie::SuSAv2QELPXSec::fXSecIntegrator

private

GSL numerical integrator.

Definition at line 86 of file SuSAv2QELPXSec.h.

double genie::SuSAv2QELPXSec::fXSecScale

private

External scaling factor for this cross section.

Definition at line 64 of file SuSAv2QELPXSec.h.

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

Generator/src/Physics/QuasiElastic/XSection/SuSAv2QELPXSec.h
Generator/src/Physics/QuasiElastic/XSection/SuSAv2QELPXSec.cxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation