| 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 <<
26 ////////////////////////////////////////////// <<
27 // 22 //
28 // class G4MaterialPropertyVector <<
29 // 23 //
30 // Class description: << 24 // $Id: G4MaterialPropertyVector.hh,v 1.8 2002/01/22 15:23:57 gcosmo Exp $
>> 25 // GEANT4 tag $Name: geant4-04-00-patch-01 $
>> 26 //
>> 27 //
>> 28 ////////////////////////////////////////////////////////////////////////
>> 29 // G4MaterialPropertyVector Class Definition
>> 30 ////////////////////////////////////////////////////////////////////////
31 // 31 //
32 // A one-to-one mapping from Photon Energy to <<
33 <<
34 // File: G4MaterialPropertyVector.hh 32 // File: G4MaterialPropertyVector.hh
35 // 33 //
36 // Version: 2.0 << 34 // Description: A one-to-one mapping from Photon Momentum to some
>> 35 // optical property
>> 36 // Version: 1.0
37 // Created: 1996-02-08 37 // Created: 1996-02-08
38 // Author: Juliet Armstrong 38 // Author: Juliet Armstrong
39 // Updated: 2011-10-13 by Peter Gumplinger << 39 // Updated: 1999-10-29 add method and class descriptors
40 // remove the class: simply typed << 40 // 1997-03-25 by Peter Gumplinger
>> 41 // > value.h -> templates.hh
>> 42 // mail: gum@triumf.ca
41 // 43 //
42 ////////////////////////////////////////////// 44 ////////////////////////////////////////////////////////////////////////
43 45
44 #ifndef G4MaterialPropertyVector_h << 46 #ifndef G4MaterialPropertyVector_h
45 #define G4MaterialPropertyVector_h 1 47 #define G4MaterialPropertyVector_h 1
46 48
47 #include "G4PhysicsFreeVector.hh" << 49 /////////////
48 using G4MaterialPropertyVector = G4PhysicsFree << 50 // Includes
>> 51 /////////////
>> 52
>> 53 #include "G4MPVEntry.hh"
>> 54 #include "g4std/vector"
>> 55 #include "g4std/functional"
>> 56
>> 57 // Class Description:
>> 58 // A one-to-one mapping from Photon Momentum to some optical property.
>> 59 // Class Description - End:
>> 60
>> 61 /////////////////////
>> 62 // Class Definition
>> 63 /////////////////////
>> 64
>> 65 class G4MaterialPropertyVector {
>> 66
>> 67 struct MPVEntry_less
>> 68 : public G4std::binary_function<G4MPVEntry*, G4MPVEntry*, G4bool>
>> 69 {
>> 70 G4bool operator()(G4MPVEntry* x, G4MPVEntry* y) { return *x < *y; }
>> 71 };
>> 72
>> 73 public: // Without description
>> 74
>> 75 //////////////
>> 76 // Operators
>> 77 //////////////
>> 78
>> 79 G4bool operator ++();
>> 80 G4MaterialPropertyVector&
>> 81 operator =(const G4MaterialPropertyVector &right);
>> 82
>> 83 /////////////////
>> 84 // Constructors
>> 85 /////////////////
>> 86
>> 87 G4MaterialPropertyVector() : MPV(0)
>> 88 {
>> 89 CurrentEntry = -1;
>> 90 NumEntries = 0;
>> 91 };
>> 92
>> 93 public: // With description
>> 94
>> 95 G4MaterialPropertyVector(G4double *PhotonMomenta,
>> 96 G4double *PropertyValues,
>> 97 G4int NumElements);
>> 98 // Constructor of G4MaterialPropertyVector object.
>> 99
>> 100 public: // Without description
>> 101
>> 102 G4MaterialPropertyVector(const G4MaterialPropertyVector &right);
>> 103
>> 104 ///////////////
>> 105 // Destructor
>> 106 ///////////////
>> 107
>> 108 ~G4MaterialPropertyVector();
>> 109
>> 110 ////////////
>> 111 // Methods
>> 112 ////////////
>> 113
>> 114 public: // With description
>> 115
>> 116 void ResetIterator();
>> 117
>> 118 void AddElement(G4double aPhotonMomentum,
>> 119 G4double aPropertyValue);
>> 120 // Add a new element (pair of numbers) to the G4MaterialPropertyVector.
>> 121 void RemoveElement(G4double aPhotonMomentum);
>> 122 // Remove the element with given x-value.
>> 123
>> 124 G4double GetProperty(G4double aPhotonMomentum) const;
>> 125 // Returns the y-value for given x-value (with interpolation).
>> 126 G4double GetPhotonMomentum(G4double aProperty) const;
>> 127 // Returns the x-value for given y-value (with interpolation).
>> 128 // NOTE: Assumes that the y-value is an increasing function of
>> 129 // the x-value. Returns the x-value corresponding to the
>> 130 // y-value passed in. If several x-values correspond to
>> 131 // the y-value passed in, the method returns the first
>> 132 // x-value in the vector that corresponds to that value.
>> 133 // For use with G4MaterialPropertyVector iterator: return
>> 134 // property (or Photon momentum) at current point of iterator.
>> 135
>> 136 G4double GetProperty() const;
>> 137 G4double GetPhotonMomentum() const;
>> 138
>> 139 G4double GetMaxProperty() const;
>> 140 G4double GetMinProperty() const;
>> 141 G4double GetMaxPhotonMomentum() const;
>> 142 G4double GetMinPhotonMomentum() const;
>> 143
>> 144 //////////
>> 145 // Tests
>> 146 //////////
>> 147
>> 148 void DumpVector();
>> 149
>> 150 private:
>> 151
>> 152 /////////////////////
>> 153 // Helper Functions
>> 154 /////////////////////
>> 155
>> 156 G4MPVEntry GetEntry(G4int i) const;
>> 157
>> 158 void GetAdjacentBins(G4double aPhotonMomentum,
>> 159 G4int *left,G4int *right) const;
>> 160
>> 161 /////////////////////////
>> 162 // Private Data Members
>> 163 /////////////////////////
>> 164
>> 165 G4std::vector<G4MPVEntry*> MPV;
>> 166 G4int NumEntries;
>> 167 G4int CurrentEntry;
>> 168 };
>> 169
>> 170 ///////////////////
>> 171 // Inline methods
>> 172 ///////////////////
>> 173
>> 174 inline
>> 175 G4double G4MaterialPropertyVector::GetMaxProperty() const
>> 176 {
>> 177 return MPV.back()->GetProperty();
>> 178 }
>> 179
>> 180 inline
>> 181 G4double G4MaterialPropertyVector::GetMinProperty() const
>> 182 {
>> 183 return MPV.front()->GetProperty();
>> 184 }
>> 185
>> 186 inline
>> 187 G4double G4MaterialPropertyVector::GetMaxPhotonMomentum() const
>> 188 {
>> 189 return MPV.back()->GetPhotonMomentum();
>> 190 }
>> 191
>> 192 inline
>> 193 G4double G4MaterialPropertyVector::GetMinPhotonMomentum() const
>> 194 {
>> 195 return MPV.front()->GetPhotonMomentum();
>> 196 }
49 197
50 #endif /* G4MaterialPropertyVector_h */ 198 #endif /* G4MaterialPropertyVector_h */
51 199