Geant4 Cross Reference |
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 << 25 // >> 26 // >> 27 // 26 ////////////////////////////////////////////// 28 //////////////////////////////////////////////////////////////////////// 27 // 29 // 28 // class G4MaterialPropertiesTable 30 // class G4MaterialPropertiesTable 29 // 31 // 30 // Class description: 32 // Class description: 31 // 33 // 32 // A Material properties table is a hash table << 34 // A Material properties table is a hash table, with 33 // key = property name, and value either G4dou 35 // key = property name, and value either G4double or 34 // G4MaterialPropertyVector 36 // G4MaterialPropertyVector 35 // << 37 36 // File: G4MaterialPropertiesTable.hh 38 // File: G4MaterialPropertiesTable.hh 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 >> 56 ///////////// >> 57 // Includes >> 58 ///////////// >> 59 >> 60 #include <cmath> >> 61 #include <map> >> 62 #include "globals.hh" 53 #include "G4MaterialPropertiesIndex.hh" 63 #include "G4MaterialPropertiesIndex.hh" 54 #include "G4MaterialPropertyVector.hh" 64 #include "G4MaterialPropertyVector.hh" 55 #include "globals.hh" << 56 65 57 #include <vector> << 66 ///////////////////// >> 67 // Class Definition >> 68 ///////////////////// 58 69 59 class G4MaterialPropertiesTable 70 class G4MaterialPropertiesTable 60 { 71 { 61 public: << 72 public: // Without description 62 G4MaterialPropertiesTable(); << 73 63 virtual ~G4MaterialPropertiesTable(); << 74 G4MaterialPropertiesTable(); 64 << 75 virtual ~G4MaterialPropertiesTable(); 65 // Add a new property to the table by giving << 76 66 void AddConstProperty(const G4String& key, G << 77 public: // With description 67 void AddConstProperty(const char* key, G4dou << 78 68 << 79 inline void AddConstProperty(const char *key, 69 // Add a new property to the table by giving << 80 G4double PropertyValue); 70 // vectors of values << 81 // Add a new property to the table by giving a key-name and value 71 G4MaterialPropertyVector* AddProperty(const << 82 72 const std::vector<G4double>& photonEnergie << 83 G4MaterialPropertyVector* AddProperty(const char *key, 73 G4bool createNewKey = false, G4bool spline << 84 G4double *PhotonEnergies, 74 << 85 G4double *PropertyValues, 75 // Add a new property to the table by giving << 86 G4int NumEntries); 76 // arrays x and y of size NumEntries. << 87 // Add a new property to the table by giving a key-name and the 77 G4MaterialPropertyVector* AddProperty(const << 88 // arrays x and y of size NumEntries. 78 G4double* propertyValues, G4int numEntries << 89 79 << 90 void AddProperty(const char *key, G4MaterialPropertyVector *opv); 80 // Add a new property to the table by giving << 91 // Add a new property to the table by giving a key-name and an 81 // already constructed G4MaterialPropertyVec << 92 // already constructed G4MaterialPropertyVector. 82 void AddProperty(const G4String& key, G4Mate << 93 83 void AddProperty(const char* key, G4Material << 94 inline void RemoveConstProperty(const char *key); 84 << 95 // Remove a constant property from the table. 85 // Add a new property to the table by giving << 96 86 // name. Properties are in namespace G4Optic << 97 inline void RemoveProperty(const char *key); 87 // Not possible to create a new key with thi << 98 // Remove a property from the table. 88 void AddProperty(const G4String& key, const << 99 89 << 100 G4double GetConstProperty(const char *key) const; 90 // Remove a constant property from the table << 101 // Get the constant property from the table corresponding to the key-name 91 void RemoveConstProperty(const G4String& key << 102 92 void RemoveConstProperty(const char* key); << 103 G4double GetConstProperty(const G4int index) const; 93 << 104 // Get the constant property from the table corresponding to the key-index 94 // Remove a property from the table. << 105 95 void RemoveProperty(const G4String& key); << 106 G4bool ConstPropertyExists(const char *key) const; 96 void RemoveProperty(const char* key); << 107 // Return true if a const property 'key' exists. 97 << 108 98 // Get a constant property from the table << 109 G4MaterialPropertyVector* GetProperty(const char *key, 99 // It is an error to ask for a const propert << 110 G4bool warning=false); 100 // Check if it has been defined with ConstP << 111 // Get the property from the table corresponding to the key-name. 101 G4double GetConstProperty(const G4String& ke << 112 102 G4double GetConstProperty(const char* key) c << 113 G4MaterialPropertyVector* GetProperty(const G4int index, 103 G4double GetConstProperty(const G4int index) << 114 G4bool warning=false); 104 << 115 // Get the property from the table corresponding to the key-index. 105 // Return true if a const property has been << 116 106 // Despite the name, this returns false for << 117 void AddEntry(const char *key, G4double aPhotonEnergy, 107 // GetMaterialConstPropertyNames() but not << 118 G4double aPropertyValue); 108 // Use this method before calling GetConstPr << 119 // Add a new entry (pair of numbers) to the table for a given key. 109 G4bool ConstPropertyExists(const G4String& k << 120 110 G4bool ConstPropertyExists(const char* key) << 121 G4int GetConstPropertyIndex(const G4String& key, 111 G4bool ConstPropertyExists(const G4int index << 122 G4bool warning=false) const; 112 << 123 // Get the constant property index from the key-name 113 // Get the property from the table correspon << 124 114 // nullptr is returned if the property has n << 125 G4int GetPropertyIndex(const G4String& key, G4bool warning=false) const; 115 G4MaterialPropertyVector* GetProperty(const << 126 // Get the property index by the key-name. 116 G4MaterialPropertyVector* GetProperty(const << 127 117 G4MaterialPropertyVector* GetProperty(const << 128 std::vector<G4String> GetMaterialPropertyNames() const; 118 << 129 std::vector<G4String> GetMaterialConstPropertyNames() const; 119 // Add a new entry (pair of numbers) to the << 130 120 void AddEntry(const G4String& key, G4double << 131 void DumpTable(); 121 void AddEntry(const char* key, G4double aPho << 132 122 << 133 public: // without description 123 // Get the constant property index from the << 134 124 // It is an error to request the index of a << 135 std::map< G4String, G4MaterialPropertyVector*, std::less<G4String> >* 125 // present in fMaterialConstPropertyNames() << 136 GetPropertiesMap(); 126 G4int GetConstPropertyIndex(const G4String& << 137 std::map< G4String, G4double, std::less<G4String> >* 127 << 138 GetPropertiesCMap(); 128 // Get the property index by the key-name. << 139 129 // It is an error to request the index of a << 140 const std::map<G4int, G4MaterialPropertyVector*, std::less<G4int> >* 130 // present in GetMaterialPropertyNames()). << 141 GetPropertyMap() const { return &MP; } 131 G4int GetPropertyIndex(const G4String& key) << 142 const std::map<G4int, G4double, std::less<G4int> >* 132 << 143 GetConstPropertyMap() const { return &MCP; } 133 // print the material properties and materia << 144 // Accessors required for persistency purposes 134 void DumpTable() const; << 145 135 << 146 private: 136 // the next four methods are used in persist << 147 137 const std::vector<G4String>& GetMaterialProp << 148 G4MaterialPropertyVector* CalculateGROUPVEL(); 138 const std::vector<G4String>& GetMaterialCons << 149 // Calculate the group velocity based on RINDEX 139 // return references to the vectors of mater << 150 140 const std::vector<G4MaterialPropertyVector*> << 151 G4MaterialPropertyVector* SetGROUPVEL(); 141 const std::vector<std::pair<G4double, G4bool << 152 // Dummy method: will be obsolete from the next (version 11) release 142 << 153 143 private: << 154 private: 144 // Calculate the group velocity based on RIN << 155 145 G4MaterialPropertyVector* CalculateGROUPVEL( << 156 std::map<G4String, G4MaterialPropertyVector*, std::less<G4String> > MPT; 146 << 157 typedef std::map< G4String, G4MaterialPropertyVector*, 147 // Vector of pointer to material property ve << 158 std::less<G4String> >::const_iterator MPTiterator; 148 // All entries are initialized to nullptr. << 159 149 // Order of entries in MP defined by enum in << 160 std::map< G4String, G4double, std::less<G4String> > MPTC; 150 std::vector<G4MaterialPropertyVector*> fMP; << 161 typedef std::map< G4String, G4double, 151 << 162 std::less<G4String> >::const_iterator MPTCiterator; 152 // Vector of energy-independent (i.e., "cons << 163 // MPT and MPTC will be obsolete when associate public interfaces, 153 // need to keep track if a property is defin << 164 // GetPropertiesMap and GetPropertiesCMap are removed from the version 11. 154 // is 'true' if the property is defined. << 165 155 // Order of entries in MCP defined by enum i << 166 std::map<G4int, G4MaterialPropertyVector*, std::less<G4int> > MP; 156 std::vector<std::pair<G4double, G4bool>> fMC << 167 typedef std::map< G4int, G4MaterialPropertyVector*, >> 168 std::less<G4int> >::const_iterator MPiterator; >> 169 >> 170 std::map< G4int, G4double, std::less<G4int> > MCP; >> 171 typedef std::map< G4int, G4double, >> 172 std::less<G4int> >::const_iterator MCPiterator; >> 173 //material property map and constant property map by index types >> 174 >> 175 std::vector<G4String> G4MaterialPropertyName; >> 176 std::vector<G4String> G4MaterialConstPropertyName; >> 177 // vectors of strings of property names 157 178 158 std::vector<G4String> fMatPropNames; // vec << 159 std::vector<G4String> fMatConstPropNames; / << 160 }; 179 }; >> 180 >> 181 ///////////////////// >> 182 // Inline definitions >> 183 ///////////////////// >> 184 >> 185 #include "G4MaterialPropertiesTable.icc" 161 186 162 #endif /* G4MaterialPropertiesTable_h */ 187 #endif /* G4MaterialPropertiesTable_h */ 163 188