| Geant4 Cross Reference |
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 // G4IStore
27 //
28 // Class description:
29 //
30 // An implementation of an "importance store" with the interface
31 // G4VIStore. See description in G4VIStore.
32 // This implementation uses G4GeometryCellImportance as the container
33 // to store the "cells" together with the importance values.
34 // Giving a cell the importance 0 is allowed as a flagging that no biasing
35 // should happen between this cell and its neighbors.
36 // If a cell is not known by the importance store no biasing should be
37 // applied between this cell and its nighbors.
38
39 // Author: Michael Dressel (CERN), 2002
40 // Modified: Alex Howard (CERN), 2013 - Changed class to a 'singleton'
41 // ----------------------------------------------------------------------
42 #ifndef G4ISTORE_HH
43 #define G4ISTORE_HH 1
44
45 #include "G4VIStore.hh"
46 #include "G4GeometryCellImportance.hh"
47 #include "G4TransportationManager.hh"
48
49 class G4IStore : public G4VIStore
50 {
51 public:
52
53 static G4IStore* GetInstance();
54 // return ptr to singleton instance of the class.
55
56 static G4IStore* GetInstance(const G4String& ParallelWorldName);
57 // return ptr to singleton instance of the class.
58
59 G4double GetImportance(const G4GeometryCell& gCell) const override;
60 // derive an importance value of a "cell" addressed by a
61 // G4GeometryCell from the store.
62
63 G4bool IsKnown(const G4GeometryCell& gCell) const override;
64 // returns true if the gCell is in the store, else false
65
66 void Clear();
67
68 void SetWorldVolume();
69 // set a reference to the world volume of the "importance" geometry
70
71 void SetParallelWorldVolume(const G4String& paraName);
72 // set a reference to parallel world volume of the "importance" geometry
73
74 const G4VPhysicalVolume& GetWorldVolume() const override;
75 // return a reference to the world volume of the "importance" geometry
76
77 virtual const G4VPhysicalVolume* GetParallelWorldVolumePointer() const;
78 // return a pointer to the world volume of the "importance" geometry
79
80 void AddImportanceGeometryCell(G4double importance,
81 const G4GeometryCell &gCell);
82 void AddImportanceGeometryCell(G4double importance,
83 const G4VPhysicalVolume &,
84 G4int aRepNum = 0);
85 // add a "cell" together with a importance value to the store.
86
87 void ChangeImportance(G4double importance, const G4GeometryCell& gCell);
88 void ChangeImportance(G4double importance, const G4VPhysicalVolume&,
89 G4int aRepNum = 0);
90 // change a importance value of a "cell".
91
92 G4double GetImportance(const G4VPhysicalVolume&, G4int aRepNum = 0) const;
93
94 protected:
95
96 explicit G4IStore();
97 // initialise the importance store for the given geometry
98 explicit G4IStore(const G4String& ParallelWorldName);
99 // initialise the importance store for the given geometry
100
101 ~G4IStore() override;
102 // destructor
103
104 private:
105
106 G4bool IsInWorld(const G4VPhysicalVolume&) const;
107 void SetInternalIterator(const G4GeometryCell& gCell) const;
108 void Error(const G4String& m) const;
109
110 private:
111
112 const G4VPhysicalVolume* fWorldVolume = nullptr;
113 G4GeometryCellImportance fGeometryCelli;
114
115 mutable G4GeometryCellImportance::const_iterator fCurrentIterator;
116
117 static G4ThreadLocal G4IStore* fInstance;
118 };
119
120 #endif
121