Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/biasing/include/G4WeightWindowAlgorithm.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 // G4WeightWindowAlgorithm
 27 // 
 28 // Class description:
 29 //
 30 // Implementation of a weight window algorithm. 
 31 // The arguments in the constructor configure the algorithm:
 32 //   - upperLimitFactor: the factor defining the upper weight limit 
 33 //      W_u = upperLimitFactor * W_l (W_l lower weight bound)
 34 //   - survivalFactor: used in calculating the survival weight
 35 //      W_s = survivalFactor * W_l
 36 //   - maxNumberOfSplits: the maximal number of splits allowed
 37 //     to be created in one go, and the reciprocal of the minimal
 38 //     survival probability in case of Russian roulette
 39 //
 40 // In case of upperLimitFactor=survivalFactor=1 the algorithm becomes
 41 // the expected weight algorithm of the importance sampling technique.
 42 //
 43 // See also G4VWeightWindowAlgorithm.
 44 
 45 // Author: Michael Dressel (CERN), 2003
 46 // ----------------------------------------------------------------------
 47 #ifndef G4WEIGHTWINDOWALGORITHM_HH
 48 #define G4WEIGHTWINDOWALGORITHM_HH 1
 49 
 50 #include "G4Nsplit_Weight.hh"
 51 #include "G4VWeightWindowAlgorithm.hh"
 52 
 53 class G4WeightWindowAlgorithm : public G4VWeightWindowAlgorithm
 54 {
 55   public:  // with description
 56   
 57     G4WeightWindowAlgorithm(G4double upperLimitFactor = 5,
 58                             G4double survivalFactor = 3,
 59                             G4int maxNumberOfSplits = 5);
 60   
 61     ~G4WeightWindowAlgorithm() override;
 62 
 63     G4Nsplit_Weight Calculate(G4double init_w,
 64                                       G4double lowerWeightBound) const override;
 65       // calculate number of tracks and their weight according
 66       // to the initial track weight and the lower energy bound
 67 
 68   private:
 69 
 70     G4double fUpperLimitFactor = 0.0;
 71     G4double fSurvivalFactor = 0.0;
 72     G4int fMaxNumberOfSplits = 0;
 73 };
 74 
 75 #endif
 76