Geant4 Cross Reference |
1 // 1 // 2 // ******************************************* 2 // ******************************************************************** 3 // * License and Disclaimer 3 // * License and Disclaimer * 4 // * 4 // * * 5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of * 6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and * 7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file * 8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These * 9 // * include a list of copyright holders. 9 // * include a list of copyright holders. * 10 // * 10 // * * 11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing * 12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this * 13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, * 14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its * 15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above * 16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. * 17 // * 17 // * * 18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and * 19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. * 20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or * 21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its * 22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your * 23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. * 24 // ******************************************* 24 // ******************************************************************** 25 // 25 // 26 // G4PhysicsVector 26 // G4PhysicsVector 27 // 27 // 28 // Class description: 28 // Class description: 29 // 29 // 30 // A physics vector which has values of energy 30 // A physics vector which has values of energy-loss, cross-section, 31 // and other physics values of a particle in m 31 // and other physics values of a particle in matter in a given 32 // range of energy, momentum, etc. 32 // range of energy, momentum, etc. 33 // This class serves as the base class for a v 33 // This class serves as the base class for a vector having various 34 // energy scale, for example like 'log', 'line 34 // energy scale, for example like 'log', 'linear', 'free', etc. 35 35 36 // Authors: 36 // Authors: 37 // - 02 Dec. 1995, G.Cosmo: Structure created 37 // - 02 Dec. 1995, G.Cosmo: Structure created based on object model 38 // - 03 Mar. 1996, K.Amako: Implemented the 1s 38 // - 03 Mar. 1996, K.Amako: Implemented the 1st version 39 // Revisions: 39 // Revisions: 40 // - 11 Nov. 2000, H.Kurashige: Use STL vector 40 // - 11 Nov. 2000, H.Kurashige: Use STL vector for dataVector and binVector >> 41 // - 02 Apr. 2008, A.Bagulya: Added SplineInterpolation() and SetSpline() >> 42 // - 19 Jun. 2009, V.Ivanchenko: Removed hidden bin >> 43 // - 15 Mar. 2019 M.Novak: added Value method with the known log-energy value >> 44 // that can avoid the log call in case of log-vectors 41 // ------------------------------------------- 45 // -------------------------------------------------------------------- 42 #ifndef G4PhysicsVector_hh 46 #ifndef G4PhysicsVector_hh 43 #define G4PhysicsVector_hh 1 47 #define G4PhysicsVector_hh 1 44 48 45 #include <fstream> 49 #include <fstream> 46 #include <iostream> 50 #include <iostream> 47 #include <vector> 51 #include <vector> 48 52 49 #include "G4Log.hh" 53 #include "G4Log.hh" 50 #include "G4PhysicsVectorType.hh" 54 #include "G4PhysicsVectorType.hh" 51 #include "G4ios.hh" 55 #include "G4ios.hh" 52 #include "globals.hh" 56 #include "globals.hh" 53 57 >> 58 using G4PVDataVector = std::vector<G4double>; >> 59 54 class G4PhysicsVector 60 class G4PhysicsVector 55 { 61 { 56 public: << 62 public: 57 // Default constructor - vector will be fill << 58 // Free vector may be filled via InsertValue << 59 explicit G4PhysicsVector(G4bool spline = fal 63 explicit G4PhysicsVector(G4bool spline = false); >> 64 // Default constructor - vector will be filled via Retrieve() method 60 65 >> 66 G4PhysicsVector(const G4PhysicsVector&); >> 67 G4PhysicsVector& operator=(const G4PhysicsVector&); 61 // Copy constructor and assignment operator 68 // Copy constructor and assignment operator 62 G4PhysicsVector(const G4PhysicsVector&) = de << 63 G4PhysicsVector& operator=(const G4PhysicsVe << 64 69 65 // not used operators << 70 G4bool operator==(const G4PhysicsVector& right) const; 66 G4PhysicsVector(const G4PhysicsVector&&) = d << 71 G4bool operator!=(const G4PhysicsVector& right) const; 67 G4PhysicsVector& operator=(const G4PhysicsVe << 72 // Equality operators 68 G4bool operator==(const G4PhysicsVector& rig << 69 G4bool operator!=(const G4PhysicsVector& rig << 70 73 71 virtual ~G4PhysicsVector() = default; << 74 virtual ~G4PhysicsVector(); 72 75 >> 76 G4double Value(G4double theEnergy, std::size_t& lastidx) const; 73 // Get the cross-section/energy-loss value c 77 // Get the cross-section/energy-loss value corresponding to the 74 // given energy. An appropriate interpolatio 78 // given energy. An appropriate interpolation is used to calculate 75 // the value. Consumer code gets changed ind 79 // the value. Consumer code gets changed index and may reuse it 76 // for the next call to save CPU for bin loc 80 // for the next call to save CPU for bin location. 77 inline G4double Value(const G4double energy, << 78 81 >> 82 inline G4double LogVectorValue(const G4double theEnergy, >> 83 const G4double theLogEnergy) const; >> 84 // Same as the Value() method above but specialised for log-vector type. >> 85 // Note, unlike the general Value() method above, this method will work >> 86 // properly only in case of G4PhysicsLogVector-s. >> 87 >> 88 inline G4double Value(G4double theEnergy) const; 79 // Get the cross-section/energy-loss value c 89 // Get the cross-section/energy-loss value corresponding to the 80 // given energy. An appropriate interpolatio 90 // given energy. An appropriate interpolation is used to calculate 81 // the value. This method should be used if << 91 // the value. This method is kept for backward compatibility reason, 82 // kept in the user code. << 92 // it should be used instead of the previous method if bin location 83 inline G4double Value(const G4double energy) << 93 // cannot be kept thread safe 84 94 >> 95 inline G4double GetValue(G4double theEnergy, G4bool& isOutRange) const; 85 // Obsolete method to get value, 'isOutRange 96 // Obsolete method to get value, 'isOutRange' is not used anymore. 86 // This method is kept for the compatibility 97 // This method is kept for the compatibility reason 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 98 >> 99 inline G4double operator[](const std::size_t index) const; 100 // Returns the value for the specified index 100 // Returns the value for the specified index of the dataVector 101 // The boundary check will not be done 101 // The boundary check will not be done 102 inline G4double operator[](const std::size_t << 102 103 inline G4double operator()(const std::size_t 103 inline G4double operator()(const std::size_t index) const; >> 104 // Returns the value for the specified index of the dataVector >> 105 // The boundary check will not be done 104 106 105 // Put data into the vector at 'index' posit << 107 inline void PutValue(std::size_t index, G4double theValue); >> 108 // Put 'theValue' into the dataVector specified by 'index'. 106 // Take note that the 'index' starts from '0 109 // Take note that the 'index' starts from '0'. 107 // It is assumed that energies are already f << 110 // To fill the vector, need to beforehand construct a vector 108 inline void PutValue(const std::size_t index << 111 // by the constructor with Emin, Emax, Nbin. 'theValue' should >> 112 // be the cross-section/energy-loss value corresponding to the >> 113 // energy of the index >> 114 >> 115 virtual void ScaleVector(G4double factorE, G4double factorV); >> 116 // Scale all values of the vector and second derivatives >> 117 // by factorV, energies by vectorE. This method may be applied >> 118 // for example after retrieving a vector from an external file to >> 119 // convert values into Geant4 units 109 120 >> 121 inline G4double Energy(std::size_t index) const; 110 // Returns the value in the energy specified 122 // Returns the value in the energy specified by 'index' 111 // of the energy vector. The boundary check 123 // of the energy vector. The boundary check will not be done. 112 // Use this when compute cross-section, dEdx << 124 // Use this function when compute cross-section or dEdx 113 // before filling the vector by PutValue(). << 125 // before filling the vector by PutValue() 114 inline G4double Energy(const std::size_t ind << 115 inline G4double GetLowEdgeEnergy(const std:: << 116 126 117 // Returns the energy of the first and the l << 118 inline G4double GetMinEnergy() const; << 119 inline G4double GetMaxEnergy() const; 127 inline G4double GetMaxEnergy() const; >> 128 // Returns the energy of the last point of the vector 120 129 121 // Returns the data of the first and the las << 130 G4double GetLowEdgeEnergy(std::size_t binNumber) const; 122 // If the vector is empty returns zeros. << 131 // Obsolete method 123 inline G4double GetMinValue() const; << 132 // Get the energy value at the low edge of the specified bin. 124 inline G4double GetMaxValue() const; << 133 // Take note that the 'binNumber' starts from '0'. >> 134 // The boundary check will not be done 125 135 126 // Get the total length of the vector << 127 inline std::size_t GetVectorLength() const; 136 inline std::size_t GetVectorLength() const; >> 137 // Get the total length of the vector >> 138 >> 139 inline std::size_t FindBin(const G4double energy, >> 140 const std::size_t idx) const; >> 141 // Find low edge index of a bin for given energy. >> 142 // Min value 0, max value VectorLength-1. >> 143 // idx is suggested bin number from user code 128 144 >> 145 inline std::size_t ComputeLogVectorBin(const G4double logenergy) const; 129 // Computes the lower index the energy bin i 146 // Computes the lower index the energy bin in case of log-vector i.e. 130 // in case of vectors with equal bin widths 147 // in case of vectors with equal bin widths on log-scale 131 // Note, that no check on the boundary is pe << 132 inline std::size_t ComputeLogVectorBin(const << 133 148 134 // Get physics vector type. << 149 void FillSecondDerivatives(); 135 inline G4PhysicsVectorType GetType() const; << 150 // Initialise second derivatives for Spline keeping 136 << 151 // 3rd derivative continues - default algorithm. 137 // True if using spline interpolation. << 152 // Warning: this method should be called when the vector 138 inline G4bool GetSpline() const; << 153 // is already filled 139 << 154 140 // Define verbosity level. << 155 void ComputeSecDerivatives(); 141 inline void SetVerboseLevel(G4int value); << 156 // Initialise second derivatives for Spline using algorithm >> 157 // which garantee only 1st derivative continues. >> 158 // Warning: this method should be called when the vector >> 159 // is already filled >> 160 >> 161 void ComputeSecondDerivatives(G4double firstPointDerivative, >> 162 G4double endPointDerivative); >> 163 // Initialise second derivatives for Spline using >> 164 // user defined 1st derivatives at edge points. >> 165 // Warning: this method should be called when the vector >> 166 // is already filled 142 167 >> 168 G4double FindLinearEnergy(G4double rand) const; 143 // Find energy using linear interpolation fo 169 // Find energy using linear interpolation for vector 144 // filled by cumulative probability function << 170 // filled by cumulative probability function 145 // Assuming that vector is already filled. << 171 // value of rand should be between 0 and 1 146 inline G4double FindLinearEnergy(const G4dou << 147 172 148 // Find low edge index of a bin for given en << 173 inline G4bool IsFilledVectorExist() const; 149 // Min value 0, max value idxmax. << 174 // Is non-empty physics vector already exist? 150 std::size_t FindBin(const G4double energy, s << 151 175 152 // Scale all values of the vector by factorV << 176 inline G4PhysicsVectorType GetType() const; 153 // AFter this method FillSecondDerivatives(. << 177 // Get physics vector type 154 // This method may be applied for example af << 178 155 // from an external file to convert values i << 179 inline void SetSpline(G4bool); 156 void ScaleVector(const G4double factorE, con << 180 // Activate/deactivate Spline interpolation 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 181 173 // To store/retrieve persistent data to/from << 174 G4bool Store(std::ofstream& fOut, G4bool asc 182 G4bool Store(std::ofstream& fOut, G4bool ascii = false) const; 175 G4bool Retrieve(std::ifstream& fIn, G4bool a << 183 virtual G4bool Retrieve(std::ifstream& fIn, G4bool ascii = false); >> 184 // To store/retrieve persistent data to/from file streams. 176 185 177 // Print vector << 178 friend std::ostream& operator<<(std::ostream 186 friend std::ostream& operator<<(std::ostream&, const G4PhysicsVector&); 179 void DumpValues(G4double unitE = 1.0, G4doub 187 void DumpValues(G4double unitE = 1.0, G4double unitV = 1.0) const; >> 188 // Print vector 180 189 181 protected: << 190 inline void SetVerboseLevel(G4int value); 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 191 197 // Linear or spline interpolation. << 192 protected: 198 inline G4double Interpolation(const std::siz << 193 void DeleteData(); 199 const G4double << 194 void CopyData(const G4PhysicsVector& vec); >> 195 // Internal methods for allowing copy of objects 200 196 201 // Assuming (edgeMin <= energy <= edgeMax). << 197 void PrintPutValueError(std::size_t index); 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 198 206 protected: << 199 G4PhysicsVectorType type = T_G4PhysicsVector; >> 200 // The type of PhysicsVector (enumerator) 207 201 208 G4double edgeMin = 0.0; // Energy of first 202 G4double edgeMin = 0.0; // Energy of first point 209 G4double edgeMax = 0.0; // Energy of the la 203 G4double edgeMax = 0.0; // Energy of the last point 210 204 211 G4double invdBin = 0.0; // 1/Bin width for << 205 G4double invdBin = 0.0; // 1/Bin width - useful only for fixed binning 212 G4double logemin = 0.0; // used only for lo << 206 G4double baseBin = 0.0; // Set this in constructor for performance 213 207 214 G4double iBin1 = 0.0; // 1/Bin width for sc << 208 G4int verboseLevel = 0; 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; 209 std::size_t numberOfNodes = 0; 221 std::size_t nLogNodes = 0; << 222 210 223 G4PhysicsVectorType type = T_G4PhysicsFreeVe << 211 G4PVDataVector dataVector; // Vector to keep the crossection/energyloss 224 // The type of PhysicsVector (enumerator) << 212 G4PVDataVector binVector; // Vector to keep energy >> 213 G4PVDataVector secDerivative; // Vector to keep second derivatives >> 214 >> 215 private: >> 216 G4bool SplinePossible(); 225 217 226 std::vector<G4double> binVector; // ene << 218 inline std::size_t FindBinLocation(const G4double theEnergy) const; 227 std::vector<G4double> dataVector; // cro << 219 // Find low edge index of a bin for given energy. 228 std::vector<G4double> secDerivative; // sec << 220 // Min value 0, max value VectorLength-1 229 std::vector<std::size_t> scale; // log << 230 221 231 private: << 222 inline G4double Interpolation(const std::size_t idx, >> 223 const G4double energy) const; 232 224 233 G4bool useSpline = false; 225 G4bool useSpline = false; 234 }; 226 }; 235 227 236 #include "G4PhysicsVector.icc" 228 #include "G4PhysicsVector.icc" 237 229 238 #endif 230 #endif 239 231