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 | // $Id: G4HadronicInteraction.hh,v 1.13 2009/10/02 17:18:33 vnivanch Exp $ |
---|
28 | // GEANT4 tag $Name: geant4-09-03-cand-01 $ |
---|
29 | // |
---|
30 | // Hadronic Interaction abstract base class |
---|
31 | // This class is the base class for the model classes. |
---|
32 | // It sorts out the energy-range for the models and provides |
---|
33 | // class utilities. |
---|
34 | // original by H.P. Wellisch |
---|
35 | // Modified by J.L.Chuma, TRIUMF, 21-Mar-1997 |
---|
36 | // Last modified: 3-Apr-1997 |
---|
37 | // Added units to energy initialization: J.L. Chuma 04-Apr-97 |
---|
38 | // Modified by J.L.Chuma, 05-May-97 to Initialize theBlockedCounter |
---|
39 | // Modified by J.L.Chuma, 08-Jul-97 to implement the Nucleus changes |
---|
40 | // Adding a registry for memory management of hadronic models, HPW 22-Mar-99 |
---|
41 | // 23-Jan-2009 V.Ivanchenko move constructor and destructor to the body |
---|
42 | // and reorder methods in the header |
---|
43 | // 29-Jun-2009 V.Ivanchenko add SampleInvariantT method |
---|
44 | // 29-Aug-2009 V.Ivanchenko moved G4ReactionDynamics to G4InelasticInteraction, |
---|
45 | // add const pointers, and added recoilEnergyThreshold |
---|
46 | // member and accesors |
---|
47 | |
---|
48 | // Class Description |
---|
49 | // This is the base class for all hadronic interaction models in geant4. |
---|
50 | // If you want to implement a new way of producing a final state, please, |
---|
51 | // inherit from here. |
---|
52 | // Class Description - End |
---|
53 | |
---|
54 | #ifndef G4HadronicInteraction_h |
---|
55 | #define G4HadronicInteraction_h 1 |
---|
56 | |
---|
57 | #include "G4HadFinalState.hh" |
---|
58 | #include "G4Material.hh" |
---|
59 | #include "G4Nucleus.hh" |
---|
60 | #include "G4Track.hh" |
---|
61 | #include "G4HadProjectile.hh" |
---|
62 | #include "G4ReactionDynamics.hh" |
---|
63 | |
---|
64 | class G4HadronicInteraction |
---|
65 | { |
---|
66 | public: // With description |
---|
67 | |
---|
68 | G4HadronicInteraction(const G4String& modelName = "HadronicModel"); |
---|
69 | |
---|
70 | virtual ~G4HadronicInteraction(); |
---|
71 | |
---|
72 | virtual G4HadFinalState *ApplyYourself(const G4HadProjectile &aTrack, |
---|
73 | G4Nucleus & targetNucleus ) = 0; |
---|
74 | // The interface to implement for final state production code. |
---|
75 | |
---|
76 | virtual G4double SampleInvariantT(const G4ParticleDefinition* p, |
---|
77 | G4double plab, |
---|
78 | G4int Z, G4int A); |
---|
79 | // The interface to implement sampling of scattering or change exchange |
---|
80 | |
---|
81 | virtual G4bool IsApplicable(const G4HadProjectile &/*aTrack*/, |
---|
82 | G4Nucleus & /*targetNucleus*/) |
---|
83 | { return true;} |
---|
84 | |
---|
85 | inline G4double GetMinEnergy() const |
---|
86 | { return theMinEnergy; } |
---|
87 | |
---|
88 | G4double GetMinEnergy( const G4Material *aMaterial, |
---|
89 | const G4Element *anElement ) const; |
---|
90 | |
---|
91 | inline void SetMinEnergy( G4double anEnergy ) |
---|
92 | { theMinEnergy = anEnergy; } |
---|
93 | |
---|
94 | void SetMinEnergy( G4double anEnergy, const G4Element *anElement ); |
---|
95 | |
---|
96 | void SetMinEnergy( G4double anEnergy, const G4Material *aMaterial ); |
---|
97 | |
---|
98 | inline G4double GetMaxEnergy() const |
---|
99 | { return theMaxEnergy; } |
---|
100 | |
---|
101 | G4double GetMaxEnergy( const G4Material *aMaterial, |
---|
102 | const G4Element *anElement ) const; |
---|
103 | |
---|
104 | inline void SetMaxEnergy( const G4double anEnergy ) |
---|
105 | { theMaxEnergy = anEnergy; } |
---|
106 | |
---|
107 | void SetMaxEnergy( G4double anEnergy, const G4Element *anElement ); |
---|
108 | |
---|
109 | void SetMaxEnergy( G4double anEnergy, const G4Material *aMaterial ); |
---|
110 | |
---|
111 | inline const G4HadronicInteraction *GetMyPointer() const |
---|
112 | { return this; } |
---|
113 | |
---|
114 | inline G4int GetVerboseLevel() const |
---|
115 | { return verboseLevel; } |
---|
116 | |
---|
117 | inline void SetVerboseLevel( G4int value ) |
---|
118 | { verboseLevel = value; } |
---|
119 | |
---|
120 | inline const G4String& GetModelName() const |
---|
121 | { return theModelName; } |
---|
122 | |
---|
123 | void DeActivateFor( const G4Material *aMaterial ); |
---|
124 | |
---|
125 | inline void ActivateFor( const G4Material *aMaterial ) |
---|
126 | { |
---|
127 | Block(); |
---|
128 | SetMaxEnergy(GetMaxEnergy(), aMaterial); |
---|
129 | SetMinEnergy(GetMinEnergy(), aMaterial); |
---|
130 | } |
---|
131 | |
---|
132 | void DeActivateFor( const G4Element *anElement ); |
---|
133 | inline void ActivateFor( const G4Element *anElement ) |
---|
134 | { |
---|
135 | Block(); |
---|
136 | SetMaxEnergy(GetMaxEnergy(), anElement); |
---|
137 | SetMinEnergy(GetMinEnergy(), anElement); |
---|
138 | } |
---|
139 | |
---|
140 | G4bool IsBlocked( const G4Material *aMaterial ) const; |
---|
141 | |
---|
142 | G4bool IsBlocked( const G4Element *anElement) const; |
---|
143 | |
---|
144 | inline void SetRecoilEnergyThreshold(G4double val) |
---|
145 | { recoilEnergyThreshold = val; } |
---|
146 | |
---|
147 | G4double GetRecoilEnergyThreshold() const |
---|
148 | { return recoilEnergyThreshold;} |
---|
149 | |
---|
150 | inline G4bool operator==(const G4HadronicInteraction &right ) const |
---|
151 | { return ( this == (G4HadronicInteraction *) &right ); } |
---|
152 | |
---|
153 | inline G4bool operator!=(const G4HadronicInteraction &right ) const |
---|
154 | { return ( this != (G4HadronicInteraction *) &right ); } |
---|
155 | |
---|
156 | private: |
---|
157 | |
---|
158 | G4HadronicInteraction(const G4HadronicInteraction &right ); |
---|
159 | |
---|
160 | const G4HadronicInteraction& operator=(const G4HadronicInteraction &right); |
---|
161 | |
---|
162 | protected: |
---|
163 | |
---|
164 | inline void SetModelName(const G4String& nam) |
---|
165 | { theModelName = nam; } |
---|
166 | |
---|
167 | inline G4bool IsBlocked() const { return isBlocked;} |
---|
168 | inline void Block() { isBlocked = true; } |
---|
169 | |
---|
170 | G4HadFinalState theParticleChange; |
---|
171 | // the G4HadFinalState object which is modified and returned |
---|
172 | // by address by the ApplyYourself method, |
---|
173 | // (instead of aParticleChange as found in G4VProcess) |
---|
174 | |
---|
175 | G4int verboseLevel; |
---|
176 | // control flag for output messages |
---|
177 | // 0: silent |
---|
178 | // 1: warning messages |
---|
179 | // 2: more |
---|
180 | // (instead of verboseLevel as found in G4VProcess) |
---|
181 | |
---|
182 | // these two have global validity energy range |
---|
183 | G4double theMinEnergy; |
---|
184 | G4double theMaxEnergy; |
---|
185 | |
---|
186 | G4bool isBlocked; |
---|
187 | |
---|
188 | private: |
---|
189 | |
---|
190 | G4double recoilEnergyThreshold; |
---|
191 | |
---|
192 | G4String theModelName; |
---|
193 | |
---|
194 | std::vector<std::pair<G4double, const G4Material *> > theMinEnergyList; |
---|
195 | std::vector<std::pair<G4double, const G4Material *> > theMaxEnergyList; |
---|
196 | std::vector<std::pair<G4double, const G4Element *> > theMinEnergyListElements; |
---|
197 | std::vector<std::pair<G4double, const G4Element *> > theMaxEnergyListElements; |
---|
198 | std::vector<const G4Material *> theBlockedList; |
---|
199 | std::vector<const G4Element *> theBlockedListElements; |
---|
200 | }; |
---|
201 | |
---|
202 | #endif |
---|