include/Geant4/G4VIonDEDXScalingAlgorithm.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 // Class:                G4VIonDEDXScalingAlgorithm
0032 //
0033 // Author:               Anton Lechner (Anton.Lechner@cern.ch)
0034 //
0035 // First implementation: 11. 03. 2009
0036 //
0037 // Modifications: 12. 11. 2009 - Added second argument (material) to energy
0038 //                               scaling function (AL)
0039 //
0040 // Class description:
0041 //    Base class for dE/dx scaling algorithms, used by G4IonDEDXHandler
0042 //
0043 // Comments:
0044 //
0045 // ===========================================================================
0046
0047 #ifndef G4VIONDEDXSCALINGALGORITHM_HH
0048 #define G4VIONDEDXSCALINGALGORITHM_HH
0049
0050 #include "globals.hh"
0051 #include "G4ParticleDefinition.hh"
0052
0053 class G4Material;
0054
0055 class G4VIonDEDXScalingAlgorithm {
0056  public:
0057   explicit G4VIonDEDXScalingAlgorithm();
0058   virtual ~G4VIonDEDXScalingAlgorithm();
0059
0060   /// Function for scaling the kinetic energy (no scaling by default).
0061   /// Returns scaling factor for a given ion.
0062   virtual G4double ScalingFactorEnergy(
0063                        const G4ParticleDefinition*,     // Projectile (ion)
0064                        const G4Material*)               // Target material
0065   { return 1.0; }
0066
0067   /// Function for scaling the dE/dx value (no scaling by default).
0068   /// Returns scaling factor for a given ion-material couple and
0069   /// a given kinetic energy.
0070   virtual G4double ScalingFactorDEDX(
0071                      const G4ParticleDefinition*,     // Projectile (ion)
0072                      const G4Material*,               // Target material
0073                      G4double)                        // Kinetic energy of projectile
0074   { return 1.0; }
0075
0076   /// Function for defining a base particle for dE/dx calculation.
0077   /// (no base particle by default). Returns atomic number of base
0078   /// particle.
0079   virtual G4int AtomicNumberBaseIon(
0080                     G4int atomicNumberIon,           // Atomic number of ion
0081                     const G4Material*)               // Target material
0082   { return atomicNumberIon; }
0083
0084 };
0085
0086 #endif