BLBeam Class Reference

#include <BLBeam.hh>

Inheritance diagram for BLBeam:

List of all members.

---

Detailed Description

class BLBeam is an interface class for a beam.

NOTE: all functions are either inline or abstract, so no .cc file is needed.

Public Member Functions
	BLBeam ()
	Constructor.
virtual int	getNEvents () const
	getNEvents() returns the # events to process.
virtual void	init ()=0
	init() will initialize internal variables.
virtual bool	generateReferenceParticle (G4Event *event)=0
	generateReferenceParticle() generates the reference particle. BLManager calls this once for the TuneParticle during event -2, and once for the ReferenceParticle during event -1. Should always call setRandomSeedToTrack() before returning. Returns true if event generated; false if not.
virtual bool	nextBeamEvent (G4Event *event)=0
	nextBeamEvent() generates the next beam event. If generating randomly, should call setRandomSeedToGenerate() and use no more than 16 random numbers. If read from a file, it should call event->SetEventID(). Should always call setRandomSeedToTrack() before returning. Returns true if event generated; false if no more events.
virtual void	summary ()
	summary() will print a summary, if necessary.
Static Public Member Functions
static void	setRandomSeedToGenerate (int evid)
	Utility: setRandomSeedToGenerate() sets the random seed for the generation of an event.
static void	setRandomSeedToTrack (int evid)
	Utility: setRandomSeedToTrack() sets the random seed for the tracking of an event.
Protected Attributes
G4int	nEvents

---

Constructor & Destructor Documentation

BLBeam::BLBeam

(

)

[inline]

Constructor.

References nEvents.

{ nEvents = 0; }

---

Member Function Documentation

static void BLBeam::setRandomSeedToGenerate

(

int

evid

)

[inline, static]

Utility: setRandomSeedToGenerate() sets the random seed for the generation of an event.

References EVENT_NUMBER, BLManager::getObject(), NO_SEED, BLManager::setPRNGSeedMethod(), TIME_US, and BLTime::timems().

Referenced by BLCMDparticlesource::nextBeamEvent(), BLCMDcosmicraybeam::nextBeamEvent(), BLCMDbeam::nextBeamEvent(), and setRandomSeedToTrack().

                { switch(BLManager::getObject()->getPRNGSeedMethod()) {
                  case EVENT_NUMBER:
                        CLHEP::HepRandom::setTheSeed(evid>=0? evid : 0);
                        break;
                  case TIME_US:
                        CLHEP::HepRandom::setTheSeed(BLTime::timems() &
                                                                0x7FFFFFFFL);
                        // do it only once, to avoid duplication
                        BLManager::getObject()->setPRNGSeedMethod(NO_SEED);
                        break;
                  case NO_SEED:
                        return;
                  }
                  CLHEP::RandGauss::setFlag(false);
                  G4UniformRand(); // eat one for luck (don't get seed back)
                }

static void BLBeam::setRandomSeedToTrack

(

int

evid

)

[inline, static]

Utility: setRandomSeedToTrack() sets the random seed for the tracking of an event.

References setRandomSeedToGenerate().

Referenced by BLCMDreference::generateReferenceParticle(), BLCMDparticlesource::nextBeamEvent(), BLCMDcosmicraybeam::nextBeamEvent(), and BLCMDbeam::nextBeamEvent().

                { setRandomSeedToGenerate(evid);
                  // allow 16 random numbers for generation
                  for(int i=0; i<16; ++i)
                        G4UniformRand();
                }

virtual int BLBeam::getNEvents

(

)

const [inline, virtual]

getNEvents() returns the # events to process.

Reimplemented in BLCMDbeam, BLCMDcosmicraybeam, BLCMDparticlesource, and BLCMDreference.

References nEvents.

{ return nEvents; }

virtual void BLBeam::init

(

)

[pure virtual]

init() will initialize internal variables.

Implemented in BLCMDbeam, BLCMDcosmicraybeam, BLCMDparticlesource, and BLCMDreference.

virtual bool BLBeam::generateReferenceParticle

(

G4Event *

event

)

[pure virtual]

generateReferenceParticle() generates the reference particle. BLManager calls this once for the TuneParticle during event -2, and once for the ReferenceParticle during event -1. Should always call setRandomSeedToTrack() before returning. Returns true if event generated; false if not.

Implemented in BLCMDbeam, BLCMDcosmicraybeam, BLCMDparticlesource, and BLCMDreference.

virtual bool BLBeam::nextBeamEvent

(

G4Event *

event

)

[pure virtual]

nextBeamEvent() generates the next beam event. If generating randomly, should call setRandomSeedToGenerate() and use no more than 16 random numbers. If read from a file, it should call event->SetEventID(). Should always call setRandomSeedToTrack() before returning. Returns true if event generated; false if no more events.

Implemented in BLCMDbeam, BLCMDcosmicraybeam, BLCMDparticlesource, and BLCMDreference.

virtual void BLBeam::summary

(

)

[inline, virtual]

summary() will print a summary, if necessary.

Reimplemented in BLCMDbeam, BLCMDcosmicraybeam, BLCMDparticlesource, and BLCMDreference.

{ }

---

Member Data Documentation

G4int BLBeam::nEvents [protected]

Reimplemented in BLCMDbeam, and BLCMDparticlesource.

Referenced by BLBeam(), BLCMDcosmicraybeam::defineNamedArgs(), BLCMDreference::getNEvents(), BLCMDcosmicraybeam::getNEvents(), getNEvents(), BLCMDcosmicraybeam::nextBeamEvent(), and BLCMDcosmicraybeam::printBeam().

---

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

• BLBeam.hh