neuron/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 TimeStepAction.hh
0027 /// \brief Definition of the TimeStepAction class
0028
0029 // This example is provided by the Geant4-DNA collaboration
0030 // Any report or published results obtained using the Geant4-DNA software
0031 // shall cite the following Geant4-DNA collaboration publication:
0032 // Med. Phys. 37 (2010) 4692-4708
0033 // and papers
0034 // M. Batmunkh et al. J Radiat Res Appl Sci 8 (2015) 498-507
0035 // O. Belov et al. Physica Medica 32 (2016) 1510-1520
0036 // The Geant4-DNA web site is available at http://geant4-dna.org
0037 //
0038 // -------------------------------------------------------------------
0039 // November 2016
0040 // -------------------------------------------------------------------
0041 //
0042 //
0043
0044 #ifndef ITACTION_H
0045 #define ITACTION_H
0046
0047 #include "G4UserTimeStepAction.hh"
0048
0049 class TimeStepAction : public G4UserTimeStepAction
0050 {
0051   public:
0052     TimeStepAction();
0053     virtual ~TimeStepAction();
0054     TimeStepAction(const TimeStepAction& other);
0055     TimeStepAction& operator=(const TimeStepAction& other);
0056
0057     virtual void StartProcessing() { ; }
0058
0059     /** In this method, the user can use :
0060      * G4ITTimeStepper::Instance()->GetGlobalTime(),
0061      *    to know the current simulation time
0062      * G4ITTimeStepper::Instance()->GetTimeStep(),
0063      *    to know the selected minimum time
0064      * WARNING :
0065      *    The call of this method happens before the call of DoIT methods
0066      */
0067     virtual void UserPreTimeStepAction() { ; }
0068     virtual void UserPostTimeStepAction();
0069
0070     /**
0071      * Inform about a reaction
0072      */
0073     virtual void UserReactionAction(const G4Track& /*trackA*/, const G4Track& /*trackB*/,
0074                                     const std::vector<G4Track*>* /*products*/);
0075
0076     virtual void EndProcessing() { ; }
0077 };
0078
0079 #endif  // ITACTION_H