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