include/Geant4/G4VXRayModel.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 // -------------------------------------------------------------------
0027 //
0028 // GEANT4 Class header file
0029 //
0030 //
0031 // File name:     G4VXRayModel
0032 //
0033 // Author:        Vladimir Ivanchenko
0034 //
0035 // Creation date: 28.04.2025
0036 //
0037 //
0038 // Class Description:
0039 //
0040 // Abstract interface to a X-Ray production model
0041
0042 // -------------------------------------------------------------------
0043 //
0044
0045 #ifndef G4VXRayModel_h
0046 #define G4VXRayModel_h 1
0047
0048 #include "globals.hh"
0049 #include <vector>
0050
0051 class G4LogicalVolume;
0052 class G4ParticleDefinition;
0053 class G4DynamicParticle;
0054 class G4LossTableManager;
0055 class G4Track;
0056 class G4Step;
0057
0058 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
0059
0060 class G4VXRayModel
0061 {
0062
0063 public:
0064
0065   explicit G4VXRayModel(const G4String& nam);
0066
0067   G4VXRayModel(const G4VXRayModel&);
0068
0069   virtual ~G4VXRayModel();
0070
0071   // return minimal beta for Cerenkov in these volumes
0072   // the method may be used for other X-Ray models
0073   G4double Initialise(std::vector<const G4LogicalVolume*>*);
0074   virtual void InitialiseModel();
0075
0076   // check applicability and propose step limit, which may be DBL_MAX
0077   // if these methods return "false", then sampling of X-rays not possible
0078   G4bool StepLimit(std::size_t idx, const G4Track&,
0079            G4double preStepBeta, G4double& limit);
0080   virtual G4bool StepLimitForVolume(G4double& limit);
0081
0082   // sampling is called if StepLimit(..) returns "true"
0083   // produced X-rays are inside vector out
0084   // each photon has time, position, and other parameters  within the step
0085   virtual void SampleXRays(std::vector<G4Track*>& out, const G4Step&);
0086
0087   // for automatic documentation
0088   virtual void ModelDescription(std::ostream& outFile) const;
0089
0090   const G4String& GetName() const { return pName; };
0091
0092   G4int GetType() const { return pTypeInt; };
0093
0094   //  hide assignment operator
0095   G4VXRayModel& operator=(const G4VXRayModel& right) = delete;
0096
0097 private:
0098
0099   void Register();
0100
0101 protected:
0102
0103   std::vector<const G4LogicalVolume*>* pLogicalVolumes{nullptr};
0104   G4LossTableManager* pEmManager{nullptr};
0105   const G4LogicalVolume* pCurrentLV{nullptr};
0106   const G4Track* pCurrentTrack{nullptr};
0107   G4double pBetaMin{1.0};
0108   G4double pPreStepBeta{0.0};
0109   G4double pMaxBetaChange{0.1};
0110
0111   G4int pMaxPhotons{100};
0112   std::size_t pIndex{0};
0113   std::size_t nVolumes{0};
0114
0115   G4int pTypeInt{0};
0116   G4int pVerbose{1};
0117   G4bool isMaster{false};
0118   const G4String pName;
0119 };
0120
0121 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.....
0122
0123 #endif