Geant4  10.01.p03
G4VSampler.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: G4VSampler.hh 66241 2012-12-13 18:34:42Z gunter $
28 //
29 // ----------------------------------------------------------------------
30 // Class G4VSampler
31 //
32 // Class description:
33 //
34 // This interface describes a configurable sampler.
35 // It applies to a given particle type.
36 // Concrete classes with this interface may be used for
37 // scoring, importance sampling and weight cutoff (weight roulette).
38 
39 // Author: Michael Dressel (Michael.Dressel@cern.ch)
40 // ----------------------------------------------------------------------
41 #ifndef G4VSampler_hh
42 #define G4VSampler_hh G4VSampler_hh
43 
44 #include "G4Types.hh"
45 #include "G4PlaceOfAction.hh"
46 
47 class G4VPhysicalVolume;
49 class G4VIStore;
52 //class G4VScorer;
53 
55 {
56 
57 public: // with description
58 
59  G4VSampler();
60  virtual ~G4VSampler();
61 
62  // virtual void PrepareScoring(G4VScorer *Scorer) = 0;
63  // virtual void PrepareScoring() = 0;
64 
65  virtual void PrepareImportanceSampling(G4VIStore *istore,
67  *ialg = 0) = 0;
68 
69 
70  virtual void PrepareWeightRoulett(G4double wsurvive = 0.5,
71  G4double wlimit = 0.25,
72  G4double isource = 1) = 0;
73 
74  virtual void PrepareWeightWindow(G4VWeightWindowStore *wwstore,
75  G4VWeightWindowAlgorithm *wwAlg = 0,
76  G4PlaceOfAction placeOfAction =
77  onBoundary) = 0;
78 
79  virtual void Configure() = 0;
80 
81  virtual void ClearSampling() = 0;
82  // clear the sampler and remove the processes
83 
84  virtual G4bool IsConfigured() const = 0;
85  // check if some initialization hase already been done
86 
87  virtual void SetParallel(G4bool paraflag) = 0;
88 
89 };
90 
91 #endif
virtual void SetParallel(G4bool paraflag)=0
virtual void PrepareImportanceSampling(G4VIStore *istore, const G4VImportanceAlgorithm *ialg=0)=0
G4PlaceOfAction
bool G4bool
Definition: G4Types.hh:79
virtual void PrepareWeightWindow(G4VWeightWindowStore *wwstore, G4VWeightWindowAlgorithm *wwAlg=0, G4PlaceOfAction placeOfAction=onBoundary)=0
virtual void Configure()=0
virtual G4bool IsConfigured() const =0
virtual void PrepareWeightRoulett(G4double wsurvive=0.5, G4double wlimit=0.25, G4double isource=1)=0
virtual ~G4VSampler()
Definition: G4VSampler.cc:41
double G4double
Definition: G4Types.hh:76
virtual void ClearSampling()=0