Geant4  10.03.p02
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4VCrossSectionDataSet.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 // $Id: $
27 //
28 // -------------------------------------------------------------------
29 //
30 // GEANT4 Class header file
31 //
32 //
33 // File name: G4VCrossSectionDataSet
34 //
35 // Author F.W. Jones, TRIUMF, 20-JAN-97
36 //
37 // Modifications:
38 // 23.01.2009 V.Ivanchenko move constructor and destructor to source
39 // 05.07.2010 V.Ivanchenko added name, min and max energy limit and
40 // corresponding access methods
41 // 12.08.2011 G.Folger, V.Ivanchenko, T.Koi, D.Wright redesign the class
42 //
43 //
44 // Class Description
45 // This is a base class for hadronic cross section data sets. Users may
46 // derive specialized cross section classes and register them with the
47 // appropriate process, or use provided data sets.
48 //
49 // Each cross section should have unique name
50 // Minimal and maximal energy for the cross section will be used in run
51 // time before IsApplicable method is called
52 //
53 // Both the name and the energy interval will be used for documentation
54 //
55 // Class Description - End
56 
57 #ifndef G4VCrossSectionDataSet_h
58 #define G4VCrossSectionDataSet_h 1
59 
60 #include "globals.hh"
61 #include "G4ParticleDefinition.hh"
62 #include "G4Element.hh"
63 #include "G4HadTmpUtil.hh"
64 #include <iostream>
65 
66 class G4DynamicParticle;
67 class G4Isotope;
68 class G4Material;
70 
72 {
73 public: //with description
74 
75  G4VCrossSectionDataSet(const G4String& nam = "");
76 
77  virtual ~G4VCrossSectionDataSet();
78 
79  //============== Is Applicable methods ===============================
80  // The following three methods have default implementations returning
81  // "false". Derived classes should implement only needed methods.
82 
83  // Element-wise cross section
84  virtual
86  const G4Material* mat = 0);
87 
88  // Derived classes should implement this method if they provide isotope-wise
89  // cross sections. Default arguments G4Element and G4Material are needed to
90  // access low-energy neutron cross sections, but are not required for others.
91  virtual
93  const G4Element* elm = 0,
94  const G4Material* mat = 0);
95 
96  //============== GetCrossSection methods ===============================
97 
98  // This is a generic method to access cross section per element
99  // This method should not be overwritten in a derived class
100  inline G4double GetCrossSection(const G4DynamicParticle*, const G4Element*,
101  const G4Material* mat = 0);
102 
103  // This is a generic method to compute cross section per element
104  // If the DataSet is not applicable the method returns zero
105  // This method should not be overwritten in a derived class
107  const G4Element*,
108  const G4Material* mat = 0);
109 
110  // The following two methods have default implementations which throw
111  // G4HadronicException. Derived classes should implement only needed
112  // methods, which are assumed to be called at run time.
113 
114  // Implement this method for element-wise cross section
115  virtual
117  const G4Material* mat = 0);
118 
119  // Derived classes should implement this method if they provide isotope-wise
120  // cross sections. Default arguments G4Element and G4Material are needed to
121  // access low-energy neutron cross sections, but are not required for others.
122  virtual
124  const G4Isotope* iso = 0,
125  const G4Element* elm = 0,
126  const G4Material* mat = 0);
127 
128  //=====================================================================
129 
130  // Implement this method if needed
131  // This method is called for element-wise cross section
132  // Default implementation assumes equal cross sections for all isotopes
133  virtual G4Isotope* SelectIsotope(const G4Element*, G4double kinEnergy);
134 
135  // Implement this method if needed
136  virtual
138 
139  // Implement this method if needed
140  // Default implementation will provide a dump of the cross section
141  // in logarithmic scale in the interval of applicability
142  virtual
144 
145  virtual void CrossSectionDescription(std::ostream&) const;
146 
147 public: // Without Description
148 
149  virtual G4int GetVerboseLevel() const;
150 
151  virtual void SetVerboseLevel(G4int value);
152 
153  inline G4double GetMinKinEnergy() const;
154 
155  inline void SetMinKinEnergy(G4double value);
156 
157  inline G4double GetMaxKinEnergy() const;
158 
159  inline void SetMaxKinEnergy(G4double value);
160 
161  inline const G4String& GetName() const;
162 
163 protected:
164 
165  inline void SetName(const G4String&);
166 
168 
169 private:
170 
173 
175 
176  G4double minKinEnergy;
177  G4double maxKinEnergy;
178 
179  G4String name;
180 };
181 
182 inline G4double
184  const G4Element* elm,
185  const G4Material* mat)
186 {
187  return ComputeCrossSection(dp, elm, mat);
188 }
189 
190 
192 {
193  return verboseLevel;
194 }
195 
197 {
199 }
200 
202 {
203  minKinEnergy = value;
204 }
205 
207 {
208  return minKinEnergy;
209 }
210 
212 {
213  maxKinEnergy = value;
214 }
215 
217 {
218  return maxKinEnergy;
219 }
220 
222 {
223  return name;
224 }
225 
227 {
228  name = nam;
229 }
230 
231 #endif
const XML_Char * name
Definition: expat.h:151
virtual G4bool IsIsoApplicable(const G4DynamicParticle *, G4int Z, G4int A, const G4Element *elm=0, const G4Material *mat=0)
virtual void CrossSectionDescription(std::ostream &) const
G4VCrossSectionDataSet(const G4String &nam="")
virtual void BuildPhysicsTable(const G4ParticleDefinition &)
virtual G4double GetElementCrossSection(const G4DynamicParticle *, G4int Z, const G4Material *mat=0)
const G4String & GetName() const
int G4int
Definition: G4Types.hh:78
void SetName(const G4String &)
virtual void DumpPhysicsTable(const G4ParticleDefinition &)
virtual G4bool IsElementApplicable(const G4DynamicParticle *, G4int Z, const G4Material *mat=0)
double A(double temperature)
const XML_Char int const XML_Char * value
Definition: expat.h:331
G4double GetCrossSection(const G4DynamicParticle *, const G4Element *, const G4Material *mat=0)
void SetMinKinEnergy(G4double value)
bool G4bool
Definition: G4Types.hh:79
virtual G4int GetVerboseLevel() const
void SetMaxKinEnergy(G4double value)
virtual G4double GetIsoCrossSection(const G4DynamicParticle *, G4int Z, G4int A, const G4Isotope *iso=0, const G4Element *elm=0, const G4Material *mat=0)
virtual void SetVerboseLevel(G4int value)
double G4double
Definition: G4Types.hh:76
G4double ComputeCrossSection(const G4DynamicParticle *, const G4Element *, const G4Material *mat=0)
virtual G4Isotope * SelectIsotope(const G4Element *, G4double kinEnergy)