GB03/include/GB03BOptrGeometryBasedBiasing.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 GB03BOptrGeometryBasedBiasing.hh
0027 /// \brief Definition of the GB03BOptrGeometryBasedBiasing class
0028
0029 #ifndef GB03BOptrGeometryBasedBiasing_h
0030 #define GB03BOptrGeometryBasedBiasing_h 1
0031
0032 #include "GB03BOptnSplitOrKillOnBoundary.hh"
0033
0034 #include "G4VBiasingOperator.hh"
0035 class G4GenericMessenger;
0036
0037 /// Biasing operator class.
0038
0039 class GB03BOptrGeometryBasedBiasing : public G4VBiasingOperator
0040 {
0041   public:
0042     GB03BOptrGeometryBasedBiasing();
0043     ~GB03BOptrGeometryBasedBiasing() override;
0044
0045   public:
0046     // ------------------------------
0047     // Method added for this example:
0048     // ------------------------------
0049     GB03BOptnSplitOrKillOnBoundary* GetSplitAndKillOperation() const
0050     {
0051       return fSplitAndKillOperation;
0052     }
0053
0054     // -------------------------
0055     // Optional from base class:
0056     // -------------------------
0057     void StartRun() override;
0058
0059   private:
0060     // --------------------------
0061     // Mandatory from base class:
0062     // --------------------------
0063     // Used for splitting/killing:
0064     G4VBiasingOperation*
0065     ProposeNonPhysicsBiasingOperation(const G4Track* track,
0066                                       const G4BiasingProcessInterface* callingProcess) override;
0067
0068     // Not used here:
0069     G4VBiasingOperation* ProposeOccurenceBiasingOperation(const G4Track*,
0070                                                           const G4BiasingProcessInterface*) override
0071     {
0072       return nullptr;
0073     }
0074     // Not used here:
0075     G4VBiasingOperation*
0076     ProposeFinalStateBiasingOperation(const G4Track*, const G4BiasingProcessInterface*) override
0077     {
0078       return nullptr;
0079     }
0080
0081   private:
0082     GB03BOptnSplitOrKillOnBoundary* fSplitAndKillOperation;
0083     G4int fSplittingFactor;
0084     G4double fApplyProbability;
0085     // Messengers to change the
0086     G4GenericMessenger* fSplittingFactorMessenger;
0087     G4GenericMessenger* fApplyProbabilityMessenger;
0088 };
0089
0090 #endif