BDSLinkPrimaryGeneratorAction Class Reference

Generates primary particle vertices using BDSBunch. More...

#include <BDSLinkPrimaryGeneratorAction.hh>

Inheritance diagram for BDSLinkPrimaryGeneratorAction:

Collaboration diagram for BDSLinkPrimaryGeneratorAction:

Public Member Functions
	BDSLinkPrimaryGeneratorAction (BDSBunch *bunchIn, int *currentElementIndexIn, BDSLinkDetectorConstruction *constructionIn, G4bool debugIn=false)
	Bunch must have a valid particle definition (ie not nullptr).
virtual void	GeneratePrimaries (G4Event *)
	Main interface for Geant4. Prepare primary(ies) for the event.
void	SetWorldExtent (const BDSExtent worldExtentIn)
	Set the world extent that particle coordinates will be checked against.

Private Attributes
BDSBunch *	bunch
	BDSIM particle generator.
int *	currentElementIndex
	External integer for which element to track in.
BDSLinkDetectorConstruction *	construction
	Cache of detector construction for link registry of transforms.
G4bool	debug
G4ParticleGun *	particleGun
	Geant4 particle gun that creates single particles.
BDSExtent	worldExtent
	World extent that particle coordinates are checked against to ensure they're inside it.

Detailed Description

Generates primary particle vertices using BDSBunch.

Author

Laurie Nevay

Definition at line 39 of file BDSLinkPrimaryGeneratorAction.hh.

Constructor & Destructor Documentation

BDSLinkPrimaryGeneratorAction()

BDSLinkPrimaryGeneratorAction::BDSLinkPrimaryGeneratorAction	(	BDSBunch *	bunchIn,
		int *	currentElementIndexIn,
		BDSLinkDetectorConstruction *	constructionIn,
		G4bool	debugIn = false
	)

Bunch must have a valid particle definition (ie not nullptr).

Definition at line 39 of file BDSLinkPrimaryGeneratorAction.cc.

References particleGun.

~BDSLinkPrimaryGeneratorAction()

BDSLinkPrimaryGeneratorAction::~BDSLinkPrimaryGeneratorAction ( )

virtual

Definition at line 56 of file BDSLinkPrimaryGeneratorAction.cc.

Member Function Documentation

GeneratePrimaries()

void BDSLinkPrimaryGeneratorAction::GeneratePrimaries ( G4Event *  anEvent )

virtual

Main interface for Geant4. Prepare primary(ies) for the event.

Definition at line 61 of file BDSLinkPrimaryGeneratorAction.cc.

References BDSParticleCoords::ApplyOffset(), BDSParticleCoords::ApplyTransform(), bunch, BDSParticleDefinition::Charge(), construction, currentElementIndex, BDSExtent::Encompasses(), BDSBunch::GetNextParticleLocal(), BDSLinkDetectorConstruction::LinkRegistry(), BDSParticleDefinition::Mass(), BDSBunch::ParticleDefinition(), BDSParticleDefinition::ParticleDefinition(), particleGun, BDSEventInfo::SetSeedStateAtStart(), BDSException::what(), and worldExtent.

Here is the call graph for this function:

SetWorldExtent()

void BDSLinkPrimaryGeneratorAction::SetWorldExtent ( const BDSExtent  worldExtentIn )

inline

Set the world extent that particle coordinates will be checked against.

Definition at line 53 of file BDSLinkPrimaryGeneratorAction.hh.

References worldExtent.

Referenced by BDSLinkDetectorConstruction::UpdateWorldSolid().

Here is the caller graph for this function:

Field Documentation

bunch

BDSBunch* BDSLinkPrimaryGeneratorAction::bunch

private

BDSIM particle generator.

Definition at line 57 of file BDSLinkPrimaryGeneratorAction.hh.

Referenced by GeneratePrimaries().

construction

BDSLinkDetectorConstruction* BDSLinkPrimaryGeneratorAction::construction

private

Cache of detector construction for link registry of transforms.

Definition at line 59 of file BDSLinkPrimaryGeneratorAction.hh.

Referenced by GeneratePrimaries().

currentElementIndex

int* BDSLinkPrimaryGeneratorAction::currentElementIndex

private

External integer for which element to track in.

Definition at line 58 of file BDSLinkPrimaryGeneratorAction.hh.

Referenced by GeneratePrimaries().

debug

G4bool BDSLinkPrimaryGeneratorAction::debug

private

Definition at line 60 of file BDSLinkPrimaryGeneratorAction.hh.

particleGun

G4ParticleGun* BDSLinkPrimaryGeneratorAction::particleGun

private

Geant4 particle gun that creates single particles.

Definition at line 61 of file BDSLinkPrimaryGeneratorAction.hh.

Referenced by BDSLinkPrimaryGeneratorAction(), and GeneratePrimaries().

worldExtent

BDSExtent BDSLinkPrimaryGeneratorAction::worldExtent

private

World extent that particle coordinates are checked against to ensure they're inside it.

Definition at line 64 of file BDSLinkPrimaryGeneratorAction.hh.

Referenced by GeneratePrimaries(), and SetWorldExtent().

---

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

• /__w/bdsim/bdsim/include/BDSLinkPrimaryGeneratorAction.hh
• /__w/bdsim/bdsim/src/BDSLinkPrimaryGeneratorAction.cc