Geant4  10.01.p03
G4WeightWindowAlgorithm.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: G4WeightWindowAlgorithm.hh 66356 2012-12-18 09:02:32Z gcosmo $
28 //
29 // ----------------------------------------------------------------------
30 // Class G4WeightWindowAlgorithm
31 //
32 // Class description:
33 // Implementation of a weight window algorithm.
34 // The arguments in the constructor configure the algorithm:
35 // - upperLimitFaktor: the factor defining the upper weight limit
36 // W_u = upperLimitFaktor * W_l (W_l lower weight bound)
37 // - survivalFaktor: used in calculating the survival weight
38 // W_s = survivalFaktor * W_l
39 // - maxNumberOfSplits: the maximal number of splits allowed
40 // to be created in one go, and the reciprocal of the minimal
41 // survival probability in case of Russian roulette
42 //
43 // In case of upperLimitFaktor=survivalFaktor=1 the algorithm
44 // becomes the expected weight algorithm of the importance sampling
45 // technique.
46 //
47 // see also G4VWeightWindowAlgorithm.
48 //
49 
50 // Author: Michael Dressel (Michael.Dressel@cern.ch)
51 // ----------------------------------------------------------------------
52 #ifndef G4WeightWindowAlgorithm_hh
53 #define G4WeightWindowAlgorithm_hh G4WeightWindowAlgorithm_hh
54 
55 #include "G4Nsplit_Weight.hh"
57 
59 {
60 
61 public: // with description
62 
63  G4WeightWindowAlgorithm(G4double upperLimitFaktor = 5,
64  G4double survivalFaktor = 3,
65  G4int maxNumberOfSplits = 5);
66 
67  virtual ~G4WeightWindowAlgorithm();
68 
69  virtual G4Nsplit_Weight Calculate(G4double init_w,
70  G4double lowerWeightBound) const;
71  // calculate number of tracks and their weight according
72  // to the initial track weight and the lower energy bound
73 
74 private:
78 };
79 
80 #endif
int G4int
Definition: G4Types.hh:78
virtual G4Nsplit_Weight Calculate(G4double init_w, G4double lowerWeightBound) const
G4WeightWindowAlgorithm(G4double upperLimitFaktor=5, G4double survivalFaktor=3, G4int maxNumberOfSplits=5)
double G4double
Definition: G4Types.hh:76