| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // WARNING : This class is released as a prototype.
28 // It might strongly evolve or even disapear in the next releases.
29 //
30 // Author: Mathieu Karamitros
31
32 // The code is developed in the framework of the ESA AO7146
33 //
34 // We would be very happy hearing from you, so do not hesitate to
35 // send us your feedback!
36 //
37 // In order for Geant4-DNA to be maintained and still open-source,
38 // article citations are crucial.
39 // If you use Geant4-DNA chemistry and you publish papers about your software,
40 // in addition to the general paper on Geant4-DNA:
41 //
42 // The Geant4-DNA project,
43 // S. Incerti et al., Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
44 //
45 // we ask that you please cite the following reference papers on chemistry:
46 //
47 // Diffusion-controlled reactions modelling in Geant4-DNA,
48 // M. Karamitros et al., 2014
49 // Modeling Radiation Chemistry in the Geant4 Toolkit,
50 // M. Karamitros et al., Prog. Nucl. Sci. Tec. 2 (2011) 503-508
51
52
53 #ifndef G4VUSERITACTION_H
54 #define G4VUSERITACTION_H
55
56 #include "globals.hh"
57 #include "G4Track.hh"
58 #include <vector>
59
60 /**
61 * G4UserTimeStepAction is used by G4Scheduler.
62 * - StartProcessing called before processing
63 * - TimeStepAction called at every global step
64 * - UserReactionAction called when a reaction occurs
65 * - EndProcessing called after processing
66 */
67
68 class G4UserTimeStepAction
69 {
70 public:
71 G4UserTimeStepAction();
72 G4UserTimeStepAction(const G4UserTimeStepAction& );
73 virtual ~G4UserTimeStepAction();
74
75 virtual void StartProcessing(){;}
76 virtual void NewStage(){;}
77
78 /** In this method, the user can use :
79 * G4Scheduler::Instance()->GetGlobalTime(), to know the current simulation time
80 * G4Scheduler::Instance()->GetTimeStep(), to know the selected minimum time
81 * WARNING : The call of this method happens before the call of DoIT methods
82 */
83 virtual void UserPreTimeStepAction(){;}
84 virtual void UserPostTimeStepAction(){;}
85
86 /**
87 * Inform about a reaction
88 */
89 virtual void UserReactionAction(const G4Track& /*trackA*/,
90 const G4Track& /*trackB*/,
91 const std::vector<G4Track*>* /*products*/){;}
92 virtual void EndProcessing(){;}
93
94 protected:
95 void SetMinimumTimeSteps(std::map<double,double>*);
96 void AddTimeStep(double /*startingTime*/, double /*timeStep*/);
97
98 private:
99 G4UserTimeStepAction& operator=(const G4UserTimeStepAction& );
100 };
101
102 #endif // G4VUSERITACTION_H
103