G4InuclNuclei Class Reference

#include <G4InuclNuclei.hh>

Inheritance diagram for G4InuclNuclei:

Public Member Functions
	G4InuclNuclei ()
	G4InuclNuclei (const G4DynamicParticle &dynPart, Model model=DefaultModel)
	G4InuclNuclei (G4int a, G4int z, G4double exc=0., Model model=DefaultModel)
	G4InuclNuclei (const G4LorentzVector &mom, G4int a, G4int z, G4double exc=0., Model model=DefaultModel)
	G4InuclNuclei (G4double ekin, G4int a, G4int z, G4double exc, Model model=DefaultModel)
	G4InuclNuclei (const G4Fragment &aFragment, Model model=DefaultModel)
	G4InuclNuclei (G4V3DNucleus *a3DNucleus, Model model=DefaultModel)
virtual	~G4InuclNuclei ()
	G4InuclNuclei (const G4InuclNuclei &right)
G4InuclNuclei &	operator= (const G4InuclNuclei &right)
bool	operator== (const G4InuclNuclei &right)
void	fill (G4int a, G4int z, G4double exc=0., Model model=DefaultModel)
void	fill (const G4LorentzVector &mom, G4int a, G4int z, G4double exc=0., Model model=DefaultModel)
void	fill (G4double ekin, G4int a, G4int z, G4double exc, Model model=DefaultModel)
void	copy (const G4Fragment &aFragment, Model model=DefaultModel)
void	copy (G4V3DNucleus *a3DNucleus, Model model=DefaultModel)
void	clear ()
void	setExitationEnergy (G4double e)
void	setExitonConfiguration (const G4ExitonConfiguration &config)
void	clearExitonConfiguration ()
G4int	getA () const
G4int	getZ () const
G4double	getNucleiMass () const
G4double	getExitationEnergy () const
G4double	getExitationEnergyInGeV () const
const G4ExitonConfiguration &	getExitonConfiguration () const
virtual void	print (std::ostream &os) const
G4Fragment	makeG4Fragment () const
	operator G4Fragment () const
Public Member Functions inherited from G4InuclParticle
	G4InuclParticle ()
	G4InuclParticle (const G4DynamicParticle &dynPart, Model model=DefaultModel)
	G4InuclParticle (const G4LorentzVector &mom, Model model=DefaultModel)
virtual	~G4InuclParticle ()
	G4InuclParticle (const G4InuclParticle &right)
G4InuclParticle &	operator= (const G4InuclParticle &right)
bool	operator== (const G4InuclParticle &right)
bool	operator!= (const G4InuclParticle &right)
void	setEnergy ()
void	setMomentum (const G4LorentzVector &mom)
void	setKineticEnergy (G4double ekin)
void	setMass (G4double mass)
G4double	getMass () const
G4double	getCharge () const
G4double	getKineticEnergy () const
G4double	getEnergy () const
G4double	getMomModule () const
G4LorentzVector	getMomentum () const
G4ParticleDefinition *	getDefinition () const
const G4DynamicParticle &	getDynamicParticle () const
void	setModel (Model model)
Model	getModel () const

Static Public Member Functions
static G4double	getNucleiMass (G4int a, G4int z, G4double exc=0.)

Static Protected Member Functions
static G4ParticleDefinition *	makeDefinition (G4int a, G4int z)
static G4ParticleDefinition *	makeNuclearFragment (G4int a, G4int z)

Additional Inherited Members
Public Types inherited from G4InuclParticle
enum	Model {   DefaultModel, bullet, target, EPCollider,   INCascader, NonEquilib, Equilib, Fissioner,   BigBanger, PreCompound, Coalescence }
Protected Member Functions inherited from G4InuclParticle
	G4InuclParticle (G4ParticleDefinition *pd, Model model=DefaultModel)
	G4InuclParticle (G4ParticleDefinition *pd, const G4LorentzVector &mom, Model model=DefaultModel)
	G4InuclParticle (G4ParticleDefinition *pd, G4double ekin, Model model=DefaultModel)
void	setDefinition (G4ParticleDefinition *pd)

Detailed Description

Definition at line 68 of file G4InuclNuclei.hh.

Constructor & Destructor Documentation

G4InuclNuclei::G4InuclNuclei ( )

inline

Definition at line 70 of file G4InuclNuclei.hh.

: G4InuclParticle() {}

G4InuclNuclei::G4InuclNuclei ( const G4DynamicParticle &  dynPart, Model  model = DefaultModel  )

inline

Definition at line 72 of file G4InuclNuclei.hh.

    : G4InuclParticle(dynPart, model) {}

G4InuclNuclei::G4InuclNuclei ( G4int  a, G4int  z, G4double  exc = 0., Model  model = DefaultModel  )

inline

Definition at line 75 of file G4InuclNuclei.hh.

References setExitationEnergy().

    : G4InuclParticle(makeDefinition(a,z), model) {
    setExitationEnergy(exc);
  }

G4InuclNuclei::G4InuclNuclei ( const G4LorentzVector &  mom, G4int  a, G4int  z, G4double  exc = 0., Model  model = DefaultModel  )

inline

Definition at line 80 of file G4InuclNuclei.hh.

References setExitationEnergy().

    : G4InuclParticle(makeDefinition(a,z), mom, model) {
    setExitationEnergy(exc);
  }

G4InuclNuclei::G4InuclNuclei ( G4double  ekin, G4int  a, G4int  z, G4double  exc, Model  model = DefaultModel  )

inline

Definition at line 86 of file G4InuclNuclei.hh.

References setExitationEnergy().

    : G4InuclParticle(makeDefinition(a,z), ekin, model) {
    setExitationEnergy(exc);
  }

G4InuclNuclei::G4InuclNuclei	(	const G4Fragment &	aFragment,
		G4InuclParticle::Model	model = DefaultModel
	)

Definition at line 80 of file G4InuclNuclei.cc.

References copy().

  : G4InuclParticle() {
  copy(aFragment, model);
}

G4InuclNuclei::G4InuclNuclei	(	G4V3DNucleus *	a3DNucleus,
		G4InuclParticle::Model	model = DefaultModel
	)

Definition at line 126 of file G4InuclNuclei.cc.

References copy().

  : G4InuclParticle() {
  copy(a3DNucleus, model);
}

virtual G4InuclNuclei::~G4InuclNuclei ( )

inlinevirtual

Definition at line 96 of file G4InuclNuclei.hh.

{}

G4InuclNuclei::G4InuclNuclei ( const G4InuclNuclei &  right )

inline

Definition at line 99 of file G4InuclNuclei.hh.

    : G4InuclParticle(right),
      theExitonConfiguration(right.theExitonConfiguration) {}

Member Function Documentation

void G4InuclNuclei::clear

(

void

)

Definition at line 173 of file G4InuclNuclei.cc.

References clearExitonConfiguration(), G4InuclParticle::DefaultModel, G4InuclParticle::setDefinition(), and G4InuclParticle::setModel().

                          {
  setDefinition(0);
  clearExitonConfiguration();
  setModel(G4InuclParticle::DefaultModel);
}

void G4InuclNuclei::clearExitonConfiguration ( )

inline

Definition at line 135 of file G4InuclNuclei.hh.

References G4ExitonConfiguration::clear().

Referenced by clear(), and fill().

{ theExitonConfiguration.clear(); }

void G4InuclNuclei::copy	(	const G4Fragment &	aFragment,
		Model	model = DefaultModel
	)

Definition at line 86 of file G4InuclNuclei.cc.

References fill(), G4Fragment::GetA_asInt(), G4Fragment::GetExcitationEnergy(), G4Fragment::GetMomentum(), G4Fragment::GetNumberOfCharged(), G4Fragment::GetNumberOfChargedHoles(), G4Fragment::GetNumberOfHoles(), G4Fragment::GetNumberOfParticles(), G4Fragment::GetZ_asInt(), python.hepunit::GeV, G4ExitonConfiguration::neutronHoles, G4ExitonConfiguration::neutronQuasiParticles, G4ExitonConfiguration::protonHoles, and G4ExitonConfiguration::protonQuasiParticles.

Referenced by G4InuclNuclei().

                                                                 {
  fill(aFragment.GetMomentum()/GeV, aFragment.GetA_asInt(),
       aFragment.GetZ_asInt(), aFragment.GetExcitationEnergy(), model);

  // Exciton configuration must be set by hand
  theExitonConfiguration.protonQuasiParticles = aFragment.GetNumberOfCharged();

  theExitonConfiguration.neutronQuasiParticles =
    aFragment.GetNumberOfParticles() - aFragment.GetNumberOfCharged();

  theExitonConfiguration.protonHoles = aFragment.GetNumberOfChargedHoles();

  theExitonConfiguration.neutronHoles =
    aFragment.GetNumberOfHoles() - theExitonConfiguration.protonHoles;
}

void G4InuclNuclei::copy	(	G4V3DNucleus *	a3DNucleus,
		Model	model = DefaultModel
	)

Definition at line 132 of file G4InuclNuclei.cc.

References G4Nucleon::AreYouHit(), G4Proton::Definition(), G4Neutron::Definition(), fill(), G4V3DNucleus::GetCharge(), G4V3DNucleus::GetMassNumber(), G4V3DNucleus::GetNextNucleon(), G4Nucleon::GetParticleType(), G4ExitonConfiguration::neutronHoles, G4ExitonConfiguration::protonHoles, and G4V3DNucleus::StartLoop().

                                                              {
  if (!a3DNucleus) return;      // Null pointer means no action

  fill(0., a3DNucleus->GetMassNumber(), a3DNucleus->GetCharge(), 0., model);

  // Convert every hit nucleon into an exciton hole
  if (a3DNucleus->StartLoop()) {
    G4Nucleon* nucl = 0;
    while ((nucl = a3DNucleus->GetNextNucleon())) {
      if (nucl->AreYouHit()) {  // Found previously interacted nucleon
    if (nucl->GetParticleType() == G4Proton::Definition())
      theExitonConfiguration.protonHoles++;

    if (nucl->GetParticleType() == G4Neutron::Definition())
      theExitonConfiguration.neutronHoles++;
      }
    }
  }
}

void G4InuclNuclei::fill ( G4int  a, G4int  z, G4double  exc = 0., Model  model = DefaultModel  )

inline

Definition at line 112 of file G4InuclNuclei.hh.

Referenced by copy(), G4CascadeInterface::createBullet(), G4IntraNucleiCascader::createTarget(), G4CascadeInterface::createTarget(), G4CascadeRecoilMaker::makeRecoilNuclei(), and G4IntraNucleiCascader::releaseSecondary().

                                                                         {
    fill(0., a, z, exc, model);
  }

void G4InuclNuclei::fill	(	const G4LorentzVector &	mom,
		G4int	a,
		G4int	z,
		G4double	exc = 0.,
		G4InuclParticle::Model	model = DefaultModel
	)

Definition at line 155 of file G4InuclNuclei.cc.

References clearExitonConfiguration(), makeDefinition(), G4InuclParticle::setDefinition(), setExitationEnergy(), G4InuclParticle::setModel(), and G4InuclParticle::setMomentum().

                                                       {
  setDefinition(makeDefinition(a,z));
  setMomentum(mom);
  setExitationEnergy(exc);
  clearExitonConfiguration();
  setModel(model);
}

void G4InuclNuclei::fill	(	G4double	ekin,
		G4int	a,
		G4int	z,
		G4double	exc,
		G4InuclParticle::Model	model = DefaultModel
	)

Definition at line 164 of file G4InuclNuclei.cc.

References clearExitonConfiguration(), makeDefinition(), G4InuclParticle::setDefinition(), setExitationEnergy(), G4InuclParticle::setKineticEnergy(), and G4InuclParticle::setModel().

                                         {
  setDefinition(makeDefinition(a,z));
  setKineticEnergy(ekin);
  setExitationEnergy(exc);
  clearExitonConfiguration();
  setModel(model);
}

G4int G4InuclNuclei::getA ( ) const

inline

Definition at line 137 of file G4InuclNuclei.hh.

References G4ParticleDefinition::GetAtomicMass(), and G4InuclParticle::getDefinition().

Referenced by G4InuclCollider::collide(), G4CascadeCheckBalance::collide(), G4NucleiModel::generateModel(), G4CascadeColliderBase::inelasticInteractionPossible(), G4IntraNucleiCascader::initialize(), G4NucleiModel::initializeCascad(), makeG4Fragment(), print(), G4InteractionCase::set(), and G4IntraNucleiCascader::setupCascade().

{ return getDefinition()->GetAtomicMass(); }

G4double G4InuclNuclei::getExitationEnergy ( ) const

inline

Definition at line 144 of file G4InuclNuclei.hh.

References G4InuclParticle::getMass(), and getNucleiMass().

Referenced by getExitationEnergyInGeV(), and print().

                                      {
    return (getMass()-getNucleiMass())*CLHEP::GeV/CLHEP::MeV; // Always in MeV
  }

G4double G4InuclNuclei::getExitationEnergyInGeV ( ) const

inline

Definition at line 148 of file G4InuclNuclei.hh.

References getExitationEnergy().

{ return getExitationEnergy()/CLHEP::GeV; }

const G4ExitonConfiguration& G4InuclNuclei::getExitonConfiguration ( ) const

inline

Definition at line 150 of file G4InuclNuclei.hh.

                                                              {
    return theExitonConfiguration;
  }

G4double G4InuclNuclei::getNucleiMass ( ) const

inline

Definition at line 140 of file G4InuclNuclei.hh.

References G4InuclParticle::getDefinition(), and G4ParticleDefinition::GetPDGMass().

Referenced by G4NonEquilibriumEvaporator::deExcite(), G4Fissioner::deExcite(), G4EquilibriumEvaporator::deExcite(), G4CascadeRecoilMaker::deltaM(), getExitationEnergy(), G4CascadeDeexciteBase::makeFragment(), makeNuclearFragment(), G4CascadeRecoilMaker::makeRecoilFragment(), and setExitationEnergy().

                                 {
    return getDefinition()->GetPDGMass()*CLHEP::MeV/CLHEP::GeV; // From G4 to Bertini
  }

G4double G4InuclNuclei::getNucleiMass ( G4int  a, G4int  z, G4double  exc = 0.  )

static

Definition at line 272 of file G4InuclNuclei.cc.

References G4NucleiProperties::GetNuclearMass(), python.hepunit::GeV, and python.hepunit::MeV.

                                                                    {
  // Simple minded mass calculation use constants in CLHEP (all in MeV)
  G4double mass = G4NucleiProperties::GetNuclearMass(a,z) + exc;

  return mass*MeV/GeV;      // Convert from GEANT4 to Bertini units
}

G4int G4InuclNuclei::getZ ( ) const

inline

Definition at line 138 of file G4InuclNuclei.hh.

References G4ParticleDefinition::GetAtomicNumber(), and G4InuclParticle::getDefinition().

Referenced by G4InuclCollider::collide(), G4IntraNucleiCascader::generateCascade(), G4NucleiModel::generateModel(), G4CascadeColliderBase::inelasticInteractionPossible(), G4IntraNucleiCascader::initialize(), G4NucleiModel::initializeCascad(), makeG4Fragment(), print(), and G4IntraNucleiCascader::setupCascade().

{ return getDefinition()->GetAtomicNumber(); }

G4ParticleDefinition * G4InuclNuclei::makeDefinition ( G4int  a, G4int  z  )

staticprotected

Definition at line 200 of file G4InuclNuclei.cc.

References G4IonTable::GetIon(), G4ParticleTable::GetIonTable(), G4ParticleTable::GetParticleTable(), and makeNuclearFragment().

Referenced by fill().

                                                                    {
  // SPECIAL CASE:  (0,0) means create dummy without definition
  if (0 == a && 0 == z) return 0;

  G4ParticleTable* pTable = G4ParticleTable::GetParticleTable();
  G4ParticleDefinition *pd = pTable->GetIonTable()->GetIon(z, a, 0);

  // SPECIAL CASE:  Non-physical nuclear fragment, for final-state return
  if (!pd) pd = makeNuclearFragment(a,z);

  return pd;        // This could return a null pointer if above fails
}

G4Fragment G4InuclNuclei::makeG4Fragment

(

)

const

Definition at line 104 of file G4InuclNuclei.cc.

References getA(), G4InuclParticle::getMomentum(), getZ(), python.hepunit::GeV, G4ExitonConfiguration::neutronHoles, G4ExitonConfiguration::neutronQuasiParticles, G4ExitonConfiguration::protonHoles, G4ExitonConfiguration::protonQuasiParticles, G4Fragment::SetNumberOfExcitedParticle(), and G4Fragment::SetNumberOfHoles().

                                               {
  G4Fragment frag(getA(), getZ(), getMomentum()*GeV);   // From Bertini units

  // Note:  exciton configuration has to be set piece by piece
  frag.SetNumberOfHoles(theExitonConfiguration.protonHoles
            + theExitonConfiguration.neutronHoles,
            theExitonConfiguration.protonHoles);

  frag.SetNumberOfExcitedParticle(theExitonConfiguration.protonQuasiParticles 
          + theExitonConfiguration.neutronQuasiParticles,
          theExitonConfiguration.protonQuasiParticles);

  return frag;
}

G4ParticleDefinition * G4InuclNuclei::makeNuclearFragment ( G4int  a, G4int  z  )

staticprotected

Definition at line 225 of file G4InuclNuclei.cc.

References test::a, python.hepunit::eplus, G4cerr, G4endl, getNucleiMass(), G4IonTable::GetNucleusEncoding(), python.hepunit::GeV, G4TemplateAutoLock< M, L, U >::lock(), python.hepunit::MeV, G4ParticleDefinition::SetAntiPDGEncoding(), G4TemplateAutoLock< M, L, U >::unlock(), and z.

Referenced by makeDefinition().

                                                   {
  if (a<=0 || z<0 || a<z) {
    G4cerr << " >>> G4InuclNuclei::makeNuclearFragment() called with"
       << " impossible arguments A=" << a << " Z=" << z << G4endl;
    throw G4HadronicException(__FILE__, __LINE__,
                  "G4InuclNuclei impossible A/Z arguments");
  }

  G4int code = G4IonTable::GetNucleusEncoding(z, a);

  // Use local lookup table (see above) to maintain singletons
  // NOTE:  G4ParticleDefinitions don't need to be explicitly deleted
  //        (see comments in G4IonTable.cc::~G4IonTable)

  G4AutoLock fragListLock(&fragListMutex);
  if (fragmentList.find(code) != fragmentList.end()) return fragmentList[code];
  fragListLock.unlock();

  // Name string follows format in G4IonTable.cc::GetIonName(Z,A,E)
  std::stringstream zstr, astr;
  zstr << z;
  astr << a;
  
  G4String name = "Z" + zstr.str() + "A" + astr.str();
  
  G4double mass = getNucleiMass(a,z) *GeV/MeV;  // From Bertini to GEANT4 units
  
  //    Arguments for constructor are as follows
  //               name             mass          width         charge
  //             2*spin           parity  C-conjugation
  //          2*Isospin       2*Isospin3       G-parity
  //               type    lepton number  baryon number   PDG encoding
  //             stable         lifetime    decay table
  //             shortlived      subType    anti_encoding Excitation-energy
  
  G4Ions* fragPD = new G4Ions(name,       mass, 0., z*eplus,
                  0,          +1,   0,
                  0,          0,    0,
                  "nucleus",  0,    a, code,
                  true,   0.,   0,
                  true, "generic",  0,  0.);
  fragPD->SetAntiPDGEncoding(0);

  fragListLock.lock();          // Protect before saving new fragment
  return (fragmentList[code] = fragPD);     // Store in table for next lookup
}

G4InuclNuclei::operator G4Fragment

(

)

const

Definition at line 119 of file G4InuclNuclei.cc.

                                         {
  return makeG4Fragment();
}

G4InuclNuclei & G4InuclNuclei::operator=

(

const G4InuclNuclei &

right

)

Definition at line 280 of file G4InuclNuclei.cc.

References G4InuclParticle::operator=().

                                                                  {
  if (this != &right) {
    theExitonConfiguration = right.theExitonConfiguration;
    G4InuclParticle::operator=(right);
  }
  return *this;
}

bool G4InuclNuclei::operator== ( const G4InuclNuclei &  right )

inline

Definition at line 106 of file G4InuclNuclei.hh.

                                              {
    return ( G4InuclParticle::operator==(right) && 
         theExitonConfiguration == right.theExitonConfiguration );
  }

void G4InuclNuclei::print ( std::ostream &  os ) const

virtual

Reimplemented from G4InuclParticle.

Definition at line 290 of file G4InuclNuclei.cc.

References G4ExitonConfiguration::empty(), G4endl, getA(), G4InuclParticle::getDefinition(), getExitationEnergy(), G4InuclParticle::getMass(), G4ParticleDefinition::GetParticleName(), getZ(), and G4InuclParticle::print().

                                              {
  G4InuclParticle::print(os);
  os << G4endl << " Nucleus: " << getDefinition()->GetParticleName() 
     << " A " << getA() << " Z " << getZ() << " mass " << getMass()
     << " Eex (MeV) " << getExitationEnergy();

  if (!theExitonConfiguration.empty())
    os << G4endl << "         " << theExitonConfiguration;
}

void G4InuclNuclei::setExitationEnergy

(

G4double

e

)

Definition at line 182 of file G4InuclNuclei.cc.

References G4InuclParticle::getKineticEnergy(), G4InuclParticle::getMass(), getNucleiMass(), python.hepunit::GeV, python.hepunit::MeV, G4InuclParticle::setKineticEnergy(), and G4InuclParticle::setMass().

Referenced by G4InuclEvaporation::BreakItUp(), fill(), and G4InuclNuclei().

                                                 {
  G4double ekin = getKineticEnergy();       // Current kinetic energy

  G4double emass = getNucleiMass() + e*MeV/GeV; // From Bertini to G4 units

  // Directly compute new kinetic energy from old
  G4double ekin_new = std::sqrt(emass*emass + ekin*(2.*getMass()+ekin)) - emass;

  setMass(emass);          // Momentum is computed from mass and Ekin
  setKineticEnergy(ekin_new);
}

void G4InuclNuclei::setExitonConfiguration ( const G4ExitonConfiguration &  config )

inline

Definition at line 131 of file G4InuclNuclei.hh.

Referenced by G4CascadeRecoilMaker::makeRecoilNuclei().

                                                                   { 
    theExitonConfiguration = config;
  }

---

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

• G4InuclNuclei.hh
• G4InuclNuclei.cc