genie::PauliBlocker Class Reference

Examines whether the generated event should be Pauli blocked. Is a concerete implementation of the EventRecordVisitorI interface. More...

#include <PauliBlocker.h>

Inheritance diagram for genie::PauliBlocker:

Collaboration diagram for genie::PauliBlocker:

Public Member Functions
	PauliBlocker ()
	PauliBlocker (string config)
	~PauliBlocker ()
void	ProcessEventRecord (GHepRecord *event_rec) const
void	Configure (const Registry &config)
void	Configure (string param_set)
double	GetFermiMomentum (const Target &tgt, int pdg_Nf, double radius=0.0) const
	Get the Fermi momentum needed to check Pauli blocking.
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.

Private Member Functions
void	LoadModelType (void)

Private Attributes
bool	fLFG
const FermiMomentumTable *	fKFTable
string	fKFTableName

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

Examines whether the generated event should be Pauli blocked. Is a concerete implementation of the EventRecordVisitorI interface.

Author

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

Changes required to implement the GENIE Boosted Dark Matter module were installed by Josh Berger (Univ. of Wisconsin)

Other code improvements, additions, fixes were installed by Joe Johnston (Univ of Pittsburgh)

Created:\n October 08, 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 36 of file PauliBlocker.h.

Constructor & Destructor Documentation

PauliBlocker() [1/2]

PauliBlocker::PauliBlocker

(

)

Definition at line 46 of file PauliBlocker.cxx.

                           :
EventRecordVisitorI("genie::PauliBlocker")
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

PauliBlocker() [2/2]

PauliBlocker::PauliBlocker

(

string

config

)

Definition at line 52 of file PauliBlocker.cxx.

                                        :
EventRecordVisitorI("genie::PauliBlocker",  config)
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

~PauliBlocker()

PauliBlocker::~PauliBlocker

(

)

Definition at line 58 of file PauliBlocker.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void PauliBlocker::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 130 of file PauliBlocker.cxx.

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

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

Configure() [2/2]

void PauliBlocker::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 136 of file PauliBlocker.cxx.

{
  Algorithm::Configure(param_set);
  this->LoadModelType();
}

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

GetFermiMomentum()

double PauliBlocker::GetFermiMomentum	(	const Target &	tgt,
		int	pdg_Nf,
		double	radius = 0.0 ) const

Get the Fermi momentum needed to check Pauli blocking.

Definition at line 168 of file PauliBlocker.cxx.

{
  // Pauli blocking should only be applied for nucleons
  assert( pdg::IsProton(pdg_Nf) || pdg::IsNeutron(pdg_Nf) );
  double kF = 0.;
  if ( fLFG ) {
    int A = tgt.A();
    bool is_p = pdg::IsProton( pdg_Nf );
    int numNuc = (is_p) ? tgt.Z() : tgt.N();
    double hbarc = kLightSpeed * kPlankConstant / units::fermi;
    kF = TMath::Power(3 * kPi2 * numNuc *
      genie::utils::nuclear::Density(radius, A), 1.0/3.0) * hbarc;
  }
  else {
    kF = fKFTable->FindClosestKF(tgt.Pdg(), pdg_Nf);
  }
 
  return kF;
}

References genie::Target::A(), genie::utils::nuclear::Density(), genie::units::fermi, fKFTable, fLFG, genie::pdg::IsNeutron(), genie::pdg::IsProton(), genie::constants::kLightSpeed, genie::constants::kPi2, genie::constants::kPlankConstant, genie::Target::N(), genie::Target::Pdg(), and genie::Target::Z().

Referenced by ProcessEventRecord().

LoadModelType()

void PauliBlocker::LoadModelType ( void )

private

Definition at line 142 of file PauliBlocker.cxx.

                                    {
  AlgConfigPool * confp = AlgConfigPool::Instance();
  const Registry * gc = confp->GlobalParameterList();
 
  // Create a nuclear model object to check the model type
  RgKey nuclkey = "NuclearModel";
  RgAlg nuclalg = gc->GetAlg(nuclkey);
  AlgFactory * algf = AlgFactory::Instance();
  const NuclearModelI* nuclModel =
    dynamic_cast<const NuclearModelI*>(
                             algf->GetAlgorithm(nuclalg.name,nuclalg.config));
  // Check if the model is a local Fermi gas
  fLFG = (nuclModel && nuclModel->ModelType(Target()) == kNucmLocalFermiGas);
 
  if ( !fLFG ) {
    // get the Fermi momentum table for relativistic Fermi gas
        GetParam( "FermiMomentumTable", fKFTableName ) ;
 
    fKFTable = 0;
 
    FermiMomentumTablePool * kftp = FermiMomentumTablePool::Instance();
    fKFTable = kftp->GetTable(fKFTableName);
    assert(fKFTable);
  }
}

References RgAlg::config, fKFTable, fKFTableName, fLFG, genie::Registry::GetAlg(), genie::AlgFactory::GetAlgorithm(), genie::Algorithm::GetParam(), genie::FermiMomentumTablePool::GetTable(), genie::AlgConfigPool::GlobalParameterList(), genie::AlgConfigPool::Instance(), genie::AlgFactory::Instance(), genie::FermiMomentumTablePool::Instance(), genie::kNucmLocalFermiGas, genie::NuclearModelI::ModelType(), and RgAlg::name.

Referenced by Configure(), and Configure().

ProcessEventRecord()

void PauliBlocker::ProcessEventRecord ( GHepRecord * event_rec ) const

virtual

Implements genie::EventRecordVisitorI.

Definition at line 63 of file PauliBlocker.cxx.

{
  // Return if the neutrino was not scatterred off a nuclear target
  GHepParticle * nucltgt = evrec->TargetNucleus();
  if (!nucltgt) {
    LOG("PauliBlock", pINFO)
            << "No nuclear target found - The Pauli Blocker exits";
    return;
  }
 
  // Handle only QEL for now...
  // (can also be dark matter elastic)
  Interaction * interaction = evrec->Summary();
  const ProcessInfo & proc = interaction->ProcInfo();
  if(!proc.IsQuasiElastic() && !proc.IsDarkMatterElastic()) {
    LOG("PauliBlock", pINFO) << "Not a QEL event - The Pauli Blocker exits";
    return;
  }
 
  // Get the particle representing the initial hit nucleon
  GHepParticle * hit = evrec->HitNucleon();
  assert(hit);
 
  // Get the particle representing the recoiling final nucleon
  GHepParticle * recoil = evrec->Particle(hit->FirstDaughter());
  assert(recoil);
  int nuc_pdgc = recoil->Pdg();
 
  const Target& tgt = interaction->InitState().Tgt();
  double radius = hit->X4()->Vect().Mag();
  double kf = this->GetFermiMomentum(tgt, nuc_pdgc, radius);
 
  LOG("PauliBlock", pINFO) << "KF = " << kf;
 
  // get the recoil momentum
  double p = recoil->P4()->P(); // |p| for the recoil nucleon
  LOG("PauliBlock", pINFO) << "Recoil nucleon |P| = " << p;
 
   // check for pauli blocking
  bool is_blocked = (p < kf);
 
  // if it is blocked, set & thow an exception
  if ( is_blocked ) {
    LOG("PauliBlock", pNOTICE)
      << " *** The generated event is Pauli-blocked ("
      << "|p_{nucleon}| = " << p << " GeV < Fermi momentum = " << kf << " GeV) ***";
 
    evrec->EventFlags()->SetBitNumber(kPauliBlock, true);
    genie::exceptions::EVGThreadException exception;
    exception.SetReason("Pauli-blocked event");
 
    // Include dark matter elastic
    if(proc.IsQuasiElastic() || proc.IsDarkMatterElastic()) {
      // nuclear suppression taken into account at the QEL cross
      // section - should attempt to regenerate the event as QEL
      exception.SwitchOnStepBack();
      exception.SetReturnStep(0);
    } else {
      // end this event generation thread and start again at the
      // interaction selection step
      // - this is irrelevant for the time being as we only handle QEL-
      exception.SwitchOnFastForward();
    }
    throw exception;
  }
}

References genie::GHepRecord::EventFlags(), genie::GHepParticle::FirstDaughter(), GetFermiMomentum(), genie::GHepRecord::HitNucleon(), genie::Interaction::InitState(), genie::ProcessInfo::IsDarkMatterElastic(), genie::ProcessInfo::IsQuasiElastic(), genie::kPauliBlock, LOG, genie::GHepParticle::P4(), genie::GHepRecord::Particle(), genie::GHepParticle::Pdg(), pINFO, pNOTICE, genie::Interaction::ProcInfo(), genie::exceptions::EVGThreadException::SetReason(), genie::exceptions::EVGThreadException::SetReturnStep(), genie::GHepRecord::Summary(), genie::exceptions::EVGThreadException::SwitchOnFastForward(), genie::exceptions::EVGThreadException::SwitchOnStepBack(), genie::GHepRecord::TargetNucleus(), genie::InitialState::Tgt(), and genie::GHepParticle::X4().

Member Data Documentation

fKFTable

const FermiMomentumTable* genie::PauliBlocker::fKFTable

private

Definition at line 59 of file PauliBlocker.h.

Referenced by GetFermiMomentum(), and LoadModelType().

fKFTableName

string genie::PauliBlocker::fKFTableName

private

Definition at line 60 of file PauliBlocker.h.

Referenced by LoadModelType().

fLFG

bool genie::PauliBlocker::fLFG

private

Definition at line 58 of file PauliBlocker.h.

Referenced by GetFermiMomentum(), and LoadModelType().

---

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

• PauliBlocker.h
• PauliBlocker.cxx