allpix::DepositionCosmicsModule

Module: Modules

Module to simulate the particles stemming from cosmics rays and showers incident on the setup. More…

#include <DepositionCosmicsModule.hpp>

Inherits from allpix::DepositionGeant4Module, allpix::SequentialModule, allpix::Module

Public Functions

	Name
	DepositionCosmicsModule(Configuration & config, Messenger * messenger, GeometryManager * geo_manager) Constructor for this unique module.
virtual void	finalizeThread() override Cleanup RunManager for each thread.
virtual void	finalize() override Display statistical summary.

Friends

	Name
class	CosmicsGeneratorActionG4

Additional inherited members

Public Functions inherited from allpix::DepositionGeant4Module

	Name
	DepositionGeant4Module(Configuration & config, Messenger * messenger, GeometryManager * geo_manager) Constructor for this unique module.
virtual void	initialize() override Initializes the physics list of processes and constructs the particle source.
virtual void	initializeThread() override Prepare thread-local instances of worker run managers.
virtual void	run(Event * event) override Deposit charges for a single event.

Protected Attributes inherited from allpix::DepositionGeant4Module

	Name
Messenger *	messenger_
GeometryManager *	geo_manager_
G4RunManager *	run_manager_g4_

Friends inherited from allpix::DepositionGeant4Module

	Name
class	SDAndFieldConstruction
class	SetTrackInfoUserHookG4

Public Functions inherited from allpix::SequentialModule

	Name
	SequentialModule(Configuration & config)
	SequentialModule(Configuration & config, std::shared_ptr< Detector > detector)

Protected Functions inherited from allpix::SequentialModule

	Name
void	waive_sequence_requirement(bool waive =true) Release strict sequence processing requirement.

Friends inherited from allpix::SequentialModule

	Name
class	Event
class	ModuleManager
class	Messenger

Public Functions inherited from allpix::Module

	Name
	Module(const Module & ) =delete Copying a module is not allowed.
Module &	operator=(const Module & ) =delete Copying a module is not allowed.
	Module(Module && ) =delete Disallow move behaviour (not possible with references)
Module &	operator=(Module && ) =delete Disallow move behaviour (not possible with references)
	Module(Configuration & config) Base constructor for unique modules.
	Module(Configuration & config, std::shared_ptr< Detector > detector) Base constructor for detector modules.
virtual	~Module() Essential virtual destructor.
std::shared_ptr< Detector >	getDetector() const Get the detector linked to this module.
std::string	getUniqueName() const Get the unique name of this module.
std::string	createOutputFile(const std::string & pathname, const std::string & extension ="", bool global =false, bool delete_file =false) Create and return an absolute path to be used for output from a relative path.
TDirectory *	getROOTDirectory() const Get ROOT directory which should be used to output histograms et cetera.
ConfigManager *	getConfigManager() const Get the config manager object to allow to read the global and other module configurations.
bool	multithreadingEnabled() const Returns if multithreading of this module is enabled.
virtual void	initializeThread() Initialize the module for each thread after the global initialization.
virtual void	initialize() Initialize the module before the event sequence.
virtual void	run(Event * event) Execute the function of the module for every event.

Protected Functions inherited from allpix::Module

	Name
void	allow_multithreading() Enable multithreading for this module.
Configuration &	get_configuration() Get the module configuration for internal use.

Protected Attributes inherited from allpix::Module

	Name
Configuration &	config_

Friends inherited from allpix::Module

	Name
class	Event
class	ModuleManager
class	Messenger
class	LocalMessenger

Detailed Description

class allpix::DepositionCosmicsModule;

Module to simulate the particles stemming from cosmics rays and showers incident on the setup.

This module inherits from the DepositionGeant4 module to handle all geant interface but provides its own particle source. The particles are generated by the CRY framework and passed to the particle gun of Geant4 for further processing. Initialization, thread handling and the run method are inherited from the DepositionGeant4 module and only CRY-specific configuration keys are handled in the constructor of this module.

Public Functions Documentation

function DepositionCosmicsModule

DepositionCosmicsModule(
    Configuration & config,
    Messenger * messenger,
    GeometryManager * geo_manager
)

Constructor for this unique module.

Parameters:

config Configuration object for this module as retrieved from the steering file
messenger Pointer to the messenger object to allow binding to messages on the bus
geo_manager Pointer to the geometry manager, containing the detectors

function finalizeThread

virtual void finalizeThread() override

Cleanup RunManager for each thread.

Reimplements: allpix::Module::finalizeThread

function finalize

virtual void finalize() override

Display statistical summary.

Reimplements: allpix::Module::finalize

Friends

friend CosmicsGeneratorActionG4

friend class CosmicsGeneratorActionG4(
    CosmicsGeneratorActionG4 
);

Updated on 2025-04-11 at 14:31:45 +0000