Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/materials/include/G4MaterialPropertyVector.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 /materials/include/G4MaterialPropertyVector.hh (Version 11.3.0) and /materials/include/G4MaterialPropertyVector.hh (Version 8.3)


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