genie::GFluxI Class Reference

GENIE Interface for user-defined flux classes. More...

#include <GFluxI.h>

Inheritance diagram for genie::GFluxI:

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

Protected Member Functions
	GFluxI ()

Detailed Description

GENIE Interface for user-defined flux classes.

Author

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

Created:\n May 25, 2005

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 29 of file GFluxI.h.

Constructor & Destructor Documentation

~GFluxI()

GFluxI::~GFluxI ( )

virtual

Definition at line 21 of file GFluxI.cxx.

{
 
}

GFluxI()

GFluxI::GFluxI ( )

protected

Definition at line 16 of file GFluxI.cxx.

{
 
}

Referenced by genie::flux::GFluxBlender::AdoptFluxGenerator(), genie::flux::GFluxBlender::GetFluxGenerator(), genie::flux::GFluxBlender::GFluxBlender(), genie::flux::GMonoEnergeticFlux::GMonoEnergeticFlux(), genie::flux::GMonoEnergeticFlux::GMonoEnergeticFlux(), genie::flux::GMonoEnergeticFlux::GMonoEnergeticFlux(), genie::flux::GPowerLawFlux::GPowerLawFlux(), genie::flux::GPowerLawFlux::GPowerLawFlux(), and genie::flux::GPowerLawFlux::GPowerLawFlux().

Member Function Documentation

Clear()

virtual void genie::GFluxI::Clear ( Option_t * opt )

pure virtual

reset state variables based on opt

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

End()

virtual bool genie::GFluxI::End ( void )

pure virtual

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

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Referenced by main().

FluxParticles()

virtual const PDGCodeList & genie::GFluxI::FluxParticles ( void )

pure virtual

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

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

GenerateNext()

virtual bool genie::GFluxI::GenerateNext ( void )

pure virtual

generate the next flux neutrino (return false in err)

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPointSourceAstroFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Referenced by GenerateUpNu().

GenerateWeighted()

virtual void genie::GFluxI::GenerateWeighted ( bool gen_weighted )

pure virtual

set whether to generate weighted or unweighted neutrinos

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Index()

virtual long int genie::GFluxI::Index ( void )

pure virtual

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

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

MaxEnergy()

virtual double genie::GFluxI::MaxEnergy ( void )

pure virtual

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

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Momentum()

virtual const TLorentzVector & genie::GFluxI::Momentum ( void )

pure virtual

returns the flux neutrino 4-momentum

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Referenced by GenerateUpNu(), and main().

PdgCode()

virtual int genie::GFluxI::PdgCode ( void )

pure virtual

returns the flux neutrino pdg code

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Referenced by GenerateUpNu(), and main().

Position()

virtual const TLorentzVector & genie::GFluxI::Position ( void )

pure virtual

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

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Weight()

virtual double genie::GFluxI::Weight ( void )

pure virtual

returns the flux neutrino weight (if any)

Implemented in genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GCylindTH1Flux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GMonoEnergeticFlux, genie::flux::GNuMIFlux, genie::flux::GPowerLawFlux, and genie::flux::GSimpleNtpFlux.

Referenced by main().

---

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

• GFluxI.h
• GFluxI.cxx