include/Geant4/G4MuonicAtom.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 // G4MuonicAtom
0027
0028 // Author: K. Lynch, July 2016
0029 // Revision:
0030 // - June 2017, K.L. Genser - added baseion, lifetimes and access functions
0031 // --------------------------------------------------------------------
0032 #ifndef G4MuonicAtom_hh
0033 #define G4MuonicAtom_hh 1
0034
0035 #include "G4Ions.hh"
0036
0037 class G4MuonicAtom : public G4Ions
0038 {
0039   public:
0040     // clang-format off
0041     G4MuonicAtom(
0042                const G4String&     aName,        G4double            mass,
0043                G4double            width,        G4double            charge,
0044                G4int               iSpin,        G4int               iParity,
0045                G4int               iConjugation, G4int               iIsospin,
0046                G4int               iIsospin3,    G4int               gParity,
0047                const G4String&     pType,        G4int               lepton,
0048                G4int               baryon,       G4int               encoding,
0049                G4bool              stable,       G4double            lifeTime,
0050                G4DecayTable        *decaytable,  G4bool              shortlived,
0051                const G4String&     subType,      G4Ions const*       baseion,
0052                G4int               anti_encoding  =0,
0053                G4double            excitation = 0.0,
0054                G4int               isomer = 0,
0055                G4double            DIOLifeTime = -1.0,
0056                G4double            NCLifeTime = -1.0
0057                );
0058     // clang-format on
0059
0060     ~G4MuonicAtom() override = default;
0061     G4MuonicAtom* MuonicAtomDefinition();
0062     G4MuonicAtom* MuonicAtom();
0063     G4Ions const* GetBaseIon() const;
0064     G4double GetDIOLifeTime() const;
0065     void SetDIOLifeTime(G4double lt);
0066     G4double GetNCLifeTime() const;
0067     void SetNCLifeTime(G4double lt);
0068
0069   protected:
0070     G4MuonicAtom() {}
0071
0072   private:
0073     G4Ions const* baseIon = nullptr;
0074     G4double fDIOLifeTime = 0.0;
0075     G4double fNCLifeTime = 0.0;
0076 };
0077
0078 // ------------------------
0079 // Inline methods
0080 // ------------------------
0081
0082 inline G4MuonicAtom* G4MuonicAtom::MuonicAtomDefinition()
0083 {
0084   return this;
0085 }
0086
0087 inline G4MuonicAtom* G4MuonicAtom::MuonicAtom()
0088 {
0089   return this;
0090 }
0091
0092 inline G4Ions const* G4MuonicAtom::GetBaseIon() const
0093 {
0094   return baseIon;
0095 }
0096
0097 inline G4double G4MuonicAtom::GetDIOLifeTime() const
0098 {
0099   return fDIOLifeTime;
0100 }
0101
0102 inline void G4MuonicAtom::SetDIOLifeTime(G4double lt)
0103 {
0104   fDIOLifeTime = lt;
0105 }
0106
0107 inline G4double G4MuonicAtom::GetNCLifeTime() const
0108 {
0109   return fNCLifeTime;
0110 }
0111
0112 inline void G4MuonicAtom::SetNCLifeTime(G4double lt)
0113 {
0114   fNCLifeTime = lt;
0115 }
0116
0117 #endif