| 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 //
27 //
28 /// \file GB03BOptnSplitOrKillOnBoundary.hh
29 /// \brief Definition of the GB03BOptnSplitOrKillOnBoundary class
30
31 #ifndef GB03BOptnSplitOrKillOnBoundary_hh
32 #define GB03BOptnSplitOrKillOnBoundary_hh 1
33
34 #include "G4ParticleChange.hh"
35 #include "G4ParticleChangeForNothing.hh"
36 #include "G4VBiasingOperation.hh"
37 class G4LogicalVolume;
38
39 class GB03BOptnSplitOrKillOnBoundary : public G4VBiasingOperation
40 {
41 public:
42 // -- Constructor :
43 GB03BOptnSplitOrKillOnBoundary(G4String name);
44 // -- destructor:
45 virtual ~GB03BOptnSplitOrKillOnBoundary();
46
47 public:
48 // ----------------------------------------------
49 // -- Methods from G4VBiasingOperation interface:
50 // ----------------------------------------------
51 // -- Unused:
52 virtual const G4VBiasingInteractionLaw*
53 ProvideOccurenceBiasingInteractionLaw(const G4BiasingProcessInterface*, G4ForceCondition&)
54 {
55 return 0;
56 }
57 virtual G4VParticleChange* ApplyFinalStateBiasing(const G4BiasingProcessInterface*,
58 const G4Track*, const G4Step*, G4bool&)
59 {
60 return 0;
61 }
62
63 // -- Used methods ("non-physics biasing methods"):
64 // ------------------------------------------------
65 // -- Method to return the distance or the condition under which
66 // -- requesting the biasing. The "condition" flag will be indeed
67 // -- used to apply the operation on the geometry boundary.
68 virtual G4double DistanceToApplyOperation(const G4Track*, G4double,
69 G4ForceCondition* condition);
70 // -- Method the generate the final state, ie, either the final states
71 // -- corresponding to the splitting or killing cases:
72 virtual G4VParticleChange* GenerateBiasingFinalState(const G4Track*, const G4Step*);
73
74 // -- Specific to this example:
75 // ----------------------------
76 // -- Set the integer splitting factor (should be >= 2):
77 // -- This determines also the killing probability : 1/splittingFactor
78 void SetSplittingFactor(G4int splittingFactor) { fSplittingFactor = splittingFactor; }
79 // -- An "invention" (?) of this example: defines a probability
80 // -- to apply the splitting(killing) techniques:
81 // -- - If proba == 1, the technique is applied normally
82 // -- - if proba < 1 (say 70%) then the splitting(killing) is
83 // -- applied in only 70% of the cases.
84 // -- This "trick" is useful when the desired splitting factor
85 // -- would rather be a non-integer value, ie in case where:
86 // -- splittingFactor = k is (a bit) too small
87 // -- splittingFactor = k+1 is (a bit) too large
88 // -- then the proba can allow to tune an in between application
89 // -- of the technique.
90 // -- Specially useful when wanting to split between "1 and 2".
91 void SetApplyProbability(G4double proba) { fApplyProbability = proba; }
92
93 G4int GetSplittingFactor() const { return fSplittingFactor; }
94 G4double GetApplyProbability() const { return fApplyProbability; }
95
96 private:
97 G4ParticleChange fParticleChange;
98 G4ParticleChangeForNothing fParticleChangeForNothing;
99 G4int fSplittingFactor;
100 G4double fApplyProbability;
101 };
102
103 #endif
104