| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // 26 //
27 // Author: Mathieu Karamitros << 27 // Author: Mathieu Karamitros (kara (AT) cenbg . in2p3 . fr)
28 <<
29 // The code is developed in the framework of t <<
30 // <<
31 // We would be very happy hearing from you, se <<
32 // 28 //
33 // In order for Geant4-DNA to be maintained an << 29 // WARNING : This class is released as a prototype.
34 // article citations are crucial. << 30 // It might strongly evolve or even disapear in the next releases.
35 // If you use Geant4-DNA chemistry and you pub <<
36 // in addition to the general paper on Geant4- <<
37 // 31 //
38 // Int. J. Model. Simul. Sci. Comput. 1 (2010) << 32 // History:
>> 33 // -----------
>> 34 // 10 Oct 2011 M.Karamitros created
39 // 35 //
40 // we would be very happy if you could please << 36 // -------------------------------------------------------------------
41 // reference papers on chemistry: <<
42 // <<
43 // J. Comput. Phys. 274 (2014) 841-882 <<
44 // Prog. Nucl. Sci. Tec. 2 (2011) 503-508 <<
45 37
46 #pragma once << 38 #ifndef G4ITMODELPROCESSOR_H
>> 39 #define G4ITMODELPROCESSOR_H
47 40
>> 41 #include <vector>
48 #include "G4ITReactionChange.hh" 42 #include "G4ITReactionChange.hh"
49 #include "G4ITType.hh" 43 #include "G4ITType.hh"
50 #include "G4ITModelHandler.hh" 44 #include "G4ITModelHandler.hh"
51 #include "G4ITStepStatus.hh" <<
52 #include <vector> <<
53 45
54 class G4VITTimeStepComputer; << 46 class G4VITTimeStepper;
55 class G4VITReactionProcess; 47 class G4VITReactionProcess;
56 class G4ITModelHandler; 48 class G4ITModelHandler;
57 class G4ITReactionSet; << 49
58 class G4UserTimeStepAction; << 50 typedef G4ReferenceCountedHandle< std::vector<G4Track*> > G4TrackVectorHandle;
59 class G4ITTrackingManager; << 51
60 class G4ITTrackHolder; << 52 /**
61 << 53 * The G4ITModelProcessor will call the two processes defined in G4VITModel.
62 /** << 54 * This processes act at the beginning and end of each step.
63 * The G4ITModelProcessor will call the two pr << 55 * The first one, the TimeStepper will calculate a time step to propagate all
64 * This processes act at the beginning and end << 56 * the track and eventually it can return some tracks that can likely react
65 * The first one, the TimeStepper will calcula << 57 * at the end of the step.
66 * the track and eventually it can return some << 58 * The second one, the ReactionProcess will make the tracks reacting.
67 * at the end of the step. << 59 */
68 * The second one, the ReactionProcess will ma << 60
69 * \deprecated This class will be removed <<
70 */ <<
71 class G4ITModelProcessor 61 class G4ITModelProcessor
72 { 62 {
73 public: 63 public:
>> 64 /** Default constructor */
74 G4ITModelProcessor(); 65 G4ITModelProcessor();
75 G4ITModelProcessor(const G4ITModelProcesso << 66 /** Default destructor */
76 G4ITModelProcessor& operator=(const G4ITMo <<
77 virtual ~G4ITModelProcessor(); 67 virtual ~G4ITModelProcessor();
78 68
79 void SetModelHandler(G4ITModelHandler*); <<
80 void SetTrackingManager(G4ITTrackingManage <<
81 <<
82 void Initialize(); <<
83 <<
84 void RegisterModel(double time, G4VITStepM <<
85 <<
86 /** Restore the original state. This metho <<
87 void CleanProcessor(); <<
88 <<
89 G4double CalculateMinTimeStep(G4double cur <<
90 G4double def <<
91 69
92 void ComputeTrackReaction(G4ITStepStatus f << 70 inline void SetModelHandler(G4ITModelHandler*);
93 G4double fGlobal <<
94 G4double current <<
95 G4double previou <<
96 G4bool reachedUs <<
97 G4double fTimeTo <<
98 G4UserTimeStepAc <<
99 G4int fVerbose); <<
100 71
101 void InitializeStepper(G4double currentGlo << 72 void Initialize();
102 G4double userMinTim << 73
>> 74 /**
>> 75 * Restaure original state of the modelProcessor.
>> 76 * This method should be call only by the ITStepManager
>> 77 */
>> 78 inline void CleanProcessor();
>> 79
>> 80 //____________________________________________________________
>> 81 // Time stepper part
>> 82 void InitializeStepper(const G4double& currentGlobalTime,
>> 83 const G4double& userMinTime);
>> 84 protected :
>> 85 const G4Track* fTrack;
>> 86 G4double fUserMinTimeStep;
>> 87 inline void SetTrack(const G4Track*);
103 88
104 bool GetComputeTimeStep() const; << 89 public :
>> 90 void CalculateTimeStep(const G4Track*, const G4double);
>> 91 void DoCalculateStep();
>> 92
>> 93 //____________________________________________________________
>> 94 // Reaction process part
>> 95 void FindReaction(std::map<G4Track*, G4TrackVectorHandle>*,
>> 96 const double currentStepTime,
>> 97 const double previousStepTime,
>> 98 const bool reachedUserStepTimeLimit) ;
>> 99
>> 100 //____________________________________________________________
>> 101 // Get results
>> 102 inline const std::vector<std::vector<G4VITModel*> >* GetCurrentModel();
>> 103
>> 104 inline std::vector<G4ITReactionChange*>* GetReactionInfo()
>> 105 {
>> 106 return &fReactionInfo;
>> 107 }
>> 108
>> 109 const G4Track* GetTrack() const
>> 110 {
>> 111 return fTrack;
>> 112 }
105 113
106 public: <<
107 const G4Track* GetTrack() const; <<
108 114
109 protected: 115 protected:
110 void SetTrack(const G4Track*); << 116 /** Copy constructor
111 << 117 * \param other Object to copy from
112 G4double fTSTimeStep; << 118 */
113 G4ITReactionSet* fReactionSet; << 119 G4ITModelProcessor(const G4ITModelProcessor& other);
114 G4ITTrackingManager* fpTrackingManager; << 120 /** Assignment operator
115 G4ITTrackHolder* fpTrackContainer; << 121 * \param other Object to assign from
>> 122 * \return A reference to this
>> 123 */
>> 124 G4ITModelProcessor& operator=(const G4ITModelProcessor& other);
116 125
>> 126 //_____________________________
>> 127 // Members
117 G4bool fInitialized; 128 G4bool fInitialized;
118 G4ITModelHandler* fpModelHandler; << 129 G4ITModelHandler* fpModelHandler ;
119 130
120 const G4Track* fpTrack; << 131 // Attributes for interaction between many IT types
121 G4double fUserMinTimeStep; << 132 // eg : electron/proton
>> 133 std::vector<std::vector<G4VITModel*> > fCurrentModel;
>> 134
>> 135 // Attributes for interaction between one type of IT
>> 136 // eg : molecule/molecule or electron/electron
>> 137 G4VITModel* fpModel;
>> 138 G4ITModelManager* fpModelManager;
>> 139 // G4double fNextTimeChangeModel ;
>> 140
>> 141 G4ITType fCurrentType1;
>> 142 G4ITType fCurrentType2;
>> 143
>> 144 // Atribute for reactions
>> 145 std::vector<G4ITReactionChange*> fReactionInfo ;
>> 146 static std::map<const G4Track*, G4bool> fHasReacted;
>> 147 };
122 148
123 std::vector<G4VITStepModel*> fActiveModels << 149 ///
124 G4VITStepModel* fpActiveModelWithMinTimeSt << 150 // Inline methods
>> 151 ///
125 152
126 std::vector<std::unique_ptr<G4ITReactionCh << 153 inline void G4ITModelProcessor::SetTrack(const G4Track* track)
>> 154 {
>> 155 fTrack = track;
>> 156 }
127 157
128 bool fComputeTimeStep; << 158 inline const std::vector<std::vector<G4VITModel*> >* G4ITModelProcessor::GetCurrentModel()
129 bool fComputeReaction; << 159 {
130 }; << 160 return &fCurrentModel ;
>> 161 }
131 162
>> 163 inline void G4ITModelProcessor::SetModelHandler(G4ITModelHandler* modelHandler)
>> 164 {
>> 165 if(fInitialized == 1)
>> 166 {
>> 167 G4ExceptionDescription exceptionDescription ;
>> 168 exceptionDescription << "You are trying to set a new model while the model processor has alreaday be initialized";
>> 169 G4Exception("G4ITModelProcessor::SetModelHandler","ITModelProcessor001",
>> 170 FatalErrorInArgument,exceptionDescription);
>> 171 }
>> 172 fpModelHandler = modelHandler;
>> 173 }
>> 174
>> 175 inline void G4ITModelProcessor::CleanProcessor()
>> 176 {
>> 177 fTrack = 0;
>> 178 }
>> 179 #endif // G4ITMODELPROCESSOR_H
132 180