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