Geant4  10.02
G4HadronicInteraction.hh
Go to the documentation of this file.
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 88839 2015-03-12 10:30:07Z gcosmo $
28 //
29 // Hadronic Interaction abstract base class
30 // This class is the base class for the model classes.
31 // It sorts out the energy-range for the models and provides
32 // class utilities.
33 // original by H.P. Wellisch
34 // Modified by J.L.Chuma, TRIUMF, 21-Mar-1997
35 // Last modified: 3-Apr-1997
36 // Added units to energy initialization: J.L. Chuma 04-Apr-97
37 // Modified by J.L.Chuma, 05-May-97 to Initialize theBlockedCounter
38 // Modified by J.L.Chuma, 08-Jul-97 to implement the Nucleus changes
39 // Adding a registry for memory management of hadronic models, HPW 22-Mar-99
40 // 23-Jan-2009 V.Ivanchenko move constructor and destructor to the body
41 // and reorder methods in the header
42 // 29-Jun-2009 V.Ivanchenko add SampleInvariantT method
43 // 29-Aug-2009 V.Ivanchenko moved G4ReactionDynamics to G4InelasticInteraction,
44 // add const pointers, and added recoilEnergyThreshold
45 // member and accesors
46 
47 // Class Description
48 // This is the base class for all hadronic interaction models in geant4.
49 // If you want to implement a new way of producing a final state, please,
50 // inherit from here.
51 // Class Description - End
52 
53 #ifndef G4HadronicInteraction_h
54 #define G4HadronicInteraction_h 1
55 
56 #include "G4HadFinalState.hh"
57 #include "G4Material.hh"
58 #include "G4Nucleus.hh"
59 #include "G4Track.hh"
60 #include "G4HadProjectile.hh"
61 
63 
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 
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  virtual G4int GetVerboseLevel() const
115  { return verboseLevel; }
116 
117  virtual 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  G4bool IsBlocked( const G4Element *anElement) const;
142 
144  { recoilEnergyThreshold = val; }
145 
147  { return recoilEnergyThreshold;}
148 
150  { return ( this == (G4HadronicInteraction *) &right ); }
151 
153  { return ( this != (G4HadronicInteraction *) &right ); }
154 
155  virtual const std::pair<G4double, G4double> GetFatalEnergyCheckLevels() const;
156 
157  virtual std::pair<G4double, G4double> GetEnergyMomentumCheckLevels() const;
158 
159  inline void SetEnergyMomentumCheckLevels(G4double relativeLevel, G4double absoluteLevel)
160  { epCheckLevels.first = relativeLevel;
161  epCheckLevels.second = absoluteLevel; }
162 
163  virtual void ModelDescription(std::ostream& outFile) const ; //=0;
164 
165  // Initialisation before run
166  virtual void BuildPhysicsTable(const G4ParticleDefinition&){;};
167 
168 private:
169 
172 
173 protected:
174 
175  inline void SetModelName(const G4String& nam)
176  { theModelName = nam; }
177 
178  inline G4bool IsBlocked() const { return isBlocked;}
179  inline void Block() { isBlocked = true; }
180 
182  // the G4HadFinalState object which is modified and returned
183  // by address by the ApplyYourself method,
184  // (instead of aParticleChange as found in G4VProcess)
185 
187  // control flag for output messages
188  // 0: silent
189  // 1: warning messages
190  // 2: more
191  // (instead of verboseLevel as found in G4VProcess)
192 
193  // these two have global validity energy range
196 
198 
199 private:
200 
202 
204 
206 
207  std::pair<G4double, G4double> epCheckLevels;
208 
209  std::vector<std::pair<G4double, const G4Material *> > theMinEnergyList;
210  std::vector<std::pair<G4double, const G4Material *> > theMaxEnergyList;
211  std::vector<std::pair<G4double, const G4Element *> > theMinEnergyListElements;
212  std::vector<std::pair<G4double, const G4Element *> > theMaxEnergyListElements;
213  std::vector<const G4Material *> theBlockedList;
214  std::vector<const G4Element *> theBlockedListElements;
215 };
216 
217 #endif
std::vector< std::pair< G4double, const G4Element * > > theMaxEnergyListElements
G4double GetMinEnergy() const
std::vector< const G4Element * > theBlockedListElements
const G4HadronicInteraction * GetMyPointer() const
virtual G4double SampleInvariantT(const G4ParticleDefinition *p, G4double plab, G4int Z, G4int A)
std::vector< std::pair< G4double, const G4Material * > > theMaxEnergyList
virtual G4bool IsApplicable(const G4HadProjectile &, G4Nucleus &)
virtual void BuildPhysicsTable(const G4ParticleDefinition &)
G4double GetMaxEnergy() const
virtual const std::pair< G4double, G4double > GetFatalEnergyCheckLevels() const
virtual void ModelDescription(std::ostream &outFile) const
G4bool operator!=(const G4HadronicInteraction &right) const
G4HadronicInteractionRegistry * registry
const G4String & GetModelName() const
int G4int
Definition: G4Types.hh:78
G4double GetRecoilEnergyThreshold() const
std::vector< std::pair< G4double, const G4Material * > > theMinEnergyList
void SetMinEnergy(G4double anEnergy)
double A(double temperature)
virtual G4int GetVerboseLevel() const
bool G4bool
Definition: G4Types.hh:79
virtual std::pair< G4double, G4double > GetEnergyMomentumCheckLevels() const
std::vector< std::pair< G4double, const G4Element * > > theMinEnergyListElements
void ActivateFor(const G4Material *aMaterial)
G4HadronicInteraction(const G4String &modelName="HadronicModel")
std::pair< G4double, G4double > epCheckLevels
void SetModelName(const G4String &nam)
const G4HadronicInteraction & operator=(const G4HadronicInteraction &right)
virtual void SetVerboseLevel(G4int value)
void SetMaxEnergy(const G4double anEnergy)
std::vector< const G4Material * > theBlockedList
G4bool operator==(const G4HadronicInteraction &right) const
void SetRecoilEnergyThreshold(G4double val)
double G4double
Definition: G4Types.hh:76
void SetEnergyMomentumCheckLevels(G4double relativeLevel, G4double absoluteLevel)
virtual G4HadFinalState * ApplyYourself(const G4HadProjectile &aTrack, G4Nucleus &targetNucleus)=0
void ActivateFor(const G4Element *anElement)
void DeActivateFor(const G4Material *aMaterial)