| 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 67970 2013-03-13 10:10:06Z 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 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 61
70 #endif << 62 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
71 <<
72 // ------------------------------------------- <<
73 63
74 class G4UnitDefinition 64 class G4UnitDefinition
75 { 65 {
76 public: << 66 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 67
100 private: << 68 G4UnitDefinition(const G4String& name, const G4String& symbol,
101 G4UnitDefinition(const G4UnitDefinition&); << 69 const G4String& category, G4double value);
102 G4UnitDefinition& operator=(const G4UnitDefi << 70
>> 71 public: // without description
>> 72
>> 73 ~G4UnitDefinition();
>> 74 G4int operator==(const G4UnitDefinition&) const;
>> 75 G4int operator!=(const G4UnitDefinition&) const;
>> 76
>> 77 public: // with description
>> 78
>> 79 inline const G4String& GetName() const;
>> 80 inline const G4String& GetSymbol() const;
>> 81 inline G4double GetValue() const;
>> 82
>> 83 void PrintDefinition();
>> 84
>> 85 static void BuildUnitsTable();
>> 86 static void PrintUnitsTable();
>> 87 static void ClearUnitsTable();
>> 88
>> 89 static G4UnitsTable& GetUnitsTable();
>> 90
>> 91 static G4double GetValueOf (const G4String&);
>> 92 static G4String GetCategory(const G4String&);
>> 93
>> 94 private:
>> 95
>> 96 G4UnitDefinition(const G4UnitDefinition&);
>> 97 G4UnitDefinition& operator=(const G4UnitDefinition&);
>> 98
>> 99 private:
>> 100
>> 101 G4String Name; // SI name
>> 102 G4String SymbolName; // SI symbol
>> 103 G4double Value; // value in the internal system of units
>> 104
>> 105 static G4ThreadLocal G4UnitsTable *pUnitsTable; // table of Units
103 106
104 private: << 107 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 }; 108 };
124 109
125 // ------------------------------------------- << 110 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
126 111
127 using G4UnitsContainer = std::vector<G4UnitDef << 112 typedef std::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 explicit G4UnitsCategory(const 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 public: // without description
139 inline G4int GetNameMxLen() const; << 124
140 inline G4int GetSymbMxLen() const; << 125 inline const G4String& GetName() const;
141 inline void UpdateNameMxLen(G4int len); << 126 inline G4UnitsContainer& GetUnitsList();
142 inline void UpdateSymbMxLen(G4int len); << 127 inline G4int GetNameMxLen() const;
143 void PrintCategory(); << 128 inline G4int GetSymbMxLen() const;
144 << 129 inline void UpdateNameMxLen(G4int len);
145 private: << 130 inline void UpdateSymbMxLen(G4int len);
146 G4UnitsCategory(const G4UnitsCategory&); << 131 void PrintCategory();
147 G4UnitsCategory& operator=(const G4UnitsCate << 132
148 << 133 private:
149 private: << 134
150 G4String Name; // dimensional << 135 G4UnitsCategory(const G4UnitsCategory&);
151 G4UnitsContainer UnitsList; // List of unit << 136 G4UnitsCategory& operator=(const G4UnitsCategory&);
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, const G4String& category);
163 // These constructors convert a physical qua << 153 G4BestUnit(const G4ThreeVector& internalValue, const 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 inline G4double* GetValue();
173 << 163 inline const G4String& GetCategory() const;
174 friend std::ostream& operator<<(std::ostream << 164 inline size_t GetIndexOfCategory() const;
175 // Default format to print the objet VU abov << 165 operator G4String () const; // Conversion to best string.
176 << 166
177 private: << 167 public: // with description
178 G4double Value[3]; // value in the interna << 168
179 G4int nbOfVals = 0; // G4double=1; G4ThreeV << 169 friend std::ostream& operator<<(std::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 #include "G4UnitsTable.icc"
>> 181
>> 182 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
185 183
186 #endif 184 #endif
187 185