G4MonopoleTransportation.h

/**************************************************************************
 * BASF2 (Belle Analysis Framework 2)                                     *
 * Copyright(C) 2018 - Belle II Collaboration                             *
 *                                                                        *
 * Author: The Belle II Collaboration                                     *
 * Contributors: Dmitrii Neverov                                          *
 *                                                                        *
 * This software is provided "as is" without any warranty.                *
 **************************************************************************/
 
// modified from GEANT4 exoticphysics/monopole/*
 
#pragma once
 
// inline include at the end of the file
 
#include <G4VProcess.hh>
#include <G4FieldManager.hh>
#include <G4Navigator.hh>
#include <G4TransportationManager.hh>
#include <G4PropagatorInField.hh>
#include <G4Track.hh>
#include <G4Step.hh>
#include <G4ParticleChangeForTransport.hh>
 
#include <simulation/monopoles/G4MonopoleFieldSetup.h>
 
class G4SafetyHelper;
 
namespace Belle2 {
  namespace Monopoles {
 
    class G4Monopole;
 
    class G4MonopoleTransportation : public G4VProcess {
 
    public:
 
      explicit G4MonopoleTransportation(const G4Monopole* mpl, G4int verb = 1);
      ~G4MonopoleTransportation();
 
      virtual G4double AlongStepGetPhysicalInteractionLength(
        const G4Track& track,
        G4double  previousStepSize,
        G4double  currentMinimumStep,
        G4double& currentSafety,
        G4GPILSelection* selection
      );
 
      virtual G4VParticleChange* AlongStepDoIt(
        const G4Track& track,
        const G4Step& stepData
      );
 
      virtual G4VParticleChange* PostStepDoIt(
        const G4Track& track,
        const G4Step&  stepData
      );
 
      virtual G4double PostStepGetPhysicalInteractionLength(
        const G4Track& track,
        G4double   previousStepSize,
        G4ForceCondition* pForceCond
      );
 
      inline G4PropagatorInField* GetPropagatorInField(); 
      inline void SetPropagatorInField(G4PropagatorInField*
                                       pFieldPropagator); 
      inline G4double GetThresholdWarningEnergy() const; 
      inline G4double GetThresholdImportantEnergy() const; 
      inline G4int GetThresholdTrials() const; 
      inline void SetThresholdWarningEnergy(G4double newEnWarn); 
      inline void SetThresholdImportantEnergy(G4double newEnImp); 
      inline void SetThresholdTrials(G4int newMaxTrials); 
      // Get/Set parameters for killing loopers:
      //   Above 'important' energy a 'looping' particle in field will
      //   *NOT* be abandoned, except after fThresholdTrials attempts.
      // Below Warning energy, no verbosity for looping particles is issued
 
      inline G4double GetMaxEnergyKilled() const; 
      inline G4double GetSumEnergyKilled() const; 
      inline void ResetKilledStatistics(G4int report = 1); 
      inline void EnableShortStepOptimisation(G4bool optimise =
                                                true); 
    public:
 
      virtual G4double AtRestGetPhysicalInteractionLength(
        const G4Track&,
        G4ForceCondition*
      ) { return -1.0; };
 
      virtual G4VParticleChange* AtRestDoIt(
        const G4Track&,
        const G4Step&
      ) {return 0;};
 
      virtual void StartTracking(G4Track* aTrack); 
    protected:
 
      G4bool               DoesGlobalFieldExist(); 
    private:
 
      const G4Monopole* fParticleDef; 
      G4MonopoleFieldSetup*  fMagSetup; 
      G4Navigator*         fLinearNavigator; 
      G4PropagatorInField* fFieldPropagator; 
      G4ThreeVector        fTransportEndPosition; 
      G4ThreeVector        fTransportEndMomentumDir; 
      G4double             fTransportEndKineticEnergy; 
      G4ThreeVector        fTransportEndSpin; 
      G4bool               fMomentumChanged; 
      //  G4bool               fEnergyChanged; /**< The particle's state after this Step, Store for DoIt*/
      G4bool               fEndGlobalTimeComputed; 
      G4double             fCandidateEndGlobalTime; 
      G4bool               fParticleIsLooping; 
      G4TouchableHandle    fCurrentTouchableHandle; 
      G4bool fGeometryLimitedStep; 
      G4ThreeVector  fPreviousSftOrigin; 
      G4double       fPreviousSafety; 
      G4ParticleChangeForTransport fParticleChange; 
      G4double endpointDistance; 
      G4double fThreshold_Trap_Energy;  //FIXME should be dependent on e.g. density
 
      // Thresholds for looping particles:
      G4double fThreshold_Warning_Energy; 
      G4double fThreshold_Important_Energy; 
      G4int    fThresholdTrials; 
      // Above 'important' energy a 'looping' particle in field will
      //   *NOT* be abandoned, except after fThresholdTrials attempts.
      // G4double fUnimportant_Energy;
      //  Below this energy, no verbosity for looping particles is issued
 
      G4int    fNoLooperTrials; 
      G4double fSumEnergyKilled; 
      G4double fMaxEnergyKilled; 
      G4bool   fShortStepOptimisation;
 
      G4SafetyHelper* fpSafetyHelper; 
    };
 
  } //end Monopoles namespace
 
} //end Belle2 namespace
 
#include <simulation/monopoles/G4MonopoleTransportationInline.h>