biasing::TargetENProcessFilter Class Reference

Public Member Functions
	TargetENProcessFilter (const std::string &name, framework::config::Parameters &parameters)
	Class constructor.
	~TargetENProcessFilter ()
	Destructor.
void	stepping (const G4Step *step) override
	Implementmthe stepping action which performs the target volume biasing.
void	EndOfEventAction (const G4Event *) override
	End of event action.
std::vector< simcore::TYPE >	getTypes () override
	Retrieve the type of actions this class defines.
Public Member Functions inherited from simcore::UserAction
	UserAction (const std::string &name, framework::config::Parameters &parameters)
	Constructor.
	DECLARE_FACTORY (UserAction, std::shared_ptr< UserAction >, const std::string &, framework::config::Parameters &)
	factory for user actions
virtual	~UserAction ()=default
	Destructor.
virtual void	BeginOfEventAction (const G4Event *)
	Method called at the beginning of every event.
virtual void	BeginOfRunAction (const G4Run *)
	Method called at the beginning of a run.
virtual void	EndOfRunAction (const G4Run *)
	Method called at the end of a run.
virtual void	PreUserTrackingAction (const G4Track *)
	Method called before the UserTrackingAction.
virtual void	PostUserTrackingAction (const G4Track *)
	Method called after the UserTrackingAction.
virtual G4ClassificationOfNewTrack	ClassifyNewTrack (const G4Track *, const G4ClassificationOfNewTrack &cl)
	Method called when a track is updated.
virtual void	NewStage ()
	Method called at the beginning of a new stage.
virtual void	PrepareNewEvent ()
	Method called at the beginning of a new event.

Private Attributes
bool	reaction_occurred_ {false}
	Flag indicating if the reaction of intereset occurred.
double	recoil_energy_threshold_ {1500}
	Energy that the recoil electron must not surpass.
std::string	process_ {"electronNuclear"}
	Process to filter on.

Additional Inherited Members
Protected Member Functions inherited from simcore::UserAction
UserEventInformation *	getEventInfo () const
	Get a handle to the event information.
const std::map< int, ldmx::SimParticle > &	getCurrentParticleMap () const
	Get the current particle map.
Protected Attributes inherited from simcore::UserAction
std::string	name_ {""}
	Name of the UserAction.
framework::config::Parameters	parameters_
	The set of parameters used to configure this class.
mutable::framework::logging::logger	the_log_
	the logging channel user actions can use ldmx_log with

Detailed Description

Definition at line 27 of file TargetENProcessFilter.h.

Constructor & Destructor Documentation

TargetENProcessFilter()

biasing::TargetENProcessFilter::TargetENProcessFilter	(	const std::string &	name,
		framework::config::Parameters &	parameters )

Class constructor.

Definition at line 24 of file TargetENProcessFilter.cxx.

    : simcore::UserAction(name, parameters) {
  recoil_energy_threshold_ = parameters.get<double>("recoilThreshold");
}

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

~TargetENProcessFilter()

biasing::TargetENProcessFilter::~TargetENProcessFilter

(

)

Destructor.

Definition at line 30 of file TargetENProcessFilter.cxx.

{}

Member Function Documentation

EndOfEventAction()

void biasing::TargetENProcessFilter::EndOfEventAction ( const G4Event * )

overridevirtual

End of event action.

Reimplemented from simcore::UserAction.

Definition at line 102 of file TargetENProcessFilter.cxx.

                                                           {
  reaction_occurred_ = false;
}

References reaction_occurred_.

getTypes()

std::vector< simcore::TYPE > biasing::TargetENProcessFilter::getTypes ( )

inlineoverridevirtual

Retrieve the type of actions this class defines.

Implements simcore::UserAction.

Definition at line 50 of file TargetENProcessFilter.h.

                                             {
    return {simcore::TYPE::EVENT, simcore::TYPE::STEPPING};
  }

stepping()

void biasing::TargetENProcessFilter::stepping ( const G4Step * step )

overridevirtual

Implementmthe stepping action which performs the target volume biasing.

Parameters

step	The Geant4 step.

Reimplemented from simcore::UserAction.

Definition at line 32 of file TargetENProcessFilter.cxx.

                                                       {
  if (reaction_occurred_) return;
 
  // Get the track associated with this step.
  G4Track* track = step->GetTrack();
 
  // Only process tracks whose parent is the primary particle
  if (track->GetParentID() != 0) return;
 
  // get the PDGID of the track.
  G4int pdg_id = track->GetParticleDefinition()->GetPDGEncoding();
 
  // Make sure that the particle being processed is an electron.
  if (pdg_id != 11) return;  // Throw an exception
 
  // Get the volume the particle is in.
  G4VPhysicalVolume* track_volume = track->GetVolume();
  auto target_volume =
      simcore::g4user::ptrretrieval::getPhysicalVolume("target_PV");
  if (!target_volume) {
    ldmx_log(warn) << "Volume 'target_PV' not found in Geant4 volume store";
  }
  // If the particle isn't in the target, don't continue with the processing.
  if (track_volume != target_volume) return;
 
  // ldmx_log(trace)<< "*   Step " << track->GetCurrentStepNumber();
 
  if (track->GetMomentum().mag() > recoil_energy_threshold_) {
    track->SetTrackStatus(fKillTrackAndSecondaries);
    G4RunManager::GetRunManager()->AbortEvent();
    return;
  }
 
  // Get the particles daughters.
  const G4TrackVector* secondaries = step->GetSecondary();
 
  // If the brem photon doesn't undergo any reaction in the target, stop
  // processing the rest of the event.
  if (secondaries->size() == 0) {
    ldmx_log(debug)
        << "Electron did not interact in the target. --> Postponing tracks.";
 
    track->SetTrackStatus(fKillTrackAndSecondaries);
    G4RunManager::GetRunManager()->AbortEvent();
    return;
  } else {
    G4String process_name =
        secondaries->at(0)->GetCreatorProcess()->GetProcessName();
 
    ldmx_log(debug) << "Electron produced " << secondaries->size()
                    << " particle via " << process_name << " process.";
 
    // Only record the process that is being biased
    if (!process_name.contains(process_)) {
      ldmx_log(debug) << "Process was not " << process_
                      << "--> Killing all tracks!";
 
      track->SetTrackStatus(fKillTrackAndSecondaries);
      G4RunManager::GetRunManager()->AbortEvent();
      return;
    }
 
    ldmx_log(info) << "Electronuclear reaction resulted in "
                   << secondaries->size() << " particles via " << process_name
                   << " process.";
    // BiasingMessenger::setEventWeight(track->GetWeight());
    reaction_occurred_ = true;
  }
}

References process_, reaction_occurred_, and recoil_energy_threshold_.

Member Data Documentation

process_

std::string biasing::TargetENProcessFilter::process_ {"electronNuclear"}

private

Process to filter on.

Definition at line 62 of file TargetENProcessFilter.h.

{"electronNuclear"};

Referenced by stepping().

reaction_occurred_

bool biasing::TargetENProcessFilter::reaction_occurred_ {false}

private

Flag indicating if the reaction of intereset occurred.

Definition at line 56 of file TargetENProcessFilter.h.

{false};

Referenced by EndOfEventAction(), and stepping().

recoil_energy_threshold_

double biasing::TargetENProcessFilter::recoil_energy_threshold_ {1500}

private

Energy that the recoil electron must not surpass.

Definition at line 59 of file TargetENProcessFilter.h.

{1500};

Referenced by stepping(), and TargetENProcessFilter().

---

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

• Biasing/include/Biasing/TargetENProcessFilter.h
• Biasing/src/Biasing/TargetENProcessFilter.cxx