G4WeightWindowProcess.hh

Go to the documentation of this file.

//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// G4WeightWindowProcess
//
// Class description:
//
// Used internally by weight window technique in the "mass" geometry.
// This process is a forced post step process. It will apply
// weight window biasing on boundaries, collisions 
// or both according to the G4PlaceOfAction argument.
//
// Author: Michael Dressel, 2002
// --------------------------------------------------------------------
#ifndef G4WeightWindowProcess_hh
#define G4WeightWindowProcess_hh 1
 
#include "G4VProcess.hh"
#include "G4VTrackTerminator.hh"
#include "G4PlaceOfAction.hh"
#include "G4VTouchable.hh"
 
class G4SamplingPostStepAction;
class G4VWeightWindowAlgorithm;
class G4VWeightWindowStore;
 
class G4Step;
class G4Navigator;
class G4TransportationManager;
class G4PathFinder;
 
#include "G4FieldTrack.hh"
#include "G4TouchableHandle.hh"
#include "G4MultiNavigator.hh"   // For ELimited enum
 
class G4WeightWindowProcess : public G4VProcess, public G4VTrackTerminator
{
 
 public:
 
  G4WeightWindowProcess(const G4VWeightWindowAlgorithm&
                              aWeightWindowAlgorithm,
                        const G4VWeightWindowStore &aWWStore,
                        const G4VTrackTerminator* TrackTerminator,
                              G4PlaceOfAction placeOfAction,
                        const G4String& aName = "WeightWindowProcess",
                              G4bool para = false);
    // creates a G4ParticleChange
 
  virtual ~G4WeightWindowProcess();
    // delete the G4ParticleChange
 
  G4WeightWindowProcess(const G4WeightWindowProcess &) = delete;
  G4WeightWindowProcess &operator=(const G4WeightWindowProcess &) = delete;
 
  //--------------------------------------------------------------
  // Set Parallel World
  //--------------------------------------------------------------
 
  void SetParallelWorld(const G4String& parallelWorldName);
  void SetParallelWorld(G4VPhysicalVolume* parallelWorld);
 
  //--------------------------------------------------------------
  //     Process interface
  //--------------------------------------------------------------
 
  void StartTracking(G4Track*);
 
  virtual G4double 
  PostStepGetPhysicalInteractionLength(const G4Track& aTrack,
                                       G4double previousStepSize,
                                       G4ForceCondition* condition);
    // make process beeing forced
  virtual G4VParticleChange *PostStepDoIt(const G4Track&, const G4Step&);
    // aply weight window sampling
 
  virtual void KillTrack() const;
    // used in case no scoring process follows that does the killing
 
  virtual const G4String& GetName() const;
 
  //  no operation in  AtRestDoIt and  AlongStepDoIt
 
  virtual G4double 
  AlongStepGetPhysicalInteractionLength(const G4Track&, G4double, G4double,
                                        G4double&, G4GPILSelection*);
  virtual G4double 
  AtRestGetPhysicalInteractionLength(const G4Track&, G4ForceCondition*);
  
  virtual G4VParticleChange* AtRestDoIt(const G4Track&, const G4Step&);
  virtual G4VParticleChange* AlongStepDoIt(const G4Track&, const G4Step&);
  
 private:
 
  void CopyStep(const G4Step& step);
 
  G4Step* fGhostStep = nullptr;
  G4StepPoint* fGhostPreStepPoint = nullptr;
  G4StepPoint* fGhostPostStepPoint = nullptr;
 
  G4ParticleChange* fParticleChange = nullptr;
  const G4VWeightWindowAlgorithm& fWeightWindowAlgorithm;
  const G4VWeightWindowStore& fWeightWindowStore;
  G4SamplingPostStepAction* fPostStepAction = nullptr;
  G4PlaceOfAction fPlaceOfAction;
 
  G4TransportationManager* fTransportationManager = nullptr;
  G4PathFinder* fPathFinder = nullptr;
 
  // -------------------------------
  // Navigation in the Ghost World:
  // -------------------------------
  G4String             fGhostWorldName = "NoParallelWorld";
  G4VPhysicalVolume*   fGhostWorld = nullptr;
  G4Navigator*         fGhostNavigator = nullptr;
  G4int                fNavigatorID = -1;
  G4TouchableHandle    fOldGhostTouchable;
  G4TouchableHandle    fNewGhostTouchable;
  G4FieldTrack         fFieldTrack = '0';
  G4double             fGhostSafety = -1;
  G4bool               fOnBoundary = false;
 
  G4bool               fParaflag = false;
  G4FieldTrack         fEndTrack = '0';
  ELimited             feLimited = kDoNot;
};
 
#endif