DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dd4hep::sim::Geant4IsotropeGenerator Class Reference

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

#include <Geant4IsotropeGenerator.h>

Inheritance diagram for dd4hep::sim::Geant4IsotropeGenerator:
dd4hep::sim::Geant4ParticleGenerator dd4hep::sim::Geant4GeneratorAction dd4hep::sim::Geant4Action dd4hep::sim::Geant4ParticleGun

Public Member Functions

 Geant4IsotropeGenerator ()=delete
 Inhibit default constructor. More...
 
 Geant4IsotropeGenerator (const Geant4IsotropeGenerator &copy)=delete
 Inhibit copy constructor. More...
 
 Geant4IsotropeGenerator (Geant4Context *context, const std::string &name)
 Standard constructor. More...
 
virtual ~Geant4IsotropeGenerator ()
 Default destructor. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4ParticleGenerator
 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...
 
Geant4Contextcontext () 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...
 
PropertyManagerproperties ()
 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...
 
Geant4UIMessengercontrol () const
 Access to the UI messenger. More...
 
virtual void enableUI ()
 Enable and install UI messenger. More...
 
template<typename T >
Geant4ActiondeclareProperty (const std::string &nam, T &val)
 Declare property. More...
 
template<typename T >
Geant4ActiondeclareProperty (const char *nam, T &val)
 Declare property. More...
 
bool hasProperty (const std::string &name) const
 Check property for existence. More...
 
Propertyproperty (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...
 
Geant4RunActionSequencerunAction () const
 Access to the main run action sequence from the kernel object. More...
 
Geant4EventActionSequenceeventAction () const
 Access to the main event action sequence from the kernel object. More...
 
Geant4SteppingActionSequencesteppingAction () const
 Access to the main stepping action sequence from the kernel object. More...
 
Geant4TrackingActionSequencetrackingAction () const
 Access to the main tracking action sequence from the kernel object. More...
 
Geant4StackingActionSequencestackingAction () const
 Access to the main stacking action sequence from the kernel object. More...
 
Geant4GeneratorActionSequencegeneratorAction () const
 Access to the main generator action sequence from the kernel object. More...
 

Protected Member Functions

virtual void getParticleDirection (int num, ROOT::Math::XYZVector &direction, double &momentum) const override
 Particle modification. Caller presets defaults to: ( direction = m_direction, momentum = [m_momentumMin, m_momentumMax]) More...
 
void getParticleDirectionFFbar (int num, ROOT::Math::XYZVector &direction, double &momentum) const
 e+e- --> ffbar particle distribution ~ 1 + cos^2(theta) More...
 
void getParticleDirectionEta (int num, ROOT::Math::XYZVector &direction, double &momentum) const
 e+e- --> ffbar particle distribution ~ 1 + cos^2(theta) More...
 
void getParticleDirectionCosTheta (int num, ROOT::Math::XYZVector &direction, double &momentum) const
 Particle distribution ~ cos(theta) More...
 
void getParticleDirectionUniform (int num, ROOT::Math::XYZVector &direction, double &momentum) const
 Uniform particle distribution. More...
 
- Protected Member Functions inherited from dd4hep::sim::Geant4ParticleGenerator
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...
 
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

std::string m_distribution
 Property: Distribution name. Default: "uniform". Allowed: "uniform", "cos(theta)", "ffbar", "eta". More...
 
double m_phiMin
 Property: Minimal phi angular value. More...
 
double m_phiMax
 Property: Maximal phi angular value. More...
 
double m_thetaMin
 Property: Minimal theta angular value. More...
 
double m_thetaMax
 Property: Maximal theta angular value. More...
 
- Protected Attributes inherited from dd4hep::sim::Geant4ParticleGenerator
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
Geant4Contextm_context { nullptr }
 Reference to the Geant4 context. More...
 
Geant4UIMessengerm_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 31 of file Geant4IsotropeGenerator.h.

Constructor & Destructor Documentation

◆ Geant4IsotropeGenerator() [1/3]

dd4hep::sim::Geant4IsotropeGenerator::Geant4IsotropeGenerator ( )
delete

Inhibit default constructor.

◆ Geant4IsotropeGenerator() [2/3]

dd4hep::sim::Geant4IsotropeGenerator::Geant4IsotropeGenerator ( const Geant4IsotropeGenerator copy)
delete

Inhibit copy constructor.

◆ Geant4IsotropeGenerator() [3/3]

Geant4IsotropeGenerator::Geant4IsotropeGenerator ( Geant4Context context,
const std::string &  name 
)

Standard constructor.

Definition at line 23 of file Geant4IsotropeGenerator.cpp.

◆ ~Geant4IsotropeGenerator()

Geant4IsotropeGenerator::~Geant4IsotropeGenerator ( )
virtual

Default destructor.

Definition at line 35 of file Geant4IsotropeGenerator.cpp.

Member Function Documentation

◆ getParticleDirection()

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

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

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 from dd4hep::sim::Geant4ParticleGenerator.

Reimplemented in dd4hep::sim::Geant4ParticleGun.

Definition at line 119 of file Geant4IsotropeGenerator.cpp.

◆ getParticleDirectionCosTheta()

void Geant4IsotropeGenerator::getParticleDirectionCosTheta ( int  num,
ROOT::Math::XYZVector &  direction,
double &  momentum 
) const
protected

Particle distribution ~ cos(theta)

Definition at line 54 of file Geant4IsotropeGenerator.cpp.

◆ getParticleDirectionEta()

void Geant4IsotropeGenerator::getParticleDirectionEta ( int  num,
ROOT::Math::XYZVector &  direction,
double &  momentum 
) const
protected

e+e- --> ffbar particle distribution ~ 1 + cos^2(theta)

Particle distribution flat in eta (pseudo rapidity)

Definition at line 69 of file Geant4IsotropeGenerator.cpp.

◆ getParticleDirectionFFbar()

void Geant4IsotropeGenerator::getParticleDirectionFFbar ( int  num,
ROOT::Math::XYZVector &  direction,
double &  momentum 
) const
protected

e+e- --> ffbar particle distribution ~ 1 + cos^2(theta)

Definition at line 90 of file Geant4IsotropeGenerator.cpp.

◆ getParticleDirectionUniform()

void Geant4IsotropeGenerator::getParticleDirectionUniform ( int  num,
ROOT::Math::XYZVector &  direction,
double &  momentum 
) const
protected

Uniform particle distribution.

Definition at line 40 of file Geant4IsotropeGenerator.cpp.

Member Data Documentation

◆ m_distribution

std::string dd4hep::sim::Geant4IsotropeGenerator::m_distribution
protected

Property: Distribution name. Default: "uniform". Allowed: "uniform", "cos(theta)", "ffbar", "eta".

Definition at line 34 of file Geant4IsotropeGenerator.h.

◆ m_phiMax

double dd4hep::sim::Geant4IsotropeGenerator::m_phiMax
protected

Property: Maximal phi angular value.

Definition at line 38 of file Geant4IsotropeGenerator.h.

◆ m_phiMin

double dd4hep::sim::Geant4IsotropeGenerator::m_phiMin
protected

Property: Minimal phi angular value.

Definition at line 36 of file Geant4IsotropeGenerator.h.

◆ m_thetaMax

double dd4hep::sim::Geant4IsotropeGenerator::m_thetaMax
protected

Property: Maximal theta angular value.

Definition at line 42 of file Geant4IsotropeGenerator.h.

◆ m_thetaMin

double dd4hep::sim::Geant4IsotropeGenerator::m_thetaMin
protected

Property: Minimal theta angular value.

Definition at line 40 of file Geant4IsotropeGenerator.h.


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