GENIE GFluxI adapter to allow flavor modification. More...

#include <GFluxBlender.h>

Inheritance diagram for genie::flux::GFluxBlender:

Collaboration diagram for genie::flux::GFluxBlender:

Public Member Functions
	GFluxBlender ()
	~GFluxBlender ()
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
int	PdgCodeGenerated (void)
	returns the flux neutrino original pdg code
double	Energy (void)
double	TravelDist (void)
	returns the distance used in the flavor mixing
void	SetBaselineDist (double dist)
double	GetBaselineDist (void)
GFluxI *	AdoptFluxGenerator (GFluxI *generator)
	return previous
GFlavorMixerI *	AdoptFlavorMixer (GFlavorMixerI *mixer)
	return previous
GFluxI *	GetFluxGenerator ()
	access, not ownership
GFlavorMixerI *	GetFlavorMixer ()
	access, not ownership
void	PrintConfig (void)
void	PrintState (bool verbose=true)
Public Member Functions inherited from genie::GFluxI
virtual	~GFluxI ()

Private Member Functions
int	ChooseFlavor (int pdg_init, double energy, double dist)

Private Attributes
GFluxI *	fRealGFluxI
	actual flux generator
GNuMIFlux *	fGNuMIFlux
	ref to avoid repeat dynamic_cast
GSimpleNtpFlux *	fGSimpleFlux
	ref to avoid repeat dynamic_cast
GFlavorMixerI *	fFlavorMixer
	flavor modification schema
PDGCodeList	fPDGListGenerator
	possible flavors from generator
PDGCodeList	fPDGListMixed
	possible flavors after mixing
size_t	fNPDGOut
double	fBaselineDist
	travel dist for mixing (if flux doesn't support GetDecayDist())
double	fEnergy
	current neutrino's energy
double	fDistance
	current neutrino's travel distance
int	fPdgCGenerated
	current neutrino's original flavor
int	fPdgCMixed
	current neutrino's new flavor
std::vector< double >	fProb
	individual transition probs
std::vector< double >	fSumProb
	cummulative probability
double	fRndm
	random # used to make choice

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

Detailed Description

GENIE GFluxI adapter to allow flavor modification.

    This adapter intervenes between the GENIE GMCJDriver class
    (MC job driver) and a concrete GFluxI flux generator, to
    allow user modification of the neutrino flavor.  This
    modification could be a fixed "swap" or an energy and/or
    distance dependent (standard oscillations) one.

    Because the GMCJDriver only queries the flavor of a
    generated neutrino once, prior to propagation through
    the geometry, this approach is _not_ appropriate with
    use of an oscillatory model in situations where the flavor
    might change significantly over the scale of the geometry.
    In such cases one would have to generate with a fixed flavor
    (energy/distance independent) swap and reweight after the fact.

    Do not use this as a means of selecting only certain flavor
    from flux generators that support other means (e.g. GNuMIFlux,
    GSimpleNtpFlux which have SetFluxParticles(PDGCodeList)) as
    those will be more efficient.

Author: Robert Hatcher <rhatcher \at fnal.gov> Fermi National Accelerator Laboratory

Created:\n 2010/12/22

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 52 of file GFluxBlender.h.

Constructor & Destructor Documentation

◆ GFluxBlender()

genie::flux::GFluxBlender::GFluxBlender ( )

Definition at line 32 of file GFluxBlender.cxx.

                           :
  GFluxI(),
  fRealGFluxI(0),
  fGNuMIFlux(0),
  fGSimpleFlux(0),
  fFlavorMixer(0),
  fPDGListGenerator(),
  fPDGListMixed(),
  fNPDGOut(0),
  fBaselineDist(0),
  fEnergy(0),
  fDistance(0),
  fPdgCGenerated(0),
  fPdgCMixed(0)
{ ; }

References fBaselineDist, fDistance, fEnergy, fFlavorMixer, fGNuMIFlux, fGSimpleFlux, fNPDGOut, fPdgCGenerated, fPdgCMixed, fPDGListGenerator, fPDGListMixed, fRealGFluxI, and genie::GFluxI::GFluxI().

◆ ~GFluxBlender()

genie::flux::GFluxBlender::~GFluxBlender ( )

Definition at line 48 of file GFluxBlender.cxx.

{
  if ( fRealGFluxI  ) { delete fRealGFluxI;  fRealGFluxI  = 0; }
  if ( fFlavorMixer ) { delete fFlavorMixer; fFlavorMixer = 0; }
}

References fFlavorMixer, and fRealGFluxI.

Member Function Documentation

◆ AdoptFlavorMixer()

GFlavorMixerI * genie::flux::GFluxBlender::AdoptFlavorMixer ( GFlavorMixerI * mixer )

return previous

Definition at line 148 of file GFluxBlender.cxx.

{
  GFlavorMixerI* oldmix = fFlavorMixer;
  fFlavorMixer = mixer;
  return oldmix;
}

References fFlavorMixer.

◆ AdoptFluxGenerator()

GFluxI * genie::flux::GFluxBlender::AdoptFluxGenerator ( GFluxI * generator )

return previous

Definition at line 134 of file GFluxBlender.cxx.

{
  GFluxI* oldgen = fRealGFluxI;
  fRealGFluxI  = generator;
  // avoid re-casting
  fGNuMIFlux   = dynamic_cast<GNuMIFlux*>(fRealGFluxI);
  fGSimpleFlux = dynamic_cast<GSimpleNtpFlux*>(fRealGFluxI);
  // force evaluation of particle lists
  this->FluxParticles();
 
  return oldgen;
}

References fGNuMIFlux, fGSimpleFlux, FluxParticles(), fRealGFluxI, generator(), and genie::GFluxI::GFluxI().

◆ ChooseFlavor()

int genie::flux::GFluxBlender::ChooseFlavor	(	int	pdg_init,
		double	energy,
		double	dist )

private

Definition at line 156 of file GFluxBlender.cxx.

{
  // choose a new flavor
  bool   isset = false;
  int    pdg_out = 0;
  double sumprob = 0;
 
  fRndm = RandomGen::Instance()->RndFlux().Rndm();
  for (size_t indx = 0; indx < fNPDGOut; ++indx ) {
    int pdg_test = fPDGListMixed[indx];
    double prob = fFlavorMixer->Probability(pdg_init,pdg_test,energy,dist);
    fProb[indx] = prob;
    sumprob += fProb[indx];
    fSumProb[indx] = sumprob;
    if ( ! isset && fRndm < sumprob ) {
      isset   = true;
      pdg_out = pdg_test;
    }
  }
 
  return pdg_out;
}

References fFlavorMixer, fNPDGOut, fPDGListMixed, fProb, fRndm, fSumProb, genie::RandomGen::Instance(), and genie::RandomGen::RndFlux().

Referenced by GenerateNext().

◆ Clear()

void genie::flux::GFluxBlender::Clear ( Option_t * opt )

virtual

reset state variables based on opt

Implements genie::GFluxI.

Definition at line 111 of file GFluxBlender.cxx.

{
// Clear method needed to conform to GFluxI interface
//
  fRealGFluxI->Clear(opt);
}

References fRealGFluxI.

◆ End()

bool genie::flux::GFluxBlender::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 72 of file GFluxBlender.h.

References fRealGFluxI.

◆ Energy()

double genie::flux::GFluxBlender::Energy ( void )

inline

Definition at line 81 of file GFluxBlender.h.

81{ return fEnergy; } //< returns the current neutrino's energy

References fEnergy.

◆ FluxParticles()

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

virtual

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

Return (reference to) list of possible neutrinos after mixing. These are PDG code that might be interacted.

Implements genie::GFluxI.

Definition at line 55 of file GFluxBlender.cxx.

{
  /// Return (reference to) list of possible neutrinos *after* mixing.
  /// These are PDG code that might be interacted.
 
  // this is only ever called by GMCJDriver::GetParticleLists()
  // during GMCJDriver::Configure() which should happen just once
  // so don't try to be too clever.
  fPDGListGenerator = fRealGFluxI->FluxParticles();
 
  // okay, really stupid at this time ...
  fPDGListMixed.clear();
  fPDGListMixed.push_back(kPdgNuE);
  fPDGListMixed.push_back(kPdgNuMu);
  fPDGListMixed.push_back(kPdgNuTau);
  fPDGListMixed.push_back(kPdgAntiNuE);
  fPDGListMixed.push_back(kPdgAntiNuMu);
  fPDGListMixed.push_back(kPdgAntiNuTau);
 
  // size the probability arrays to the same number of entries
  fNPDGOut = fPDGListMixed.size();
  fProb.resize(fNPDGOut);
  fSumProb.resize(fNPDGOut);
 
  if ( ! fFlavorMixer ) return fRealGFluxI->FluxParticles();
  else                  return fPDGListMixed;
}

References fFlavorMixer, fNPDGOut, fPDGListGenerator, fPDGListMixed, fProb, fRealGFluxI, fSumProb, genie::kPdgAntiNuE, genie::kPdgAntiNuMu, genie::kPdgAntiNuTau, genie::kPdgNuE, genie::kPdgNuMu, and genie::kPdgNuTau.

Referenced by AdoptFluxGenerator().

◆ GenerateNext()

bool genie::flux::GFluxBlender::GenerateNext ( void )

virtual

generate the next flux neutrino (return false in err)

Implements genie::GFluxI.

Definition at line 84 of file GFluxBlender.cxx.

{
 
  bool gen1 = false;
  while ( ! gen1 ) {
    if ( ! fRealGFluxI->GenerateNext() ) return false;
    // have a new entry
    fPdgCGenerated = fRealGFluxI->PdgCode();
    if ( ! fFlavorMixer ) {
      // simple case when not configured with a mixing model
      fPdgCMixed = fPdgCGenerated;
      gen1 = true;
    } else {
      // now pick a new flavor
      fDistance = fBaselineDist;
      if ( fGNuMIFlux   ) fDistance = fGNuMIFlux->GetDecayDist();
      if ( fGSimpleFlux ) fDistance = fGSimpleFlux->GetDecayDist();
      fEnergy = fRealGFluxI->Momentum().Energy();
      fPdgCMixed = ChooseFlavor(fPdgCGenerated,fEnergy,fDistance);
      // we may have to generate a new neutrino if it oscillates away
      // don't pass non-particles to GENIE ... it won't like it
      gen1 = ( fPdgCMixed != 0 );
    }
  }
  return true;
}

References ChooseFlavor(), fBaselineDist, fDistance, fEnergy, fFlavorMixer, fGNuMIFlux, fGSimpleFlux, fPdgCGenerated, fPdgCMixed, and fRealGFluxI.

◆ GenerateWeighted()

void genie::flux::GFluxBlender::GenerateWeighted ( bool gen_weighted )

virtual

set whether to generate weighted or unweighted neutrinos

Implements genie::GFluxI.

Definition at line 125 of file GFluxBlender.cxx.

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

References LOG, and pERROR.

◆ GetBaselineDist()

double genie::flux::GFluxBlender::GetBaselineDist ( void )

inline

Definition at line 90 of file GFluxBlender.h.

90{ return fBaselineDist; }

References fBaselineDist.

◆ GetFlavorMixer()

GFlavorMixerI * genie::flux::GFluxBlender::GetFlavorMixer ( )

inline

access, not ownership

Definition at line 98 of file GFluxBlender.h.

References fFlavorMixer.

◆ GetFluxGenerator()

GFluxI * genie::flux::GFluxBlender::GetFluxGenerator ( )

inline

access, not ownership

Definition at line 97 of file GFluxBlender.h.

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

◆ Index()

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

virtual

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

Implements genie::GFluxI.

Definition at line 118 of file GFluxBlender.cxx.

{
// Index method needed to conform to GFluxI interface
//
  return fRealGFluxI->Index();
}

References fRealGFluxI.

◆ MaxEnergy()

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

inlinevirtual

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

Implements genie::GFluxI.

Definition at line 66 of file GFluxBlender.h.

References fRealGFluxI.

◆ Momentum()

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

inlinevirtual

returns the flux neutrino 4-momentum

Implements genie::GFluxI.

Definition at line 70 of file GFluxBlender.h.

References fRealGFluxI.

◆ PdgCode()

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

inlinevirtual

returns the flux neutrino pdg code

Implements genie::GFluxI.

Definition at line 68 of file GFluxBlender.h.

References fPdgCMixed.

◆ PdgCodeGenerated()

int genie::flux::GFluxBlender::PdgCodeGenerated ( void )

inline

returns the flux neutrino original pdg code

Definition at line 80 of file GFluxBlender.h.

References fPdgCGenerated.

◆ Position()

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

inlinevirtual

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

Implements genie::GFluxI.

Definition at line 71 of file GFluxBlender.h.

References fRealGFluxI.

◆ PrintConfig()

void genie::flux::GFluxBlender::PrintConfig ( void )

Definition at line 180 of file GFluxBlender.cxx.

{
  LOG_BEGIN("FluxBlender", pINFO) << "GFluxBlender::PrintConfig()" << LOG_END;
  if ( fRealGFluxI ) {
    LOG_BEGIN("FluxBlender", pINFO)
      << "   fRealGFluxI is a \""
      << typeid(fRealGFluxI).name() << "\""
      << LOG_END;
  } else {
    LOG_BEGIN("FluxBlender", pINFO)
      << "   fRealGFluxI is not initialized" << LOG_END;
  }
  if ( fFlavorMixer ) {
    LOG_BEGIN("FluxBlender", pINFO)
      << "   fFlavorMixer is a \""
      << typeid(fFlavorMixer).name() << "\""
      << LOG_END;
  } else {
    LOG_BEGIN("FluxBlender", pINFO)
      << "   fFlavorMixer is not initialized" << LOG_END;
  }
  LOG_BEGIN("FluxBlender", pINFO)
    << "   BaselineDist " << fBaselineDist << LOG_END;
  LOG_BEGIN("FluxBlender", pINFO)
    << "PDG List from Generator" << fPDGListGenerator << LOG_END;
  LOG_BEGIN("FluxBlender", pINFO)
    << "PDG List after mixing (n=" << fNPDGOut << ")"
    << fPDGListMixed << LOG_END;
 
}

References fBaselineDist, fFlavorMixer, fNPDGOut, fPDGListGenerator, fPDGListMixed, fRealGFluxI, LOG_BEGIN, LOG_END, and pINFO.

◆ PrintState()

void genie::flux::GFluxBlender::PrintState ( bool verbose = true )

Definition at line 212 of file GFluxBlender.cxx.

{
  LOG_BEGIN("FluxBlender", pINFO) << "GFluxBlender::PrintState()" << LOG_END;
  LOG_BEGIN("FluxBlender", pINFO)
    << "  Flavor " << fPdgCGenerated
    << " ==> " << fPdgCMixed
    << " (E=" << fEnergy << ", dist=" << fDistance << ")" << LOG_END;
  if ( verbose ) {
    LOG_BEGIN("FluxBlender", pINFO) << "  Rndm = " << fRndm << LOG_END;
    for (size_t indx = 0; indx < fNPDGOut; ++indx ) {
      LOG_BEGIN("FluxBlender", pINFO)
        << "   [" << indx << "] "
        << std::setw(3) << fPdgCGenerated << " => "
        << std::setw(3) << fPDGListMixed[indx]
        << "  p = " << std::setw(10) << fProb[indx]
        << "  sum_p = " << std::setw(10) << fSumProb[indx] << LOG_END;
    }
  }
}

References fDistance, fEnergy, fNPDGOut, fPdgCGenerated, fPdgCMixed, fPDGListMixed, fProb, fRndm, fSumProb, LOG_BEGIN, LOG_END, and pINFO.

◆ SetBaselineDist()

void genie::flux::GFluxBlender::SetBaselineDist ( double dist )

inline

Definition at line 89 of file GFluxBlender.h.

89{ fBaselineDist = dist; }

References fBaselineDist.

◆ TravelDist()

double genie::flux::GFluxBlender::TravelDist ( void )

inline

returns the distance used in the flavor mixing

Definition at line 82 of file GFluxBlender.h.

References fDistance.

◆ Weight()

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

inlinevirtual

returns the flux neutrino weight (if any)

Implements genie::GFluxI.

Definition at line 69 of file GFluxBlender.h.

References fRealGFluxI.

Member Data Documentation

◆ fBaselineDist

double genie::flux::GFluxBlender::fBaselineDist

private

travel dist for mixing (if flux doesn't support GetDecayDist())

Definition at line 116 of file GFluxBlender.h.

Referenced by GenerateNext(), GetBaselineDist(), GFluxBlender(), PrintConfig(), and SetBaselineDist().

◆ fDistance

double genie::flux::GFluxBlender::fDistance

private

current neutrino's travel distance

Definition at line 119 of file GFluxBlender.h.

Referenced by GenerateNext(), GFluxBlender(), PrintState(), and TravelDist().

◆ fEnergy

double genie::flux::GFluxBlender::fEnergy

private

current neutrino's energy

Definition at line 118 of file GFluxBlender.h.

Referenced by Energy(), GenerateNext(), GFluxBlender(), and PrintState().

◆ fFlavorMixer

GFlavorMixerI* genie::flux::GFluxBlender::fFlavorMixer

private

flavor modification schema

Definition at line 110 of file GFluxBlender.h.

Referenced by AdoptFlavorMixer(), ChooseFlavor(), FluxParticles(), GenerateNext(), GetFlavorMixer(), GFluxBlender(), PrintConfig(), and ~GFluxBlender().

◆ fGNuMIFlux

GNuMIFlux* genie::flux::GFluxBlender::fGNuMIFlux

private

ref to avoid repeat dynamic_cast

Definition at line 107 of file GFluxBlender.h.

Referenced by AdoptFluxGenerator(), GenerateNext(), and GFluxBlender().

◆ fGSimpleFlux

GSimpleNtpFlux* genie::flux::GFluxBlender::fGSimpleFlux

private

ref to avoid repeat dynamic_cast

Definition at line 108 of file GFluxBlender.h.

Referenced by AdoptFluxGenerator(), GenerateNext(), and GFluxBlender().

◆ fNPDGOut

size_t genie::flux::GFluxBlender::fNPDGOut

private

of possible output flavors

Definition at line 114 of file GFluxBlender.h.

Referenced by ChooseFlavor(), FluxParticles(), GFluxBlender(), PrintConfig(), and PrintState().

◆ fPdgCGenerated

int genie::flux::GFluxBlender::fPdgCGenerated

private

current neutrino's original flavor

Definition at line 120 of file GFluxBlender.h.

Referenced by GenerateNext(), GFluxBlender(), PdgCodeGenerated(), and PrintState().

◆ fPdgCMixed

int genie::flux::GFluxBlender::fPdgCMixed

private

current neutrino's new flavor

Definition at line 121 of file GFluxBlender.h.

Referenced by GenerateNext(), GFluxBlender(), PdgCode(), and PrintState().

◆ fPDGListGenerator

PDGCodeList genie::flux::GFluxBlender::fPDGListGenerator

private

possible flavors from generator

Definition at line 112 of file GFluxBlender.h.

Referenced by FluxParticles(), GFluxBlender(), and PrintConfig().

◆ fPDGListMixed

PDGCodeList genie::flux::GFluxBlender::fPDGListMixed

private

possible flavors after mixing

Definition at line 113 of file GFluxBlender.h.

Referenced by ChooseFlavor(), FluxParticles(), GFluxBlender(), PrintConfig(), and PrintState().

◆ fProb

std::vector<double> genie::flux::GFluxBlender::fProb

private

individual transition probs

Definition at line 123 of file GFluxBlender.h.

Referenced by ChooseFlavor(), FluxParticles(), and PrintState().

◆ fRealGFluxI

GFluxI* genie::flux::GFluxBlender::fRealGFluxI

private

actual flux generator

Definition at line 106 of file GFluxBlender.h.

Referenced by AdoptFluxGenerator(), Clear(), End(), FluxParticles(), GenerateNext(), GetFluxGenerator(), GFluxBlender(), Index(), MaxEnergy(), Momentum(), Position(), PrintConfig(), Weight(), and ~GFluxBlender().

◆ fRndm

double genie::flux::GFluxBlender::fRndm

private

random # used to make choice

Definition at line 125 of file GFluxBlender.h.

Referenced by ChooseFlavor(), and PrintState().

◆ fSumProb

std::vector<double> genie::flux::GFluxBlender::fSumProb

private

cummulative probability

Definition at line 124 of file GFluxBlender.h.

Referenced by ChooseFlavor(), FluxParticles(), and PrintState().

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

◆ GFluxBlender()

◆ ~GFluxBlender()

Member Function Documentation

◆ AdoptFlavorMixer()

◆ AdoptFluxGenerator()

◆ ChooseFlavor()

◆ Clear()

◆ End()

◆ Energy()

◆ FluxParticles()

◆ GenerateNext()

◆ GenerateWeighted()

◆ GetBaselineDist()

◆ GetFlavorMixer()

◆ GetFluxGenerator()

◆ Index()

◆ MaxEnergy()

◆ Momentum()

◆ PdgCode()

◆ PdgCodeGenerated()

◆ Position()

◆ PrintConfig()

◆ PrintState()

◆ SetBaselineDist()

◆ TravelDist()

◆ Weight()

Member Data Documentation

◆ fBaselineDist

◆ fDistance

◆ fEnergy

◆ fFlavorMixer

◆ fGNuMIFlux

◆ fGSimpleFlux

◆ fNPDGOut

of possible output flavors

◆ fPdgCGenerated

◆ fPdgCMixed

◆ fPDGListGenerator

◆ fPDGListMixed

◆ fProb

◆ fRealGFluxI

◆ fRndm

◆ fSumProb