scavenger/include/TimeStepAction.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 /// \file scavenger/include/TimeStepAction.hh
0027 /// \brief Definition of the scavenger::TimeStepAction class
0028
0029 #ifndef TimeStepAction_h
0030 #  define TimeStepAction_h 1
0031
0032 #  include "G4UserTimeStepAction.hh"
0033
0034 namespace scavenger
0035 {
0036
0037 class TimeStepAction : public G4UserTimeStepAction
0038 {
0039   public:
0040     TimeStepAction();
0041     virtual ~TimeStepAction();
0042     TimeStepAction(const TimeStepAction& other);
0043     TimeStepAction& operator=(const TimeStepAction& other);
0044
0045     virtual void StartProcessing() { ; }
0046
0047     /** In this method, the user can use :
0048      * G4ITTimeStepper::Instance()->GetGlobalTime(),
0049      *    to know the current simulation time
0050      * G4ITTimeStepper::Instance()->GetTimeStep(),
0051      *    to know the selected minimum time
0052      * WARNING :
0053      *    The call of this method happens before the call of DoIT methods
0054      */
0055     virtual void UserPreTimeStepAction();
0056     virtual void UserPostTimeStepAction();
0057
0058     /**
0059      * Inform about a reaction
0060      */
0061     virtual void UserReactionAction(const G4Track& /*trackA*/, const G4Track& /*trackB*/,
0062                                     const std::vector<G4Track*>* /*products*/);
0063
0064     virtual void EndProcessing() { ; }
0065     void Clear();
0066 };
0067
0068 #endif  // TimeStepAction_h
0069 }