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 // G4Physics2DVector << 27 // 26 // 28 // Class description: << 27 // $Id:$ 29 // 28 // 30 // A 2-dimentional vector with linear interpol << 29 // >> 30 //--------------------------------------------------------------- >> 31 // GEANT 4 class header file >> 32 // >> 33 // G4Physics2DVector.hh >> 34 // >> 35 // Class description: >> 36 // >> 37 // A 2-dimentional vector with linear interpolation. 31 38 32 // Author: Vladimir Ivanchenko, 25.09.2011 << 39 // Author: Vladimir Ivanchenko 33 // ------------------------------------------- << 40 // 34 #ifndef G4Physics2DVector_hh << 41 // Creation date: 25.09.2011 35 #define G4Physics2DVector_hh 1 << 42 // >> 43 // Modified: >> 44 // 16.05.2013 V.Ivanchenko removed cache; changed signature of >> 45 // several methods; all run time methods become const; >> 46 // the class become read only in run time >> 47 //--------------------------------------------------------------- >> 48 >> 49 #ifndef G4Physics2DVector_h >> 50 #define G4Physics2DVector_h 1 36 51 37 #include <fstream> << 38 #include <iostream> 52 #include <iostream> >> 53 #include <fstream> 39 #include <vector> 54 #include <vector> 40 55 41 #include "G4PhysicsVectorType.hh" << 42 #include "G4ios.hh" << 43 #include "globals.hh" 56 #include "globals.hh" >> 57 #include "G4ios.hh" >> 58 #include "G4PhysicsVectorType.hh" 44 59 45 using G4PV2DDataVector = std::vector<G4double> << 60 typedef std::vector<G4double> G4PV2DDataVector; 46 61 47 class G4Physics2DVector << 62 class G4Physics2DVector 48 { 63 { 49 public: << 64 public: // with description >> 65 50 G4Physics2DVector(); 66 G4Physics2DVector(); 51 // Vector will be filled via Retrieve method 67 // Vector will be filled via Retrieve method 52 68 53 explicit G4Physics2DVector(std::size_t nx, s << 69 explicit G4Physics2DVector(size_t nx, size_t ny); 54 // Vector will be filled via Put methods 70 // Vector will be filled via Put methods 55 71 56 G4Physics2DVector(const G4Physics2DVector&); 72 G4Physics2DVector(const G4Physics2DVector&); 57 G4Physics2DVector& operator=(const G4Physics 73 G4Physics2DVector& operator=(const G4Physics2DVector&); 58 // Copy constructor and assignment operator << 74 // Copy constructor and assignment operator. 59 << 60 G4bool operator==(const G4Physics2DVector& r << 61 G4bool operator!=(const G4Physics2DVector& r << 62 75 63 ~G4Physics2DVector(); 76 ~G4Physics2DVector(); 64 // Destructor << 77 // destructor 65 << 78 66 G4double Value(G4double x, G4double y, std:: << 79 G4double Value(G4double x, G4double y, 67 std::size_t& lastidy) const; << 80 size_t& lastidx, size_t& lastidy) const; 68 G4double Value(G4double x, G4double y) const 81 G4double Value(G4double x, G4double y) const; 69 // Main method to interpolate 2D vector 82 // Main method to interpolate 2D vector 70 // Consumer class should provide initial val << 83 // Consumer class should provide initial values >> 84 // lastidx and lastidy, 71 85 72 inline void PutX(std::size_t idx, G4double v << 86 inline void PutX(size_t idx, G4double value); 73 inline void PutY(std::size_t idy, G4double v << 87 inline void PutY(size_t idy, G4double value); 74 inline void PutValue(std::size_t idx, std::s << 88 inline void PutValue(size_t idx, size_t idy, G4double value); 75 void PutVectors(const std::vector<G4double>& 89 void PutVectors(const std::vector<G4double>& vecX, 76 const std::vector<G4double>& << 90 const std::vector<G4double>& vecY); 77 // Methods to fill vector << 91 // Methods to fill vector 78 // Take note that the 'index' starts from '0 << 92 // Take note that the 'index' starts from '0'. 79 93 80 void ScaleVector(G4double factor); 94 void ScaleVector(G4double factor); 81 // Scale all values of the vector by factor. << 95 // Scale all values of the vector by factor, 82 // This method may be applied for example af << 96 // This method may be applied 83 // from an external file to convert values i << 97 // for example after Retrieve a vector from an external file to >> 98 // convert values into Geant4 units 84 99 85 G4double FindLinearX(G4double rand, G4double << 100 G4double >> 101 FindLinearX(G4double rand, G4double y, size_t& lastidy) const; 86 inline G4double FindLinearX(G4double rand, G 102 inline G4double FindLinearX(G4double rand, G4double y) const; 87 // Find Y using linear interpolation for Y-v << 103 // Find Y using linear interpolation for Y-vector 88 // probability function value of rand should << 104 // filled by cumulative probability function 89 << 105 // value of rand should be between 0 and 1 90 inline G4double GetX(std::size_t index) cons << 106 91 inline G4double GetY(std::size_t index) cons << 107 inline G4double GetX(size_t index) const; 92 inline G4double GetValue(std::size_t idx, st << 108 inline G4double GetY(size_t index) const; >> 109 inline G4double GetValue(size_t idx, size_t idy) const; 93 // Returns simply the values of the vector b 110 // Returns simply the values of the vector by index 94 // of the energy vector. The boundary check << 111 // of the energy vector. The boundary check will not be done. 95 112 96 inline std::size_t FindBinLocationX(const G4 << 113 inline size_t FindBinLocationX(G4double x, size_t lastidx) const; 97 const st << 114 inline size_t FindBinLocationY(G4double y, size_t lastidy) const; 98 inline std::size_t FindBinLocationY(const G4 << 115 // Find the bin# in which theEnergy belongs 99 const st << 116 // Starting from 0 100 // Find the bin# in which theEnergy belongs. << 117 101 << 118 inline size_t GetLengthX() const; 102 inline std::size_t GetLengthX() const; << 119 inline size_t GetLengthY() const; 103 inline std::size_t GetLengthY() const; << 120 // Get the lengths of the vector. 104 // Get the lengths of the vector << 105 121 106 inline G4PhysicsVectorType GetType() const; 122 inline G4PhysicsVectorType GetType() const; 107 // Get physics vector type 123 // Get physics vector type 108 124 109 inline void SetBicubicInterpolation(G4bool); 125 inline void SetBicubicInterpolation(G4bool); 110 // Activate/deactivate bicubic interpolation << 126 // Activate/deactivate bicubic interpolation. 111 127 112 void Store(std::ofstream& fOut) const; 128 void Store(std::ofstream& fOut) const; 113 G4bool Retrieve(std::ifstream& fIn); 129 G4bool Retrieve(std::ifstream& fIn); 114 // To store/retrieve persistent data to/from << 130 // To store/retrieve persistent data to/from file streams. 115 131 116 inline void SetVerboseLevel(G4int value); 132 inline void SetVerboseLevel(G4int value); 117 133 118 protected: << 134 protected: >> 135 119 void PrepareVectors(); 136 void PrepareVectors(); 120 137 121 void ClearVectors(); 138 void ClearVectors(); 122 139 123 void CopyData(const G4Physics2DVector& vec); 140 void CopyData(const G4Physics2DVector& vec); 124 141 125 G4double BicubicInterpolation(const G4double << 142 G4double BicubicInterpolation(G4double x, G4double y, 126 const std::siz << 143 size_t idx, size_t idy) const; 127 const std::siz << 144 // Bicubic interpolation of 2D vector 128 // Bicubic interpolation of 2D vector << 145 129 << 146 size_t FindBinLocation(G4double z, const G4PV2DDataVector&) const; 130 inline std::size_t FindBin(const G4double z, << 147 // Main method to local bin 131 const std::size_t << 148 132 const std::size_t << 149 inline size_t FindBin(G4double z, const G4PV2DDataVector&, >> 150 size_t idz, size_t idzmax) const; >> 151 >> 152 private: 133 153 134 private: << 135 G4double InterpolateLinearX(G4PV2DDataVector 154 G4double InterpolateLinearX(G4PV2DDataVector& v, G4double rand) const; 136 155 137 inline G4double DerivativeX(std::size_t idx, << 156 inline G4double DerivativeX(size_t idx, size_t idy, G4double fac) const; 138 G4double fac) co << 157 inline G4double DerivativeY(size_t idx, size_t idy, G4double fac) const; 139 inline G4double DerivativeY(std::size_t idx, << 158 inline G4double DerivativeXY(size_t idx, size_t idy, G4double fac) const; 140 G4double fac) co << 141 inline G4double DerivativeXY(std::size_t idx << 142 G4double fac) c << 143 // computation of derivatives 159 // computation of derivatives 144 160 145 G4PhysicsVectorType type = T_G4PhysicsFreeVe << 161 G4int operator==(const G4Physics2DVector &right) const = delete; 146 // The type of PhysicsVector (enumerator) << 162 G4int operator!=(const G4Physics2DVector &right) const = delete; >> 163 >> 164 G4PhysicsVectorType type; // The type of PhysicsVector (enumerator) 147 165 148 std::size_t numberOfXNodes = 0; << 166 size_t numberOfXNodes; 149 std::size_t numberOfYNodes = 0; << 167 size_t numberOfYNodes; 150 168 151 G4PV2DDataVector xVector; << 169 G4PV2DDataVector xVector; 152 G4PV2DDataVector yVector; << 170 G4PV2DDataVector yVector; 153 std::vector<G4PV2DDataVector*> value; 171 std::vector<G4PV2DDataVector*> value; 154 172 155 G4int verboseLevel = 0; << 173 G4int verboseLevel; 156 G4bool useBicubic = false; << 174 G4bool useBicubic; 157 }; 175 }; 158 176 159 #include "G4Physics2DVector.icc" 177 #include "G4Physics2DVector.icc" 160 178 161 #endif 179 #endif 162 180