| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
26 // G4PhysicsVector <<
27 // 23 //
28 // Class description: << 24 // $Id: G4PhysicsVector.hh,v 1.12 2003/06/06 16:17:14 gcosmo Exp $
>> 25 // GEANT4 tag $Name: geant4-06-00 $
29 // 26 //
30 // A physics vector which has values of energy << 27 //
31 // and other physics values of a particle in m << 28 //---------------------------------------------------------------
32 // range of energy, momentum, etc. << 29 // GEANT 4 class header file
33 // This class serves as the base class for a v << 30 //
34 // energy scale, for example like 'log', 'line << 31 // G4PhysicsVector.hh
35 << 32 //
36 // Authors: << 33 // Class description:
37 // - 02 Dec. 1995, G.Cosmo: Structure created << 34 //
38 // - 03 Mar. 1996, K.Amako: Implemented the 1s << 35 // A physics vector which has values of energy-loss, cross-section,
39 // Revisions: << 36 // and other physics values of a particle in matter in a given
40 // - 11 Nov. 2000, H.Kurashige: Use STL vector << 37 // range of the energy, momentum, etc.
41 // ------------------------------------------- << 38 // This class serves as the base class for a vector having various
42 #ifndef G4PhysicsVector_hh << 39 // energy scale, for example like 'log', 'linear', 'free', etc.
43 #define G4PhysicsVector_hh 1 << 40
>> 41 // History:
>> 42 // 02 Dec. 1995, G.Cosmo : Structure created based on object model
>> 43 // 03 Mar. 1996, K.Amako : Implemented the 1st version
>> 44 // 27 Apr. 1996, K.Amako : Cache mechanism added
>> 45 // 01 Jul. 1996, K.Amako : Now GetValue not virtual
>> 46 // 21 Sep. 1996, K.Amako : Added [] and () operators
>> 47 // 11 Nov. 2000, H.Kurashige : use STL vector for dataVector and binVector
>> 48 // 18 Jan. 2001, H.Kurashige : removed ptrNextTable
>> 49 // 09 Mar. 2001, H.Kurashige : added G4PhysicsVectorType & Store/Retrieve()
>> 50 //
>> 51 //---------------------------------------------------------------
44 52
45 #include <fstream> << 53 #ifndef G4PhysicsVector_h
46 #include <iostream> << 54 #define G4PhysicsVector_h 1
47 #include <vector> <<
48 55
49 #include "G4Log.hh" << 56 #include <vector>
50 #include "G4PhysicsVectorType.hh" <<
51 #include "G4ios.hh" <<
52 #include "globals.hh" 57 #include "globals.hh"
>> 58 #include "G4ios.hh"
>> 59 #include <iostream>
>> 60 #include <fstream>
53 61
54 class G4PhysicsVector << 62 #include "G4PhysicsVectorType.hh"
>> 63
>> 64 class G4PhysicsVector
55 { 65 {
56 public: << 66 public:
57 // Default constructor - vector will be fill << 67
58 // Free vector may be filled via InsertValue << 68 G4PhysicsVector();
59 explicit G4PhysicsVector(G4bool spline = fal << 69 // constructor
60 << 70 // This class is an abstract class with pure virtual method of
61 // Copy constructor and assignment operator << 71 // virtual size_t FindBinLocation(G4double theEnergy) const
62 G4PhysicsVector(const G4PhysicsVector&) = de << 72 // So, default constructor is not supposed to be invoked explicitly
63 G4PhysicsVector& operator=(const G4PhysicsVe << 73
64 << 74 G4PhysicsVector(const G4PhysicsVector&);
65 // not used operators << 75 G4PhysicsVector& operator=(const G4PhysicsVector&);
66 G4PhysicsVector(const G4PhysicsVector&&) = d << 76 // Copy constructor and assignment operator.
67 G4PhysicsVector& operator=(const G4PhysicsVe << 77
68 G4bool operator==(const G4PhysicsVector& rig << 78 public: // with description
69 G4bool operator!=(const G4PhysicsVector& rig << 79
70 << 80 virtual ~G4PhysicsVector();
71 virtual ~G4PhysicsVector() = default; << 81 // destructor
72 << 82
73 // Get the cross-section/energy-loss value c << 83 inline G4double GetValue(G4double theEnergy, G4bool& isOutRange);
74 // given energy. An appropriate interpolatio << 84 // Get the cross-section/energy-loss value corresponding to the
75 // the value. Consumer code gets changed ind << 85 // given energy. An appropriate interpolation is used to calculate
76 // for the next call to save CPU for bin loc << 86 // the value.
77 inline G4double Value(const G4double energy, << 87 // [Note] isOutRange is not used anymore. This argument is kept
78 << 88 // for the compatibility reason.
79 // Get the cross-section/energy-loss value c << 89
80 // given energy. An appropriate interpolatio << 90 G4int operator==(const G4PhysicsVector &right) const ;
81 // the value. This method should be used if << 91 G4int operator!=(const G4PhysicsVector &right) const ;
82 // kept in the user code. << 92 inline G4double operator[](const size_t binNumber) const ;
83 inline G4double Value(const G4double energy) << 93 // Returns simply the value in the bin specified by 'binNumber'
84 << 94 // of the dataVector. The boundary check will be Done. If you
85 // Obsolete method to get value, 'isOutRange << 95 // don't want this check, use the operator ().
86 // This method is kept for the compatibility << 96 inline G4double operator()(const size_t binNumber) const ;
87 inline G4double GetValue(const G4double ener << 97 // Returns simply the value in the bin specified by 'binNumber'
88 << 98 // of the dataVector. The boundary check will not be Done. If
89 // Same as the Value() method above but spec << 99 // you want this check, use the operator [].
90 // Note, unlike the general Value() method a << 100
91 // properly only for G4PhysicsLogVector. << 101 inline void PutValue(size_t binNumber, G4double theValue);
92 inline G4double LogVectorValue(const G4doubl << 102 // Put 'theValue' into the bin specified by 'binNumber'.
93 const G4doubl << 103 // Take note that the 'binNumber' starts from '0'.
94 << 104 // To fill the vector, you have beforehand to Construct a vector
95 // Same as the Value() method above but spec << 105 // by the constructor with Emin, Emax, Nbin. 'theValue' should
96 // with logarithmic seach of bin number << 106 // be the crosssection/energyloss value corresponding to the low
97 inline G4double LogFreeVectorValue(const G4d << 107 // edge energy of the bin specified by 'binNumber'. You can get
98 const G4d << 108 // the low edge energy value of a bin by GetLowEdgeEnergy().
99 << 109 virtual G4double GetLowEdgeEnergy(size_t binNumber) const;
100 // Returns the value for the specified index << 110 // Get the energy value at the low edge of the specified bin.
101 // The boundary check will not be done << 111 // Take note that the 'binNumber' starts from '0'.
102 inline G4double operator[](const std::size_t << 112 // This value is defined when a physics vector is constructed
103 inline G4double operator()(const std::size_t << 113 // by a constructor of a derived class. Use this function
104 << 114 // when you fill physis vector by PutValue().
105 // Put data into the vector at 'index' posit << 115 inline size_t GetVectorLength() const;
106 // Take note that the 'index' starts from '0 << 116 // Get the toal length (bin number) of the vector.
107 // It is assumed that energies are already f << 117 inline G4bool IsFilledVectorExist() const;
108 inline void PutValue(const std::size_t index << 118 // Is non-empty physics vector already exist?
109 << 119
110 // Returns the value in the energy specified << 120 inline void PutComment(const G4String& theComment);
111 // of the energy vector. The boundary check << 121 // Put a comment to the G4PhysicsVector. This may help to check
112 // Use this when compute cross-section, dEdx << 122 // whether your are accessing to the one you want.
113 // before filling the vector by PutValue(). << 123 inline const G4String& GetComment() const;
114 inline G4double Energy(const std::size_t ind << 124 // Retrieve the comment of the G4PhysicsVector.
115 inline G4double GetLowEdgeEnergy(const std:: << 125
116 << 126 inline G4PhysicsVectorType GetType() const;
117 // Returns the energy of the first and the l << 127 // Get physics vector type
118 inline G4double GetMinEnergy() const; << 128
119 inline G4double GetMaxEnergy() const; << 129 virtual G4bool Store(std::ofstream& fOut, G4bool ascii=false);
120 << 130 virtual G4bool Retrieve(std::ifstream& fIn, G4bool ascii=false);
121 // Returns the data of the first and the las << 131 // To store/retrieve persistent data to/from file streams.
122 // If the vector is empty returns zeros. << 132
123 inline G4double GetMinValue() const; << 133 friend std::ostream& operator<<(std::ostream&, const G4PhysicsVector&);
124 inline G4double GetMaxValue() const; << 134
125 << 135 protected:
126 // Get the total length of the vector << 136
127 inline std::size_t GetVectorLength() const; << 137 typedef std::vector<G4double> G4PVDataVector;
128 << 138
129 // Computes the lower index the energy bin i << 139 G4PhysicsVectorType type; // The type of PhysicsVector (enumerator)
130 // in case of vectors with equal bin widths << 140
131 // Note, that no check on the boundary is pe << 141 G4double edgeMin; // Lower edge value of the lowest bin
132 inline std::size_t ComputeLogVectorBin(const << 142 G4double edgeMax; // Lower edge value of the highest bin
133 << 143 size_t numberOfBin;
134 // Get physics vector type. << 144
135 inline G4PhysicsVectorType GetType() const; << 145 G4double lastEnergy; // Cache the last input value
136 << 146 G4double lastValue; // Cache the last output value
137 // True if using spline interpolation. << 147 size_t lastBin; // Cache the last bin location
138 inline G4bool GetSpline() const; << 148
139 << 149 G4PVDataVector dataVector; // Vector to keep the crossection/energyloss
140 // Define verbosity level. << 150 G4PVDataVector binVector; // Vector to keep the low edge value of bin
141 inline void SetVerboseLevel(G4int value); << 151
142 << 152 inline G4double LinearInterpolation(G4double theEnergy, size_t theLocBin);
143 // Find energy using linear interpolation fo << 153 // Linear interpolation function
144 // filled by cumulative probability function << 154
145 // Assuming that vector is already filled. << 155 virtual size_t FindBinLocation(G4double theEnergy) const=0;
146 inline G4double FindLinearEnergy(const G4dou << 156 // Find the bin# in which theEnergy belongs - pure virtual function
147 <<
148 // Find low edge index of a bin for given en <<
149 // Min value 0, max value idxmax. <<
150 std::size_t FindBin(const G4double energy, s <<
151 <<
152 // Scale all values of the vector by factorV <<
153 // AFter this method FillSecondDerivatives(. <<
154 // This method may be applied for example af <<
155 // from an external file to convert values i <<
156 void ScaleVector(const G4double factorE, con <<
157 <<
158 // This method should be called when the vec <<
159 // There are 3 types of second derivative co <<
160 // fSplineSimple - 2d derivative cont <<
161 // fSplineBase - 3d derivative cont <<
162 // fSplineFixedEdges - 3d derivatives con <<
163 // derivatives are fi <<
164 void FillSecondDerivatives(const G4SplineTyp <<
165 const G4double di <<
166 const G4double di <<
167 <<
168 // This method can be applied if both energy <<
169 // grow monotonically, for example, if in th <<
170 // cumulative probability density function i <<
171 G4double GetEnergy(const G4double value) con <<
172 <<
173 // To store/retrieve persistent data to/from <<
174 G4bool Store(std::ofstream& fOut, G4bool asc <<
175 G4bool Retrieve(std::ifstream& fIn, G4bool a <<
176 <<
177 // Print vector <<
178 friend std::ostream& operator<<(std::ostream <<
179 void DumpValues(G4double unitE = 1.0, G4doub <<
180 <<
181 protected: <<
182 <<
183 // The default implements a free vector init <<
184 virtual void Initialise(); <<
185 <<
186 void PrintPutValueError(std::size_t index, G <<
187 const G4String& text <<
188 <<
189 private: <<
190 <<
191 void ComputeSecDerivative0(); <<
192 void ComputeSecDerivative1(); <<
193 void ComputeSecDerivative2(const G4double fi <<
194 const G4double en <<
195 // Internal methods for computing of spline <<
196 <<
197 // Linear or spline interpolation. <<
198 inline G4double Interpolation(const std::siz <<
199 const G4double <<
200 <<
201 // Assuming (edgeMin <= energy <= edgeMax). <<
202 inline std::size_t LogBin(const G4double ene <<
203 inline std::size_t BinaryBin(const G4double <<
204 inline std::size_t GetBin(const G4double ene <<
205 <<
206 protected: <<
207 <<
208 G4double edgeMin = 0.0; // Energy of first <<
209 G4double edgeMax = 0.0; // Energy of the la <<
210 <<
211 G4double invdBin = 0.0; // 1/Bin width for <<
212 G4double logemin = 0.0; // used only for lo <<
213 <<
214 G4double iBin1 = 0.0; // 1/Bin width for sc <<
215 G4double lmin1 = 0.0; // used for log searc <<
216 <<
217 G4int verboseLevel = 0; <<
218 std::size_t idxmax = 0; <<
219 std::size_t imax1 = 0; <<
220 std::size_t numberOfNodes = 0; <<
221 std::size_t nLogNodes = 0; <<
222 <<
223 G4PhysicsVectorType type = T_G4PhysicsFreeVe <<
224 // The type of PhysicsVector (enumerator) <<
225 <<
226 std::vector<G4double> binVector; // ene <<
227 std::vector<G4double> dataVector; // cro <<
228 std::vector<G4double> secDerivative; // sec <<
229 std::vector<std::size_t> scale; // log <<
230 157
231 private: << 158 private:
232 159
233 G4bool useSpline = false; << 160 G4String comment;
234 }; 161 };
235 162
236 #include "G4PhysicsVector.icc" 163 #include "G4PhysicsVector.icc"
237 164
238 #endif 165 #endif
239 166