| 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 // G4ParticleChangeForOccurenceBiasing
27 //
28 // Class Description:
29 //
30 // A G4VParticleChange dedicated to occurrence biasing : it
31 // applies weights for non-interaction over a step, and for
32 // interaction at the end of the step (if interaction occurs) on
33 // top of a given particle change, that is the one produced by a
34 // physics process (biased in its final state or not).
35 //
36 // Author: Marc Verderi, November 2013.
37 //
38 // --------------------------------------------------------------------
39 #ifndef G4ParticleChangeForOccurenceBiasing_hh
40 #define G4ParticleChangeForOccurenceBiasing_hh 1
41
42 #include "G4VParticleChange.hh"
43
44 class G4ParticleChangeForOccurenceBiasing : public G4VParticleChange
45 {
46 public:
47
48 G4ParticleChangeForOccurenceBiasing(const G4String& name);
49 ~G4ParticleChangeForOccurenceBiasing() = default;
50
51 void SetOccurenceWeightForNonInteraction(G4double w)
52 { fOccurenceWeightForNonInteraction = w; }
53 G4double GetOccurenceWeightForNonInteraction() const
54 { return fOccurenceWeightForNonInteraction; }
55 void SetOccurenceWeightForInteraction(G4double w)
56 { fOccurenceWeightForInteraction = w; }
57 G4double GetOccurenceWeightForInteraction() const
58 { return fOccurenceWeightForInteraction; }
59
60 // -- set a wrapped particle change AND USE IT TO UPDATE this occurrence
61 // particle change state:
62 void SetWrappedParticleChange(G4VParticleChange* wpc);
63 G4VParticleChange* GetWrappedParticleChange() const
64 { return fWrappedParticleChange; }
65
66 // -- collect the secondaries from the wrapped particle change,
67 // apply weight correction, and clear wrapped particle change:
68 void StealSecondaries();
69
70 // -- from base class G4VParticleChange:
71 virtual G4Step* UpdateStepForAtRest (G4Step* step);
72 virtual G4Step* UpdateStepForAlongStep(G4Step* step);
73 virtual G4Step* UpdateStepForPostStep (G4Step* step);
74
75 const G4String& GetName() const { return fName; }
76
77 private:
78
79 G4String fName;
80 G4VParticleChange* fWrappedParticleChange = nullptr;
81 G4double fOccurenceWeightForNonInteraction = -1.0;
82 G4double fOccurenceWeightForInteraction = -1.0;
83 };
84
85 #endif
86