include/Geant4/G4PenelopeOscillator.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 // Author: Luciano Pandola
0028 //
0029 // History:
0030 // -----------
0031 // 18 Dec 2008   L. Pandola   First implementation
0032 //
0033 //
0034 // -------------------------------------------------------------------
0035 //
0036 // Class description:
0037 // Class designed to contain data of atomic oscillators that are used by
0038 // several Penelope models. Objects of G4PenelopeOscillators are managed
0039 // by a dedicated G4PenelopeOscillatorManager.
0040 // -------------------------------------------------------------------
0041
0042 #ifndef G4PENELOPEOSCILLATOR_HH
0043 #define G4PENELOPEOSCILLATOR_HH 1
0044
0045 #include "globals.hh"
0046
0047 class G4PenelopeOscillator
0048 {
0049  public:
0050   explicit G4PenelopeOscillator();
0051   G4PenelopeOscillator(const G4PenelopeOscillator&);
0052
0053   ~G4PenelopeOscillator(){;};
0054
0055   //I need to overload the following operators: > < == =
0056   G4PenelopeOscillator& operator=(const G4PenelopeOscillator&);
0057   G4bool operator==(const G4PenelopeOscillator&) const;
0058   G4bool operator>(const G4PenelopeOscillator&) const;
0059   G4bool operator<(const G4PenelopeOscillator&) const;
0060
0061   //Setters and getters
0062   G4double GetHartreeFactor() {return fHartreeFactor;};
0063   void SetHartreeFactor(G4double hf) {fHartreeFactor = hf;};
0064   //
0065   G4double GetIonisationEnergy() {return fIonisationEnergy;};
0066   void SetIonisationEnergy(G4double ie) {fIonisationEnergy = ie;};
0067   //
0068   G4double GetResonanceEnergy() const {return fResonanceEnergy;};
0069   void SetResonanceEnergy(G4double re) {fResonanceEnergy = re;};
0070   //
0071   G4double GetOscillatorStrength() {return fOscillatorStrength;};
0072   void SetOscillatorStrength(G4double ostr) {fOscillatorStrength=ostr;};
0073   //
0074   G4int GetShellFlag() {return fShellFlag;};
0075   void SetShellFlag(G4int theflag) {fShellFlag=theflag;};
0076   //
0077   G4double GetParentZ() {return fParentZ;};
0078   void SetParentZ(G4double parZ) {fParentZ = parZ;};
0079   //
0080   G4int GetParentShellID() {return fParentShellID;};
0081   void SetParentShellID(G4int psID) {fParentShellID = psID;};
0082   //
0083   G4double GetCutoffRecoilResonantEnergy(){return fCutoffRecoilResonantEnergy;};
0084   void SetCutoffRecoilResonantEnergy(G4double ene){fCutoffRecoilResonantEnergy = ene;};
0085
0086 private:
0087   G4double fHartreeFactor;
0088   G4double fIonisationEnergy;
0089   G4double fResonanceEnergy;
0090   G4double fOscillatorStrength;
0091   G4double fParentZ;
0092   G4double fCutoffRecoilResonantEnergy;
0093   G4int fParentShellID; //necessary for interface to AtomicDeexcitationManager
0094   G4int fShellFlag;
0095 };
0096
0097 struct G4PenelopeOscillatorResEnergyComparator
0098 {
0099 public:
0100   G4int operator()(const G4PenelopeOscillator& left,
0101          const G4PenelopeOscillator& right)
0102   {return ((left.GetResonanceEnergy() < right.GetResonanceEnergy()) ? 1 : 0);};
0103 };
0104
0105 #endif
0106