BDSElectronQuantumLevel.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSELECTRONQUANTUMLEVEL_H
#define BDSELECTRONQUANTUMLEVEL_H
#include "G4Types.hh"
 
class BDSElectronQuantumLevel
{
public:
        BDSElectronQuantumLevel() = delete;
        BDSElectronQuantumLevel(G4int n, G4int l, G4double j);
        ~BDSElectronQuantumLevel() = default;
 
        G4double DiracEnergyNJ(G4int n, G4int j) const;
        void AddElectrons(G4int number);
        void RemoveElectrons(G4int number);
 
        // setters
        inline void SetnPrincipleNumber(G4int nPrincipleNumberIn)       {nPrincipleNumber=nPrincipleNumberIn;}
        inline void SetlAngularNumber(G4int lAngularNumberIn)   {lAngularNumber=lAngularNumberIn;}
        inline void SetExcitedLifetime(G4double excitedLifetimeIn) {excitedLifetime=excitedLifetimeIn;}
        inline void SetTimeOfExcitement(G4double timeOfExcitementIn) {timeOfExcitement=timeOfExcitementIn;}
 
        // getters
        inline G4int    GetnPrincipleNumnber() const {return nPrincipleNumber;}
        inline G4int    GetlAngularNumber() const {return lAngularNumber;}
        inline G4double GetjSpinOrbitCoupling() const {return jSpinOrbitCoupling;}
        inline G4int    GetMaxOccupancy() const {return maxOccupancy;}
        inline G4int    GetCurrentOccupancy()   const {return currentOccupancy;}
        inline G4double GetLevelEnergy() const {return levelEnergy;}
        inline G4double GetExcitedLifetime() const {return excitedLifetime;}
        inline G4double GetTimeOfExcitement()   const   {return timeOfExcitement;}
 
private:
        G4int    nPrincipleNumber;
        G4int    lAngularNumber;
        G4double jSpinOrbitCoupling;
        G4double levelEnergy;
        G4int    maxOccupancy;
        G4int    currentOccupancy;
        G4double excitedLifetime;
        G4double timeOfExcitement;
};
 
#endif