1 | // |
---|
2 | // ******************************************************************** |
---|
3 | // * License and Disclaimer * |
---|
4 | // * * |
---|
5 | // * The Geant4 software is copyright of the Copyright Holders of * |
---|
6 | // * the Geant4 Collaboration. It is provided under the terms and * |
---|
7 | // * conditions of the Geant4 Software License, included in the file * |
---|
8 | // * LICENSE and available at http://cern.ch/geant4/license . These * |
---|
9 | // * include a list of copyright holders. * |
---|
10 | // * * |
---|
11 | // * Neither the authors of this software system, nor their employing * |
---|
12 | // * institutes,nor the agencies providing financial support for this * |
---|
13 | // * work make any representation or warranty, express or implied, * |
---|
14 | // * regarding this software system or assume any liability for its * |
---|
15 | // * use. Please see the license in the file LICENSE and URL above * |
---|
16 | // * for the full disclaimer and the limitation of liability. * |
---|
17 | // * * |
---|
18 | // * This code implementation is the result of the scientific and * |
---|
19 | // * technical work of the GEANT4 collaboration. * |
---|
20 | // * By using, copying, modifying or distributing the software (or * |
---|
21 | // * any work based on the software) you agree to acknowledge its * |
---|
22 | // * use in resulting scientific publications, and indicate your * |
---|
23 | // * acceptance of all terms of the Geant4 Software license. * |
---|
24 | // ******************************************************************** |
---|
25 | // |
---|
26 | // |
---|
27 | // $Id: G4PhysicsFreeVector.hh,v 1.12 2008/09/22 14:49:57 gcosmo Exp $ |
---|
28 | // GEANT4 tag $Name: geant4-09-02-cand-01 $ |
---|
29 | // |
---|
30 | // |
---|
31 | //-------------------------------------------------------------------- |
---|
32 | // GEANT 4 class header file |
---|
33 | // |
---|
34 | // G4PhysicsFreeVector.hh |
---|
35 | // |
---|
36 | // Class description: |
---|
37 | // |
---|
38 | // A physics vector which has values of energy-loss, cross-section, |
---|
39 | // and other physics values of a particle in matter in a given |
---|
40 | // range of the energy, momentum, etc. The scale of energy/momentum |
---|
41 | // bins is in free, ie. it is NOT need to be linear or log. Only |
---|
42 | // restrication is that bin values alway have to increase from |
---|
43 | // a lower bin to a higher bin. This is necessary for the binary |
---|
44 | // search to work correctly. |
---|
45 | |
---|
46 | // History: |
---|
47 | // 02 Dec. 1995, G.Cosmo : Structure created based on object model |
---|
48 | // 06 Jun. 1996, K.Amako : Implemented the 1st version |
---|
49 | // 01 Jul. 1996, K.Amako : Cache mechanism and hidden bin from the |
---|
50 | // user introduced |
---|
51 | // 26 Sep. 1996, K.Amako : Constructor with only 'bin size' added |
---|
52 | // 11 Nov. 2000, H.Kurashige : Use STL vector for dataVector and binVector |
---|
53 | // |
---|
54 | //-------------------------------------------------------------------- |
---|
55 | |
---|
56 | #ifndef G4PhysicsFreeVector_h |
---|
57 | #define G4PhysicsFreeVector_h 1 |
---|
58 | |
---|
59 | #include "globals.hh" |
---|
60 | #include "G4PhysicsVector.hh" |
---|
61 | #include "G4DataVector.hh" |
---|
62 | |
---|
63 | class G4PhysicsFreeVector : public G4PhysicsVector |
---|
64 | { |
---|
65 | public: // with description |
---|
66 | |
---|
67 | G4PhysicsFreeVector(); |
---|
68 | explicit G4PhysicsFreeVector(size_t theNbin); |
---|
69 | G4PhysicsFreeVector(const G4DataVector& binVector, |
---|
70 | const G4DataVector& dataVector); |
---|
71 | // Constructors: |
---|
72 | // 'binVector' has the low edge value of each scale bin. |
---|
73 | // 'dataVector' has the cross-section/energy-loss/etc at |
---|
74 | // the energy/momenturm of the corresponding a bin of |
---|
75 | // 'binVector'. 'binVector' and 'dataVector' need to have |
---|
76 | // the same vector length. |
---|
77 | |
---|
78 | ~G4PhysicsFreeVector(); |
---|
79 | // Destructor |
---|
80 | |
---|
81 | void PutValue( size_t binNumber, G4double binValue, |
---|
82 | G4double dataValue ); |
---|
83 | // To use this method to fill a PhysicsFreeVector, you have |
---|
84 | // to Construct a PhysicsFreeVector of the size you need |
---|
85 | // using G4PhysicsFreeVector(size_t theNbin). Also take |
---|
86 | // note that you have to fill all bin values and data |
---|
87 | // values before you the PhysicsFreeVector. |
---|
88 | |
---|
89 | protected: |
---|
90 | |
---|
91 | size_t FindBinLocation(G4double theEnergy) const; |
---|
92 | // Find bin# in which theEnergy belongs - virtual function |
---|
93 | }; |
---|
94 | |
---|
95 | |
---|
96 | inline |
---|
97 | size_t G4PhysicsFreeVector::FindBinLocation(G4double theEnergy) const |
---|
98 | { |
---|
99 | // For G4PhysicsFreeVector, FindBinLocation is implemented using |
---|
100 | // the binary search algorithm. |
---|
101 | // |
---|
102 | // Because this is a virtual function, it is accessed through a |
---|
103 | // pointer to the G4PhysicsVector object for most usages. In this |
---|
104 | // case, 'inline' will not be invoked. However, there is a possibility |
---|
105 | // that the user access to the G4PhysicsFreeVector object directly and |
---|
106 | // not through pointers or references. In this case, the 'inline' will |
---|
107 | // be invoked. (See R.B.Murray, "C++ Strategies and Tactics", Chap.6.6) |
---|
108 | |
---|
109 | size_t lowerBound = 0; |
---|
110 | size_t upperBound = numberOfBin-1; |
---|
111 | |
---|
112 | while (lowerBound <= upperBound) |
---|
113 | { |
---|
114 | size_t midBin = (lowerBound + upperBound)/2; |
---|
115 | if( theEnergy < binVector[midBin] ) |
---|
116 | { upperBound = midBin-1; } |
---|
117 | else |
---|
118 | { lowerBound = midBin+1; } |
---|
119 | } |
---|
120 | |
---|
121 | return upperBound; |
---|
122 | } |
---|
123 | |
---|
124 | #endif |
---|