GB06/include/GB06BOptnSplitAndKillByImportance.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 /// \file GB06BOptnSplitAndKillByImportance.hh
0027 /// \brief Definition of the GB06BOptnSplitAndKillByImportance class
0028
0029 #ifndef GB06BOptnSplitAndKillByImportance_hh
0030 #define GB06BOptnSplitAndKillByImportance_hh 1
0031
0032 #include "G4ParticleChange.hh"
0033 #include "G4ParticleChangeForNothing.hh"
0034 #include "G4TouchableHandle.hh"
0035 #include "G4VBiasingOperation.hh"
0036 class G4BiasingProcessSharedData;
0037 #include <map>
0038
0039 class GB06BOptnSplitAndKillByImportance : public G4VBiasingOperation
0040 {
0041   public:
0042     // -- Constructor :
0043     GB06BOptnSplitAndKillByImportance(G4String name);
0044     // -- destructor:
0045     ~GB06BOptnSplitAndKillByImportance() override;
0046
0047   public:
0048     // ----------------------------------------------
0049     // -- Methods from G4VBiasingOperation interface:
0050     // ----------------------------------------------
0051     // -- Unused:
0052     const G4VBiasingInteractionLaw*
0053     ProvideOccurenceBiasingInteractionLaw(const G4BiasingProcessInterface*, G4ForceCondition&) final
0054     {
0055       return nullptr;
0056     }
0057     G4VParticleChange* ApplyFinalStateBiasing(const G4BiasingProcessInterface*, const G4Track*,
0058                                               const G4Step*, G4bool&) final
0059     {
0060       return nullptr;
0061     }
0062
0063     // -- Used methods ("non-physics biasing methods"):
0064     // ------------------------------------------------
0065     // -- Method to return the distance or the condition under which
0066     // -- requesting the biasing.
0067     // -- Here we use the condition "forced" and the distance returned
0068     // -- is "dummy" (DBL_MAX).
0069     G4double DistanceToApplyOperation(const G4Track*, G4double, G4ForceCondition* condition) final;
0070     // -- Method the generate the final state, which is:
0071     // --  - made of the primary with half of its original weight, and a clone of it in
0072     // --    case of splitting
0073     // --  - the primary with increased weight or the primary killed, in case of killing
0074     G4VParticleChange* GenerateBiasingFinalState(const G4Track*, const G4Step*) final;
0075
0076     // -- Specific to this example:
0077     // ----------------------------
0078     // -- The parallel world index refers to the index in the list of parallel worlds
0079     // -- handled by the G4ParallelGeometriesLimiterProcess intance:
0080     void SetParallelWorldIndex(G4int parallelWorldIndex)
0081     {
0082       fParallelWorldIndex = parallelWorldIndex;
0083     }
0084     G4int GetParallelWorldIndex() const { return fParallelWorldIndex; }
0085     // -- Method to set the biasing shared data, they contain many
0086     // -- of the information we need related to parallel geometry:
0087     void SetBiasingSharedData(const G4BiasingProcessSharedData* sharedData)
0088     {
0089       fBiasingSharedData = sharedData;
0090     }
0091     // -- Set the importance map to be used:
0092     void SetImportanceMap(std::map<G4int, G4int>* importanceMap) { fImportanceMap = importanceMap; }
0093
0094   private:
0095     G4int fParallelWorldIndex;
0096     const G4BiasingProcessSharedData* fBiasingSharedData;
0097     G4TouchableHandle fPreStepTouchableHistory;
0098     G4TouchableHandle fPostStepTouchableHistory;
0099     G4ParticleChange fParticleChange;
0100     G4ParticleChangeForNothing fDummyParticleChange;
0101     std::map<G4int, G4int>* fImportanceMap;
0102 };
0103
0104 #endif