include/Geant4/G4ionIonisation.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 //
0029 // GEANT4 Class header file
0030 //
0031 //
0032 // File name:     G4ionIonisation
0033 //
0034 // Author:        Vladimir Ivanchenko
0035 //
0036 // Creation date: 07.05.2002
0037 //
0038 // Modifications:
0039 //
0040 // 26-12-02 Secondary production moved to derived classes (VI)
0041 // 24-01-03 Make models region aware (V.Ivanchenko)
0042 // 05-02-03 Fix compilation warnings (V.Ivanchenko)
0043 // 13-02-03 SubCutoff regime is assigned to a region (V.Ivanchenko)
0044 // 15-02-03 Add control on delta pointer (V.Ivanchenko)
0045 // 23-05-03 Add fluctuation model as a member function (V.Ivanchenko)
0046 // 03-08-03 Add effective charge and saturation of tmax (V.Ivanchenko)
0047 // 12-11-03 Fix problem of negative effective charge (V.Ivanchenko)
0048 // 12-11-03 G4EnergyLossSTD -> G4EnergyLossProcess (V.Ivanchenko)
0049 // 21-01-04 Migrade to G4ParticleChangeForLoss (V.Ivanchenko)
0050 // 08-11-04 Migration to new interface of Store/Retrieve tables (V.Ivantchenko)
0051 // 08-04-05 Major optimisation of internal interfaces (V.Ivantchenko)
0052 // 11-04-05 Move MaxSecondary energy to model (V.Ivanchneko)
0053 // 11-04-04 Move MaxSecondaryEnergy to models (V.Ivanchenko)
0054 // 10-05-06 Add a possibility to download user data (V.Ivantchenko)
0055 // 22-07-06 Remove obsolete method (V.Ivantchenko)
0056 // 07-11-07 Moved CorrectionsAlongStep to cc (V.Ivantchenko)
0057 // 12-09-08 Removed InitialiseMassCharge and CorrectionsAlongStep (VI)
0058 //
0059 // Class Description:
0060 //
0061 // This class manages the ionisation process for ions. Effective charge,
0062 // nuclear stopping power, energy loss corrections are taken into account.
0063 // It inherites from G4VEnergyLossLoss.
0064 //
0065
0066 // -------------------------------------------------------------------
0067 //
0068
0069 #ifndef G4ionIonisation_h
0070 #define G4ionIonisation_h 1
0071
0072 #include "G4VEnergyLossProcess.hh"
0073
0074 class G4Material;
0075
0076 class G4ionIonisation : public G4VEnergyLossProcess
0077 {
0078 public:
0079
0080   explicit G4ionIonisation(const G4String& name = "ionIoni");
0081
0082   ~G4ionIonisation() override = default;
0083
0084   G4bool IsApplicable(const G4ParticleDefinition& p) final;
0085
0086   void AddStoppingData(G4int Z, G4int A, const G4String& materialName,
0087                G4PhysicsVector* dVector);
0088
0089   void ActivateStoppingData(G4bool);
0090
0091   // print documentation in html format
0092   void ProcessDescription(std::ostream&) const override;
0093
0094   // hide assignment operator
0095   G4ionIonisation & operator=(const G4ionIonisation &right) = delete;
0096   G4ionIonisation(const G4ionIonisation&) = delete;
0097
0098 protected:
0099
0100   void InitialiseEnergyLossProcess(const G4ParticleDefinition*,
0101                    const G4ParticleDefinition*) override;
0102
0103   G4double MinPrimaryEnergy(const G4ParticleDefinition* p,
0104                 const G4Material*, G4double cut) final;
0105
0106   inline G4double BetheBlochEnergyThreshold();
0107
0108 private:
0109
0110
0111   const G4ParticleDefinition* theParticle = nullptr;
0112   G4double eth;
0113
0114   G4bool isInitialised = false;
0115 };
0116
0117 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0118
0119 inline G4double G4ionIonisation::BetheBlochEnergyThreshold()
0120 {
0121   return eth;
0122 }
0123
0124 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo....
0125
0126 #endif