Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/biasing/include/G4WeightWindowStore.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  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 // G4WeightWindowStore
 27 //
 28 // Class description:
 29 //
 30 // Implementation of a weight window store according to the
 31 // G4VWeightWindowStore interface.
 32 // See also G4VWeightWindowStore.
 33 
 34 // Author: Michael Dressel (CERN), 2003
 35 // Modified: Alex Howard (CERN), 2013 - Changed class to a 'singleton'
 36 // ----------------------------------------------------------------------
 37 #ifndef G4WEIGHTWINDOWSTORE_HH
 38 #define G4WEIGHTWINDOWSTORE_HH 1
 39 
 40 #include "G4VWeightWindowStore.hh"
 41 #include "G4GeometryCellWeight.hh"
 42 #include <set>
 43 #include <vector>
 44 
 45 class G4WeightWindowStore: public G4VWeightWindowStore
 46 {
 47   public:  // with description
 48 
 49     static G4WeightWindowStore* GetInstance();
 50       // return ptr to singleton instance of the class
 51 
 52     static G4WeightWindowStore* GetInstance(const G4String& ParallelWorldName);
 53       // return ptr to singleton instance of the class
 54 
 55     G4double GetLowerWeight(const G4GeometryCell& gCell, 
 56                                           G4double partEnergy) const override;
 57       // derive a lower weight bound value of a "cell" addressed by a 
 58       // G4GeometryCell and the corresponding energy from the store
 59 
 60     G4bool IsKnown(const G4GeometryCell &gCell) const override;
 61       // returns true if the gCell is in the store, else false 
 62 
 63     void Clear();
 64 
 65     void SetWorldVolume();
 66       // set a pointer to the world volume of the weightwindow geometry
 67     void SetParallelWorldVolume(const G4String& paraName);
 68       // set a pointer to parallel world volume of the weightwindow geometry
 69 
 70     const G4VPhysicalVolume& GetWorldVolume() const override;
 71       // return a reference to the world volume of the weightwindow geometry
 72     virtual const G4VPhysicalVolume* GetParallelWorldVolumePointer() const;
 73       // return a pointer to parallel world volume of the weightwindow geometry
 74 
 75     void AddLowerWeights(const G4GeometryCell& gCell,
 76                          const std::vector<G4double>& lowerWeights);
 77       // add lower weights. Only if general upper energy bounds have been set
 78 
 79     void AddUpperEboundLowerWeightPairs(const G4GeometryCell& gCell,
 80                                   const G4UpperEnergyToLowerWeightMap& enWeMap);
 81       // set upper energy - lower weight pairs for a cell
 82 
 83     void SetGeneralUpperEnergyBounds(const std::set<G4double,
 84                                           std::less<G4double> >& enBounds);
 85   protected:
 86 
 87     explicit G4WeightWindowStore();
 88       // initialise the weight window store for the given geometry
 89     explicit G4WeightWindowStore(const G4String& ParallelWorldName);
 90       // initialise the weight window store for the given geometry
 91 
 92    ~G4WeightWindowStore() override;
 93       // destructor
 94 
 95   private:
 96 
 97     G4bool IsInWorld(const G4VPhysicalVolume&) const;
 98     void Error(const G4String& m) const;
 99     void SetInternalIterator(const G4GeometryCell& gCell) const;
100 
101   private:
102 
103     const G4VPhysicalVolume* fWorldVolume = nullptr;  
104 
105     std::set<G4double, std::less<G4double> > fGeneralUpperEnergyBounds;
106     G4GeometryCellWeight fCellToUpEnBoundLoWePairsMap;
107     mutable G4GeometryCellWeight::const_iterator fCurrentIterator;
108 
109     static G4ThreadLocal G4WeightWindowStore* fInstance;
110 };
111 
112 #endif
113