genie::VertexGenerator Class Reference

#include <VertexGenerator.h>

Inheritance diagram for genie::VertexGenerator:

Collaboration diagram for genie::VertexGenerator:

Public Member Functions
	VertexGenerator ()
	VertexGenerator (string config)
	~VertexGenerator ()
void	ProcessEventRecord (GHepRecord *event_rec) const
void	Configure (const Registry &config)
void	Configure (string param_set)
TVector3	GenerateVertex (const Interaction *in, double A) const
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
int	fVtxGenMethod
	vtx generation method (0: uniform, 1: according to nuclear density [def])
double	fR0
	parameter controlling nuclear sizes

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

Author

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

Created:\n June 16, 2007

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 27 of file VertexGenerator.h.

Constructor & Destructor Documentation

VertexGenerator() [1/2]

VertexGenerator::VertexGenerator

(

)

Definition at line 34 of file VertexGenerator.cxx.

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

References genie::EventRecordVisitorI::EventRecordVisitorI().

VertexGenerator() [2/2]

VertexGenerator::VertexGenerator

(

string

config

)

Definition at line 40 of file VertexGenerator.cxx.

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

References genie::EventRecordVisitorI::EventRecordVisitorI().

~VertexGenerator()

VertexGenerator::~VertexGenerator

(

)

Definition at line 46 of file VertexGenerator.cxx.

{
 
}

Member Function Documentation

Configure() [1/2]

void VertexGenerator::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 78 of file VertexGenerator.cxx.

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

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

Referenced by genie::LwlynSmithQELCCPXSec::Integral().

Configure() [2/2]

void VertexGenerator::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 84 of file VertexGenerator.cxx.

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

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

GenerateVertex()

TVector3 VertexGenerator::GenerateVertex	(	const Interaction *	in,
		double	A ) const

Definition at line 98 of file VertexGenerator.cxx.

                                                        {
  RandomGen * rnd = RandomGen::Instance();
  TVector3 vtx(999999.,999999.,999999.);
 
  //GHepParticle * nucltgt = evrec->TargetNucleus();
 
  bool uniform   = fVtxGenMethod==0;
  bool realistic = !uniform;
 
  //if(!nucltgt) {
  //vtx.SetXYZ(0.,0.,0.);
  //}
  //else {
    //double A = nucltgt->A();
  double R = fR0 * TMath::Power(A, 1./3.);
 
  //Interaction * interaction = evrec->Summary();
  const ProcessInfo & proc_info = interaction->ProcInfo();
  bool is_coh = proc_info.IsCoherentProduction() || proc_info.IsCoherentElastic();
  bool is_ve  = proc_info.IsInverseMuDecay() ||
    proc_info.IsIMDAnnihilation() ||
    proc_info.IsNuElectronElastic() ||
    proc_info.IsGlashowResonance() ||
    proc_info.IsPhotonResonance() ||
    proc_info.IsPhotonCoherent();
 
  if(is_coh||is_ve) {
    // ** For COH or ve- set a vertex positon on the nuclear boundary
    //
    LOG("Vtx", pINFO)  << "Setting vertex on the nuclear boundary";
    double phi      = 2*kPi * rnd->RndFsi().Rndm();
    double cosphi   = TMath::Cos(phi);
    double sinphi   = TMath::Sin(phi);
    double costheta = -1 + 2 * rnd->RndFsi().Rndm();
    double sintheta = TMath::Sqrt(1-costheta*costheta);
    vtx.SetX(R*sintheta*cosphi);
    vtx.SetY(R*sintheta*sinphi);
    vtx.SetZ(R*costheta);
  }
  else {
    // ** For other events on nuclear targets set the interaction vertex
    // ** using the requested method: either using a realistic nuclear
    // ** density or by setting it uniformly within the nucleus
    //
    if(realistic) {
      // Generate the vertex using a realistic nuclear density
      //
      LOG("Vtx", pINFO)
        << "Generating vertex according to a realistic nuclear density profile";
      // get inputs to the rejection method
      double ymax = -1;
      double rmax = 3*R;
      double dr   = R/40.;
      for(double r = 0; r < rmax; r+=dr) {
        ymax = TMath::Max(ymax, r*r * utils::nuclear::Density(r,(int)A));
      }
      ymax *= 1.2;
 
      // select a vertex using the rejection method
      unsigned int iter = 0;
      while(1) {
        iter++;
 
        // throw an exception if it hasn't find a solution after many attempts
        if(iter > kRjMaxIterations) {
          LOG("Vtx", pWARN)
            << "Couldn't generate a vertex position after " << iter << " iterations";
          //evrec->EventFlags()->SetBitNumber(kGenericErr, true);
          genie::exceptions::EVGThreadException exception;
          exception.SetReason("Couldn't generate vertex");
          exception.SwitchOnFastForward();
          throw exception;
        }
 
        double r = rmax * rnd->RndFsi().Rndm();
        double t = ymax * rnd->RndFsi().Rndm();
        double y = r*r * utils::nuclear::Density(r,(int)A);
        if(y > ymax) {
          LOG("Vtx", pERROR)
            << "y = " << y << " > ymax = " << ymax
            << " for r = " << r << ", A = " << A;
        }
        bool accept = (t < y);
        if(accept) {
          double phi      = 2*kPi * rnd->RndFsi().Rndm();
          double cosphi   = TMath::Cos(phi);
          double sinphi   = TMath::Sin(phi);
          double costheta = -1 + 2 * rnd->RndFsi().Rndm();
          double sintheta = TMath::Sqrt(1-costheta*costheta);
          vtx.SetX(r*sintheta*cosphi);
          vtx.SetY(r*sintheta*sinphi);
          vtx.SetZ(r*costheta);
          break;
        }
      }//w(1)
    } //use density?
 
    if(uniform) {
      // Generate the vertex uniformly within the nucleus
      //
      LOG("Vtx", pINFO)
        << "Generating intranuclear vertex uniformly in volume";
      while(vtx.Mag() > R) {
        vtx.SetX(-R + 2*R * rnd->RndFsi().Rndm());
        vtx.SetY(-R + 2*R * rnd->RndFsi().Rndm());
        vtx.SetZ(-R + 2*R * rnd->RndFsi().Rndm());
      }
    }// uniform?
 
  } // coh or ve-?
    //} // nuclear target ?
 
  LOG("Vtx", pINFO)
    << "Generated vtx @ r = " << vtx.Mag() << " fm / "
    << print::Vec3AsString(&vtx);
  return vtx;
}

References genie::utils::nuclear::Density(), fR0, fVtxGenMethod, genie::RandomGen::Instance(), genie::ProcessInfo::IsCoherentElastic(), genie::ProcessInfo::IsCoherentProduction(), genie::ProcessInfo::IsGlashowResonance(), genie::ProcessInfo::IsIMDAnnihilation(), genie::ProcessInfo::IsInverseMuDecay(), genie::ProcessInfo::IsNuElectronElastic(), genie::ProcessInfo::IsPhotonCoherent(), genie::ProcessInfo::IsPhotonResonance(), genie::constants::kPi, genie::controls::kRjMaxIterations, LOG, pERROR, pINFO, genie::Interaction::ProcInfo(), pWARN, genie::RandomGen::RndFsi(), genie::exceptions::EVGThreadException::SetReason(), genie::exceptions::EVGThreadException::SwitchOnFastForward(), and genie::utils::print::Vec3AsString().

Referenced by genie::LwlynSmithQELCCPXSec::Integral(), genie::NewQELXSec::Integrate(), and ProcessEventRecord().

LoadConfig()

void VertexGenerator::LoadConfig ( void )

private

Definition at line 90 of file VertexGenerator.cxx.

{
 
  GetParam( "VtxGenerationMethod", fVtxGenMethod ) ;
  GetParam( "NUCL-R0",             fR0 ) ;  //fm
 
}

References fR0, fVtxGenMethod, and genie::Algorithm::GetParam().

Referenced by Configure(), and Configure().

ProcessEventRecord()

void VertexGenerator::ProcessEventRecord ( GHepRecord * event_rec ) const

virtual

Implements genie::EventRecordVisitorI.

Definition at line 51 of file VertexGenerator.cxx.

{
// generate a vtx and set it to all GHEP physical particles
  Interaction * interaction = evrec->Summary();
  GHepParticle * nucltgt = evrec->TargetNucleus();
  TVector3 vtx(9999999.,999999.,999999.);
  if(!nucltgt){
    vtx.SetXYZ(0.,0.,0.);
  }else{
    double A = nucltgt->A();
    vtx = GenerateVertex(interaction,A);
  }
 
  // Copy the vertex info to the particles already in the event  record
  //
  TObjArrayIter piter(evrec);
  GHepParticle * p = 0;
  while( (p = (GHepParticle *) piter.Next()) )
  {
    if(pdg::IsPseudoParticle(p->Pdg())) continue;
    if(pdg::IsIon           (p->Pdg())) continue;
 
    LOG("Vtx", pINFO) << "Setting vertex position for: " << p->Name();
    p->SetPosition(vtx.x(), vtx.y(), vtx.z(), 0.);
  }
}

References genie::GHepParticle::A(), GenerateVertex(), genie::pdg::IsIon(), genie::pdg::IsPseudoParticle(), LOG, genie::GHepParticle::Name(), genie::GHepParticle::Pdg(), pINFO, genie::GHepParticle::SetPosition(), genie::GHepRecord::Summary(), and genie::GHepRecord::TargetNucleus().

Member Data Documentation

fR0

double genie::VertexGenerator::fR0

private

parameter controlling nuclear sizes

Definition at line 50 of file VertexGenerator.h.

Referenced by GenerateVertex(), and LoadConfig().

fVtxGenMethod

int genie::VertexGenerator::fVtxGenMethod

private

vtx generation method (0: uniform, 1: according to nuclear density [def])

Definition at line 49 of file VertexGenerator.h.

Referenced by GenerateVertex(), and LoadConfig().

---

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

• VertexGenerator.h
• VertexGenerator.cxx