210 lines
7.2 KiB
C++
210 lines
7.2 KiB
C++
//
|
|
// ********************************************************************
|
|
// * License and Disclaimer *
|
|
// * *
|
|
// * The Geant4 software is copyright of the Copyright Holders of *
|
|
// * the Geant4 Collaboration. It is provided under the terms and *
|
|
// * conditions of the Geant4 Software License, included in the file *
|
|
// * LICENSE and available at http://cern.ch/geant4/license . These *
|
|
// * include a list of copyright holders. *
|
|
// * *
|
|
// * Neither the authors of this software system, nor their employing *
|
|
// * institutes,nor the agencies providing financial support for this *
|
|
// * work make any representation or warranty, express or implied, *
|
|
// * regarding this software system or assume any liability for its *
|
|
// * use. Please see the license in the file LICENSE and URL above *
|
|
// * for the full disclaimer and the limitation of liability. *
|
|
// * *
|
|
// * This code implementation is the result of the scientific and *
|
|
// * technical work of the GEANT4 collaboration. *
|
|
// * By using, copying, modifying or distributing the software (or *
|
|
// * any work based on the software) you agree to acknowledge its *
|
|
// * use in resulting scientific publications, and indicate your *
|
|
// * acceptance of all terms of the Geant4 Software license. *
|
|
// ********************************************************************
|
|
//
|
|
//
|
|
//
|
|
//
|
|
// -----------------------------------------------------------------
|
|
//
|
|
// ------------------- class G4UnitsTable -----------------
|
|
//
|
|
// 17-05-98: first version, M.Maire
|
|
// 13-10-98: Units and symbols printed in fixed length, M.Maire
|
|
// 18-01-00: BestUnit for three vector, M.Maire
|
|
// 06-03-01: Migrated to STL vectors, G.Cosmo
|
|
//
|
|
// Class description:
|
|
//
|
|
// This class maintains a table of Units.
|
|
// A Unit has a name, a symbol, a value and belong to a category (i.e. its
|
|
// dimensional definition): Length, Time, Energy, etc...
|
|
// The Units are grouped by category. The TableOfUnits is a list of categories.
|
|
// The class G4BestUnit allows to convert automaticaly a physical quantity
|
|
// from its internal value into the most appropriate Unit of the same category.
|
|
//
|
|
|
|
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
|
|
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
|
|
|
|
#ifndef G4UnitsTable_HH
|
|
#define G4UnitsTable_HH
|
|
|
|
#include "globals.hh"
|
|
#include <vector>
|
|
#include "G4ThreeVector.hh"
|
|
|
|
class G4UnitsCategory;
|
|
class G4UnitDefinition;
|
|
|
|
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
|
|
#ifdef G4MULTITHREADED
|
|
class G4UnitsTable : public std::vector<G4UnitsCategory*>
|
|
{
|
|
public:
|
|
using std::vector<G4UnitsCategory*>::vector;
|
|
G4UnitsTable();
|
|
~G4UnitsTable();
|
|
|
|
public:
|
|
void Synchronize();
|
|
G4bool Contains(const G4UnitDefinition*,const G4String&);
|
|
};
|
|
#else
|
|
typedef std::vector<G4UnitsCategory*> G4UnitsTable;
|
|
#endif
|
|
|
|
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
|
|
|
|
class G4UnitDefinition
|
|
{
|
|
public: // with description
|
|
|
|
G4UnitDefinition(const G4String& name, const G4String& symbol,
|
|
const G4String& category, G4double value);
|
|
|
|
public: // without description
|
|
|
|
~G4UnitDefinition();
|
|
G4bool operator==(const G4UnitDefinition&) const;
|
|
G4bool operator!=(const G4UnitDefinition&) const;
|
|
|
|
public: // with description
|
|
|
|
inline const G4String& GetName() const;
|
|
inline const G4String& GetSymbol() const;
|
|
inline G4double GetValue() const;
|
|
|
|
void PrintDefinition();
|
|
|
|
static void BuildUnitsTable();
|
|
static void PrintUnitsTable();
|
|
static void ClearUnitsTable();
|
|
|
|
static G4UnitsTable& GetUnitsTable();
|
|
|
|
static G4bool IsUnitDefined(const G4String&);
|
|
static G4double GetValueOf (const G4String&);
|
|
static G4String GetCategory(const G4String&);
|
|
|
|
private:
|
|
|
|
G4UnitDefinition(const G4UnitDefinition&);
|
|
G4UnitDefinition& operator=(const G4UnitDefinition&);
|
|
|
|
private:
|
|
|
|
G4String Name; // SI name
|
|
G4String SymbolName; // SI symbol
|
|
G4double Value; // value in the internal system of units
|
|
|
|
static G4ThreadLocal G4UnitsTable *pUnitsTable; // table of Units
|
|
static G4ThreadLocal G4bool unitsTableDestroyed;
|
|
|
|
size_t CategoryIndex; // category index of this unit
|
|
|
|
#ifdef G4MULTITHREADED
|
|
static G4UnitsTable *pUnitsTableShadow; // shadow of table of Units
|
|
public:
|
|
inline static G4UnitsTable& GetUnitsTableShadow()
|
|
{return *pUnitsTableShadow;}
|
|
#endif
|
|
};
|
|
|
|
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
|
|
|
|
typedef std::vector<G4UnitDefinition*> G4UnitsContainer;
|
|
|
|
class G4UnitsCategory
|
|
{
|
|
public: // without description
|
|
|
|
explicit G4UnitsCategory(const G4String& name);
|
|
~G4UnitsCategory();
|
|
G4bool operator==(const G4UnitsCategory&) const;
|
|
G4bool operator!=(const G4UnitsCategory&) const;
|
|
|
|
public: // without description
|
|
|
|
inline const G4String& GetName() const;
|
|
inline G4UnitsContainer& GetUnitsList();
|
|
inline G4int GetNameMxLen() const;
|
|
inline G4int GetSymbMxLen() const;
|
|
inline void UpdateNameMxLen(G4int len);
|
|
inline void UpdateSymbMxLen(G4int len);
|
|
void PrintCategory();
|
|
|
|
private:
|
|
|
|
G4UnitsCategory(const G4UnitsCategory&);
|
|
G4UnitsCategory& operator=(const G4UnitsCategory&);
|
|
|
|
private:
|
|
|
|
G4String Name; // dimensional family: Length,Volume,Energy
|
|
G4UnitsContainer UnitsList; // List of units in this family
|
|
G4int NameMxLen; // max length of the units name
|
|
G4int SymbMxLen; // max length of the units symbol
|
|
};
|
|
|
|
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
|
|
|
|
class G4BestUnit
|
|
{
|
|
public: // with description
|
|
|
|
G4BestUnit(G4double internalValue, const G4String& category);
|
|
G4BestUnit(const G4ThreeVector& internalValue, const G4String& category);
|
|
// These constructors convert a physical quantity from its internalValue
|
|
// into the most appropriate unit of the same category.
|
|
// In practice it builds an object VU = (newValue, newUnit)
|
|
|
|
~G4BestUnit();
|
|
|
|
public: // without description
|
|
|
|
inline G4double* GetValue();
|
|
inline const G4String& GetCategory() const;
|
|
inline size_t GetIndexOfCategory() const;
|
|
operator G4String () const; // Conversion to best string.
|
|
|
|
public: // with description
|
|
|
|
friend std::ostream& operator<<(std::ostream&,G4BestUnit VU);
|
|
// Default format to print the objet VU above.
|
|
|
|
private:
|
|
|
|
G4double Value[3]; // value in the internal system of units
|
|
G4int nbOfVals; // G4double=1; G4ThreeVector=3
|
|
G4String Category; // dimensional family: Length,Volume,Energy ...
|
|
size_t IndexOfCategory; // position of Category in UnitsTable
|
|
};
|
|
|
|
#include "G4UnitsTable.icc"
|
|
|
|
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
|
|
|
|
#endif
|