Generate particles isotrop in space around origine (0,0,0) More...

#include <Geant4ParticleGenerator.h>

Inheritance diagram for dd4hep::sim::Geant4ParticleGenerator:

Public Member Functions
	Geant4ParticleGenerator (Geant4Context *context, const std::string &name)
	Standard constructor. More...

virtual	~Geant4ParticleGenerator ()
	Default destructor. More...

virtual void	operator() (G4Event *event) override
	Callback to generate primary particles. More...

Public Member Functions inherited from dd4hep::sim::Geant4GeneratorAction
	Geant4GeneratorAction (Geant4Context *context, const std::string &name)
	Standard constructor. More...

virtual	~Geant4GeneratorAction ()
	Default destructor. More...

Public Member Functions inherited from dd4hep::sim::Geant4Action
	Geant4Action (Geant4Context *context, const std::string &nam)
	Standard constructor. More...

long	addRef ()
	Increase reference count. More...

long	release ()
	Decrease reference count. Implicit destruction. More...

Geant4Context *	context () const
	Access the context. More...

virtual void	updateContext (Geant4Context *ctxt)
	Set or update client context. More...

virtual void	configureFiber (Geant4Context *thread_context)
	Set or update client for the use in a new thread fiber. More...

const std::string &	name () const
	Access name of the action. More...

const char *	c_name () const
	Access name of the action. More...

void	setName (const std::string &new_name)
	Set the object name. More...

PropertyManager &	properties ()
	Access to the properties of the object. More...

PrintLevel	outputLevel () const
	Access the output level. More...

PrintLevel	setOutputLevel (PrintLevel new_level)
	Set the output level; returns previous value. More...

Geant4UIMessenger *	control () const
	Access to the UI messenger. More...

virtual void	enableUI ()
	Enable and install UI messenger. More...

template<typename T >
Geant4Action &	declareProperty (const std::string &nam, T &val)
	Declare property. More...

template<typename T >
Geant4Action &	declareProperty (const char *nam, T &val)
	Declare property. More...

bool	hasProperty (const std::string &name) const
	Check property for existence. More...

Property &	property (const std::string &name)
	Access single property. More...

virtual void	installMessengers ()
	Install property control messenger if wanted. More...

virtual void	installCommandMessenger ()
	Install command control messenger if wanted. More...

virtual void	installPropertyMessenger ()
	Install property control messenger if wanted. More...

void	print (const char *fmt,...) const
	Support for messages with variable output level using output level. More...

void	printM1 (const char *fmt,...) const
	Support for messages with variable output level using output level-1. More...

void	printM2 (const char *fmt,...) const
	Support for messages with variable output level using output level-2. More...

void	printP1 (const char *fmt,...) const
	Support for messages with variable output level using output level+1. More...

void	printP2 (const char *fmt,...) const
	Support for messages with variable output level using output level+2. More...

void	always (const char *fmt,...) const
	Support of always printed messages. More...

void	debug (const char *fmt,...) const
	Support of debug messages. More...

void	info (const char *fmt,...) const
	Support of info messages. More...

void	warning (const char *fmt,...) const
	Support of warning messages. More...

void	error (const char *fmt,...) const
	Support of error messages. More...

bool	return_error (bool return_value, const char *fmt,...) const
	Action to support error messages. More...

void	fatal (const char *fmt,...) const
	Support of fatal messages. Throws exception. More...

void	except (const char *fmt,...) const
	Support of exceptions: Print fatal message and throw runtime_error. More...

void	abortRun (const std::string &exception, const char *fmt,...) const
	Abort Geant4 Run by throwing a G4Exception with type RunMustBeAborted. More...

Geant4RunActionSequence &	runAction () const
	Access to the main run action sequence from the kernel object. More...

Geant4EventActionSequence &	eventAction () const
	Access to the main event action sequence from the kernel object. More...

Geant4SteppingActionSequence &	steppingAction () const
	Access to the main stepping action sequence from the kernel object. More...

Geant4TrackingActionSequence &	trackingAction () const
	Access to the main tracking action sequence from the kernel object. More...

Geant4StackingActionSequence &	stackingAction () const
	Access to the main stacking action sequence from the kernel object. More...

Geant4GeneratorActionSequence &	generatorAction () const
	Access to the main generator action sequence from the kernel object. More...

Protected Member Functions
virtual void	getParticleMultiplicity (int &multiplicity) const
	Particle modification. Caller presets defaults to: (multiplicity=m_multiplicity) More...

virtual void	getVertexPosition (ROOT::Math::XYZVector &position) const
	Particle's vertex modification. Caller presets defaults to: (multiplicity=m_multiplicity) More...

virtual void	getParticleDirection (int num, ROOT::Math::XYZVector &direction, double &momentum) const
	Particle modification. Caller presets defaults to: ( direction = m_direction, momentum = m_energy) More...

void	getParticleMomentumUniform (double &momentum) const
	Uniform particle momentum. More...

virtual void	printInteraction (int mask) const
	Print single particle interaction identified by its mask. More...

virtual void	printInteraction (Geant4PrimaryInteraction *inter) const
	Print single particle interaction identified by its reference. More...

Protected Member Functions inherited from dd4hep::sim::Geant4GeneratorAction
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4GeneratorAction)
	Define standard assignments and constructors. More...

Protected Member Functions inherited from dd4hep::sim::Geant4Action
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Action)
	Define standard assignments and constructors. More...

virtual	~Geant4Action ()
	Default destructor. More...

Protected Attributes
ROOT::Math::XYZVector	m_direction
	Property: Shooting direction of the gun. More...

ROOT::Math::XYZVector	m_position
	Property: Position of the gun in space. More...

std::string	m_particleName
	Property: Particle name. More...

G4ParticleDefinition *	m_particle
	Pointer to geant4 particle definition. More...

double	m_energy
	Property: Fixed momentum value, overwrites momentumMin and momentumMax if set. More...

double	m_momentumMin
	Property: Minimal momentum value. More...

double	m_momentumMax
	Property: Maximal momentum value. More...

int	m_multiplicity
	Property: Desired multiplicity of the particles to be shot. More...

int	m_mask
	Property: User mask passed to all particles in the generated interaction. More...

Protected Attributes inherited from dd4hep::sim::Geant4GeneratorAction
Callback	m_calls

Protected Attributes inherited from dd4hep::sim::Geant4Action
Geant4Context *	m_context { nullptr }
	Reference to the Geant4 context. More...

Geant4UIMessenger *	m_control { nullptr }
	Control directory of this action. More...

int	m_outputLevel { 3 }
	Default property: Output level. More...

bool	m_needsControl { false }
	Default property: Flag to create control instance. More...

std::string	m_name { }
	Action name. More...

PropertyManager	m_properties { }
	Property pool. More...

long	m_refCount { 1 }
	Reference count. Initial value: 1. More...

Additional Inherited Members
Public Types inherited from dd4hep::sim::Geant4GeneratorAction
typedef Geant4SharedGeneratorAction	shared_type

Detailed Description

Generate particles isotrop in space around origine (0,0,0)

Author: M.Frank

Version: 1.0

Definition at line 38 of file Geant4ParticleGenerator.h.

Constructor & Destructor Documentation

◆ Geant4ParticleGenerator()

Geant4ParticleGenerator::Geant4ParticleGenerator	(	Geant4Context *	context,
		const std::string &	name
	)

Standard constructor.

Definition at line 34 of file Geant4ParticleGenerator.cpp.

◆ ~Geant4ParticleGenerator()

Geant4ParticleGenerator::~Geant4ParticleGenerator ( )

virtual

Default destructor.

Definition at line 51 of file Geant4ParticleGenerator.cpp.

Member Function Documentation

◆ getParticleDirection()

void Geant4ParticleGenerator::getParticleDirection	(	int	num,
		ROOT::Math::XYZVector &	direction,
		double &	momentum
	)		const

protectedvirtual

Particle modification. Caller presets defaults to: ( direction = m_direction, momentum = m_energy)

Particle modification. Caller presets defaults to: ( direction = m_direction, momentum = [mMin, mMax])

Use this function to implement isotrop guns, multiple guns etc. User must return a UNIT vector, which gets scaled with momentum.

Reimplemented in dd4hep::sim::Geant4ParticleGun, and dd4hep::sim::Geant4IsotropeGenerator.

Definition at line 56 of file Geant4ParticleGenerator.cpp.

◆ getParticleMomentumUniform()

void Geant4ParticleGenerator::getParticleMomentumUniform ( double & momentum ) const

protected

Uniform particle momentum.

Uniform momentum distribution.

Definition at line 61 of file Geant4ParticleGenerator.cpp.

◆ getParticleMultiplicity()

void Geant4ParticleGenerator::getParticleMultiplicity ( int & multiplicity ) const

protectedvirtual

Particle modification. Caller presets defaults to: (multiplicity=m_multiplicity)

Definition at line 76 of file Geant4ParticleGenerator.cpp.

◆ getVertexPosition()

void Geant4ParticleGenerator::getVertexPosition ( ROOT::Math::XYZVector & position ) const

protectedvirtual

Particle's vertex modification. Caller presets defaults to: (multiplicity=m_multiplicity)

Particle modification. Caller presets defaults to: (multiplicity=m_multiplicity)

Definition at line 80 of file Geant4ParticleGenerator.cpp.

◆ operator()()

void Geant4ParticleGenerator::operator() ( G4Event * event )

overridevirtual

Callback to generate primary particles.

Reimplemented from dd4hep::sim::Geant4GeneratorAction.

Reimplemented in dd4hep::sim::Geant4ParticleGun.

Definition at line 120 of file Geant4ParticleGenerator.cpp.

◆ printInteraction() [1/2]

void Geant4ParticleGenerator::printInteraction ( Geant4PrimaryInteraction * inter ) const

protectedvirtual

Print single particle interaction identified by its reference.

Definition at line 99 of file Geant4ParticleGenerator.cpp.

◆ printInteraction() [2/2]

void Geant4ParticleGenerator::printInteraction ( int mask ) const

protectedvirtual

Print single particle interaction identified by its mask.

Definition at line 84 of file Geant4ParticleGenerator.cpp.

Member Data Documentation

◆ m_direction

ROOT::Math::XYZVector dd4hep::sim::Geant4ParticleGenerator::m_direction

protected

Property: Shooting direction of the gun.

Definition at line 42 of file Geant4ParticleGenerator.h.

◆ m_energy

double dd4hep::sim::Geant4ParticleGenerator::m_energy

protected

Property: Fixed momentum value, overwrites momentumMin and momentumMax if set.

Definition at line 50 of file Geant4ParticleGenerator.h.

◆ m_mask

int dd4hep::sim::Geant4ParticleGenerator::m_mask

protected

Property: User mask passed to all particles in the generated interaction.

Definition at line 58 of file Geant4ParticleGenerator.h.

◆ m_momentumMax

double dd4hep::sim::Geant4ParticleGenerator::m_momentumMax

protected

Property: Maximal momentum value.

Definition at line 54 of file Geant4ParticleGenerator.h.

◆ m_momentumMin

double dd4hep::sim::Geant4ParticleGenerator::m_momentumMin

protected

Property: Minimal momentum value.

Definition at line 52 of file Geant4ParticleGenerator.h.

◆ m_multiplicity

int dd4hep::sim::Geant4ParticleGenerator::m_multiplicity

protected

Property: Desired multiplicity of the particles to be shot.

Definition at line 56 of file Geant4ParticleGenerator.h.

◆ m_particle

G4ParticleDefinition* dd4hep::sim::Geant4ParticleGenerator::m_particle

protected

Pointer to geant4 particle definition.

Definition at line 48 of file Geant4ParticleGenerator.h.

◆ m_particleName

std::string dd4hep::sim::Geant4ParticleGenerator::m_particleName

protected

Property: Particle name.

Definition at line 46 of file Geant4ParticleGenerator.h.

◆ m_position

ROOT::Math::XYZVector dd4hep::sim::Geant4ParticleGenerator::m_position

protected

Property: Position of the gun in space.

Definition at line 44 of file Geant4ParticleGenerator.h.

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

DDG4/include/DDG4/Geant4ParticleGenerator.h
DDG4/src/Geant4ParticleGenerator.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geant4ParticleGenerator()

◆ ~Geant4ParticleGenerator()

Member Function Documentation

◆ getParticleDirection()

◆ getParticleMomentumUniform()

◆ getParticleMultiplicity()

◆ getVertexPosition()

◆ operator()()

◆ printInteraction() [1/2]

◆ printInteraction() [2/2]

Member Data Documentation

◆ m_direction

◆ m_energy

◆ m_mask

◆ m_momentumMax

◆ m_momentumMin

◆ m_multiplicity

◆ m_particle

◆ m_particleName

◆ m_position