G4CerenkovProcess.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.          *
// ********************************************************************
//
// Cerenkov Radiation Class Definition
//
// Class:       RAT::G4CerenkovProcess
// File:        G4CerenkovProcess.hh
// Description: Discrete Process - Generation of Cerenkov Photons
// Version:     2.0
// Created:     1996-02-21
// Author:      Juliet Armstrong
// Updated:     2007-09-30 change inheritance to G4VDiscreteProcess
//              2005-07-28 add G4ProcessType to constructor
//              1999-10-29 add method and class descriptors
//              1997-04-09 by Peter Gumplinger
//              > G4MaterialPropertiesTable; new physics/tracking scheme
//
 
#ifndef __RAT_G4CerenkovProcess_h
#define __RAT_G4CerenkovProcess_h 1
 
#include <memory>
#include <vector>
 
#include "G4DynamicParticle.hh"
#include "G4ForceCondition.hh"
#include "G4GPILSelection.hh"
#include "G4MaterialPropertyVector.hh"
#include "G4VProcess.hh"
#include "globals.hh"
 
class G4Material;
class G4ParticleDefinition;
class G4PhysicsTable;
class G4Step;
class G4Track;
class G4VParticleChange;
 
namespace RAT {
 
class G4CerenkovProcess : public G4VProcess {
 public:
  explicit G4CerenkovProcess(const G4String& processName = "G4CerenkovProcess", G4ProcessType type = fElectromagnetic);
  ~G4CerenkovProcess();
 
  explicit G4CerenkovProcess(const G4CerenkovProcess& right);
 
  G4CerenkovProcess& operator=(const G4CerenkovProcess& right) = delete;
 
  G4bool IsApplicable(const G4ParticleDefinition& aParticleType) override;
  // Returns true -> 'is applicable', for all charged particles
  // except short-lived particles.
 
  void BuildPhysicsTable(const G4ParticleDefinition& aParticleType) override;
  // Build table at a right time
  void PreparePhysicsTable(const G4ParticleDefinition& part) override;
  void Initialise();
 
  G4double GetMeanFreePath(const G4Track& aTrack, G4double, G4ForceCondition*);
  // Returns the discrete step limit and sets the 'StronglyForced'
  // condition for the DoIt to be invoked at every step.
 
  G4double PostStepGetPhysicalInteractionLength(const G4Track& aTrack, G4double, G4ForceCondition*) override;
  // Returns the discrete step limit and sets the 'StronglyForced'
  // condition for the DoIt to be invoked at every step.
 
  G4VParticleChange* PostStepDoIt(const G4Track& aTrack, const G4Step& aStep) override;
  // This is the method implementing the Cerenkov process.
 
  //  no operation in  AtRestDoIt and  AlongStepDoIt
  virtual G4double AlongStepGetPhysicalInteractionLength(const G4Track&, G4double, G4double, G4double&,
                                                         G4GPILSelection*) override {
    return -1.0;
  };
 
  virtual G4double AtRestGetPhysicalInteractionLength(const G4Track&, G4ForceCondition*) override { return -1.0; };
 
  //  no operation in  AtRestDoIt and  AlongStepDoIt
  virtual G4VParticleChange* AtRestDoIt(const G4Track&, const G4Step&) override { return nullptr; };
 
  virtual G4VParticleChange* AlongStepDoIt(const G4Track&, const G4Step&) override { return nullptr; };
 
  void SetTrackSecondariesFirst(const G4bool state);
  // If set, the primary particle tracking is interrupted and any
  // produced Cerenkov photons are tracked next. When all have
  // been tracked, the tracking of the primary resumes.
 
  G4bool GetTrackSecondariesFirst() const;
  // Returns the boolean flag for tracking secondaries first.
 
  void SetMaxBetaChangePerStep(const G4double d);
  // Set the maximum allowed change in beta = v/c in % (perCent) per step.
 
  G4double GetMaxBetaChangePerStep() const;
  // Returns the maximum allowed change in beta = v/c in % (perCent)
 
  void SetMaxNumPhotonsPerStep(const G4int NumPhotons);
  // Set the maximum number of Cerenkov photons allowed to be generated during
  // a tracking step. This is an average ONLY; the actual number will vary
  // around this average. If invoked, the maximum photon stack will roughly be
  // of the size set. If not called, the step is not limited by the number of
  // photons generated.
 
  G4int GetMaxNumPhotonsPerStep() const;
  // Returns the maximum number of Cerenkov photons allowed to be
  // generated during a tracking step.
 
  void SetStackPhotons(const G4bool);
  // Call by the user to set the flag for stacking the scint. photons
 
  G4bool GetStackPhotons() const;
  // Return the boolean for whether or not the scint. photons are stacked
 
  G4int GetNumPhotons() const;
  // Returns the current number of scint. photons (after PostStepDoIt)
 
  G4PhysicsTable* GetPhysicsTable() const;
  // Returns the address of the physics table.
 
  void DumpPhysicsTable() const;
  // Prints the physics table.
 
  G4double GetAverageNumberOfPhotons(const G4double charge, const G4double beta, const G4Material* aMaterial,
                                     G4MaterialPropertyVector* Rindex) const;
 
  void DumpInfo() const override { ProcessDescription(G4cout); };
  void ProcessDescription(std::ostream& out) const override;
 
  void SetVerboseLevel(G4int);
  // sets verbosity
 
 protected:
  G4PhysicsTable* thePhysicsTable;
  std::shared_ptr<std::vector<std::vector<G4double>>> refractiveIndexValuesVectors =
      std::make_shared<std::vector<std::vector<G4double>>>();
  std::shared_ptr<std::vector<std::vector<G4double>>> refractiveIndexEnergyVectors =
      std::make_shared<std::vector<std::vector<G4double>>>();
 
  std::vector<G4double> fMinRindex;
  std::vector<G4double> fMaxRindex;
 
 private:
  G4double fMaxBetaChange;
 
  G4int fMaxPhotons;
  G4int fNumPhotons;
 
  G4bool fStackingFlag;
  G4bool fTrackSecondariesFirst;
 
  G4int secID = -1;  // creator modelID
};
 
inline G4bool G4CerenkovProcess::GetTrackSecondariesFirst() const { return fTrackSecondariesFirst; }
 
inline G4double G4CerenkovProcess::GetMaxBetaChangePerStep() const { return fMaxBetaChange; }
 
inline G4int G4CerenkovProcess::GetMaxNumPhotonsPerStep() const { return fMaxPhotons; }
 
inline G4bool G4CerenkovProcess::GetStackPhotons() const { return fStackingFlag; }
 
inline G4int G4CerenkovProcess::GetNumPhotons() const { return fNumPhotons; }
 
inline G4PhysicsTable* G4CerenkovProcess::GetPhysicsTable() const { return thePhysicsTable; }
 
}  // namespace RAT
 
#endif /* __RAT_G4CerenkovProcess_h */