GENIEGenerator: genie::GFluxI Class Reference

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

#include <GFluxI.h>

Inheritance diagram for genie::GFluxI:

Inheritance graph

Public Member Functions
virtual	~GFluxI ()

virtual const PDGCodeList &	FluxParticles (void)=0
	declare list of flux neutrinos that can be generated (for init. purposes) More...

virtual double	MaxEnergy (void)=0
	declare the max flux neutrino energy that can be generated (for init. purposes) More...

virtual bool	GenerateNext (void)=0
	generate the next flux neutrino (return false in err) More...

virtual int	PdgCode (void)=0
	returns the flux neutrino pdg code More...

virtual double	Weight (void)=0
	returns the flux neutrino weight (if any) More...

virtual const TLorentzVector &	Momentum (void)=0
	returns the flux neutrino 4-momentum More...

virtual const TLorentzVector &	Position (void)=0
	returns the flux neutrino 4-position (note: expect SI rather than physical units) More...

virtual bool	End (void)=0
	true if no more flux nu's can be thrown (eg reaching end of beam sim ntuples) More...

virtual long int	Index (void)=0
	returns corresponding index for current flux neutrino (e.g. for a flux ntuple returns the current entry number) More...

virtual void	Clear (Option_t *opt)=0
	reset state variables based on opt More...

virtual void	GenerateWeighted (bool gen_weighted)=0
	set whether to generate weighted or unweighted neutrinos More...

Protected Member Functions
	GFluxI ()

Detailed Description

GENIE Interface for user-defined flux classes.

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

Created:: May 25, 2005

License:: Copyright (c) 2003-2024, 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 ( )

virtual

Definition at line 21 of file GFluxI.cxx.

 {
 
 }

GFluxI::GFluxI ( )

protected

Definition at line 16 of file GFluxI.cxx.

 {
 
 }

Member Function Documentation

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

pure virtual

reset state variables based on opt

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

Referenced by genie::flux::GFluxBlender::Clear(), and genie::geometry::ROOTGeomAnalyzer::ComputeMaxPathLengths().

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::GNuMIFlux, genie::flux::GSimpleNtpFlux, genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GCylindTH1Flux, genie::flux::GMonoEnergeticFlux, and genie::flux::GPowerLawFlux.

Referenced by genie::flux::GFluxBlender::End(), and main().

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::GNuMIFlux, genie::flux::GSimpleNtpFlux, genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GCylindTH1Flux, genie::flux::GMonoEnergeticFlux, and genie::flux::GPowerLawFlux.

Referenced by genie::flux::GFluxBlender::FluxParticles().

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

pure virtual

generate the next flux neutrino (return false in err)

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

Referenced by createFluxNtuple(), genie::flux::GFluxBlender::GenerateNext(), GenerateUpNu(), and genie::geometry::ROOTGeomAnalyzer::MaxPathLengthsFluxMethod().

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

pure virtual

set whether to generate weighted or unweighted neutrinos

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

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::GNuMIFlux, genie::flux::GSimpleNtpFlux, genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GCylindTH1Flux, genie::flux::GMonoEnergeticFlux, and genie::flux::GPowerLawFlux.

Referenced by genie::flux::GFluxBlender::Index().

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::GNuMIFlux, genie::flux::GSimpleNtpFlux, genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GCylindTH1Flux, genie::flux::GMonoEnergeticFlux, and genie::flux::GPowerLawFlux.

Referenced by genie::flux::GFluxBlender::MaxEnergy(), and genie::geometry::ROOTGeomAnalyzer::MaxPathLengthsFluxMethod().

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

pure virtual

returns the flux neutrino 4-momentum

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

Referenced by createFluxNtuple(), genie::flux::GFluxBlender::GenerateNext(), GenerateUpNu(), main(), genie::geometry::ROOTGeomAnalyzer::MaxPathLengthsFluxMethod(), and genie::flux::GFluxBlender::Momentum().

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

pure virtual

returns the flux neutrino pdg code

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

Referenced by createFluxNtuple(), genie::flux::GFluxBlender::GenerateNext(), GenerateUpNu(), and main().

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::GNuMIFlux, genie::flux::GSimpleNtpFlux, genie::flux::GAstroFlux, genie::flux::GAtmoFlux, genie::flux::GFluxBlender, genie::flux::GJPARCNuFlux, genie::flux::GCylindTH1Flux, genie::flux::GMonoEnergeticFlux, and genie::flux::GPowerLawFlux.

Referenced by createFluxNtuple(), genie::geometry::ROOTGeomAnalyzer::MaxPathLengthsFluxMethod(), and genie::flux::GFluxBlender::Position().

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

pure virtual

returns the flux neutrino weight (if any)

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

Referenced by createFluxNtuple(), main(), and genie::flux::GFluxBlender::Weight().

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