Geant4 Cross Reference

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


  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 G4MaterialPropertiesTable             << 
 29 //                                                 26 //
 30 // Class description:                          <<  27 // $Id: G4MaterialPropertiesTable.hh,v 1.18 2006/06/29 19:11:15 gunter Exp $
                                                   >>  28 // GEANT4 tag $Name: geant4-08-01 $
 31 //                                                 29 //
 32 // A Material properties table is a hash table <<  30 // 
 33 // key = property name, and value either G4dou <<  31 ////////////////////////////////////////////////////////////////////////
 34 // G4MaterialPropertyVector                    <<  32 // G4MaterialPropertiesTable Definition
                                                   >>  33 ////////////////////////////////////////////////////////////////////////
 35 //                                                 34 //
 36 // File:        G4MaterialPropertiesTable.hh       35 // File:        G4MaterialPropertiesTable.hh
                                                   >>  36 // Description: An Material properties table is a hash table, with 
                                                   >>  37 //    key = property name, and value either G4double or
                                                   >>  38 //              G4MaterialPropertyVector 
 37 // Version:     1.0                                39 // Version:     1.0
 38 // Created:     1996-02-08                         40 // Created:     1996-02-08
 39 // Author:      Juliet Armstrong                   41 // Author:      Juliet Armstrong
 40 // Updated:     2005-05-12 add SetGROUPVEL() b     42 // Updated:     2005-05-12 add SetGROUPVEL() by P. Gumplinger
 41 //              2002-11-05 add named material      43 //              2002-11-05 add named material constants by P. Gumplinger
 42 //              1999-11-05 Migration from G4RW     44 //              1999-11-05 Migration from G4RWTPtrHashDictionary to STL
 43 //                         by John Allison         45 //                         by John Allison
 44 //              1999-10-29 add method and clas     46 //              1999-10-29 add method and class descriptors
 45 //              1997-03-25 by Peter Gumplinger     47 //              1997-03-25 by Peter Gumplinger
 46 //              > cosmetics (only)                 48 //              > cosmetics (only)
                                                   >>  49 // mail:        gum@triumf.ca
 47 //                                                 50 //
 48 //////////////////////////////////////////////     51 ////////////////////////////////////////////////////////////////////////
 49                                                    52 
 50 #ifndef G4MaterialPropertiesTable_h                53 #ifndef G4MaterialPropertiesTable_h
 51 #define G4MaterialPropertiesTable_h 1              54 #define G4MaterialPropertiesTable_h 1
 52                                                    55 
 53 #include "G4MaterialPropertiesIndex.hh"        <<  56 /////////////
 54 #include "G4MaterialPropertyVector.hh"         <<  57 // Includes
                                                   >>  58 /////////////
                                                   >>  59 
                                                   >>  60 #include <cmath>
                                                   >>  61 #include <map>
 55 #include "globals.hh"                              62 #include "globals.hh"
                                                   >>  63 #include "G4MaterialPropertyVector.hh"
                                                   >>  64 
                                                   >>  65 // Class Description:
                                                   >>  66 // An Material properties table is a hash table, with key = property
                                                   >>  67 // name, and value either G4double or G4MaterialPropertyVector.
                                                   >>  68 // Class Description - End:
                                                   >>  69 
                                                   >>  70 /////////////////////
                                                   >>  71 // Class Definition
                                                   >>  72 /////////////////////
                                                   >>  73 
                                                   >>  74 class G4MaterialPropertiesTable {
                                                   >>  75 
                                                   >>  76         ////////////////
                                                   >>  77         // Constructor
                                                   >>  78         ////////////////
                                                   >>  79 
                                                   >>  80 public: // Without description
                                                   >>  81 
                                                   >>  82   G4MaterialPropertiesTable(); 
                                                   >>  83   
                                                   >>  84   ///////////////
                                                   >>  85   // Destructor
                                                   >>  86   ///////////////
                                                   >>  87 
                                                   >>  88 public: // Without description
                                                   >>  89 
                                                   >>  90   ~G4MaterialPropertiesTable();
                                                   >>  91 
                                                   >>  92   ////////////
                                                   >>  93   // Methods
                                                   >>  94   ////////////
                                                   >>  95 
                                                   >>  96 public: // With description
                                                   >>  97 
                                                   >>  98         void AddConstProperty(const char     *key,
                                                   >>  99                               G4double PropertyValue);
                                                   >> 100         // Add a new property to the table by giving a key-name and value 
                                                   >> 101 
                                                   >> 102   void AddProperty(const char     *key,
                                                   >> 103              G4double *PhotonMomenta,
                                                   >> 104              G4double *PropertyValues,
                                                   >> 105              G4int     NumEntries);
                                                   >> 106         // Add a new property to the table by giving a key-name and the
                                                   >> 107         // arrays x and y of size NumEntries.
                                                   >> 108 
                                                   >> 109   void AddProperty(const char *key, G4MaterialPropertyVector *opv);
                                                   >> 110         // Add a new property to the table by giving a key-name and an
                                                   >> 111         // already constructed G4MaterialPropertyVector.
                                                   >> 112 
                                                   >> 113         void RemoveConstProperty(const char *key);
                                                   >> 114         // Remove a constant property from the table.
                                                   >> 115 
                                                   >> 116   void RemoveProperty(const char *key);
                                                   >> 117         // Remove a property from the table.
                                                   >> 118 
                                                   >> 119         G4double GetConstProperty(const char *key);
                                                   >> 120         // Get the constant property from the table corresponding to the key-name
                                                   >> 121 
                                                   >> 122         G4bool ConstPropertyExists(const char *key);
                                                   >> 123         // Return true if a const property 'key' exists.
                                                   >> 124 
                                                   >> 125   G4MaterialPropertyVector* GetProperty(const char *key);
                                                   >> 126         // Get the property from the table corresponding to the key-name.
                                                   >> 127 
                                                   >> 128   void AddEntry(const char *key, G4double aPhotonMomentum,
                                                   >> 129                                  G4double  aPropertyValue);
                                                   >> 130         // Add a new entry (pair of numbers) to the table for a given key.
                                                   >> 131 
                                                   >> 132   void RemoveEntry(const char *key, G4double  aPhotonMomentum);
                                                   >> 133         // Remove an entry from the table for a given key and x-value.
                                                   >> 134 
                                                   >> 135   void DumpTable();
                                                   >> 136 
                                                   >> 137 private:
                                                   >> 138 
                                                   >> 139   /////////////////////////
                                                   >> 140   // Private Data members
                                                   >> 141   /////////////////////////
                                                   >> 142 
                                                   >> 143   std::map<G4String, G4MaterialPropertyVector*, std::less<G4String> > MPT;
                                                   >> 144   typedef std::map<G4String, G4MaterialPropertyVector*,
                                                   >> 145     std::less<G4String> >::iterator MPTiterator;
 56                                                   146 
 57 #include <vector>                              << 147         std::map< G4String, G4double, std::less<G4String> > MPTC;
                                                   >> 148         typedef std::map< G4String, G4double,
                                                   >> 149           std::less<G4String> >::iterator MPTCiterator;
 58                                                   150 
 59 class G4MaterialPropertiesTable                << 151         G4MaterialPropertyVector* SetGROUPVEL();
 60 {                                              << 
 61  public:                                       << 
 62   G4MaterialPropertiesTable();                 << 
 63   virtual ~G4MaterialPropertiesTable();        << 
 64                                                << 
 65   // Add a new property to the table by giving << 
 66   void AddConstProperty(const G4String& key, G << 
 67   void AddConstProperty(const char* key, G4dou << 
 68                                                << 
 69   // Add a new property to the table by giving << 
 70   // vectors of values                         << 
 71   G4MaterialPropertyVector* AddProperty(const  << 
 72     const std::vector<G4double>& photonEnergie << 
 73     G4bool createNewKey = false, G4bool spline << 
 74                                                << 
 75   // Add a new property to the table by giving << 
 76   // arrays x and y of size NumEntries.        << 
 77   G4MaterialPropertyVector* AddProperty(const  << 
 78     G4double* propertyValues, G4int numEntries << 
 79                                                << 
 80   // Add a new property to the table by giving << 
 81   // already constructed G4MaterialPropertyVec << 
 82   void AddProperty(const G4String& key, G4Mate << 
 83   void AddProperty(const char* key, G4Material << 
 84                                                << 
 85   // Add a new property to the table by giving << 
 86   // name. Properties are in namespace G4Optic << 
 87   // Not possible to create a new key with thi << 
 88   void AddProperty(const G4String& key, const  << 
 89                                                << 
 90   // Remove a constant property from the table << 
 91   void RemoveConstProperty(const G4String& key << 
 92   void RemoveConstProperty(const char* key);   << 
 93                                                << 
 94   // Remove a property from the table.         << 
 95   void RemoveProperty(const G4String& key);    << 
 96   void RemoveProperty(const char* key);        << 
 97                                                << 
 98   // Get a constant property from the table    << 
 99   // It is an error to ask for a const propert << 
100   //  Check if it has been defined with ConstP << 
101   G4double GetConstProperty(const G4String& ke << 
102   G4double GetConstProperty(const char* key) c << 
103   G4double GetConstProperty(const G4int index) << 
104                                                << 
105   // Return true if a const property has been  << 
106   // Despite the name, this returns false for  << 
107   //  GetMaterialConstPropertyNames() but not  << 
108   // Use this method before calling GetConstPr << 
109   G4bool ConstPropertyExists(const G4String& k << 
110   G4bool ConstPropertyExists(const char* key)  << 
111   G4bool ConstPropertyExists(const G4int index << 
112                                                << 
113   // Get the property from the table correspon << 
114   // nullptr is returned if the property has n << 
115   G4MaterialPropertyVector* GetProperty(const  << 
116   G4MaterialPropertyVector* GetProperty(const  << 
117   G4MaterialPropertyVector* GetProperty(const  << 
118                                                << 
119   // Add a new entry (pair of numbers) to the  << 
120   void AddEntry(const G4String& key, G4double  << 
121   void AddEntry(const char* key, G4double aPho << 
122                                                << 
123   // Get the constant property index from the  << 
124   // It is an error to request the index of a  << 
125   //  present in fMaterialConstPropertyNames() << 
126   G4int GetConstPropertyIndex(const G4String&  << 
127                                                << 
128   // Get the property index by the key-name.   << 
129   // It is an error to request the index of a  << 
130   //  present in GetMaterialPropertyNames()).  << 
131   G4int GetPropertyIndex(const G4String& key)  << 
132                                                << 
133   // print the material properties and materia << 
134   void DumpTable() const;                      << 
135                                                << 
136   // the next four methods are used in persist << 
137   const std::vector<G4String>& GetMaterialProp << 
138   const std::vector<G4String>& GetMaterialCons << 
139   // return references to the vectors of mater << 
140   const std::vector<G4MaterialPropertyVector*> << 
141   const std::vector<std::pair<G4double, G4bool << 
142                                                << 
143  private:                                      << 
144   // Calculate the group velocity based on RIN << 
145   G4MaterialPropertyVector* CalculateGROUPVEL( << 
146                                                << 
147   // Vector of pointer to material property ve << 
148   // All entries are initialized to nullptr.   << 
149   // Order of entries in MP defined by enum in << 
150   std::vector<G4MaterialPropertyVector*> fMP;  << 
151                                                << 
152   // Vector of energy-independent (i.e., "cons << 
153   // need to keep track if a property is defin << 
154   // is 'true' if the property is defined.     << 
155   // Order of entries in MCP defined by enum i << 
156   std::vector<std::pair<G4double, G4bool>> fMC << 
157                                                   152 
158   std::vector<G4String> fMatPropNames;  // vec << 
159   std::vector<G4String> fMatConstPropNames;  / << 
160 };                                                153 };
161                                                   154 
162 #endif /* G4MaterialPropertiesTable_h */          155 #endif /* G4MaterialPropertiesTable_h */
163                                                   156