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