GB03BOptnSplitOrKillOnBoundary.hh

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file GB03BOptnSplitOrKillOnBoundary.hh

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
//

#ifndef GB03BOptnSplitOrKillOnBoundary_hh
#define GB03BOptnSplitOrKillOnBoundary_hh 1

#include "G4VBiasingOperation.hh"
#include "G4ParticleChange.hh"
#include "G4ParticleChangeForNothing.hh"
class G4LogicalVolume;

class GB03BOptnSplitOrKillOnBoundary : public G4VBiasingOperation {
public:
  // -- Constructor :
  GB03BOptnSplitOrKillOnBoundary(G4String name);
  // -- destructor:
  virtual ~GB03BOptnSplitOrKillOnBoundary();

public:
  // ----------------------------------------------
  // -- Methods from G4VBiasingOperation interface:
  // ----------------------------------------------
  // -- Unused:
  virtual const G4VBiasingInteractionLaw*
  ProvideOccurenceBiasingInteractionLaw( const G4BiasingProcessInterface*,
                                         G4ForceCondition&                 ) {return 0;}
  virtual G4VParticleChange*                            
  ApplyFinalStateBiasing               ( const G4BiasingProcessInterface*,
                                         const G4Track*,
                                         const G4Step*,
                                         G4bool&                           ) {return 0;}

  // -- Used methods ("non-physics biasing methods"):
  // ------------------------------------------------
  // -- Method to return the distance or the condition under which
  // -- requesting the biasing. The "condition" flag will be indeed
  // -- used to apply the operation on the geometry boundary.
  virtual G4double
  DistanceToApplyOperation              ( const G4Track*,
                                          G4double,
                                          G4ForceCondition* condition      );
  // -- Method the generate the final state, ie, either the final states
  // -- corresponding to the splitting or killing cases:
  virtual G4VParticleChange* 
  GenerateBiasingFinalState             ( const G4Track*,
                                          const G4Step*                    );

  // -- Specific to this example:
  // ----------------------------
  // -- Set the integer splitting factor (should be >= 2):
  // -- This determines also the killing probability : 1/splittingFactor
  void SetSplittingFactor( G4int splittingFactor )
  { fSplittingFactor = splittingFactor; }
  // -- An "invention" (?) of this example: defines a probability
  // -- to apply the splitting(killing) techniques:
  // --   - If proba == 1, the technique is applied normally
  // --   - if proba < 1 (say 70%) then the splitting(killing) is
  // --     applied in only 70% of the cases.
  // -- This "trick" is useful when the desired splitting factor
  // -- would rather be a non-integer value, ie in case where:
  // --    splittingFactor = k   is (a bit) too small
  // --    splittingFactor = k+1 is (a bit) too large
  // -- then the proba can allow to tune an in between application
  // -- of the technique.
  // -- Specially useful when wanting to split between "1 and 2".
  void SetApplyProbability( G4double proba )
  { fApplyProbability = proba; }
  
  G4int    GetSplittingFactor()  const { return fSplittingFactor;  }
  G4double GetApplyProbability() const { return fApplyProbability; }
  
private:
  G4ParticleChange            fParticleChange;
  G4ParticleChangeForNothing  fParticleChangeForNothing;
  G4int    fSplittingFactor;
  G4double fApplyProbability;
};

#endif