| Geant4 Cross Reference |
1 // 1
2 // *******************************************
3 // * License and Disclaimer
4 // *
5 // * The Geant4 software is copyright of th
6 // * the Geant4 Collaboration. It is provided
7 // * conditions of the Geant4 Software License
8 // * LICENSE and available at http://cern.ch/
9 // * include a list of copyright holders.
10 // *
11 // * Neither the authors of this software syst
12 // * institutes,nor the agencies providing fin
13 // * work make any representation or warran
14 // * regarding this software system or assum
15 // * use. Please see the license in the file
16 // * for the full disclaimer and the limitatio
17 // *
18 // * This code implementation is the result
19 // * technical work of the GEANT4 collaboratio
20 // * By using, copying, modifying or distri
21 // * any work based on the software) you ag
22 // * use in resulting scientific publicati
23 // * acceptance of all terms of the Geant4 Sof
24 // *******************************************
25 //
26 // G4PhysicsVector
27 //
28 // Class description:
29 //
30 // A physics vector which has values of energy
31 // and other physics values of a particle in m
32 // range of energy, momentum, etc.
33 // This class serves as the base class for a v
34 // energy scale, for example like 'log', 'line
35
36 // Authors:
37 // - 02 Dec. 1995, G.Cosmo: Structure created
38 // - 03 Mar. 1996, K.Amako: Implemented the 1s
39 // Revisions:
40 // - 11 Nov. 2000, H.Kurashige: Use STL vector
41 // -------------------------------------------
42 #ifndef G4PhysicsVector_hh
43 #define G4PhysicsVector_hh 1
44
45 #include <fstream>
46 #include <iostream>
47 #include <vector>
48
49 #include "G4Log.hh"
50 #include "G4PhysicsVectorType.hh"
51 #include "G4ios.hh"
52 #include "globals.hh"
53
54 class G4PhysicsVector
55 {
56 public:
57 // Default constructor - vector will be fill
58 // Free vector may be filled via InsertValue
59 explicit G4PhysicsVector(G4bool spline = fal
60
61 // Copy constructor and assignment operator
62 G4PhysicsVector(const G4PhysicsVector&) = de
63 G4PhysicsVector& operator=(const G4PhysicsVe
64
65 // not used operators
66 G4PhysicsVector(const G4PhysicsVector&&) = d
67 G4PhysicsVector& operator=(const G4PhysicsVe
68 G4bool operator==(const G4PhysicsVector& rig
69 G4bool operator!=(const G4PhysicsVector& rig
70
71 virtual ~G4PhysicsVector() = default;
72
73 // Get the cross-section/energy-loss value c
74 // given energy. An appropriate interpolatio
75 // the value. Consumer code gets changed ind
76 // for the next call to save CPU for bin loc
77 inline G4double Value(const G4double energy,
78
79 // Get the cross-section/energy-loss value c
80 // given energy. An appropriate interpolatio
81 // the value. This method should be used if
82 // kept in the user code.
83 inline G4double Value(const G4double energy)
84
85 // Obsolete method to get value, 'isOutRange
86 // This method is kept for the compatibility
87 inline G4double GetValue(const G4double ener
88
89 // Same as the Value() method above but spec
90 // Note, unlike the general Value() method a
91 // properly only for G4PhysicsLogVector.
92 inline G4double LogVectorValue(const G4doubl
93 const G4doubl
94
95 // Same as the Value() method above but spec
96 // with logarithmic seach of bin number
97 inline G4double LogFreeVectorValue(const G4d
98 const G4d
99
100 // Returns the value for the specified index
101 // The boundary check will not be done
102 inline G4double operator[](const std::size_t
103 inline G4double operator()(const std::size_t
104
105 // Put data into the vector at 'index' posit
106 // Take note that the 'index' starts from '0
107 // It is assumed that energies are already f
108 inline void PutValue(const std::size_t index
109
110 // Returns the value in the energy specified
111 // of the energy vector. The boundary check
112 // Use this when compute cross-section, dEdx
113 // before filling the vector by PutValue().
114 inline G4double Energy(const std::size_t ind
115 inline G4double GetLowEdgeEnergy(const std::
116
117 // Returns the energy of the first and the l
118 inline G4double GetMinEnergy() const;
119 inline G4double GetMaxEnergy() const;
120
121 // Returns the data of the first and the las
122 // If the vector is empty returns zeros.
123 inline G4double GetMinValue() const;
124 inline G4double GetMaxValue() const;
125
126 // Get the total length of the vector
127 inline std::size_t GetVectorLength() const;
128
129 // Computes the lower index the energy bin i
130 // in case of vectors with equal bin widths
131 // Note, that no check on the boundary is pe
132 inline std::size_t ComputeLogVectorBin(const
133
134 // Get physics vector type.
135 inline G4PhysicsVectorType GetType() const;
136
137 // True if using spline interpolation.
138 inline G4bool GetSpline() const;
139
140 // Define verbosity level.
141 inline void SetVerboseLevel(G4int value);
142
143 // Find energy using linear interpolation fo
144 // filled by cumulative probability function
145 // Assuming that vector is already filled.
146 inline G4double FindLinearEnergy(const G4dou
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
231 private:
232
233 G4bool useSpline = false;
234 };
235
236 #include "G4PhysicsVector.icc"
237
238 #endif
239