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 // G4UnitsTable << 26 // >> 27 // $Id: G4UnitsTable.hh,v 1.18 2006/11/30 10:37:57 gcosmo Exp $ >> 28 // GEANT4 tag $Name: geant4-08-02-patch-01-ref $ >> 29 // >> 30 // >> 31 // ----------------------------------------------------------------- >> 32 // >> 33 // ------------------- class G4UnitsTable ----------------- >> 34 // >> 35 // 17-05-98: first version, M.Maire >> 36 // 13-10-98: Units and symbols printed in fixed length, M.Maire >> 37 // 18-01-00: BestUnit for three vector, M.Maire >> 38 // 06-03-01: Migrated to STL vectors, G.Cosmo 27 // 39 // 28 // Class description: 40 // Class description: 29 // 41 // 30 // This class maintains a table of Units. 42 // This class maintains a table of Units. 31 // A Unit has a name, a symbol, a value and be 43 // A Unit has a name, a symbol, a value and belong to a category (i.e. its 32 // dimensional definition): Length, Time, Ener 44 // dimensional definition): Length, Time, Energy, etc... 33 // The Units are grouped by category. The Tabl 45 // The Units are grouped by category. The TableOfUnits is a list of categories. 34 // The class G4BestUnit allows to convert auto 46 // The class G4BestUnit allows to convert automaticaly a physical quantity 35 // from its internal value into the most appro 47 // from its internal value into the most appropriate Unit of the same category. >> 48 // 36 49 37 // Author: M.Maire, 17.05.1998 - First version << 50 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... 38 // Revisions: G.Cosmo, 06.03.2001 - Migrated t << 51 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... 39 // ------------------------------------------- << 40 #ifndef G4UnitsTable_hh << 41 #define G4UnitsTable_hh 1 << 42 52 43 #include <vector> << 53 #ifndef G4UnitsTable_HH >> 54 #define G4UnitsTable_HH 44 55 45 #include "G4ThreeVector.hh" << 46 #include "globals.hh" 56 #include "globals.hh" >> 57 #include <vector> >> 58 #include "G4ThreeVector.hh" 47 59 48 class G4UnitsCategory; 60 class G4UnitsCategory; 49 class G4UnitDefinition; << 61 typedef std::vector<G4UnitsCategory*> G4UnitsTable; 50 << 51 // ------------------------------------------- << 52 << 53 #ifdef G4MULTITHREADED << 54 << 55 class G4UnitsTable : public std::vector<G4Unit << 56 { << 57 public: << 58 using std::vector<G4UnitsCategory*>::vector; << 59 G4UnitsTable() = default; << 60 ~G4UnitsTable(); << 61 << 62 public: << 63 void Synchronize(); << 64 G4bool Contains(const G4UnitDefinition*, con << 65 }; << 66 #else << 67 << 68 using G4UnitsTable = std::vector<G4UnitsCatego << 69 62 70 #endif << 63 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... 71 << 72 // ------------------------------------------- << 73 64 74 class G4UnitDefinition 65 class G4UnitDefinition 75 { 66 { 76 public: << 67 public: // with description 77 G4UnitDefinition(const G4String& name, const << 78 const G4String& category, G << 79 << 80 ~G4UnitDefinition() = default; << 81 G4bool operator==(const G4UnitDefinition&) c << 82 G4bool operator!=(const G4UnitDefinition&) c << 83 << 84 inline const G4String& GetName() const; << 85 inline const G4String& GetSymbol() const; << 86 inline G4double GetValue() const; << 87 << 88 void PrintDefinition(); << 89 << 90 static void BuildUnitsTable(); << 91 static void PrintUnitsTable(); << 92 static void ClearUnitsTable(); << 93 << 94 static G4UnitsTable& GetUnitsTable(); << 95 << 96 static G4bool IsUnitDefined(const G4String&) << 97 static G4double GetValueOf(const G4String&); << 98 static G4String GetCategory(const G4String&) << 99 68 100 private: << 69 G4UnitDefinition(const G4String& name, const G4String& symbol, 101 G4UnitDefinition(const G4UnitDefinition&); << 70 const G4String& category, G4double value); 102 G4UnitDefinition& operator=(const G4UnitDefi << 71 >> 72 public: // without description >> 73 >> 74 ~G4UnitDefinition(); >> 75 G4int operator==(const G4UnitDefinition&) const; >> 76 G4int operator!=(const G4UnitDefinition&) const; >> 77 >> 78 public: // with description >> 79 >> 80 inline const G4String& GetName() const; >> 81 inline const G4String& GetSymbol() const; >> 82 inline G4double GetValue() const; >> 83 >> 84 void PrintDefinition(); >> 85 >> 86 static void BuildUnitsTable(); >> 87 static void PrintUnitsTable(); >> 88 static void ClearUnitsTable(); >> 89 >> 90 static G4UnitsTable& GetUnitsTable(); >> 91 >> 92 static G4double GetValueOf (const G4String&); >> 93 static G4String GetCategory(const G4String&); >> 94 >> 95 private: >> 96 >> 97 G4UnitDefinition(const G4UnitDefinition&); >> 98 G4UnitDefinition& operator=(const G4UnitDefinition&); >> 99 >> 100 private: >> 101 >> 102 G4String Name; // SI name >> 103 G4String SymbolName; // SI symbol >> 104 G4double Value; // value in the internal system of units >> 105 >> 106 static G4UnitsTable theUnitsTable; // table of Units 103 107 104 private: << 108 size_t CategoryIndex; // category index of this unit 105 G4String Name; // SI name << 106 G4String SymbolName; // SI symbol << 107 G4double Value = 0.0; // value in the inter << 108 << 109 static G4ThreadLocal G4UnitsTable* pUnitsTab << 110 static G4ThreadLocal G4bool unitsTableDestro << 111 << 112 std::size_t CategoryIndex = 0; // category << 113 << 114 #ifdef G4MULTITHREADED << 115 static G4UnitsTable* pUnitsTableShadow; // << 116 << 117 public: << 118 inline static G4UnitsTable& GetUnitsTableSha << 119 { << 120 return *pUnitsTableShadow; << 121 } << 122 #endif << 123 }; 109 }; 124 110 125 // ------------------------------------------- << 111 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... 126 112 127 using G4UnitsContainer = std::vector<G4UnitDef << 113 typedef std::vector<G4UnitDefinition*> G4UnitsContainer; 128 114 129 class G4UnitsCategory 115 class G4UnitsCategory 130 { 116 { 131 public: << 117 public: // without description 132 explicit G4UnitsCategory(const G4String& nam << 118 133 ~G4UnitsCategory(); << 119 explicit G4UnitsCategory(const G4String& name); 134 G4bool operator==(const G4UnitsCategory&) co << 120 ~G4UnitsCategory(); 135 G4bool operator!=(const G4UnitsCategory&) co << 121 G4int operator==(const G4UnitsCategory&) const; 136 << 122 G4int operator!=(const G4UnitsCategory&) const; 137 inline const G4String& GetName() const; << 123 138 inline G4UnitsContainer& GetUnitsList(); << 124 public: // without description 139 inline G4int GetNameMxLen() const; << 125 140 inline G4int GetSymbMxLen() const; << 126 inline const G4String& GetName() const; 141 inline void UpdateNameMxLen(G4int len); << 127 inline G4UnitsContainer& GetUnitsList(); 142 inline void UpdateSymbMxLen(G4int len); << 128 inline G4int GetNameMxLen() const; 143 void PrintCategory(); << 129 inline G4int GetSymbMxLen() const; 144 << 130 inline void UpdateNameMxLen(G4int len); 145 private: << 131 inline void UpdateSymbMxLen(G4int len); 146 G4UnitsCategory(const G4UnitsCategory&); << 132 void PrintCategory(); 147 G4UnitsCategory& operator=(const G4UnitsCate << 133 148 << 134 private: 149 private: << 135 150 G4String Name; // dimensional << 136 G4UnitsCategory(const G4UnitsCategory&); 151 G4UnitsContainer UnitsList; // List of unit << 137 G4UnitsCategory& operator=(const G4UnitsCategory&); 152 G4int NameMxLen = 0; // max length o << 138 153 G4int SymbMxLen = 0; // max length o << 139 private: >> 140 >> 141 G4String Name; // dimensional family: Length,Volume,Energy >> 142 G4UnitsContainer UnitsList; // List of units in this family >> 143 G4int NameMxLen; // max length of the units name >> 144 G4int SymbMxLen; // max length of the units symbol 154 }; 145 }; 155 146 156 // ------------------------------------------- << 147 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... 157 148 158 class G4BestUnit 149 class G4BestUnit 159 { 150 { 160 public: << 151 public: // with description 161 G4BestUnit(G4double internalValue, const G4S << 152 162 G4BestUnit(const G4ThreeVector& internalValu << 153 G4BestUnit(G4double internalValue, const G4String& category); 163 // These constructors convert a physical qua << 154 G4BestUnit(const G4ThreeVector& internalValue, const G4String& category); 164 // into the most appropriate unit of the sam << 155 // These constructors convert a physical quantity from its internalValue 165 // In practice it builds an object VU = (new << 156 // into the most appropriate unit of the same category. 166 << 157 // In practice it builds an object VU = (newValue, newUnit) 167 ~G4BestUnit() = default; << 158 168 << 159 ~G4BestUnit(); 169 inline G4double* GetValue(); << 160 170 inline const G4String& GetCategory() const; << 161 public: // without description 171 inline std::size_t GetIndexOfCategory() cons << 162 172 operator G4String() const; // Conversion to << 163 inline G4double* GetValue(); 173 << 164 inline const G4String& GetCategory() const; 174 friend std::ostream& operator<<(std::ostream << 165 inline size_t GetIndexOfCategory() const; 175 // Default format to print the objet VU abov << 166 operator G4String () const; // Conversion to best string. 176 << 167 177 private: << 168 public: // with description 178 G4double Value[3]; // value in the interna << 169 179 G4int nbOfVals = 0; // G4double=1; G4ThreeV << 170 friend std::ostream& operator<<(std::ostream&,G4BestUnit VU); 180 G4String Category; // dimensional family: << 171 // Default format to print the objet VU above. 181 std::size_t IndexOfCategory = 0; // positio << 172 >> 173 private: >> 174 >> 175 G4double Value[3]; // value in the internal system of units >> 176 G4int nbOfVals; // G4double=1; G4ThreeVector=3 >> 177 G4String Category; // dimensional family: Length,Volume,Energy ... >> 178 size_t IndexOfCategory; // position of Category in UnitsTable 182 }; 179 }; 183 180 184 #include "G4UnitsTable.icc" 181 #include "G4UnitsTable.icc" >> 182 >> 183 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... 185 184 186 #endif 185 #endif 187 186