Geant4 Cross Reference |
>> 1 // This code implementation is the intellectual property of >> 2 // the GEANT4 collaboration. 1 // 3 // 2 // ******************************************* << 4 // By copying, distributing or modifying the Program (or any work 3 // * License and Disclaimer << 5 // based on the Program) you indicate your acceptance of this statement, 4 // * << 6 // and all its terms. 5 // * The Geant4 software is copyright of th << 7 // 6 // * the Geant4 Collaboration. It is provided << 8 // $Id: G4PhysicsVector.hh,v 1.9 2001/03/09 12:08:19 gcosmo Exp $ 7 // * conditions of the Geant4 Software License << 9 // GEANT4 tag $Name: geant4-03-01 $ 8 // * LICENSE and available at http://cern.ch/ << 10 // 9 // * include a list of copyright holders. << 11 // 10 // * << 12 //--------------------------------------------------------------- 11 // * Neither the authors of this software syst << 13 // GEANT 4 class header file 12 // * institutes,nor the agencies providing fin << 14 // 13 // * work make any representation or warran << 15 // G4PhysicsVector.hh 14 // * regarding this software system or assum << 16 // 15 // * use. Please see the license in the file << 17 // Class description: 16 // * for the full disclaimer and the limitatio << 18 // 17 // * << 19 // A physics vector which has values of energy-loss, cross-section, 18 // * This code implementation is the result << 20 // and other physics values of a particle in matter in a given 19 // * technical work of the GEANT4 collaboratio << 21 // range of the energy, momentum, etc. 20 // * By using, copying, modifying or distri << 22 // This class serves as the base class for a vector having various 21 // * any work based on the software) you ag << 23 // energy scale, for example like 'log', 'linear', 'free', etc. 22 // * use in resulting scientific publicati << 24 23 // * acceptance of all terms of the Geant4 Sof << 25 // History: 24 // ******************************************* << 26 // 02 Dec. 1995, G.Cosmo : Structure created based on object model 25 // << 27 // 03 Mar. 1996, K.Amako : Implemented the 1st version 26 // G4PhysicsVector << 28 // 27 Apr. 1996, K.Amako : Cache mechanism added 27 // << 29 // 01 Jul. 1996, K.Amako : Now GetValue not virtual 28 // Class description: << 30 // 21 Sep. 1996, K.Amako : Added [] and () operators 29 // << 31 // 11 Nov. 2000, H.Kurashige : use STL vector for dataVector and binVector 30 // A physics vector which has values of energy << 32 // 18 Jan. 2001, H.Kurashige : removed ptrNextTable 31 // and other physics values of a particle in m << 33 // 09 Mar. 2001, H.Kurashige : added G4PhysicsVectorType & Store/Retrieve() 32 // range of energy, momentum, etc. << 34 // 33 // This class serves as the base class for a v << 35 //--------------------------------------------------------------- 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 36 49 #include "G4Log.hh" << 37 #ifndef G4PhysicsVector_h 50 #include "G4PhysicsVectorType.hh" << 38 #define G4PhysicsVector_h 1 51 #include "G4ios.hh" << 39 >> 40 #include "g4std/vector" 52 #include "globals.hh" 41 #include "globals.hh" >> 42 #include "G4ios.hh" >> 43 #include "g4std/iostream" >> 44 #include "g4std/fstream" 53 45 54 class G4PhysicsVector << 46 #include "G4PhysicsVectorType.hh" >> 47 >> 48 class G4PhysicsVector 55 { 49 { 56 public: << 50 public: 57 // Default constructor - vector will be fill << 51 58 // Free vector may be filled via InsertValue << 52 G4PhysicsVector(); 59 explicit G4PhysicsVector(G4bool spline = fal << 53 // constructor 60 << 54 // This class is an abstract class with pure virtual method of 61 // Copy constructor and assignment operator << 55 // virtual size_t FindBinLocation(G4double theEnergy) const 62 G4PhysicsVector(const G4PhysicsVector&) = de << 56 // So, default constructor is not supposed to be invoked explicitly 63 G4PhysicsVector& operator=(const G4PhysicsVe << 57 64 << 58 public: // with description 65 // not used operators << 59 66 G4PhysicsVector(const G4PhysicsVector&&) = d << 60 virtual ~G4PhysicsVector(); 67 G4PhysicsVector& operator=(const G4PhysicsVe << 61 // destructor 68 G4bool operator==(const G4PhysicsVector& rig << 62 69 G4bool operator!=(const G4PhysicsVector& rig << 63 inline G4double GetValue(G4double theEnergy, G4bool& isOutRange); 70 << 64 // Get the cross-section/energy-loss value corresponding to the 71 virtual ~G4PhysicsVector() = default; << 65 // given energy. An appropriate interpolation is used to calculate 72 << 66 // the value. 73 // Get the cross-section/energy-loss value c << 67 // [Note] isOutRange is not used anymore. This argument is kept 74 // given energy. An appropriate interpolatio << 68 // for the compatibility reason. 75 // the value. Consumer code gets changed ind << 69 76 // for the next call to save CPU for bin loc << 70 G4int operator==(const G4PhysicsVector &right) const ; 77 inline G4double Value(const G4double energy, << 71 G4int operator!=(const G4PhysicsVector &right) const ; 78 << 72 inline G4double operator[](const size_t binNumber) const ; 79 // Get the cross-section/energy-loss value c << 73 // Returns simply the value in the bin specified by 'binNumber' 80 // given energy. An appropriate interpolatio << 74 // of the dataVector. The boundary check will be Done. If you 81 // the value. This method should be used if << 75 // don't want this check, use the operator (). 82 // kept in the user code. << 76 inline G4double operator()(const size_t binNumber) const ; 83 inline G4double Value(const G4double energy) << 77 // Returns simply the value in the bin specified by 'binNumber' 84 << 78 // of the dataVector. The boundary check will not be Done. If 85 // Obsolete method to get value, 'isOutRange << 79 // you want this check, use the operator []. 86 // This method is kept for the compatibility << 80 87 inline G4double GetValue(const G4double ener << 81 inline void PutValue(size_t binNumber, G4double theValue); 88 << 82 // Put 'theValue' into the bin specified by 'binNumber'. 89 // Same as the Value() method above but spec << 83 // Take note that the 'binNumber' starts from '0'. 90 // Note, unlike the general Value() method a << 84 // To fill the vector, you have beforehand to Construct a vector 91 // properly only for G4PhysicsLogVector. << 85 // by the constructor with Emin, Emax, Nbin. 'theValue' should 92 inline G4double LogVectorValue(const G4doubl << 86 // be the crosssection/energyloss value corresponding to the low 93 const G4doubl << 87 // edge energy of the bin specified by 'binNumber'. You can get 94 << 88 // the low edge energy value of a bin by GetLowEdgeEnergy(). 95 // Same as the Value() method above but spec << 89 virtual G4double GetLowEdgeEnergy(size_t binNumber) const; 96 // with logarithmic seach of bin number << 90 // Get the energy value at the low edge of the specified bin. 97 inline G4double LogFreeVectorValue(const G4d << 91 // Take note that the 'binNumber' starts from '0'. 98 const G4d << 92 // This value is defined when a physics vector is constructed 99 << 93 // by a constructor of a derived class. Use this function 100 // Returns the value for the specified index << 94 // when you fill physis vector by PutValue(). 101 // The boundary check will not be done << 95 inline size_t GetVectorLength() const; 102 inline G4double operator[](const std::size_t << 96 // Get the toal length (bin number) of the vector. 103 inline G4double operator()(const std::size_t << 97 inline G4bool IsFilledVectorExist() const; 104 << 98 // Is non-empty physics vector already exist? 105 // Put data into the vector at 'index' posit << 99 106 // Take note that the 'index' starts from '0 << 100 inline void PutComment(const G4String& theComment); 107 // It is assumed that energies are already f << 101 // Put a comment to the G4PhysicsVector. This may help to check 108 inline void PutValue(const std::size_t index << 102 // whether your are accessing to the one you want. 109 << 103 inline const G4String& GetComment() const; 110 // Returns the value in the energy specified << 104 // Retrieve the comment of the G4PhysicsVector. 111 // of the energy vector. The boundary check << 105 112 // Use this when compute cross-section, dEdx << 106 inline G4PhysicsVectorType GetType() const; 113 // before filling the vector by PutValue(). << 107 // Get physics vector type 114 inline G4double Energy(const std::size_t ind << 108 115 inline G4double GetLowEdgeEnergy(const std:: << 109 virtual G4bool Store(G4std::ofstream& fOut, G4bool ascii=false); 116 << 110 virtual G4bool Retrieve(G4std::ifstream& fIn, G4bool ascii=false); 117 // Returns the energy of the first and the l << 111 // To store/retrieve persistent data to/from file streams. 118 inline G4double GetMinEnergy() const; << 112 119 inline G4double GetMaxEnergy() const; << 113 friend G4std::ostream& operator<<(G4std::ostream&, const G4PhysicsVector&); 120 << 114 121 // Returns the data of the first and the las << 115 protected: 122 // If the vector is empty returns zeros. << 116 123 inline G4double GetMinValue() const; << 117 typedef G4std::vector<G4double> G4PVDataVector; 124 inline G4double GetMaxValue() const; << 118 125 << 119 G4PhysicsVectorType type; // The type of PhysicsVector (enumerator) 126 // Get the total length of the vector << 120 127 inline std::size_t GetVectorLength() const; << 121 G4double edgeMin; // Lower edge value of the lowest bin 128 << 122 G4double edgeMax; // Lower edge value of the highest bin 129 // Computes the lower index the energy bin i << 123 size_t numberOfBin; 130 // in case of vectors with equal bin widths << 124 131 // Note, that no check on the boundary is pe << 125 G4double lastEnergy; // Cache the last input value 132 inline std::size_t ComputeLogVectorBin(const << 126 G4double lastValue; // Cache the last output value 133 << 127 size_t lastBin; // Cache the last bin location 134 // Get physics vector type. << 128 135 inline G4PhysicsVectorType GetType() const; << 129 G4PVDataVector dataVector; // Vector to keep the crossection/energyloss 136 << 130 G4PVDataVector binVector; // Vector to keep the low edge value of bin 137 // True if using spline interpolation. << 131 138 inline G4bool GetSpline() const; << 132 inline G4double LinearInterpolation(G4double theEnergy, size_t theLocBin); 139 << 133 // Linear interpolation function 140 // Define verbosity level. << 134 141 inline void SetVerboseLevel(G4int value); << 135 virtual size_t FindBinLocation(G4double theEnergy) const=0; 142 << 136 // Find the bin# in which theEnergy belongs - pure virtual function 143 // Find energy using linear interpolation fo << 137 144 // filled by cumulative probability function << 138 protected: 145 // Assuming that vector is already filled. << 139 146 inline G4double FindLinearEnergy(const G4dou << 140 G4PhysicsVector(const G4PhysicsVector&); 147 << 141 G4PhysicsVector& operator=(const G4PhysicsVector&); 148 // Find low edge index of a bin for given en << 142 // Protected copy constructor and assignment operator. 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 143 231 private: << 144 private: 232 145 233 G4bool useSpline = false; << 146 G4String comment; 234 }; 147 }; 235 148 236 #include "G4PhysicsVector.icc" 149 #include "G4PhysicsVector.icc" 237 150 238 #endif 151 #endif 239 152