Geant4  10.01
G4WeightWindowStore.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4WeightWindowStore.hh 77780 2013-11-28 07:50:59Z gcosmo $
28 //
29 // ----------------------------------------------------------------------
30 // Class G4WeightWindowStore
31 //
32 // Class description:
33 //
34 // Implementation of a weight window store according to the
35 // G4VWeightWindowStore interface.
36 // See G4VWeightWindowStore.
37 
38 // Author: Michael Dressel (Michael.Dressel@cern.ch)
39 //
40 // Alex Howard (alexander.howard@cern.ch):
41 // Changed class to a `singleton', with access via the static method
42 // G4WeightWindowStore::GetInstance().
43 //
44 // Member data:
45 //
46 // static G4WeightWindowStore* fInstance
47 // - Ptr to the unique instance of class
48 //
49 // ----------------------------------------------------------------------
50 #ifndef G4WeightWindowStore_hh
51 #define G4WeightWindowStore_hh G4WeightWindowStore_hh
52 
53 #include "G4VWeightWindowStore.hh"
54 #include "G4GeometryCellWeight.hh"
55 #include <set>
56 #include <vector>
57 
59 {
60 
61 public: // with description
62 
64  // Return ptr to singleton instance of the class.
65 
66  static G4WeightWindowStore* GetInstance(G4String ParallelWorldName);
67  // Return ptr to singleton instance of the class.
68 
69 protected:
70 
71  explicit G4WeightWindowStore();
72  // initialise the weight window store for the given geometry
73  explicit G4WeightWindowStore(G4String ParallelWorldName);
74  // initialise the weight window store for the given geometry
75 
76 public: // with description
77 
78  virtual ~G4WeightWindowStore();
79  // destructor
80 
81  virtual G4double GetLowerWeight(const G4GeometryCell &gCell,
82  G4double partEnergy) const;
83  // derive a lower weight bound value of a "cell" addresed by a
84  // G4GeometryCell and the coresponding energy from the store.
85 
86  virtual G4bool IsKnown(const G4GeometryCell &gCell) const;
87  // returns true if the gCell is in the store, else false
88 
89  void Clear();
90 
91  void SetWorldVolume();
92  // set a pointer to the world volume of the
93  // weightwindow geometry
94  void SetParallelWorldVolume(G4String paraName);
95  // set a pointer to the parallel world volume of the
96  // weightwindow geometry
97 
98 
99  virtual const G4VPhysicalVolume &GetWorldVolume() const;
100  // return a reference to the world volume of the
101  // weightwindow geometry
102  virtual const G4VPhysicalVolume* GetParallelWorldVolumePointer() const;
103  // return a pointer to the parallel world volume of the
104  // weightwindow geometry
105 
106  void AddLowerWeights(const G4GeometryCell &gCell,
107  const std::vector<G4double> &lowerWeights);
108  // add lower weights. Only if general upper energy bounds have
109  // been set
110 
113  enWeMap);
114  // set upper energy - lower weight pairs for a cell
115 
116  void SetGeneralUpperEnergyBounds(const std::set<G4double, std::less<G4double> > &enBounds);
117 
118 private:
119 
120  G4bool IsInWorld(const G4VPhysicalVolume &) const;
121  void Error(const G4String &m) const;
122  void SetInternalIterator(const G4GeometryCell &gCell) const;
123 
124 private:
125 
127  // G4bool fParaFlag;
128 
129  std::set<G4double, std::less<G4double> > fGeneralUpperEnergyBounds;
131  mutable G4GeometryCellWeight::const_iterator fCurrentIterator;
132 
134 
135 };
136 
137 #endif
const G4VPhysicalVolume * fWorldVolume
std::set< G4double, std::less< G4double > > fGeneralUpperEnergyBounds
static G4WeightWindowStore * fInstance
void AddLowerWeights(const G4GeometryCell &gCell, const std::vector< G4double > &lowerWeights)
virtual const G4VPhysicalVolume * GetParallelWorldVolumePointer() const
void Error(const G4String &m) const
G4bool IsInWorld(const G4VPhysicalVolume &) const
G4GeometryCellWeight::const_iterator fCurrentIterator
virtual G4bool IsKnown(const G4GeometryCell &gCell) const
void SetInternalIterator(const G4GeometryCell &gCell) const
bool G4bool
Definition: G4Types.hh:79
void AddUpperEboundLowerWeightPairs(const G4GeometryCell &gCell, const G4UpperEnergyToLowerWeightMap &enWeMap)
void SetParallelWorldVolume(G4String paraName)
virtual const G4VPhysicalVolume & GetWorldVolume() const
static G4WeightWindowStore * GetInstance()
std::map< G4double, G4double, std::less< G4double > > G4UpperEnergyToLowerWeightMap
virtual G4double GetLowerWeight(const G4GeometryCell &gCell, G4double partEnergy) const
G4GeometryCellWeight fCellToUpEnBoundLoWePairsMap
std::map< G4GeometryCell, G4UpperEnergyToLowerWeightMap, G4GeometryCellComp > G4GeometryCellWeight
void SetGeneralUpperEnergyBounds(const std::set< G4double, std::less< G4double > > &enBounds)
static const double m
Definition: G4SIunits.hh:110
double G4double
Definition: G4Types.hh:76