Created this new module that controls the addition of the recoil nucleon in the event record and extracts its kinematics. More...

#include <SRCNuclearRecoil.h>

Inheritance diagram for genie::SRCNuclearRecoil:

[legend]

Collaboration diagram for genie::SRCNuclearRecoil:

[legend]

Public Member Functions
	SRCNuclearRecoil ()
	SRCNuclearRecoil (string config)
	~SRCNuclearRecoil ()
void	ProcessEventRecord (GHepRecord *event_rec) const
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::SecondNucleonEmissionI
virtual	~SecondNucleonEmissionI ()
Public Member Functions inherited from genie::EventRecordVisitorI
virtual	~EventRecordVisitorI ()
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 Member Functions
void	LoadConfig (void)
int	SRCRecoilPDG (const GHepParticle &nucleon, const Target &tgt) const
Protected Member Functions inherited from genie::SecondNucleonEmissionI
virtual bool	EmitSecondNucleon (GHepRecord *evrec, const int eject_nucleon_pdg) const
	SecondNucleonEmissionI (string name)
	SecondNucleonEmissionI (string name, string config)
void	LoadConfig (void)
Protected Member Functions inherited from genie::EventRecordVisitorI
	EventRecordVisitorI ()
	EventRecordVisitorI (string name)
	EventRecordVisitorI (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.

Private Attributes
double	fPPPairPercentage
double	fPNPairPercentage

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 Attributes inherited from genie::SecondNucleonEmissionI
const NuclearModelI *	fNuclModel
	nuclear model
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

Created this new module that controls the addition of the recoil nucleon in the event record and extracts its kinematics.

Author: Afroditi Papadopoulou <apapadop \at mit.edu> Massachusetts Institute of Technology - October 04, 2019

Created:\n October 04, 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 31 of file SRCNuclearRecoil.h.

Constructor & Destructor Documentation

◆ SRCNuclearRecoil() [1/2]

SRCNuclearRecoil::SRCNuclearRecoil ( )

Definition at line 51 of file SRCNuclearRecoil.cxx.

                                   :
SecondNucleonEmissionI("genie::SRCNuclearRecoil")
{
 
}

References genie::SecondNucleonEmissionI::SecondNucleonEmissionI().

◆ SRCNuclearRecoil() [2/2]

SRCNuclearRecoil::SRCNuclearRecoil ( string config )

Definition at line 57 of file SRCNuclearRecoil.cxx.

                                                :
  SecondNucleonEmissionI("genie::SRCNuclearRecoil", config )
{
 
}

References genie::SecondNucleonEmissionI::SecondNucleonEmissionI().

◆ ~SRCNuclearRecoil()

SRCNuclearRecoil::~SRCNuclearRecoil ( )

Definition at line 65 of file SRCNuclearRecoil.cxx.

{
 
}

Member Function Documentation

◆ Configure() [1/2]

void SRCNuclearRecoil::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 121 of file SRCNuclearRecoil.cxx.

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

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

◆ Configure() [2/2]

void SRCNuclearRecoil::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 127 of file SRCNuclearRecoil.cxx.

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

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

◆ LoadConfig()

void SRCNuclearRecoil::LoadConfig ( void )

protected

Definition at line 133 of file SRCNuclearRecoil.cxx.

{
 
  SecondNucleonEmissionI::LoadConfig() ;
 
  this->GetParamDef("PNPairPercentage",       fPNPairPercentage,    0.95);
 
  if (fPNPairPercentage < 0. || fPNPairPercentage > 1.) { 
 
        LOG("SRCNuclearRecoil", pFATAL)
        << "PNPairPercentage either less than 0 or greater than 1: Exiting" ;
 
        exit(78); 
  }
 
  fPPPairPercentage = 1. - fPNPairPercentage;
 
}

References fPNPairPercentage, fPPPairPercentage, genie::Algorithm::GetParamDef(), genie::SecondNucleonEmissionI::LoadConfig(), LOG, and pFATAL.

Referenced by Configure(), and Configure().

◆ ProcessEventRecord()

void SRCNuclearRecoil::ProcessEventRecord ( GHepRecord * event_rec ) const

virtual

Implements genie::EventRecordVisitorI.

Definition at line 72 of file SRCNuclearRecoil.cxx.

{
 
  const Interaction *  interaction = evrec       -> Summary();
  const InitialState & init_state  = interaction -> InitState();
  const Target       & tgt         = init_state.Tgt();
 
  // do nothing for non-nuclear targets
  if(! tgt.IsNucleus()) return;
 
  // access the hit nucleon and target nucleus at the GHEP record
  GHepParticle * nucleon = evrec->HitNucleon();
  GHepParticle * nucleus = evrec->TargetNucleus();
  assert(nucleon);
  assert(nucleus);
 
  // Set this to either a proton or neutron to eject a secondary particle
  int eject_nucleon_pdg = this->SRCRecoilPDG( *nucleon, tgt );
 
  // Ejection of secondary particle
  if (eject_nucleon_pdg != 0) { EmitSecondNucleon(evrec,eject_nucleon_pdg); }
 
}

References genie::SecondNucleonEmissionI::EmitSecondNucleon(), genie::GHepRecord::HitNucleon(), genie::Target::IsNucleus(), SRCRecoilPDG(), genie::GHepRecord::TargetNucleus(), and genie::InitialState::Tgt().

◆ SRCRecoilPDG()

int SRCNuclearRecoil::SRCRecoilPDG	(	const GHepParticle &	nucleon,
		const Target &	tgt ) const

protected

Definition at line 98 of file SRCNuclearRecoil.cxx.

                                                                                          {
 
      int eject_nucleon_pdg = 0;
 
      // const int nucleus_pdgc = tgt->Pdg();
      const int nucleon_pdgc = nucleon.Pdg();
 
      double pN2 = TMath::Power(nucleon.P4()->Rho(),2.); // (momentum of struck nucleon)^2
 
      double kF = fNuclModel -> LocalFermiMomentum( tgt, 
                                                    nucleon_pdgc, 
                                                    nucleon.X4()->Vect().Mag() );
 
      if (TMath::Sqrt(pN2) > kF) {
        double Pp = (nucleon_pdgc == kPdgProton) ? fPPPairPercentage : fPNPairPercentage;
        RandomGen * rnd = RandomGen::Instance();
        double prob = rnd->RndGen().Rndm();
        eject_nucleon_pdg = (prob > Pp) ? kPdgNeutron : kPdgProton;
      }
      
      return eject_nucleon_pdg;
}

References genie::SecondNucleonEmissionI::fNuclModel, fPNPairPercentage, fPPPairPercentage, genie::RandomGen::Instance(), genie::kPdgNeutron, genie::kPdgProton, genie::GHepParticle::P4(), genie::GHepParticle::Pdg(), genie::RandomGen::RndGen(), and genie::GHepParticle::X4().

Referenced by ProcessEventRecord().

Member Data Documentation

◆ fPNPairPercentage

double genie::SRCNuclearRecoil::fPNPairPercentage

private

Definition at line 56 of file SRCNuclearRecoil.h.

Referenced by LoadConfig(), and SRCRecoilPDG().

◆ fPPPairPercentage

double genie::SRCNuclearRecoil::fPPPairPercentage

private

Definition at line 55 of file SRCNuclearRecoil.h.

Referenced by LoadConfig(), and SRCRecoilPDG().

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SRCNuclearRecoil() [1/2]

◆ SRCNuclearRecoil() [2/2]

◆ ~SRCNuclearRecoil()

Member Function Documentation

◆ Configure() [1/2]

◆ Configure() [2/2]

◆ LoadConfig()

◆ ProcessEventRecord()

◆ SRCRecoilPDG()

Member Data Documentation

◆ fPNPairPercentage

◆ fPPPairPercentage