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