chem6/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 // This example is provided by the Geant4-DNA collaboration
0027 // chem6 example is derived from chem4 and chem5 examples
0028 //
0029 // Any report or published results obtained using the Geant4-DNA software
0030 // shall cite the following Geant4-DNA collaboration publication:
0031 // J. Appl. Phys. 125 (2019) 104301
0032 // Med. Phys. 45 (2018) e722-e739
0033 // J. Comput. Phys. 274 (2014) 841-882
0034 // Med. Phys. 37 (2010) 4692-4708
0035 // Int. J. Model. Simul. Sci. Comput. 1 (2010) 157-178
0036 // The Geant4-DNA web site is available at http://geant4-dna.org
0037 //
0038 // Authors: W. G. Shin and S. Incerti (CENBG, France)
0039 //
0040 // $Id$
0041 //
0042 /// \file TimeStepAction.hh
0043 /// \brief Definition of the TimeStepAction class
0044
0045 #ifndef CHEM6_TimeStepAction_h
0046 #define CHEM6_TimeStepAction_h 1
0047
0048 #include "G4UserTimeStepAction.hh"
0049
0050 class TimeStepAction : public G4UserTimeStepAction
0051 {
0052   public:
0053     TimeStepAction();
0054     virtual ~TimeStepAction();
0055     TimeStepAction(const TimeStepAction& other);
0056     TimeStepAction& operator=(const TimeStepAction& other);
0057
0058     virtual void StartProcessing() { ; }
0059
0060     /** In this method, the user can use :
0061      * G4ITTimeStepper::Instance()->GetGlobalTime(),
0062      *    to know the current simulation time
0063      * G4ITTimeStepper::Instance()->GetTimeStep(),
0064      *    to know the selected minimum time
0065      * WARNING :
0066      *    The call of this method happens before the call of DoIT methods
0067      */
0068     virtual void UserPreTimeStepAction();
0069     virtual void UserPostTimeStepAction();
0070
0071     /**
0072      * Inform about a reaction
0073      */
0074     virtual void UserReactionAction(const G4Track& /*trackA*/, const G4Track& /*trackB*/,
0075                                     const std::vector<G4Track*>* /*products*/);
0076
0077     virtual void EndProcessing() { ; }
0078     void Clear();
0079 };
0080
0081 #endif  // CHEM6_TimeStepAction_h