Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/global/management/include/G4Physics2DVector.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /global/management/include/G4Physics2DVector.hh (Version 11.3.0) and /global/management/include/G4Physics2DVector.hh (Version 10.6.p2)


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