include/Geant4/G4VTrackingManager.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4VTrackingManager
0027 //
0028 // Class description:
0029 //
0030 // Interface class for implementing a custom tracking manager that is
0031 // specialized for stepping one or a small number of particle types.
0032 //
0033 // Original author: Jonas Hahnfeld, 2021
0034
0035 #ifndef G4VTrackingManager_hh
0036 #define G4VTrackingManager_hh 1
0037
0038 class G4ParticleDefinition;
0039 class G4Track;
0040
0041 ////////////////////////
0042 class G4VTrackingManager
0043 ////////////////////////
0044 {
0045  public:
0046   virtual ~G4VTrackingManager() = default;
0047
0048   // Messaged by the Particle definition whenever cross-section tables have
0049   // to be rebuilt (i.e. if new materials have been defined).
0050   virtual void BuildPhysicsTable(const G4ParticleDefinition&) {}
0051
0052   // Messaged by the Particle definition whenever cross-section tables have
0053   // to be prepared for rebuild (i.e. if new materials have been defined).
0054   virtual void PreparePhysicsTable(const G4ParticleDefinition&) {}
0055
0056   // Invoking this function, a G4Track given by the argument will be
0057   // handed over to this tracking manager. It may be tracked immediately
0058   // or processing may be deferred to a later time, at the latest when
0059   // calling FlushEvent().
0060   virtual void HandOverOneTrack(G4Track* aTrack) = 0;
0061
0062   // Signal that all tracks in the current event have been finished and
0063   // this manager should process all tracks that may have been deferred.
0064   // When called via this method, the tracking manager may stack new
0065   // secondaries which will be tracked afterwards.
0066   virtual void FlushEvent() {}
0067 };
0068
0069 #endif