G4Ions Class Reference

#include <G4Ions.hh>

Inheritance diagram for G4Ions:

Public Types
enum class	G4FloatLevelBase {   no_Float = 0 , plus_X , plus_Y , plus_Z ,   plus_U , plus_V , plus_W , plus_R ,   plus_S , plus_T , plus_A , plus_B ,   plus_C , plus_D , plus_E }

Public Member Functions
	G4Ions (const G4String &aName, G4double mass, G4double width, G4double charge, G4int iSpin, G4int iParity, G4int iConjugation, G4int iIsospin, G4int iIsospin3, G4int gParity, const G4String &pType, G4int lepton, G4int baryon, G4int encoding, G4bool stable, G4double lifetime, G4DecayTable *decaytable, G4bool shortlived, const G4String &subType="", G4int anti_encoding=0, G4double excitation=0.0, G4int isomer=0)
	~G4Ions () override=default
G4Ions *	IonsDefinition ()
G4Ions *	Ions ()
G4double	GetExcitationEnergy () const
G4int	GetIsomerLevel () const
G4Ions::G4FloatLevelBase	GetFloatLevelBase () const
G4int	GetFloatLevelBaseIndex () const
void	SetFloatLevelBase (G4Ions::G4FloatLevelBase flb)
void	SetFloatLevelBase (char flbChar)
void	SetFloatLevelBase (G4int flbIdx)
Public Member Functions inherited from G4ParticleDefinition
	G4ParticleDefinition (const G4String &aName, G4double mass, G4double width, G4double charge, G4int iSpin, G4int iParity, G4int iConjugation, G4int iIsospin, G4int iIsospinZ, G4int gParity, const G4String &pType, G4int lepton, G4int baryon, G4int encoding, G4bool stable, G4double lifetime, G4DecayTable *decaytable, G4bool shortlived=false, const G4String &subType="", G4int anti_encoding=0, G4double magneticMoment=0.0)
virtual	~G4ParticleDefinition ()
	G4ParticleDefinition (const G4ParticleDefinition &)=delete
G4ParticleDefinition &	operator= (const G4ParticleDefinition &)=delete
G4bool	operator== (const G4ParticleDefinition &right) const
G4bool	operator!= (const G4ParticleDefinition &right) const
const G4String &	GetParticleName () const
G4double	GetPDGMass () const
G4double	GetPDGWidth () const
G4double	GetPDGCharge () const
G4double	GetPDGSpin () const
G4int	GetPDGiSpin () const
G4int	GetPDGiParity () const
G4int	GetPDGiConjugation () const
G4double	GetPDGIsospin () const
G4double	GetPDGIsospin3 () const
G4int	GetPDGiIsospin () const
G4int	GetPDGiIsospin3 () const
G4int	GetPDGiGParity () const
G4double	GetPDGMagneticMoment () const
void	SetPDGMagneticMoment (G4double mageticMoment)
G4double	CalculateAnomaly () const
const G4String &	GetParticleType () const
const G4String &	GetParticleSubType () const
G4int	GetLeptonNumber () const
G4int	GetBaryonNumber () const
G4int	GetPDGEncoding () const
G4int	GetAntiPDGEncoding () const
void	SetAntiPDGEncoding (G4int aEncoding)
G4int	GetQuarkContent (G4int flavor) const
G4int	GetAntiQuarkContent (G4int flavor) const
G4bool	IsShortLived () const
G4bool	GetPDGStable () const
void	SetPDGStable (const G4bool aFlag)
G4double	GetPDGLifeTime () const
void	SetPDGLifeTime (G4double aLifeTime)
G4double	GetIonLifeTime () const
G4DecayTable *	GetDecayTable () const
void	SetDecayTable (G4DecayTable *aDecayTable)
G4ProcessManager *	GetProcessManager () const
void	SetProcessManager (G4ProcessManager *aProcessManager)
G4VTrackingManager *	GetTrackingManager () const
void	SetTrackingManager (G4VTrackingManager *aTrackingManager)
G4ParticleTable *	GetParticleTable () const
G4int	GetAtomicNumber () const
G4int	GetAtomicMass () const
void	DumpTable () const
void	SetVerboseLevel (G4int value)
G4int	GetVerboseLevel () const
void	SetApplyCutsFlag (G4bool)
G4bool	GetApplyCutsFlag () const
G4bool	IsGeneralIon () const
G4bool	IsMuonicAtom () const
G4ProcessManager *	GetMasterProcessManager () const
void	SetMasterProcessManager (G4ProcessManager *aNewPM)
G4int	GetInstanceID () const
void	SetParticleDefinitionID (G4int id=-1)
G4int	GetParticleDefinitionID () const
G4bool	IsHypernucleus () const
G4int	GetNumberOfLambdasInHypernucleus () const
G4bool	IsAntiHypernucleus () const
G4int	GetNumberOfAntiLambdasInAntiHypernucleus () const

Static Public Member Functions
static G4Ions::G4FloatLevelBase	FloatLevelBase (char flbChar)
static G4Ions::G4FloatLevelBase	FloatLevelBase (G4int flbIdx)
static char	FloatLevelBaseChar (G4Ions::G4FloatLevelBase flb)
Static Public Member Functions inherited from G4ParticleDefinition
static const G4PDefManager &	GetSubInstanceManager ()
static void	Clean ()

Protected Member Functions
	G4Ions ()=default
Protected Member Functions inherited from G4ParticleDefinition
	G4ParticleDefinition ()
G4int	FillQuarkContents ()
void	SetParticleSubType (const G4String &subtype)
void	SetAtomicNumber (G4int)
void	SetAtomicMass (G4int)

Additional Inherited Members
Protected Types inherited from G4ParticleDefinition
enum	{ NumberOfQuarkFlavor = 6 }
Protected Attributes inherited from G4ParticleDefinition
G4int	theQuarkContent [NumberOfQuarkFlavor]
G4int	theAntiQuarkContent [NumberOfQuarkFlavor]
G4bool	isGeneralIon = false
G4bool	isMuonicAtom = false

Detailed Description

Definition at line 47 of file G4Ions.hh.

Member Enumeration Documentation

G4FloatLevelBase

enum class G4Ions::G4FloatLevelBase

strong

Enumerator
no_Float
plus_X
plus_Y
plus_Z
plus_U
plus_V
plus_W
plus_R
plus_S
plus_T
plus_A
plus_B
plus_C
plus_D
plus_E

Definition at line 79 of file G4Ions.hh.

    {
      no_Float = 0,
      plus_X,
      plus_Y,
      plus_Z,
      plus_U,
      plus_V,
      plus_W,
      plus_R,
      plus_S,
      plus_T,
      plus_A,
      plus_B,
      plus_C,
      plus_D,
      plus_E
    };

Constructor & Destructor Documentation

G4Ions() [1/2]

G4Ions::G4Ions	(	const G4String &	aName,
		G4double	mass,
		G4double	width,
		G4double	charge,
		G4int	iSpin,
		G4int	iParity,
		G4int	iConjugation,
		G4int	iIsospin,
		G4int	iIsospin3,
		G4int	gParity,
		const G4String &	pType,
		G4int	lepton,
		G4int	baryon,
		G4int	encoding,
		G4bool	stable,
		G4double	lifetime,
		G4DecayTable *	decaytable,
		G4bool	shortlived,
		const G4String &	subType = "",
		G4int	anti_encoding = 0,
		G4double	excitation = 0.0,
		G4int	isomer = 0 )

Definition at line 41 of file G4Ions.cc.

  : G4ParticleDefinition( aName,mass,width,charge,iSpin,iParity,
                          iConjugation,iIsospin,iIsospin3,gParity,pType,
                          lepton,baryon,encoding,stable,lifetime,decaytable,
              shortlived, subType, anti_encoding),
    theExcitationEnergy(excitation),
    theIsomerLevel(isomer)
// clang-format on
{
  if ((aName == "proton") || (aName == "neutron")) {
    isGeneralIon = false;
  }
  else if ((aName == "GenericIon") || (aName == "alpha") || (aName == "He3")
           || (aName == "deuteron") || (aName == "triton"))
  {
    isGeneralIon = false;
  }
  else if ((aName == "anti_He3") || (aName == "anti_deuteron") || (aName == "anti_triton")
           || (aName == "anti_alpha"))
  {
    isGeneralIon = false;
  }
  else if ((aName == "iron") || (aName == "oxygen") || (aName == "nitrogen") || (aName == "carbon")
           || (aName == "helium") || (aName == "alpha+") || (aName == "hydrogen")
           || (aName == "Ps-1s") || (aName == "Ps-2s"))
  {
    isGeneralIon = false;
  }
  else if (aName == "hypertriton" || aName == "anti_hypertriton" || aName == "hyperalpha"
           || aName == "anti_hyperalpha" || aName == "hyperH4" || aName == "anti_hyperH4"
           || aName == "doublehyperH4" || aName == "anti_doublehyperH4"
           || aName == "doublehyperdoubleneutron" || aName == "anti_doublehyperdoubleneutron"
           || aName == "hyperHe5" || aName == "anti_hyperHe5")
  {
    isGeneralIon = false;
  }
  else {
    isGeneralIon = true;
  }
 
  // isomer level isset to 9
  // if isomer level is set to 0 for excited state
  //
  if ((theExcitationEnergy > 0.0) && (isomer == 0)) isomer = 9;
 
  if (GetAtomicNumber() == 0) {
    // AtomicNumber/Mass is positive even for anti_nulceus
    SetAtomicNumber(std::abs(G4int(GetPDGCharge() / eplus)));
    SetAtomicMass(std::abs(GetBaryonNumber()));
  }
}

~G4Ions()

G4Ions::~G4Ions ( )

overridedefault

G4Ions() [2/2]

G4Ions::G4Ions ( )

protecteddefault

Referenced by G4Alpha::Definition(), G4AntiAlpha::Definition(), G4AntiDeuteron::Definition(), G4AntiDoubleHyperDoubleNeutron::Definition(), G4AntiDoubleHyperH4::Definition(), G4AntiHe3::Definition(), G4AntiHyperAlpha::Definition(), G4AntiHyperH4::Definition(), G4AntiHyperHe5::Definition(), G4AntiHyperTriton::Definition(), G4AntiTriton::Definition(), G4Deuteron::Definition(), G4DoubleHyperDoubleNeutron::Definition(), G4DoubleHyperH4::Definition(), G4GenericIon::Definition(), G4He3::Definition(), G4HyperAlpha::Definition(), G4HyperH4::Definition(), G4HyperHe5::Definition(), G4HyperTriton::Definition(), G4Neutron::Definition(), G4Proton::Definition(), and G4Triton::Definition().

Member Function Documentation

FloatLevelBase() [1/2]

G4Ions::G4FloatLevelBase G4Ions::FloatLevelBase ( char flbChar )

static

Definition at line 107 of file G4Ions.cc.

{
  G4Ions::G4FloatLevelBase flb = noFloat;
  switch (flbChar) {
    case 'x':
    case 'X':
      flb = plusX;
      break;
    case 'y':
    case 'Y':
      flb = plusY;
      break;
    case 'z':
    case 'Z':
      flb = plusZ;
      break;
    case 'u':
    case 'U':
      flb = plusU;
      break;
    case 'v':
    case 'V':
      flb = plusV;
      break;
    case 'w':
    case 'W':
      flb = plusW;
      break;
    case 'r':
    case 'R':
      flb = plusR;
      break;
    case 's':
    case 'S':
      flb = plusS;
      break;
    case 't':
    case 'T':
      flb = plusT;
      break;
    case 'a':
    case 'A':
      flb = plusA;
      break;
    case 'b':
    case 'B':
      flb = plusB;
      break;
    case 'c':
    case 'C':
      flb = plusC;
      break;
    case 'd':
    case 'D':
      flb = plusD;
      break;
    case 'e':
    case 'E':
      flb = plusE;
      break;
    case '\0':
    default:
      break;
  }
  return flb;
}

Referenced by G4ExcitationHandler::BreakItUp(), G4IonTable::CreateIon(), G4ITDecay::DecayIt(), G4IonTable::FindIon(), G4IonTable::FindIon(), G4IonTable::FindIon(), G4IonTable::FindIon(), G4IonTable::GetIon(), G4IonTable::GetIon(), G4IonTable::GetLifeTime(), G4RadioactiveDecay::LoadDecayTable(), SetFloatLevelBase(), SetFloatLevelBase(), and G4IsotopeProperty::SetFloatLevelBase().

FloatLevelBase() [2/2]

G4Ions::G4FloatLevelBase G4Ions::FloatLevelBase ( G4int flbIdx )

static

Definition at line 174 of file G4Ions.cc.

{
  // clang-format off
  static G4Ions::G4FloatLevelBase flb[] = 
  { noFloat,
    plusX, plusY, plusZ, plusU, plusV, plusW, 
    plusR, plusS, plusT, plusA, plusB, plusC, plusD, plusE };
  // clang-format on
  return (flbIdx >= 0 && flbIdx < 15) ? flb[flbIdx] : flb[0];
}

FloatLevelBaseChar()

char G4Ions::FloatLevelBaseChar ( G4Ions::G4FloatLevelBase flb )

static

Definition at line 185 of file G4Ions.cc.

{
  // clang-format off
  static char flbChar[] = {'\0', 'X', 'Y', 'Z', 'U', 'V', 'W', 'R',
                           'S',  'T', 'A', 'B', 'C', 'D', 'E'};
  // clang-format on
  return flbChar[static_cast<G4int>(flb)];
}

Referenced by G4IonTable::CreateIon(), G4IsotopeProperty::DumpInfo(), and G4IonTable::GetIonName().

GetExcitationEnergy()

G4double G4Ions::GetExcitationEnergy ( ) const

inline

Definition at line 149 of file G4Ions.hh.

{
  return theExcitationEnergy;
}

Referenced by G4Radioactivation::CalculateChainsFromParent(), G4RadioactiveDecay::GetMeanLifeTime(), G4RadioactiveDecay::IsApplicable(), and G4RadioactiveDecay::LoadDecayTable().

GetFloatLevelBase()

G4Ions::G4FloatLevelBase G4Ions::GetFloatLevelBase ( ) const

inline

Definition at line 159 of file G4Ions.hh.

{
  return floatLevelBase;
}

Referenced by G4RadioactiveDecay::LoadDecayTable().

GetFloatLevelBaseIndex()

G4int G4Ions::GetFloatLevelBaseIndex ( ) const

inline

Definition at line 164 of file G4Ions.hh.

{
  return static_cast<G4int>(floatLevelBase);
}

GetIsomerLevel()

G4int G4Ions::GetIsomerLevel ( ) const

inline

Definition at line 154 of file G4Ions.hh.

{
  return theIsomerLevel;
}

Ions()

G4Ions * G4Ions::Ions ( )

inline

Definition at line 144 of file G4Ions.hh.

{
  return this;
}

IonsDefinition()

G4Ions * G4Ions::IonsDefinition ( )

inline

Definition at line 139 of file G4Ions.hh.

{
  return this;
}

SetFloatLevelBase() [1/3]

void G4Ions::SetFloatLevelBase ( char flbChar )

inline

Definition at line 174 of file G4Ions.hh.

{
  floatLevelBase = FloatLevelBase(flbChar);
}

SetFloatLevelBase() [2/3]

void G4Ions::SetFloatLevelBase ( G4int flbIdx )

inline

Definition at line 179 of file G4Ions.hh.

{
  floatLevelBase = FloatLevelBase(flbIdx);
}

SetFloatLevelBase() [3/3]

void G4Ions::SetFloatLevelBase ( G4Ions::G4FloatLevelBase flb )

inline

Definition at line 169 of file G4Ions.hh.

{
  floatLevelBase = flb;
}

Referenced by G4MuonicAtom::G4MuonicAtom().

---

The documentation for this class was generated from the following files:

• G4Ions.hh
• G4Ions.cc