include/Geant4/G4FermiParticle.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 // G4FermiBreakUpAN alternative de-excitation model
0028 // by A. Novikov (January 2025)
0029 //
0030
0031 #ifndef G4FERMIPARTICLE_HH
0032 #define G4FERMIPARTICLE_HH
0033
0034 #include "G4FermiDataTypes.hh"
0035
0036 class G4FermiParticle
0037 {
0038   public:
0039     G4FermiParticle() = delete;
0040
0041     G4FermiParticle(const G4FermiParticle&) = default;
0042     G4FermiParticle(G4FermiParticle&&) = default;
0043
0044     G4FermiParticle& operator=(const G4FermiParticle&) = default;
0045     G4FermiParticle& operator=(G4FermiParticle&&) = default;
0046
0047     G4FermiParticle(G4FermiAtomicMass atomicMass, G4FermiChargeNumber chargeNumber,
0048                     const G4LorentzVector& momentum);
0049
0050     G4FermiAtomicMass GetAtomicMass() const;
0051
0052     G4FermiChargeNumber GetChargeNumber() const;
0053
0054     const G4LorentzVector& GetMomentum() const;
0055
0056     G4double GetExcitationEnergy() const;
0057
0058     G4bool IsStable() const;
0059
0060   private:
0061     void RecalculateExcitationEnergy();
0062
0063     G4FermiAtomicMass atomicMass_;
0064     G4FermiChargeNumber chargeNumber_;
0065     G4LorentzVector momentum_;
0066
0067     G4double excitationEnergy_ = 0;
0068 };
0069
0070 namespace std
0071 {
0072 ostream& operator<<(ostream&, const G4FermiParticle&);
0073 }  // namespace std
0074
0075 #endif  // G4FERMIPARTICLE_HH