include/Geant4/G4VIonDEDXTable.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 // GEANT4 class header file
0028 //
0029 // Class:                G4VIonDEDXTable
0030 //
0031 // Author:               Anton Lechner (Anton.Lechner@cern.ch)
0032 //
0033 // First implementation: 15. 02. 2009
0034 //
0035 // Modifications:
0036 // 02. 11. 2009 A. Lechner: Added BuildPhysicsVector function which should
0037 //              invoke the build process of physics vectors.
0038 //
0039 // Class description:
0040 //    Base class for electronic stopping power tables for ions.
0041 //
0042 // Comments:
0043 //
0044 // ===========================================================================
0045
0046 #ifndef G4VIONDEDXTABLE_HH
0047 #define G4VIONDEDXTABLE_HH
0048
0049 #include "globals.hh"
0050
0051 class G4PhysicsVector;
0052
0053 class G4VIonDEDXTable
0054 {
0055  public:
0056   explicit G4VIonDEDXTable() = default;
0057   virtual ~G4VIonDEDXTable() = default;
0058   G4VIonDEDXTable(G4VIonDEDXTable&) = delete;
0059   const G4VIonDEDXTable& operator=(const G4VIonDEDXTable&) = delete;
0060
0061   // Function for building a stopping power table for a material consisting of
0062   // a single element only.
0063   virtual G4bool BuildPhysicsVector(G4int,  // Atomic number of ion
0064     G4int  // Atomic number of elemental material
0065     ) = 0;
0066
0067   // Function building stopping power table for a given ion-material pair.
0068   virtual G4bool BuildPhysicsVector(G4int,  // Atomic number of ion
0069     const G4String&  // Name or chemical formula of material
0070     ) = 0;
0071
0072   // Function for checking the availability of stopping power tables
0073   // for a given ion-material pair, where the material consists of
0074   // a single element only.
0075   virtual G4bool IsApplicable(G4int,  // Atomic number of ion
0076     G4int  // Atomic number of elemental material
0077     ) = 0;
0078
0079   // Function for checking the availability of stopping power tables
0080   // for a given ion-material pair.
0081   virtual G4bool IsApplicable(G4int,  // Atomic number of ion
0082     const G4String&  // Name or chemical formula of material
0083     ) = 0;
0084
0085   // Function returning the stopping power vector for a given ion-material
0086   // pair, where the material consists of a single element only (the
0087   // physics vector returned by this function must contain the kinetic
0088   // energy per nucleon vs the mass stopping power of the elemental material).
0089   virtual G4PhysicsVector* GetPhysicsVector(G4int,  // Atomic number of ion
0090     G4int  // Atomic number of elemental material
0091     ) = 0;
0092
0093   // Function returning the stopping power vector for given ion-material
0094   // pair (the physics vector returned by this function must contain the
0095   // kinetic energy per nucleon vs the mass stopping power of the material).
0096   virtual G4PhysicsVector* GetPhysicsVector(G4int,  // Atomic number of ion
0097     const G4String&  // Name or chemical formula of material
0098     ) = 0;
0099 };
0100
0101 #endif  // G4VIONDEDXTABLE_HH