A simple GENIE flux driver for monoenergetic neutrinos along the z direction. Can handle a mix of neutrinos with their corresponding weight. This trivial flux driver was added in so that single energy neutrinos can be easily used with the event generation driver that can handle a target mix or detailed geometries. More...

#include <GMonoEnergeticFlux.h>

Inheritance diagram for genie::flux::GMonoEnergeticFlux:

[legend]

Collaboration diagram for genie::flux::GMonoEnergeticFlux:

[legend]

Public Member Functions
	GMonoEnergeticFlux ()
	GMonoEnergeticFlux (double Ev, int pdg)
	GMonoEnergeticFlux (double Ev, const map< int, double > &numap)
	~GMonoEnergeticFlux ()
const PDGCodeList &	FluxParticles (void)
	declare list of flux neutrinos that can be generated (for init. purposes)
double	MaxEnergy (void)
	declare the max flux neutrino energy that can be generated (for init. purposes)
bool	GenerateNext (void)
	generate the next flux neutrino (return false in err)
int	PdgCode (void)
	returns the flux neutrino pdg code
double	Weight (void)
	returns the flux neutrino weight (if any)
const TLorentzVector &	Momentum (void)
	returns the flux neutrino 4-momentum
const TLorentzVector &	Position (void)
	returns the flux neutrino 4-position (note: expect SI rather than physical units)
bool	End (void)
	true if no more flux nu's can be thrown (eg reaching end of beam sim ntuples)
long int	Index (void)
	returns corresponding index for current flux neutrino (e.g. for a flux ntuple returns the current entry number)
void	Clear (Option_t *opt)
	reset state variables based on opt
void	GenerateWeighted (bool gen_weighted)
	set whether to generate weighted or unweighted neutrinos
void	SetDirectionCos (double dx, double dy, double dz)
void	SetRayOrigin (double x, double y, double z)
void	SetNuDirection (const TVector3 &direction)
void	SetBeamSpot (const TVector3 &spot)
void	Initialize (double Ev, int pdg)
void	Initialize (double Ev, const map< int, double > &numap)
Public Member Functions inherited from genie::GFluxI
virtual	~GFluxI ()

Private Member Functions
void	CleanUp (void)

Private Attributes
double	fMaxEv
	maximum energy
PDGCodeList *	fPdgCList
	list of neutrino pdg-codes
int	fgPdgC
	running generated nu pdg-code
TLorentzVector	fgP4
	running generated nu 4-momentum
TLorentzVector	fgX4
	running generated nu 4-position
map< int, double >	fProb
double	fProbMax

Additional Inherited Members
Protected Member Functions inherited from genie::GFluxI
	GFluxI ()

Detailed Description

A simple GENIE flux driver for monoenergetic neutrinos along the z direction. Can handle a mix of neutrinos with their corresponding weight. This trivial flux driver was added in so that single energy neutrinos can be easily used with the event generation driver that can handle a target mix or detailed geometries.

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

Created:\n Feb 08, 2008

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 38 of file GMonoEnergeticFlux.h.

Constructor & Destructor Documentation

◆ GMonoEnergeticFlux() [1/3]

GMonoEnergeticFlux::GMonoEnergeticFlux ( )

Definition at line 28 of file GMonoEnergeticFlux.cxx.

                                       :
GFluxI()
{
  // default ctor for consistency with GFluxDriverFactory needs
  // up to user to call Initialize() to set energy and flavor(s)
}

References genie::GFluxI::GFluxI().

◆ GMonoEnergeticFlux() [2/3]

GMonoEnergeticFlux::GMonoEnergeticFlux	(	double	Ev,
		int	pdg )

Definition at line 35 of file GMonoEnergeticFlux.cxx.

                                                         :
GFluxI()
{
  this->Initialize(Ev,pdg);
}

References genie::GFluxI::GFluxI(), and Initialize().

◆ GMonoEnergeticFlux() [3/3]

GMonoEnergeticFlux::GMonoEnergeticFlux	(	double	Ev,
		const map< int, double > &	numap )

Definition at line 41 of file GMonoEnergeticFlux.cxx.

                                                 :
GFluxI()
{
  this->Initialize(Ev,numap);
}

References genie::GFluxI::GFluxI(), and Initialize().

◆ ~GMonoEnergeticFlux()

GMonoEnergeticFlux::~GMonoEnergeticFlux ( )

Definition at line 48 of file GMonoEnergeticFlux.cxx.

{
  this->CleanUp();
}

References CleanUp().

Member Function Documentation

◆ CleanUp()

void GMonoEnergeticFlux::CleanUp ( void )

private

Definition at line 130 of file GMonoEnergeticFlux.cxx.

{
  LOG("Flux", pNOTICE) << "Cleaning up...";
 
  if (fPdgCList) delete fPdgCList;
}

References fPdgCList, LOG, and pNOTICE.

Referenced by ~GMonoEnergeticFlux().

◆ Clear()

void GMonoEnergeticFlux::Clear ( Option_t * opt )

virtual

reset state variables based on opt

Implements genie::GFluxI.

Definition at line 77 of file GMonoEnergeticFlux.cxx.

{
// Dummy clear method needed to conform to GFluxI interface
//
  LOG("Flux", pERROR) <<
      "No Clear(Option_t * opt) method implemented for opt: "<< opt;
}

References LOG, and pERROR.

◆ End()

bool genie::flux::GMonoEnergeticFlux::End ( void )

inlinevirtual

true if no more flux nu's can be thrown (eg reaching end of beam sim ntuples)

Implements genie::GFluxI.

Definition at line 54 of file GMonoEnergeticFlux.h.

54{ return false; }

◆ FluxParticles()

const PDGCodeList & genie::flux::GMonoEnergeticFlux::FluxParticles ( void )

inlinevirtual

declare list of flux neutrinos that can be generated (for init. purposes)

Implements genie::GFluxI.

Definition at line 47 of file GMonoEnergeticFlux.h.

47{ return *fPdgCList; }

References fPdgCList.

◆ GenerateNext()

bool GMonoEnergeticFlux::GenerateNext ( void )

virtual

generate the next flux neutrino (return false in err)

Implements genie::GFluxI.

Definition at line 53 of file GMonoEnergeticFlux.cxx.

{
  RandomGen * rnd = RandomGen::Instance();
  double p = fProbMax * rnd->RndFlux().Rndm();
 
  map<int,double>::const_iterator iter;
  for(iter = fProb.begin(); iter != fProb.end(); ++iter) {
     int    nupdgc = iter->first;
     double prob   = iter->second;
     if (p<prob) {
       fgPdgC = nupdgc;
       break;
     }
  }
 
  LOG("Flux", pINFO)
        << "Generated neutrino: "
        << "\n pdg-code: " << fgPdgC
        << "\n p4: " << utils::print::P4AsShortString(&fgP4)
        << "\n x4: " << utils::print::X4AsString(&fgX4);
 
  return true;
}

References fgP4, fgPdgC, fgX4, fProb, fProbMax, genie::RandomGen::Instance(), LOG, genie::utils::print::P4AsShortString(), pINFO, genie::RandomGen::RndFlux(), and genie::utils::print::X4AsString().

◆ GenerateWeighted()

void GMonoEnergeticFlux::GenerateWeighted ( bool gen_weighted )

virtual

set whether to generate weighted or unweighted neutrinos

Implements genie::GFluxI.

Definition at line 85 of file GMonoEnergeticFlux.cxx.

{
// Dummy implementation needed to conform to GFluxI interface
//
  LOG("Flux", pERROR) <<
      "No GenerateWeighted(bool gen_weighted) method implemented for " <<
      "gen_weighted: " << gen_weighted;
}

References LOG, and pERROR.

◆ Index()

long int genie::flux::GMonoEnergeticFlux::Index ( void )

inlinevirtual

returns corresponding index for current flux neutrino (e.g. for a flux ntuple returns the current entry number)

Implements genie::GFluxI.

Definition at line 55 of file GMonoEnergeticFlux.h.

55{ return -1; }

◆ Initialize() [1/2]

void GMonoEnergeticFlux::Initialize	(	double	Ev,
		const map< int, double > &	numap )

Definition at line 102 of file GMonoEnergeticFlux.cxx.

{
  LOG("Flux", pNOTICE) << "Initializing GMonoEnergeticFlux driver";
 
  fMaxEv = Ev + 0.05;
 
  fPdgCList = new PDGCodeList;
  fPdgCList->clear();
 
  fProbMax = 0;
  fProb.clear();
 
  map<int,double>::const_iterator iter;
  for(iter = numap.begin(); iter != numap.end(); ++iter) {
        int    nupdgc = iter->first;
        double nuwgt  = iter->second;
 
        fPdgCList->push_back(nupdgc);
 
        fProbMax+=nuwgt;
        fProb.insert(map<int, double>::value_type(nupdgc,fProbMax));
  }
 
  fgPdgC = 0;
  fgP4.SetPxPyPzE (0.,0.,Ev,Ev);
  fgX4.SetXYZT    (0.,0.,0.,0.);
}

References fgP4, fgPdgC, fgX4, fMaxEv, fPdgCList, fProb, fProbMax, LOG, and pNOTICE.

◆ Initialize() [2/2]

void GMonoEnergeticFlux::Initialize	(	double	Ev,
		int	pdg )

Definition at line 94 of file GMonoEnergeticFlux.cxx.

{
  map<int,double> numap;
  numap.insert( map<int, double>::value_type(pdg, 1.) );
 
  this->Initialize(Ev,numap);
}

References Initialize().

◆ MaxEnergy()

double genie::flux::GMonoEnergeticFlux::MaxEnergy ( void )

inlinevirtual

declare the max flux neutrino energy that can be generated (for init. purposes)

Implements genie::GFluxI.

Definition at line 48 of file GMonoEnergeticFlux.h.

48{ return fMaxEv; }

References fMaxEv.

◆ Momentum()

const TLorentzVector & genie::flux::GMonoEnergeticFlux::Momentum ( void )

inlinevirtual

returns the flux neutrino 4-momentum

Implements genie::GFluxI.

Definition at line 52 of file GMonoEnergeticFlux.h.

52{ return fgP4; }

References fgP4.

◆ PdgCode()

int genie::flux::GMonoEnergeticFlux::PdgCode ( void )

inlinevirtual

returns the flux neutrino pdg code

Implements genie::GFluxI.

Definition at line 50 of file GMonoEnergeticFlux.h.

50{ return fgPdgC; }

References fgPdgC.

◆ Position()

const TLorentzVector & genie::flux::GMonoEnergeticFlux::Position ( void )

inlinevirtual

returns the flux neutrino 4-position (note: expect SI rather than physical units)

Implements genie::GFluxI.

Definition at line 53 of file GMonoEnergeticFlux.h.

53{ return fgX4; }

References fgX4.

◆ SetBeamSpot()

void GMonoEnergeticFlux::SetBeamSpot ( const TVector3 & spot )

Definition at line 160 of file GMonoEnergeticFlux.cxx.

{
  SetRayOrigin(spot.x(), spot.y(), spot.z());
}

References SetRayOrigin().

◆ SetDirectionCos()

void GMonoEnergeticFlux::SetDirectionCos	(	double	dx,
		double	dy,
		double	dz )

Definition at line 137 of file GMonoEnergeticFlux.cxx.

{
  TVector3 dircos1 = TVector3(dx,dy,dz).Unit();
  LOG("Flux", pNOTICE) << "SetDirectionCos "
                       << utils::print::P3AsString(&dircos1);
  double E = fgP4.E();
  fgP4.SetVect(E*dircos1);
 
}

References fgP4, LOG, genie::utils::print::P3AsString(), and pNOTICE.

Referenced by SetNuDirection().

◆ SetNuDirection()

void GMonoEnergeticFlux::SetNuDirection ( const TVector3 & direction )

Definition at line 155 of file GMonoEnergeticFlux.cxx.

{
  SetDirectionCos(direction.x(), direction.y(), direction.z());
}

References SetDirectionCos().

◆ SetRayOrigin()

void GMonoEnergeticFlux::SetRayOrigin	(	double	x,
		double	y,
		double	z )

Definition at line 147 of file GMonoEnergeticFlux.cxx.

{
  TVector3 xyz(x,y,z);
  LOG("Flux", pNOTICE) << "SetRayOrigin "
                       << utils::print::Vec3AsString(&xyz);
  fgX4.SetVect(xyz);
}

References fgX4, LOG, pNOTICE, and genie::utils::print::Vec3AsString().

Referenced by SetBeamSpot().

◆ Weight()

double genie::flux::GMonoEnergeticFlux::Weight ( void )

inlinevirtual

returns the flux neutrino weight (if any)

Implements genie::GFluxI.

Definition at line 51 of file GMonoEnergeticFlux.h.

51{ return 1.0; }

Member Data Documentation

◆ fgP4

TLorentzVector genie::flux::GMonoEnergeticFlux::fgP4

private

running generated nu 4-momentum

Definition at line 79 of file GMonoEnergeticFlux.h.

Referenced by GenerateNext(), Initialize(), Momentum(), and SetDirectionCos().

◆ fgPdgC

int genie::flux::GMonoEnergeticFlux::fgPdgC

private

running generated nu pdg-code

Definition at line 78 of file GMonoEnergeticFlux.h.

Referenced by GenerateNext(), Initialize(), and PdgCode().

◆ fgX4

TLorentzVector genie::flux::GMonoEnergeticFlux::fgX4

private

running generated nu 4-position

Definition at line 80 of file GMonoEnergeticFlux.h.

Referenced by GenerateNext(), Initialize(), Position(), and SetRayOrigin().

◆ fMaxEv

double genie::flux::GMonoEnergeticFlux::fMaxEv

private

maximum energy

Definition at line 76 of file GMonoEnergeticFlux.h.

Referenced by Initialize(), and MaxEnergy().

◆ fPdgCList

PDGCodeList* genie::flux::GMonoEnergeticFlux::fPdgCList

private

list of neutrino pdg-codes

Definition at line 77 of file GMonoEnergeticFlux.h.

Referenced by CleanUp(), FluxParticles(), and Initialize().

◆ fProb

map<int, double> genie::flux::GMonoEnergeticFlux::fProb

private

Definition at line 81 of file GMonoEnergeticFlux.h.

Referenced by GenerateNext(), and Initialize().

◆ fProbMax

double genie::flux::GMonoEnergeticFlux::fProbMax

private

Definition at line 82 of file GMonoEnergeticFlux.h.

Referenced by GenerateNext(), and Initialize().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GMonoEnergeticFlux() [1/3]

◆ GMonoEnergeticFlux() [2/3]

◆ GMonoEnergeticFlux() [3/3]

◆ ~GMonoEnergeticFlux()

Member Function Documentation

◆ CleanUp()

◆ Clear()

◆ End()

◆ FluxParticles()

◆ GenerateNext()

◆ GenerateWeighted()

◆ Index()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ MaxEnergy()

◆ Momentum()

◆ PdgCode()

◆ Position()

◆ SetBeamSpot()

◆ SetDirectionCos()

◆ SetNuDirection()

◆ SetRayOrigin()

◆ Weight()

Member Data Documentation

◆ fgP4

◆ fgPdgC

◆ fgX4

◆ fMaxEv

◆ fPdgCList

◆ fProb

◆ fProbMax