GB03/include/GB03BOptnSplitOrKillOnBoundary.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 //
0027 //
0028 /// \file GB03BOptnSplitOrKillOnBoundary.hh
0029 /// \brief Definition of the GB03BOptnSplitOrKillOnBoundary class
0030
0031 #ifndef GB03BOptnSplitOrKillOnBoundary_hh
0032 #define GB03BOptnSplitOrKillOnBoundary_hh 1
0033
0034 #include "G4ParticleChange.hh"
0035 #include "G4ParticleChangeForNothing.hh"
0036 #include "G4VBiasingOperation.hh"
0037 class G4LogicalVolume;
0038
0039 class GB03BOptnSplitOrKillOnBoundary : public G4VBiasingOperation
0040 {
0041   public:
0042     // -- Constructor :
0043     GB03BOptnSplitOrKillOnBoundary(G4String name);
0044     // -- destructor:
0045     ~GB03BOptnSplitOrKillOnBoundary() override;
0046
0047   public:
0048     // ----------------------------------------------
0049     // -- Methods from G4VBiasingOperation interface:
0050     // ----------------------------------------------
0051     // -- Unused:
0052     const G4VBiasingInteractionLaw*
0053     ProvideOccurenceBiasingInteractionLaw(const G4BiasingProcessInterface*,
0054                                           G4ForceCondition&) override
0055     {
0056       return nullptr;
0057     }
0058     G4VParticleChange* ApplyFinalStateBiasing(const G4BiasingProcessInterface*, const G4Track*,
0059                                               const G4Step*, G4bool&) override
0060     {
0061       return nullptr;
0062     }
0063
0064     // -- Used methods ("non-physics biasing methods"):
0065     // ------------------------------------------------
0066     // -- Method to return the distance or the condition under which
0067     // -- requesting the biasing. The "condition" flag will be indeed
0068     // -- used to apply the operation on the geometry boundary.
0069     G4double DistanceToApplyOperation(const G4Track*, G4double,
0070                                       G4ForceCondition* condition) override;
0071     // -- Method the generate the final state, ie, either the final states
0072     // -- corresponding to the splitting or killing cases:
0073     G4VParticleChange* GenerateBiasingFinalState(const G4Track*, const G4Step*) override;
0074
0075     // -- Specific to this example:
0076     // ----------------------------
0077     // -- Set the integer splitting factor (should be >= 2):
0078     // -- This determines also the killing probability : 1/splittingFactor
0079     void SetSplittingFactor(G4int splittingFactor) { fSplittingFactor = splittingFactor; }
0080     // -- An "invention" (?) of this example: defines a probability
0081     // -- to apply the splitting(killing) techniques:
0082     // --   - If proba == 1, the technique is applied normally
0083     // --   - if proba < 1 (say 70%) then the splitting(killing) is
0084     // --     applied in only 70% of the cases.
0085     // -- This "trick" is useful when the desired splitting factor
0086     // -- would rather be a non-integer value, ie in case where:
0087     // --    splittingFactor = k   is (a bit) too small
0088     // --    splittingFactor = k+1 is (a bit) too large
0089     // -- then the proba can allow to tune an in between application
0090     // -- of the technique.
0091     // -- Specially useful when wanting to split between "1 and 2".
0092     void SetApplyProbability(G4double proba) { fApplyProbability = proba; }
0093
0094     G4int GetSplittingFactor() const { return fSplittingFactor; }
0095     G4double GetApplyProbability() const { return fApplyProbability; }
0096
0097   private:
0098     G4ParticleChange fParticleChange;
0099     G4ParticleChangeForNothing fParticleChangeForNothing;
0100     G4int fSplittingFactor;
0101     G4double fApplyProbability;
0102 };
0103
0104 #endif