include/Geant4/G4UserTimeStepAction.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 //
0027 // WARNING : This class is released as a prototype.
0028 // It might strongly evolve or even disapear in the next releases.
0029 //
0030 // Author: Mathieu Karamitros
0031
0032 // The code is developed in the framework of the ESA AO7146
0033 //
0034 // We would be very happy hearing from you, so do not hesitate to
0035 // send us your feedback!
0036 //
0037 // In order for Geant4-DNA to be maintained and still open-source,
0038 // article citations are crucial.
0039 // If you use Geant4-DNA chemistry and you publish papers about your software,
0040 // in addition to the general paper on Geant4-DNA:
0041 //
0042 // The Geant4-DNA project,
0043 // S. Incerti et al., Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
0044 //
0045 // we ask that you please cite the following reference papers on chemistry:
0046 //
0047 // Diffusion-controlled reactions modelling in Geant4-DNA,
0048 // M. Karamitros et al., 2014
0049 // Modeling Radiation Chemistry in the Geant4 Toolkit,
0050 // M. Karamitros et al., Prog. Nucl. Sci. Tec. 2 (2011) 503-508
0051
0052
0053 #ifndef G4VUSERITACTION_H
0054 #define G4VUSERITACTION_H
0055
0056 #include "globals.hh"
0057 #include "G4Track.hh"
0058 #include <vector>
0059
0060 /**
0061  * G4UserTimeStepAction is used by G4Scheduler.
0062  * - StartProcessing called before processing
0063  * - TimeStepAction called at every global step
0064  * - UserReactionAction called when a reaction occurs
0065  * - EndProcessing called after processing
0066  */
0067
0068 class G4UserTimeStepAction
0069 {
0070 public:
0071   G4UserTimeStepAction();
0072   G4UserTimeStepAction(const G4UserTimeStepAction& );
0073   virtual ~G4UserTimeStepAction();
0074
0075   virtual void StartProcessing(){;}
0076   virtual void NewStage(){;}
0077
0078   /** In this method, the user can use :
0079    * G4Scheduler::Instance()->GetGlobalTime(), to know the current simulation time
0080    * G4Scheduler::Instance()->GetTimeStep(), to know the selected minimum time
0081    * WARNING : The call of this method happens before the call of DoIT methods
0082    */
0083   virtual void UserPreTimeStepAction(){;}
0084   virtual void UserPostTimeStepAction(){;}
0085
0086   /**
0087    * Inform about a reaction
0088    */
0089   virtual void UserReactionAction(const G4Track& /*trackA*/,
0090       const G4Track& /*trackB*/,
0091       const std::vector<G4Track*>* /*products*/){;}
0092   virtual void EndProcessing(){;}
0093
0094 protected:
0095   void SetMinimumTimeSteps(std::map<double,double>*);
0096   void AddTimeStep(double /*startingTime*/, double /*timeStep*/);
0097
0098 private:
0099   G4UserTimeStepAction& operator=(const G4UserTimeStepAction& );
0100 };
0101
0102 #endif // G4VUSERITACTION_H