| Geant4 Cross Reference |
1 // 1
2 // *******************************************
3 // * License and Disclaimer
4 // *
5 // * The Geant4 software is copyright of th
6 // * the Geant4 Collaboration. It is provided
7 // * conditions of the Geant4 Software License
8 // * LICENSE and available at http://cern.ch/
9 // * include a list of copyright holders.
10 // *
11 // * Neither the authors of this software syst
12 // * institutes,nor the agencies providing fin
13 // * work make any representation or warran
14 // * regarding this software system or assum
15 // * use. Please see the license in the file
16 // * for the full disclaimer and the limitatio
17 // *
18 // * This code implementation is the result
19 // * technical work of the GEANT4 collaboratio
20 // * By using, copying, modifying or distri
21 // * any work based on the software) you ag
22 // * use in resulting scientific publicati
23 // * acceptance of all terms of the Geant4 Sof
24 // *******************************************
25 //
26 // G4UnitsTable
27 //
28 // Class description:
29 //
30 // This class maintains a table of Units.
31 // A Unit has a name, a symbol, a value and be
32 // dimensional definition): Length, Time, Ener
33 // The Units are grouped by category. The Tabl
34 // The class G4BestUnit allows to convert auto
35 // from its internal value into the most appro
36
37 // Author: M.Maire, 17.05.1998 - First version
38 // Revisions: G.Cosmo, 06.03.2001 - Migrated t
39 // -------------------------------------------
40 #ifndef G4UnitsTable_hh
41 #define G4UnitsTable_hh 1
42
43 #include <vector>
44
45 #include "G4ThreeVector.hh"
46 #include "globals.hh"
47
48 class G4UnitsCategory;
49 class G4UnitDefinition;
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
70 #endif
71
72 // -------------------------------------------
73
74 class G4UnitDefinition
75 {
76 public:
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
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
114 #ifdef G4MULTITHREADED
115 static G4UnitsTable* pUnitsTableShadow; //
116
117 public:
118 inline static G4UnitsTable& GetUnitsTableSha
119 {
120 return *pUnitsTableShadow;
121 }
122 #endif
123 };
124
125 // -------------------------------------------
126
127 using G4UnitsContainer = std::vector<G4UnitDef
128
129 class G4UnitsCategory
130 {
131 public:
132 explicit G4UnitsCategory(const G4String& nam
133 ~G4UnitsCategory();
134 G4bool operator==(const G4UnitsCategory&) co
135 G4bool operator!=(const G4UnitsCategory&) co
136
137 inline const G4String& GetName() const;
138 inline G4UnitsContainer& GetUnitsList();
139 inline G4int GetNameMxLen() const;
140 inline G4int GetSymbMxLen() const;
141 inline void UpdateNameMxLen(G4int len);
142 inline void UpdateSymbMxLen(G4int len);
143 void PrintCategory();
144
145 private:
146 G4UnitsCategory(const G4UnitsCategory&);
147 G4UnitsCategory& operator=(const G4UnitsCate
148
149 private:
150 G4String Name; // dimensional
151 G4UnitsContainer UnitsList; // List of unit
152 G4int NameMxLen = 0; // max length o
153 G4int SymbMxLen = 0; // max length o
154 };
155
156 // -------------------------------------------
157
158 class G4BestUnit
159 {
160 public:
161 G4BestUnit(G4double internalValue, const G4S
162 G4BestUnit(const G4ThreeVector& internalValu
163 // These constructors convert a physical qua
164 // into the most appropriate unit of the sam
165 // In practice it builds an object VU = (new
166
167 ~G4BestUnit() = default;
168
169 inline G4double* GetValue();
170 inline const G4String& GetCategory() const;
171 inline std::size_t GetIndexOfCategory() cons
172 operator G4String() const; // Conversion to
173
174 friend std::ostream& operator<<(std::ostream
175 // Default format to print the objet VU abov
176
177 private:
178 G4double Value[3]; // value in the interna
179 G4int nbOfVals = 0; // G4double=1; G4ThreeV
180 G4String Category; // dimensional family:
181 std::size_t IndexOfCategory = 0; // positio
182 };
183
184 #include "G4UnitsTable.icc"
185
186 #endif
187