Class that extends the functionality of G4GeneralParticleSource. More...

#include <GeneralParticleSource.h>

Public Member Functions
	GeneralParticleSource (const std::string &name, const framework::config::Parameters &parameters)
	Constructor.

virtual	~GeneralParticleSource ()=default
	Destructor.

void	GeneratePrimaryVertex (G4Event *event) override
	Generate the primary vertices in the Geant4 event.

void	RecordConfig (const std::string &id, ldmx::RunHeader &rh) override
	Record the configuration of the primary generator into the run header.

Public Member Functions inherited from simcore::PrimaryGenerator
	PrimaryGenerator (const std::string &name, const framework::config::Parameters &parameters)
	Constructor.

	DECLARE_FACTORY_WITH_WAREHOUSE (PrimaryGenerator, std::shared_ptr< PrimaryGenerator >, const std::string &, const framework::config::Parameters &)

virtual	~PrimaryGenerator ()=default
	Destructor.

std::string	name ()

Private Attributes
G4GeneralParticleSource	the_g4_source_
	The underlying Geant4 GPS implementation.

std::vector< std::string >	init_commands_
	storage of initialization commands (for config recording)

Additional Inherited Members
Protected Attributes inherited from simcore::PrimaryGenerator
std::string	name_ {""}
	Name of the PrimaryGenerator.

Detailed Description

Class that extends the functionality of G4GeneralParticleSource.

Definition at line 30 of file GeneralParticleSource.h.

Constructor & Destructor Documentation

◆ GeneralParticleSource()

simcore::generators::GeneralParticleSource::GeneralParticleSource	(	const std::string &	name,
		const framework::config::Parameters &	parameters )

Constructor.

Parameters

parameters Parameters used to configure the particle gun.

Parameters: initCommands : vector of Geant4 strings to initialize the GPS

Definition at line 23 of file GeneralParticleSource.cxx.

    : PrimaryGenerator(name, parameters) {
  init_commands_ = parameters.get<std::vector<std::string>>("initCommands");
  for (const auto& cmd : init_commands_) {
    int g4_ret = G4UImanager::GetUIpointer()->ApplyCommand(cmd);
    if (g4_ret > 0) {
      EXCEPTION_RAISE("InitCmd",
                      "Initialization command '" + cmd +
                          "' returned a failue status from Geant4: " +
                          std::to_string(g4_ret));
    }
  }
}

References framework::config::Parameters::get(), and init_commands_.

Member Function Documentation

◆ GeneratePrimaryVertex()

void simcore::generators::GeneralParticleSource::GeneratePrimaryVertex ( G4Event * event )

overridevirtual

Generate the primary vertices in the Geant4 event.

Parameters

event The Geant4 event.

Implements simcore::PrimaryGenerator.

Definition at line 38 of file GeneralParticleSource.cxx.

                                                                {
  // just pass to the Geant4 implementation
  the_g4_source_.GeneratePrimaryVertex(event);
  return;
}

References the_g4_source_.

◆ RecordConfig()

void simcore::generators::GeneralParticleSource::RecordConfig	(	const std::string &	id,
		ldmx::RunHeader &	rh )

overridevirtual

Record the configuration of the primary generator into the run header.

Note: you must include the id number in each entry into the run header just in case there are other generators

Implements simcore::PrimaryGenerator.

Definition at line 44 of file GeneralParticleSource.cxx.

                                                            {
  rh.setStringParameter(id + " Class",
                        "simcore::generators::GeneralParticleSource");
  std::string init_prefix{id + " Init Cmd "};
  for (std::size_t i{0}; i < init_commands_.size(); i++) {
    rh.setStringParameter(init_prefix + std::to_string(i),
                          init_commands_.at(i));
  }
}

References init_commands_, and ldmx::RunHeader::setStringParameter().

Member Data Documentation

◆ init_commands_

std::vector<std::string> simcore::generators::GeneralParticleSource::init_commands_

private

storage of initialization commands (for config recording)

Definition at line 64 of file GeneralParticleSource.h.

Referenced by GeneralParticleSource(), and RecordConfig().

◆ the_g4_source_

G4GeneralParticleSource simcore::generators::GeneralParticleSource::the_g4_source_

private

The underlying Geant4 GPS implementation.

The creation of this class creates a new messenger that we can pass commands to.

Definition at line 61 of file GeneralParticleSource.h.

Referenced by GeneratePrimaryVertex().

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

SimCore/include/SimCore/Generators/GeneralParticleSource.h
SimCore/src/SimCore/Generators/GeneralParticleSource.cxx

Public Member Functions

Private Attributes

Additional Inherited Members