genie::HadronTransporter Class Reference

Intranuclear hadronic transport module. It is being used to transfer all hadrons outside the nucleus without rescattering -if rescattering is switched off- or to call one of the supported hadron transport MCs -if rescattering is switched on-. More...

#include <HadronTransporter.h>

Inheritance diagram for genie::HadronTransporter:

Collaboration diagram for genie::HadronTransporter:

Public Member Functions
	HadronTransporter ()
	HadronTransporter (string config)
	~HadronTransporter ()
void	ProcessEventRecord (GHepRecord *event_rec) const
void	Configure (const Registry &config)
void	Configure (string param_set)
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	LoadConfig (void)
void	TransportInTransparentNuc (GHepRecord *ev) const

Private Attributes
bool	fEnabled
	hadron transport enabled?
const EventRecordVisitorI *	fHadTranspModel
	hadron transport MC to use
const EventRecordVisitorI *	fCascadeReweight
	Cascade reweight member.

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

Intranuclear hadronic transport module. It is being used to transfer all hadrons outside the nucleus without rescattering -if rescattering is switched off- or to call one of the supported hadron transport MCs -if rescattering is switched on-.

Author

Costas Andreopoulos <c.andreopoulos \at cern.ch> STFC, Rutherford Lab

Created:\n September 14, 2006

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 28 of file HadronTransporter.h.

Constructor & Destructor Documentation

HadronTransporter() [1/2]

HadronTransporter::HadronTransporter

(

)

Definition at line 43 of file HadronTransporter.cxx.

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

References genie::EventRecordVisitorI::EventRecordVisitorI().

HadronTransporter() [2/2]

HadronTransporter::HadronTransporter

(

string

config

)

Definition at line 49 of file HadronTransporter.cxx.

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

References genie::EventRecordVisitorI::EventRecordVisitorI().

~HadronTransporter()

HadronTransporter::~HadronTransporter

(

)

Definition at line 55 of file HadronTransporter.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

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

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

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

Configure() [2/2]

void HadronTransporter::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 133 of file HadronTransporter.cxx.

{
  Algorithm::Configure(param_set);
 
  Registry * algos = AlgConfigPool::Instance() -> GlobalParameterList() ;
  Registry r( "HadronTransporter_specific", false ) ;
 
  r.Set("HadronTransp-Enable", algos -> GetBool("HadronTransp-Enable") ) ;
  r.Set("HadronTransp-Model",  algos -> GetAlg("HadronTransp-Model")   ) ;
  if( algos->Exists("CascadeReweightAlg") ) {
    r.Set("CascadeReweightAlg",  algos -> GetAlg("CascadeReweightAlg")   ) ;
  }
 
  Algorithm::Configure(r) ;
 
  this->LoadConfig();
}

References genie::Algorithm::Configure(), genie::Registry::Exists(), genie::AlgConfigPool::Instance(), LoadConfig(), and genie::Registry::Set().

LoadConfig()

void HadronTransporter::LoadConfig ( void )

private

Definition at line 151 of file HadronTransporter.cxx.

{
  bool good_config = true ;
 
  fHadTranspModel = 0;
  GetParam("HadronTransp-Enable", fEnabled ) ;
 
  LOG("HadTransp", pDEBUG) 
       << "Hadron transport was " << ((fEnabled) ? "" : "not ") << " enabled";
  if(fEnabled) {
     RgAlg hadtransp_model ;
     GetParam( "HadronTransp-Model", hadtransp_model ) ;
     LOG("HadTransp", pDEBUG) 
         << "Loading the hadron transport model: " << hadtransp_model;
 
     fHadTranspModel = 
         dynamic_cast<const EventRecordVisitorI *> ( this -> SubAlg("HadronTransp-Model") );
 
     if(!fHadTranspModel){
       good_config = false ;
       LOG("HadronTransporter", pERROR) << "The SubAlg HadronTransp-Model is not a XSecAlgorithmI";
     }
 
     // Read optional CascadeReweight EventRecordVisitorI
     fCascadeReweight = nullptr; 
     if( GetConfig().Exists("CascadeReweightAlg") ) {
       fCascadeReweight = dynamic_cast<const CascadeReweight *> ( this->SubAlg("CascadeReweightAlg") );
       if( !fCascadeReweight ) {
         good_config = false ; 
         LOG("HadronTransporter", pERROR) << "The required CascadeReweightAlg does not exist. AlgID is : " << SubAlg("CascadeReweightAlg")->Id() ;
       }
     }
 
     if( ! good_config ) {
       LOG("HadronTransporter", pERROR) << "Configuration has failed.";
       exit(78) ;
     }
  }
}

References genie::EventRecordVisitorI::EventRecordVisitorI(), fCascadeReweight, fEnabled, fHadTranspModel, genie::Algorithm::GetConfig(), genie::Algorithm::GetParam(), genie::Algorithm::Id(), LOG, pDEBUG, pERROR, and genie::Algorithm::SubAlg().

Referenced by Configure(), and Configure().

ProcessEventRecord()

void HadronTransporter::ProcessEventRecord ( GHepRecord * event_rec ) const

virtual

Implements genie::EventRecordVisitorI.

Definition at line 60 of file HadronTransporter.cxx.

{
  // Return if the neutrino was not scatterred off a nuclear target
  GHepParticle * nucltgt = evrec->TargetNucleus();
  if (!nucltgt) {
    LOG("HadTransp", pINFO) 
           << "No nuclear target found - Hadron transporter exits";
    return;
  }
 
  // If rescattering is turned off but the interaction was on a nuclear
  // target then simply transfer the hadrons outside the nucleus inhibiting
  // any rescattering
  if(!fEnabled) {
    LOG("HadTransp", pNOTICE) 
             << "*** Intranuclear rescattering has been turned off";
    this->TransportInTransparentNuc(evrec);
    return;
  }
 
  // Use the specified intrsnuclear rescattering model
  LOG("HadTransp", pINFO)  << "Calling the selected hadron transport MC";
  fHadTranspModel->ProcessEventRecord(evrec);
 
  // Process Event record for the cascade reweight if required:
  if(fCascadeReweight) fCascadeReweight->ProcessEventRecord(evrec);
 
  return ;
}

References fCascadeReweight, fEnabled, fHadTranspModel, LOG, pINFO, pNOTICE, return, genie::GHepRecord::TargetNucleus(), and TransportInTransparentNuc().

TransportInTransparentNuc()

void HadronTransporter::TransportInTransparentNuc ( GHepRecord * ev ) const

private

Definition at line 90 of file HadronTransporter.cxx.

{
// Transport all hadrons assuming a transparent nucleus - used when the
// realistic hadron transport is tuned off.
 
  LOG("HadTransp", pNOTICE) 
     << "Getting the nucleons out of the nucleus as if it was transparent";
 
  TObjArrayIter piter(evrec);
  GHepParticle * p = 0;
  int icurr=-1;
 
  while( (p = (GHepParticle *) piter.Next()) )
  {
    icurr++;
    assert(p);
 
    // Check whether the particle needs rescattering, otherwise skip it
 
    bool had_in_nuc = (p->Status() == kIStHadronInTheNucleus);
    if(!had_in_nuc) continue;
 
    LOG("HadTransp", pINFO)
       << "Transporting " << p->Name() << " out of the nuclear target";
 
    // move it outside the nucleus
    GHepParticle * cp = new GHepParticle(*p); // create a clone
 
    cp->SetFirstMother(icurr);                // clone's mother
    cp->SetStatus(kIStStableFinalState);      // mark it & done with it
 
    evrec->AddParticle(*cp); // add it at the event record
 
    //LOG("HadronTransporter", pDEBUG) << *evrec;
  }
}

References genie::GHepRecord::AddParticle(), genie::kIStHadronInTheNucleus, genie::kIStStableFinalState, LOG, genie::GHepParticle::Name(), pINFO, pNOTICE, genie::GHepParticle::SetFirstMother(), genie::GHepParticle::SetStatus(), and genie::GHepParticle::Status().

Referenced by ProcessEventRecord().

Member Data Documentation

fCascadeReweight

const EventRecordVisitorI* genie::HadronTransporter::fCascadeReweight

private

Cascade reweight member.

Definition at line 49 of file HadronTransporter.h.

Referenced by LoadConfig(), and ProcessEventRecord().

fEnabled

bool genie::HadronTransporter::fEnabled

private

hadron transport enabled?

Definition at line 47 of file HadronTransporter.h.

Referenced by LoadConfig(), and ProcessEventRecord().

fHadTranspModel

const EventRecordVisitorI* genie::HadronTransporter::fHadTranspModel

private

hadron transport MC to use

Definition at line 48 of file HadronTransporter.h.

Referenced by LoadConfig(), and ProcessEventRecord().

---

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

• HadronTransporter.h
• HadronTransporter.cxx