genie::NucBindEnergyAggregator Class Reference

A nuclear binding energy 'collector' which visits the event record, finds nucleons originating from within a nuclei and subtracts the binding energy they had in the nucleus. To record this action in the event record a hypothetical BINDINO is added to the event record. Is a concerete implementation of the EventRecordVisitorI interface. More...

#include <NucBindEnergyAggregator.h>

Inheritance diagram for genie::NucBindEnergyAggregator:

Collaboration diagram for genie::NucBindEnergyAggregator:

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

Private Attributes
bool	fAllowRecombination

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

A nuclear binding energy 'collector' which visits the event record, finds nucleons originating from within a nuclei and subtracts the binding energy they had in the nucleus. To record this action in the event record a hypothetical BINDINO is added to the event record. Is a concerete implementation of the EventRecordVisitorI interface.

Author

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

Created:\n November 19, 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 33 of file NucBindEnergyAggregator.h.

Constructor & Destructor Documentation

NucBindEnergyAggregator() [1/2]

NucBindEnergyAggregator::NucBindEnergyAggregator

(

)

Definition at line 36 of file NucBindEnergyAggregator.cxx.

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

References genie::EventRecordVisitorI::EventRecordVisitorI().

NucBindEnergyAggregator() [2/2]

NucBindEnergyAggregator::NucBindEnergyAggregator

(

string

config

)

Definition at line 42 of file NucBindEnergyAggregator.cxx.

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

References genie::EventRecordVisitorI::EventRecordVisitorI().

~NucBindEnergyAggregator()

NucBindEnergyAggregator::~NucBindEnergyAggregator

(

)

Definition at line 48 of file NucBindEnergyAggregator.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void NucBindEnergyAggregator::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 213 of file NucBindEnergyAggregator.cxx.

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

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

Configure() [2/2]

void NucBindEnergyAggregator::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 219 of file NucBindEnergyAggregator.cxx.

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

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

LoadConfig()

void NucBindEnergyAggregator::LoadConfig ( void )

private

Definition at line 225 of file NucBindEnergyAggregator.cxx.

{
        GetParamDef("AllowNuclRecombination",fAllowRecombination, true  ) ;
 
}

References fAllowRecombination, and genie::Algorithm::GetParamDef().

Referenced by Configure(), and Configure().

ProcessEventRecord()

void NucBindEnergyAggregator::ProcessEventRecord ( GHepRecord * event_rec ) const

virtual

Implements genie::EventRecordVisitorI.

Definition at line 53 of file NucBindEnergyAggregator.cxx.

{
  // Return if the neutrino was not scatterred off a nuclear target
  GHepParticle * nucltgt = evrec->TargetNucleus();
  if (!nucltgt) {
    LOG("Nuclear", pINFO)
        << "No nuclear target found - Not subtracting any binding energy";
    return;
  }
 
  // Loop over particles, find final state nucleons for which a removal 
  // energy has been set and subtract it from their energy
  TIter stdhep_iter(evrec);
  GHepParticle * p = 0;
 
  while( (p = (GHepParticle * ) stdhep_iter.Next()) ) {
 
     bool is_nucleon   = pdg::IsNeutronOrProton(p->Pdg());  
     bool in_fin_state = (p->Status() == kIStStableFinalState);
     bool had_bind_e   = (p->RemovalEnergy() > 0.);
 
     bool handle = is_nucleon && in_fin_state && had_bind_e;
     if(!handle) continue;
 
     //-- ask for the binding energy set by the nuclear model
     double bindE = p->RemovalEnergy();
     LOG("Nuclear", pINFO) << "Binding energy = " << bindE;
 
     //-- subtract this energy from the final state nucleon
     LOG("Nuclear", pINFO)
          << "Subtracting the binding energy from the escaped nucleon";
 
     double M  = p->Mass();
     double En = p->Energy();
     double KE = En-M;
 
     LOG("Nuclear", pINFO)  << "Kinetic energy before subtraction = " << KE;
     KE -= bindE;
 
     LOG("Nuclear", pINFO) << "Kinetic energy after subtraction = " << KE;
 
     En = KE+M;
 
     if(En>M || !fAllowRecombination) { 
         double pmag_old = p->P4()->P();
         double pmag_new = TMath::Sqrt(utils::math::NonNegative(En*En-M*M));
         double scale    = pmag_new / pmag_old;
         LOG("Nuclear", pINFO) 
             << "|pnew| = " << pmag_new << ", |pold| = " << pmag_old
             << ", scale = " << scale;
 
         double pxn = scale * p->Px();
         double pyn = scale * p->Py();
         double pzn = scale * p->Pz();
 
         double pxb = (1-scale) * p->Px();
         double pyb = (1-scale) * p->Py();
         double pzb = (1-scale) * p->Pz();
 
          p->SetEnergy ( En  );
          p->SetPx     ( pxn );
          p->SetPy     ( pyn );
          p->SetPz     ( pzn );
          p->SetRemovalEnergy(0);
 
          //-- and add a GHEP entry to record this in the event record and
          //   conserve energy/momentum
          LOG("Nuclear", pINFO)
             << "Adding a [BindingE] to account for nuclear binding energy";
 
          evrec->AddParticle(kPdgBindino, kIStStableFinalState, 
                                   -1,-1,-1,-1, pxb,pyb,pzb,bindE, 0,0,0,0);
     } else {
          LOG("Nuclear", pNOTICE)
               << "Nucleon is above the Fermi sea but can't escape the nucleus";
          LOG("Nuclear", pNOTICE)
               << "Recombining remnant nucleus + f/s nucleon";
 
 
          // find the remnant nucleus if corresponding cascade modules provide it
          int rnucpos = evrec->RemnantNucleusPosition();
 
          if (rnucpos != -1)
          {
            GHepParticle * rnucl = evrec->Particle(rnucpos);
 
            // mark both the remnant nucleus and the final state nucleon as 
            // intermediate states
            rnucl -> SetStatus(kIStIntermediateState);
            p     -> SetStatus(kIStIntermediateState);
 
            // figure out the recombined nucleus PDG code
            int Z = rnucl->Z();
            int A = rnucl->A();
            if(pdg::IsProton(p->Pdg())) Z++;
            A++;
            int ipdgc = pdg::IonPdgCode(A,Z);
 
            // add-up their 4-momenta
            double pxnuc = rnucl->Px() + p->Px();
            double pynuc = rnucl->Py() + p->Py();
            double pznuc = rnucl->Pz() + p->Pz();
            double Enuc  = rnucl->E()  + p->E();
 
            evrec->AddParticle(ipdgc, kIStStableFinalState,
                        rnucpos,-1,-1,-1, pxnuc,pynuc,pznuc,Enuc, 0,0,0,0);
          }
          else
          {
              // Find hadronic blob which is provided by Intranuke models
              GHepParticle *hblob = evrec->FindParticle(kPdgHadronicBlob  , kIStFinalStateNuclearRemnant, 0);
              // If there is no hadronic blob do nothing
              if (hblob == nullptr) return;
              p     -> SetStatus(kIStIntermediateState);
              
              // add-up their 4-momenta
              double pxhblob = hblob->Px() + p->Px();
              double pyhblob = hblob->Py() + p->Py();
              double pzhblob = hblob->Pz() + p->Pz();
              double Ehblob  = hblob->E()  + p->E();
              hblob->SetMomentum(pxhblob, pyhblob, pzhblob, Ehblob);
          }
     }
  }
}

References genie::GHepParticle::A(), genie::GHepRecord::AddParticle(), genie::GHepParticle::E(), genie::GHepParticle::Energy(), fAllowRecombination, genie::GHepRecord::FindParticle(), genie::pdg::IonPdgCode(), genie::pdg::IsNeutronOrProton(), genie::pdg::IsProton(), genie::kIStFinalStateNuclearRemnant, genie::kIStIntermediateState, genie::kIStStableFinalState, genie::kPdgBindino, genie::kPdgHadronicBlob, LOG, genie::GHepParticle::Mass(), genie::utils::math::NonNegative(), genie::GHepParticle::P4(), genie::GHepRecord::Particle(), genie::GHepParticle::Pdg(), pINFO, pNOTICE, genie::GHepParticle::Px(), genie::GHepParticle::Py(), genie::GHepParticle::Pz(), genie::GHepRecord::RemnantNucleusPosition(), genie::GHepParticle::RemovalEnergy(), genie::GHepParticle::SetEnergy(), genie::GHepParticle::SetMomentum(), genie::GHepParticle::SetPx(), genie::GHepParticle::SetPy(), genie::GHepParticle::SetPz(), genie::GHepParticle::SetRemovalEnergy(), genie::GHepParticle::Status(), genie::GHepRecord::TargetNucleus(), and genie::GHepParticle::Z().

Member Data Documentation

fAllowRecombination

bool genie::NucBindEnergyAggregator::fAllowRecombination

private

Definition at line 52 of file NucBindEnergyAggregator.h.

Referenced by LoadConfig(), and ProcessEventRecord().

---

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

• NucBindEnergyAggregator.h
• NucBindEnergyAggregator.cxx