| 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.16 2005/03/21 16:04:56 allison Exp $
>> 25 // GEANT4 tag $Name: geant4-07-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 <vector>
>> 55 #include "G4ThreeVector.hh"
47 56
48 class G4UnitsCategory; 57 class G4UnitsCategory;
49 class G4UnitDefinition; << 58 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 59
70 #endif << 60 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
71 <<
72 // ------------------------------------------- <<
73 61
74 class G4UnitDefinition 62 class G4UnitDefinition
75 { 63 {
76 public: << 64 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 65
100 private: << 66 G4UnitDefinition(const G4String& name, const G4String& symbol,
101 G4UnitDefinition(const G4UnitDefinition&); << 67 const G4String& category, G4double value);
102 G4UnitDefinition& operator=(const G4UnitDefi << 68
>> 69 public: // without description
>> 70
>> 71 ~G4UnitDefinition();
>> 72 G4int operator==(const G4UnitDefinition&) const;
>> 73 G4int operator!=(const G4UnitDefinition&) const;
>> 74
>> 75 public: // with description
>> 76
>> 77 inline const G4String& GetName() const;
>> 78 inline const G4String& GetSymbol() const;
>> 79 inline G4double GetValue() const;
>> 80
>> 81 void PrintDefinition();
>> 82
>> 83 static void BuildUnitsTable();
>> 84 static void PrintUnitsTable();
>> 85
>> 86 static G4UnitsTable& GetUnitsTable();
>> 87
>> 88 static G4double GetValueOf (const G4String&);
>> 89 static G4String GetCategory(const G4String&);
>> 90
>> 91 private:
>> 92
>> 93 G4UnitDefinition(const G4UnitDefinition&);
>> 94 G4UnitDefinition& operator=(const G4UnitDefinition&);
>> 95
>> 96 private:
>> 97
>> 98 G4String Name; // SI name
>> 99 G4String SymbolName; // SI symbol
>> 100 G4double Value; // value in the internal system of units
>> 101
>> 102 static G4UnitsTable theUnitsTable; // table of Units
103 103
104 private: << 104 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 }; 105 };
124 106
125 // ------------------------------------------- << 107 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
126 108
127 using G4UnitsContainer = std::vector<G4UnitDef << 109 typedef std::vector<G4UnitDefinition*> G4UnitsContainer;
128 110
129 class G4UnitsCategory 111 class G4UnitsCategory
130 { 112 {
131 public: << 113 public: // without description
132 explicit G4UnitsCategory(const G4String& nam << 114
133 ~G4UnitsCategory(); << 115 explicit G4UnitsCategory(const G4String& name);
134 G4bool operator==(const G4UnitsCategory&) co << 116 ~G4UnitsCategory();
135 G4bool operator!=(const G4UnitsCategory&) co << 117 G4int operator==(const G4UnitsCategory&) const;
136 << 118 G4int operator!=(const G4UnitsCategory&) const;
137 inline const G4String& GetName() const; << 119
138 inline G4UnitsContainer& GetUnitsList(); << 120 public: // without description
139 inline G4int GetNameMxLen() const; << 121
140 inline G4int GetSymbMxLen() const; << 122 inline const G4String& GetName() const;
141 inline void UpdateNameMxLen(G4int len); << 123 inline G4UnitsContainer& GetUnitsList();
142 inline void UpdateSymbMxLen(G4int len); << 124 inline G4int GetNameMxLen() const;
143 void PrintCategory(); << 125 inline G4int GetSymbMxLen() const;
144 << 126 inline void UpdateNameMxLen(G4int len);
145 private: << 127 inline void UpdateSymbMxLen(G4int len);
146 G4UnitsCategory(const G4UnitsCategory&); << 128 void PrintCategory();
147 G4UnitsCategory& operator=(const G4UnitsCate << 129
148 << 130 private:
149 private: << 131
150 G4String Name; // dimensional << 132 G4UnitsCategory(const G4UnitsCategory&);
151 G4UnitsContainer UnitsList; // List of unit << 133 G4UnitsCategory& operator=(const G4UnitsCategory&);
152 G4int NameMxLen = 0; // max length o << 134
153 G4int SymbMxLen = 0; // max length o << 135 private:
>> 136
>> 137 G4String Name; // dimensional family: Length,Volume,Energy
>> 138 G4UnitsContainer UnitsList; // List of units in this family
>> 139 G4int NameMxLen; // max length of the units name
>> 140 G4int SymbMxLen; // max length of the units symbol
154 }; 141 };
155 142
156 // ------------------------------------------- << 143 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
157 144
158 class G4BestUnit 145 class G4BestUnit
159 { 146 {
160 public: << 147 public: // with description
161 G4BestUnit(G4double internalValue, const G4S << 148
162 G4BestUnit(const G4ThreeVector& internalValu << 149 G4BestUnit(G4double internalValue, const G4String& category);
163 // These constructors convert a physical qua << 150 G4BestUnit(const G4ThreeVector& internalValue, const G4String& category);
164 // into the most appropriate unit of the sam << 151 // These constructors convert a physical quantity from its internalValue
165 // In practice it builds an object VU = (new << 152 // into the most appropriate unit of the same category.
166 << 153 // In practice it builds an object VU = (newValue, newUnit)
167 ~G4BestUnit() = default; << 154
168 << 155 ~G4BestUnit();
169 inline G4double* GetValue(); << 156
170 inline const G4String& GetCategory() const; << 157 public: // without description
171 inline std::size_t GetIndexOfCategory() cons << 158
172 operator G4String() const; // Conversion to << 159 inline G4double* GetValue();
173 << 160 inline const G4String& GetCategory() const;
174 friend std::ostream& operator<<(std::ostream << 161 inline size_t GetIndexOfCategory() const;
175 // Default format to print the objet VU abov << 162 operator G4String () const; // Conversion to best string.
176 << 163
177 private: << 164 public: // with description
178 G4double Value[3]; // value in the interna << 165
179 G4int nbOfVals = 0; // G4double=1; G4ThreeV << 166 friend std::ostream& operator<<(std::ostream&,G4BestUnit VU);
180 G4String Category; // dimensional family: << 167 // Default format to print the objet VU above.
181 std::size_t IndexOfCategory = 0; // positio << 168
>> 169 private:
>> 170
>> 171 G4double Value[3]; // value in the internal system of units
>> 172 G4int nbOfVals; // G4double=1; G4ThreeVector=3
>> 173 G4String Category; // dimensional family: Length,Volume,Energy ...
>> 174 size_t IndexOfCategory; // position of Category in UnitsTable
182 }; 175 };
183 176
184 #include "G4UnitsTable.icc" 177 #include "G4UnitsTable.icc"
>> 178
>> 179 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
185 180
186 #endif 181 #endif
187 182