G4TrackingManager Class Reference

#include <G4TrackingManager.hh>

Public Types
using	ProfilerConfig = G4Track::ProfilerConfig

Public Member Functions
void	EventAborted ()
	G4TrackingManager ()
G4SteppingManager *	GetSteppingManager () const
G4int	GetStoreTrajectory () const
G4Track *	GetTrack () const
G4UserTrackingAction *	GetUserTrackingAction () const
G4int	GetVerboseLevel () const
G4TrackVector *	GimmeSecondaries () const
G4VTrajectory *	GimmeTrajectory () const
void	ProcessOneTrack (G4Track *apValueG4Track)
void	SetStoreTrajectory (G4int value)
void	SetTrajectory (G4VTrajectory *aTrajectory)
void	SetUserAction (G4UserSteppingAction *apAction)
void	SetUserAction (G4UserTrackingAction *apAction)
void	SetUserTrackInformation (G4VUserTrackInformation *aValue)
void	SetVerboseLevel (G4int vLevel)
	~G4TrackingManager ()

Private Member Functions
void	TrackBanner ()

Private Attributes
G4bool	EventIsAborted = false
G4SteppingManager *	fpSteppingManager = nullptr
G4Track *	fpTrack = nullptr
G4VTrajectory *	fpTrajectory = nullptr
G4UserTrackingAction *	fpUserTrackingAction = nullptr
G4TrackingMessenger *	messenger = nullptr
G4int	StoreTrajectory = 0
G4int	verboseLevel = 0

Detailed Description

Definition at line 59 of file G4TrackingManager.hh.

Member Typedef Documentation

ProfilerConfig

using G4TrackingManager::ProfilerConfig = G4Track::ProfilerConfig

Definition at line 63 of file G4TrackingManager.hh.

Constructor & Destructor Documentation

G4TrackingManager()

G4TrackingManager::G4TrackingManager

(

)

Definition at line 43 of file G4TrackingManager.cc.

{
  messenger = new G4TrackingMessenger(this);
  fpSteppingManager = new G4SteppingManager();
}

References fpSteppingManager, and messenger.

~G4TrackingManager()

G4TrackingManager::~G4TrackingManager

(

)

Definition at line 51 of file G4TrackingManager.cc.

{
  delete messenger;
  delete fpSteppingManager;
  delete fpUserTrackingAction;
}

References fpSteppingManager, fpUserTrackingAction, and messenger.

Member Function Documentation

EventAborted()

void G4TrackingManager::EventAborted

(

)

Definition at line 187 of file G4TrackingManager.cc.

{
  fpTrack->SetTrackStatus( fKillTrackAndSecondaries );
  EventIsAborted = true;
}

References EventIsAborted, fKillTrackAndSecondaries, fpTrack, and G4Track::SetTrackStatus().

Referenced by G4EventManager::AbortCurrentEvent().

GetSteppingManager()

G4SteppingManager * G4TrackingManager::GetSteppingManager ( ) const

inline

Definition at line 155 of file G4TrackingManager.hh.

{ 
  return fpSteppingManager; 
}

References fpSteppingManager.

Referenced by G4ExceptionHandler::DumpTrackInfo(), G4ErrorPropagator::G4ErrorPropagator(), G4TrackingMessenger::G4TrackingMessenger(), G4ErrorPropagatorManager::SetSteppingManagerVerboseLevel(), and G4ErrorPropagatorManager::StartNavigator().

GetStoreTrajectory()

G4int G4TrackingManager::GetStoreTrajectory ( ) const

inline

Definition at line 145 of file G4TrackingManager.hh.

{ 
  return StoreTrajectory;
}

References StoreTrajectory.

Referenced by G4VisManager::Disable(), export_G4TrackingManager(), and G4TrackingMessenger::GetCurrentValue().

GetTrack()

G4Track * G4TrackingManager::GetTrack ( ) const

inline

Definition at line 140 of file G4TrackingManager.hh.

{ 
  return fpTrack;
}

References fpTrack.

GetUserTrackingAction()

G4UserTrackingAction * G4TrackingManager::GetUserTrackingAction ( ) const

inline

Definition at line 160 of file G4TrackingManager.hh.

{ 
  return fpUserTrackingAction; 
}

References fpUserTrackingAction.

GetVerboseLevel()

G4int G4TrackingManager::GetVerboseLevel ( ) const

inline

Definition at line 199 of file G4TrackingManager.hh.

{ 
  return verboseLevel; 
}

References verboseLevel.

Referenced by export_G4TrackingManager(), G4TrackingMessenger::GetCurrentValue(), and G4ErrorPropagatorManager::SetSteppingManagerVerboseLevel().

GimmeSecondaries()

G4TrackVector * G4TrackingManager::GimmeSecondaries ( ) const

inline

Definition at line 170 of file G4TrackingManager.hh.

{ 
  return fpSteppingManager->GetfSecondary(); 
}

References fpSteppingManager, and G4SteppingManager::GetfSecondary().

Referenced by G4EventManager::DoProcessing(), and ProcessOneTrack().

GimmeTrajectory()

G4VTrajectory * G4TrackingManager::GimmeTrajectory ( ) const

inline

Definition at line 165 of file G4TrackingManager.hh.

{ 
  return fpTrajectory; 
}

References fpTrajectory.

Referenced by G4EventManager::DoProcessing().

ProcessOneTrack()

void G4TrackingManager::ProcessOneTrack

(

G4Track *

apValueG4Track

)

Definition at line 60 of file G4TrackingManager.cc.

{
  // Receiving a G4Track from the EventManager, this funciton has the
  // responsibility to trace the track till it stops
 
  fpTrack = apValueG4Track;
  EventIsAborted = false;
 
  // Clear secondary particle vector
  //
  for(std:: size_t itr=0; itr<GimmeSecondaries()->size(); ++itr)
  { 
    delete (*GimmeSecondaries())[itr];
  }
  GimmeSecondaries()->clear();  
   
  if(verboseLevel>0 && (G4VSteppingVerbose::GetSilent()!=1) ) TrackBanner();
  
  // Give SteppingManger the pointer to the track which will be tracked
  //
  fpSteppingManager->SetInitialStep(fpTrack);
 
  // Pre tracking user intervention process
 
  fpTrajectory = nullptr;
  if( fpUserTrackingAction != nullptr )
  {
    fpUserTrackingAction->PreUserTrackingAction(fpTrack);
  }
 
  // we need this to scope the G4Track::ProfilerConfig b/t
  // the PreUserTrackingAction and PostUserTrackingAction
  {
#if defined(GEANT4_USE_TIMEMORY)
    ProfilerConfig profiler{ fpTrack };
#endif
 
#ifdef G4_STORE_TRAJECTORY
    // Construct a trajectory if it is requested
    //
    if(StoreTrajectory && (fpTrajectory == nullptr))
    {
      // default trajectory concrete class object
      switch(StoreTrajectory)
      {
        default:
        case 1:
          fpTrajectory = new G4Trajectory(fpTrack);
          break;
        case 2:
          fpTrajectory = new G4SmoothTrajectory(fpTrack);
          break;
        case 3:
          fpTrajectory = new G4RichTrajectory(fpTrack);
          break;
        case 4:
          fpTrajectory = new G4RichTrajectory(fpTrack);
          break;
      }
    }
#endif
 
    // Give SteppingManger the maxmimum number of processes
    fpSteppingManager->GetProcessNumber();
 
    // Give track the pointer to the Step
    fpTrack->SetStep(fpSteppingManager->GetStep());
 
    // Inform beginning of tracking to physics processes
    fpTrack->GetDefinition()->GetProcessManager()->StartTracking(fpTrack);
 
    // Track the particle Step-by-Step while it is alive
    //
    while((fpTrack->GetTrackStatus() == fAlive) ||
          (fpTrack->GetTrackStatus() == fStopButAlive))
    {
      fpTrack->IncrementCurrentStepNumber();
      fpSteppingManager->Stepping();
#ifdef G4_STORE_TRAJECTORY
      if(StoreTrajectory)
      {
        fpTrajectory->AppendStep(fpSteppingManager->GetStep());
      }
#endif
      if(EventIsAborted)
      {
        fpTrack->SetTrackStatus(fKillTrackAndSecondaries);
      }
    }
    // Inform end of tracking to physics processes
    fpTrack->GetDefinition()->GetProcessManager()->EndTracking();
  }
 
  // Post tracking user intervention process.
  if( fpUserTrackingAction != nullptr )
  {
    fpUserTrackingAction->PostUserTrackingAction(fpTrack);
  }
 
  // Destruct the trajectory if it was created
#ifdef G4VERBOSE
  if(StoreTrajectory&&verboseLevel>10)
  {
    fpTrajectory->ShowTrajectory();
  }
#endif
  if( (!StoreTrajectory) && (fpTrajectory != nullptr) )
  {
    delete fpTrajectory;
    fpTrajectory = nullptr;
  }
}

References G4VTrajectory::AppendStep(), G4ProcessManager::EndTracking(), EventIsAborted, fAlive, fKillTrackAndSecondaries, fpSteppingManager, fpTrack, fpTrajectory, fpUserTrackingAction, fStopButAlive, G4Track::GetDefinition(), G4ParticleDefinition::GetProcessManager(), G4SteppingManager::GetProcessNumber(), G4VSteppingVerbose::GetSilent(), G4SteppingManager::GetStep(), G4Track::GetTrackStatus(), GimmeSecondaries(), G4Track::IncrementCurrentStepNumber(), G4UserTrackingAction::PostUserTrackingAction(), G4UserTrackingAction::PreUserTrackingAction(), G4SteppingManager::SetInitialStep(), G4Track::SetStep(), G4Track::SetTrackStatus(), G4VTrajectory::ShowTrajectory(), G4ProcessManager::StartTracking(), G4SteppingManager::Stepping(), StoreTrajectory, TrackBanner(), and verboseLevel.

Referenced by G4EventManager::DoProcessing().

SetStoreTrajectory()

void G4TrackingManager::SetStoreTrajectory ( G4int  value )

inline

Definition at line 150 of file G4TrackingManager.hh.

{ 
  StoreTrajectory = value;
}

References StoreTrajectory.

Referenced by export_G4TrackingManager(), and G4TrackingMessenger::SetNewValue().

SetTrajectory()

void G4TrackingManager::SetTrajectory

(

G4VTrajectory *

aTrajectory

)

Definition at line 175 of file G4TrackingManager.cc.

{
#ifndef G4_STORE_TRAJECTORY
  G4Exception("G4TrackingManager::SetTrajectory()",
              "Tracking0015", FatalException,
              "Invoked without G4_STORE_TRAJECTORY option set!");
#endif
  fpTrajectory = aTrajectory;
}

References FatalException, fpTrajectory, and G4Exception().

Referenced by G4RTTrackingAction::PreUserTrackingAction().

SetUserAction() [1/2]

void G4TrackingManager::SetUserAction ( G4UserSteppingAction *  apAction )

inline

Definition at line 184 of file G4TrackingManager.hh.

{
  fpSteppingManager->SetUserAction(apAction);
  if(apAction != nullptr)
  {
    apAction->SetSteppingManagerPointer(fpSteppingManager);  
  }
}

References fpSteppingManager, G4UserSteppingAction::SetSteppingManagerPointer(), and G4SteppingManager::SetUserAction().

SetUserAction() [2/2]

void G4TrackingManager::SetUserAction ( G4UserTrackingAction *  apAction )

inline

Definition at line 175 of file G4TrackingManager.hh.

{
  fpUserTrackingAction = apAction;
  if(apAction != nullptr)
  {
    apAction->SetTrackingManagerPointer(this);
  }
}

References fpUserTrackingAction, and G4UserTrackingAction::SetTrackingManagerPointer().

Referenced by G4EventManager::SetUserAction().

SetUserTrackInformation()

void G4TrackingManager::SetUserTrackInformation ( G4VUserTrackInformation *  aValue )

inline

Definition at line 205 of file G4TrackingManager.hh.

{
  if(fpTrack != nullptr) fpTrack->SetUserInformation(aValue);
}

References fpTrack, and G4Track::SetUserInformation().

Referenced by export_G4TrackingManager().

SetVerboseLevel()

void G4TrackingManager::SetVerboseLevel ( G4int  vLevel )

inline

Definition at line 193 of file G4TrackingManager.hh.

{ 
  verboseLevel = vLevel; 
  fpSteppingManager -> SetVerboseLevel( vLevel );
}

References fpSteppingManager, SetVerboseLevel(), and verboseLevel.

Referenced by export_G4TrackingManager(), G4TrackingMessenger::SetNewValue(), and SetVerboseLevel().

TrackBanner()

void G4TrackingManager::TrackBanner ( )

private

Definition at line 195 of file G4TrackingManager.cc.

{
  G4cout << G4endl;
  G4cout << "*******************************************************"
         << "**************************************************"
         << G4endl;
  G4cout << "* G4Track Information: "
         << "  Particle = " << fpTrack->GetDefinition()->GetParticleName()
         << ","
         << "   Track ID = " << fpTrack->GetTrackID()
         << ","
         << "   Parent ID = " << fpTrack->GetParentID()
         << G4endl;
  G4cout << "*******************************************************"
         << "**************************************************"
         << G4endl;
  G4cout << G4endl;
}

References fpTrack, G4cout, G4endl, G4Track::GetDefinition(), G4Track::GetParentID(), G4ParticleDefinition::GetParticleName(), and G4Track::GetTrackID().

Referenced by ProcessOneTrack().

Field Documentation

EventIsAborted

G4bool G4TrackingManager::EventIsAborted = false

private

Definition at line 131 of file G4TrackingManager.hh.

Referenced by EventAborted(), and ProcessOneTrack().

fpSteppingManager

G4SteppingManager* G4TrackingManager::fpSteppingManager = nullptr

private

Definition at line 125 of file G4TrackingManager.hh.

Referenced by G4TrackingManager(), GetSteppingManager(), GimmeSecondaries(), ProcessOneTrack(), SetUserAction(), SetVerboseLevel(), and ~G4TrackingManager().

fpTrack

G4Track* G4TrackingManager::fpTrack = nullptr

private

Definition at line 124 of file G4TrackingManager.hh.

Referenced by EventAborted(), GetTrack(), ProcessOneTrack(), SetUserTrackInformation(), and TrackBanner().

fpTrajectory

G4VTrajectory* G4TrackingManager::fpTrajectory = nullptr

private

Definition at line 127 of file G4TrackingManager.hh.

Referenced by GimmeTrajectory(), ProcessOneTrack(), and SetTrajectory().

fpUserTrackingAction

G4UserTrackingAction* G4TrackingManager::fpUserTrackingAction = nullptr

private

Definition at line 126 of file G4TrackingManager.hh.

Referenced by GetUserTrackingAction(), ProcessOneTrack(), SetUserAction(), and ~G4TrackingManager().

messenger

G4TrackingMessenger* G4TrackingManager::messenger = nullptr

private

Definition at line 130 of file G4TrackingManager.hh.

Referenced by G4TrackingManager(), and ~G4TrackingManager().

StoreTrajectory

G4int G4TrackingManager::StoreTrajectory = 0

private

Definition at line 128 of file G4TrackingManager.hh.

Referenced by GetStoreTrajectory(), ProcessOneTrack(), and SetStoreTrajectory().

verboseLevel

G4int G4TrackingManager::verboseLevel = 0

private

Definition at line 129 of file G4TrackingManager.hh.

Referenced by GetVerboseLevel(), ProcessOneTrack(), and SetVerboseLevel().

---

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

• source/tracking/include/G4TrackingManager.hh
• source/tracking/src/G4TrackingManager.cc