include/Geant4/G4BOptnCloning.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 // G4BOptnCloning
0027 //
0028 // Class Description:
0029 //
0030 // A G4VBiasingOperation to clone a track, allowing to set
0031 // weight arbitrary weights.
0032 //
0033 // Author: Marc Verderi, November 2013.
0034 // --------------------------------------------------------------------
0035 #ifndef G4BOptnCloning_hh
0036 #define G4BOptnCloning_hh 1
0037
0038 #include "G4VBiasingOperation.hh"
0039 #include "G4ParticleChange.hh"
0040
0041 class G4BOptnCloning : public G4VBiasingOperation
0042 {
0043   public:
0044
0045     // -- Constructor :
0046     G4BOptnCloning(const G4String& name);
0047     // -- destructor:
0048     virtual ~G4BOptnCloning();
0049
0050     // -- Methods from G4VBiasingOperation interface:
0051     // -------------------------------------------
0052     // -- Unsed:
0053     virtual const G4VBiasingInteractionLaw*
0054     ProvideOccurenceBiasingInteractionLaw( const G4BiasingProcessInterface*,
0055                   G4ForceCondition& ) { return nullptr; }
0056     virtual G4VParticleChange*
0057     ApplyFinalStateBiasing( const G4BiasingProcessInterface*,
0058                   const G4Track*, const G4Step*, G4bool& ) { return nullptr; }
0059     // -- Used:
0060     virtual G4double
0061     DistanceToApplyOperation( const G4Track*,
0062                   G4double, G4ForceCondition* condition )
0063     {
0064       *condition = NotForced; return 0.; // -- acts immediately
0065     }
0066     virtual G4VParticleChange*
0067     GenerateBiasingFinalState( const G4Track*, const G4Step* );
0068
0069     // -- Additional methods, specific to this class:
0070     // ----------------------------------------------
0071     void SetCloneWeights( G4double clone1Weight, G4double clone2Weight )
0072     {
0073       fClone1W = clone1Weight;
0074       fClone2W = clone2Weight;
0075     }
0076
0077     G4Track* GetCloneTrack() const { return fCloneTrack; }
0078
0079   private:
0080
0081     G4double fClone1W = -1.0, fClone2W = -1.0;
0082     G4ParticleChange fParticleChange;
0083     G4Track* fCloneTrack = nullptr;
0084 };
0085
0086 #endif