| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
26 // G4PhysicsFreeVector <<
27 // 23 //
28 // Class description: << 24 // $Id: G4PhysicsFreeVector.hh,v 1.8 2001/07/11 10:00:50 gunter Exp $
>> 25 // GEANT4 tag $Name: geant4-05-01-patch-01 $
29 // 26 //
30 // A physics vector which has values of energy << 27 //
31 // and other physics values of a particle in m << 28 //--------------------------------------------------------------------
32 // range of the energy, momentum, etc. The sca << 29 // GEANT 4 class header file
33 // bins is in free, i.e. it is NOT need to be << 30 //
34 // restriction is that bin values alway have t << 31 // G4PhysicsFreeVector.hh
35 // a lower bin to a higher bin. This is necess << 32 //
36 // search to work correctly. << 33 // Class description:
37 << 34 //
38 // Authors: << 35 // A physics vector which has values of energy-loss, cross-section,
39 // - 02 Dec. 1995, G.Cosmo: Structure created << 36 // and other physics values of a particle in matter in a given
40 // - 06 Jun. 1996, K.Amako: Implemented the 1s << 37 // range of the energy, momentum, etc. The scale of energy/momentum
41 // Revisions: << 38 // bins is in free, ie. it is NOT need to be linear or log. Only
42 // - 11 Nov. 2000, H.Kurashige: Use STL vector << 39 // restrication is that bin values alway have to increase from
43 // - 04 Feb. 2021, V.Ivanchenko moved implemen << 40 // a lower bin to a higher bin. This is necessary for the binary
44 // to this class << 41 // search to work correctly.
45 // ------------------------------------------- << 42
46 #ifndef G4PhysicsFreeVector_hh << 43 // History:
47 #define G4PhysicsFreeVector_hh 1 << 44 // 02 Dec. 1995, G.Cosmo : Structure created based on object model
>> 45 // 06 Jun. 1996, K.Amako : Implemented the 1st version
>> 46 // 01 Jul. 1996, K.Amako : Cache mechanism and hidden bin from the
>> 47 // user introduced
>> 48 // 26 Sep. 1996, K.Amako : Constructor with only 'bin size' added
>> 49 // 11 Nov. 2000, H.Kurashige : Use STL vector for dataVector and binVector
>> 50 //
>> 51 //--------------------------------------------------------------------
>> 52
>> 53 #ifndef G4PhysicsFreeVector_h
>> 54 #define G4PhysicsFreeVector_h 1
48 55
49 #include "G4PhysicsVector.hh" <<
50 #include "globals.hh" 56 #include "globals.hh"
51 #include <vector> << 57 #include "G4PhysicsVector.hh"
>> 58 #include "G4DataVector.hh"
52 59
53 class G4PhysicsFreeVector : public G4PhysicsVe << 60 class G4PhysicsFreeVector : public G4PhysicsVector
54 { 61 {
55 public: << 62 public: // with description
>> 63
>> 64 G4PhysicsFreeVector();
>> 65 G4PhysicsFreeVector(size_t theNbin);
>> 66 G4PhysicsFreeVector(const G4DataVector& binVector,
>> 67 const G4DataVector& dataVector);
>> 68 // Constructors:
>> 69 // 'binVector' has the low edge value of each scale bin.
>> 70 // 'dataVector' has the cross-section/energy-loss/etc at
>> 71 // the energy/momenturm of the corresponding a bin of
>> 72 // 'binVector'. 'binVector' and 'dataVector' need to have
>> 73 // the same vector length.
>> 74
>> 75 ~G4PhysicsFreeVector();
>> 76 // Destructor
>> 77
>> 78 void PutValue( size_t binNumber, G4double binValue,
>> 79 G4double dataValue );
>> 80 // To use this method to fill a PhysicsFreeVector, you have
>> 81 // to Construct a PhysicsFreeVector of the size you need
>> 82 // using G4PhysicsFreeVector(size_t theNbin). Also take
>> 83 // note that you have to fill all bin values and data
>> 84 // values before you the PhysicsFreeVector.
>> 85
>> 86 protected:
56 87
57 // Constructors of a free vector without fil << 88 size_t FindBinLocation(G4double theEnergy) const;
58 // The vector will be filled using PutValues << 89 // Find bin# in which theEnergy belongs - virtual function
59 // InsertValues(..) methods. <<
60 // If length > 0 energy and data vectors are <<
61 explicit G4PhysicsFreeVector(G4bool spline = <<
62 explicit G4PhysicsFreeVector(G4int length); <<
63 explicit G4PhysicsFreeVector(std::size_t len <<
64 <<
65 // Obsolete constructor - emin and emax are <<
66 explicit G4PhysicsFreeVector(std::size_t len <<
67 G4double emax, <<
68 <<
69 // The vector is filled in these constructor <<
70 // 'energies' and 'values' need to have the <<
71 // 'energies' assumed to increase, it is all <<
72 // equal energies <<
73 explicit G4PhysicsFreeVector(const std::vect <<
74 const std::vect <<
75 G4bool spline = <<
76 explicit G4PhysicsFreeVector(const G4double* <<
77 std::size_t len <<
78 <<
79 ~G4PhysicsFreeVector() override = default; <<
80 <<
81 // Filling of the vector with the check on i <<
82 void PutValues(const std::size_t index, <<
83 const G4double energy, const <<
84 <<
85 // Insert extra pair of energy and value <<
86 // If energy coincide with previously added <<
87 // this new pair is added after <<
88 void InsertValues(const G4double energy, con <<
89 <<
90 void EnableLogBinSearch(const G4int n = 1); <<
91 <<
92 // Obsolete method <<
93 inline void PutValue(const std::size_t index <<
94 const G4double e, const <<
95 }; 90 };
96 91
97 inline void G4PhysicsFreeVector::PutValue(cons << 92
98 cons << 93 inline
99 cons << 94 size_t G4PhysicsFreeVector::FindBinLocation(G4double theEnergy) const
100 { 95 {
101 PutValues(index, e, value); << 96 // For G4PhysicsFreeVector, FindBinLocation is implemented using
>> 97 // the binary search algorithm.
>> 98 //
>> 99 // Because this is a virtual function, it is accessed through a
>> 100 // pointer to the G4PhysicsVector object for most usages. In this
>> 101 // case, 'inline' will not be invoked. However, there is a possibility
>> 102 // that the user access to the G4PhysicsFreeVector object directly and
>> 103 // not through pointers or references. In this case, the 'inline' will
>> 104 // be invoked. (See R.B.Murray, "C++ Strategies and Tactics", Chap.6.6)
>> 105
>> 106 size_t lowerBound = 0;
>> 107 size_t upperBound = numberOfBin-1;
>> 108
>> 109 while (lowerBound <= upperBound) {
>> 110 size_t midBin = (lowerBound + upperBound)/2;
>> 111 if( theEnergy < binVector[midBin] )
>> 112 upperBound = midBin-1;
>> 113 else
>> 114 lowerBound = midBin+1;
>> 115 }
>> 116
>> 117 return upperBound;
102 } 118 }
103 119
104 #endif 120 #endif
105 121