#include <G4CascadeCoalescence.hh>

Public Member Functions
void	FindClusters (G4CollisionOutput &finalState)

	G4CascadeCoalescence (G4int verbose=0)

void	setVerboseLevel (G4int verbose)

virtual	~G4CascadeCoalescence ()

Private Types
typedef std::vector< size_t >	ClusterCandidate

Private Member Functions
bool	allNucleons (const ClusterCandidate &clus) const

G4int	clusterType (const ClusterCandidate &aCluster) const

void	createNuclei ()

void	fillCluster (size_t idx1, size_t idx2)

void	fillCluster (size_t idx1, size_t idx2, size_t idx3)

void	fillCluster (size_t idx1, size_t idx2, size_t idx3, size_t idx4)

G4LorentzVector	getClusterMomentum (const ClusterCandidate &aCluster) const

const G4InuclElementaryParticle &	getHadron (size_t idx) const

bool	goodCluster (const ClusterCandidate &clus) const

bool	makeLightIon (const ClusterCandidate &aCluster)

G4double	maxDeltaP (const ClusterCandidate &aCluster) const

bool	nucleonUsed (size_t idx) const

void	removeNucleons ()

void	reportArgs (const G4String &name, const ClusterCandidate &clus) const

void	reportResult (const G4String &name, const G4InuclNuclei &nucl) const

void	selectCandidates ()

void	tryClusters (size_t idx1, size_t idx2)

void	tryClusters (size_t idx1, size_t idx2, size_t idx3)

void	tryClusters (size_t idx1, size_t idx2, size_t idx3, size_t idx4)

Private Attributes
std::vector< ClusterCandidate >	allClusters

const G4double	dpMaxAlpha

const G4double	dpMaxDoublet

const G4double	dpMaxTriplet

G4LorentzVector	pCluster

ClusterCandidate	thisCluster

G4CollisionOutput *	thisFinalState

const std::vector< G4InuclElementaryParticle > *	thisHadrons

G4InuclNuclei	thisLightIon

std::set< size_t >	usedNucleons

G4int	verboseLevel

Detailed Description

Definition at line 52 of file G4CascadeCoalescence.hh.

Member Typedef Documentation

◆ ClusterCandidate

typedef std::vector<size_t> G4CascadeCoalescence::ClusterCandidate

private

Definition at line 63 of file G4CascadeCoalescence.hh.

Constructor & Destructor Documentation

◆ G4CascadeCoalescence()

G4CascadeCoalescence::G4CascadeCoalescence ( G4int verbose = 0 )

Definition at line 66 of file G4CascadeCoalescence.cc.

  : verboseLevel(verbose), thisFinalState(0), thisHadrons(0),
    dpMaxDoublet(G4CascadeParameters::dpMaxDoublet()),
    dpMaxTriplet(G4CascadeParameters::dpMaxTriplet()),
    dpMaxAlpha(G4CascadeParameters::dpMaxAlpha()) {}

◆ ~G4CascadeCoalescence()

G4CascadeCoalescence::~G4CascadeCoalescence ( )

virtual

Definition at line 72 of file G4CascadeCoalescence.cc.

72{}

Member Function Documentation

◆ allNucleons()

bool G4CascadeCoalescence::allNucleons ( const ClusterCandidate & clus ) const

private

Definition at line 287 of file G4CascadeCoalescence.cc.

                                                                         {
  bool result = true;
  for (size_t i=0; i<clus.size(); i++)
    result &= getHadron(clus[0]).nucleon();
  return result;
}

References getHadron(), and G4InuclElementaryParticle::nucleon().

Referenced by goodCluster().

◆ clusterType()

G4int G4CascadeCoalescence::clusterType ( const ClusterCandidate & aCluster ) const

private

Definition at line 247 of file G4CascadeCoalescence.cc.

                                                    {
  G4int type = 0;
  for (size_t i=0; i<aCluster.size(); i++) {
    const G4InuclElementaryParticle& had = getHadron(aCluster[i]);
    type += had.nucleon() ? had.type() : 0;
  }
 
  return type;
}

References getHadron(), G4InuclElementaryParticle::nucleon(), and G4InuclElementaryParticle::type().

Referenced by goodCluster(), and makeLightIon().

◆ createNuclei()

void G4CascadeCoalescence::createNuclei ( )

private

Definition at line 179 of file G4CascadeCoalescence.cc.

                                        {
  if (verboseLevel)
    G4cout << " >>> G4CascadeCoalescence::createNuclei()" << G4endl;
 
  usedNucleons.clear();
 
  for (size_t i=0; i<allClusters.size(); i++) {
    if (verboseLevel>1) G4cout << " attempting candidate #" << i << G4endl;
 
    const ClusterCandidate& cand = allClusters[i];
    if (makeLightIon(cand)) {           // Success, put ion in output
      thisFinalState->addOutgoingNucleus(thisLightIon);
      usedNucleons.insert(cand.begin(), cand.end());
    }
  }
}

References G4CollisionOutput::addOutgoingNucleus(), allClusters, G4cout, G4endl, makeLightIon(), thisFinalState, thisLightIon, usedNucleons, and verboseLevel.

Referenced by FindClusters().

◆ fillCluster() [1/3]

void G4CascadeCoalescence::fillCluster	(	size_t	idx1,
		size_t	idx2
	)

private

Definition at line 261 of file G4CascadeCoalescence.cc.

                                                               {
  thisCluster.clear();
  thisCluster.push_back(idx1);
  thisCluster.push_back(idx2);
}

References thisCluster.

Referenced by tryClusters().

◆ fillCluster() [2/3]

void G4CascadeCoalescence::fillCluster	(	size_t	idx1,
		size_t	idx2,
		size_t	idx3
	)

private

Definition at line 267 of file G4CascadeCoalescence.cc.

                                                                            {
  thisCluster.clear();
  thisCluster.push_back(idx1);
  thisCluster.push_back(idx2);
  thisCluster.push_back(idx3);
}

References thisCluster.

◆ fillCluster() [3/3]

void G4CascadeCoalescence::fillCluster	(	size_t	idx1,
		size_t	idx2,
		size_t	idx3,
		size_t	idx4
	)

private

Definition at line 274 of file G4CascadeCoalescence.cc.

                                   {
  thisCluster.clear();
  thisCluster.push_back(idx1);
  thisCluster.push_back(idx2);
  thisCluster.push_back(idx3);
  thisCluster.push_back(idx4);
}

References thisCluster.

◆ FindClusters()

void G4CascadeCoalescence::FindClusters ( G4CollisionOutput & finalState )

Definition at line 77 of file G4CascadeCoalescence.cc.

                                                                     {
  if (verboseLevel)
    G4cout << " >>> G4CascadeCoalescence::FindClusters()" << G4endl;
 
  thisFinalState = &finalState;     // Save pointers for use in processing
  thisHadrons = &finalState.getOutgoingParticles();
 
  if (verboseLevel>1) thisFinalState->printCollisionOutput();   // Before
 
  selectCandidates();
  createNuclei();
  removeNucleons();
 
  if (verboseLevel>1) thisFinalState->printCollisionOutput();   // After
}

References createNuclei(), G4cout, G4endl, G4CollisionOutput::getOutgoingParticles(), G4CollisionOutput::printCollisionOutput(), removeNucleons(), selectCandidates(), thisFinalState, thisHadrons, and verboseLevel.

Referenced by G4IntraNucleiCascader::finishCascade().

◆ getClusterMomentum()

G4LorentzVector G4CascadeCoalescence::getClusterMomentum ( const ClusterCandidate & aCluster ) const

private

Definition at line 215 of file G4CascadeCoalescence.cc.

                                                                               {
  pCluster.set(0.,0.,0.,0.);
  for (size_t i=0; i<aCluster.size(); i++)
    pCluster += getHadron(aCluster[i]).getMomentum();
 
  return pCluster;
}

References getHadron(), G4InuclParticle::getMomentum(), pCluster, and CLHEP::HepLorentzVector::set().

Referenced by makeLightIon(), and maxDeltaP().

◆ getHadron()

const G4InuclElementaryParticle & G4CascadeCoalescence::getHadron ( size_t idx ) const

inlineprivate

Definition at line 106 of file G4CascadeCoalescence.hh.

                                                               {
    return (*thisHadrons)[idx];
  }

References thisHadrons.

Referenced by allNucleons(), clusterType(), getClusterMomentum(), maxDeltaP(), reportArgs(), and selectCandidates().

◆ goodCluster()

bool G4CascadeCoalescence::goodCluster ( const ClusterCandidate & clus ) const

private

Definition at line 297 of file G4CascadeCoalescence.cc.

                                                                         {
  if (verboseLevel>2) reportArgs("goodCluster?",clus);
 
  if (!allNucleons(clus)) return false;
 
  if (clus.size() == 2)                 // Deuterons (pn)
    return (clusterType(clus) == 3 && maxDeltaP(clus) < dpMaxDoublet);
 
  if (clus.size() == 3)                 // Tritons or He-3
    return ((clusterType(clus) == 4 || clusterType(clus) == 5)  // ppn OR pnn
        && maxDeltaP(clus) < dpMaxTriplet);
 
  if (clus.size() == 4)                 // Alphas (ppnn)
    return (clusterType(clus) == 6 && maxDeltaP(clus) < dpMaxAlpha);
 
  return false;
}

References allNucleons(), clusterType(), dpMaxAlpha, dpMaxDoublet, dpMaxTriplet, maxDeltaP(), reportArgs(), and verboseLevel.

Referenced by tryClusters().

◆ makeLightIon()

bool G4CascadeCoalescence::makeLightIon ( const ClusterCandidate & aCluster )

private

Definition at line 319 of file G4CascadeCoalescence.cc.

                                                                        {
  if (verboseLevel>1) reportArgs("makeLightIon",aCluster);
 
  thisLightIon.clear();     // Initialize nucleus buffer before filling
 
  if (aCluster.size()<2) return false;      // Sanity check
 
  G4int A = aCluster.size();
  G4int Z = -1;
 
  G4int type = clusterType(aCluster);
  if (A==2 && type==3) Z = 1;       // Deuteron (pn)
  if (A==3 && type==5) Z = 1;       // Triton (pnn)
  if (A==3 && type==4) Z = 2;       // He-3 (ppn)
  if (A==4 && type==6) Z = 2;       // He-4/alpha (ppnn)
 
  if (Z < 0) return false;      // Invalid cluster content
 
  // NOTE:  Four-momentum will not be conserved due to binding energy
  thisLightIon.fill(getClusterMomentum(aCluster), A, Z, 0.,
            G4InuclParticle::Coalescence);
 
  if (verboseLevel>1) reportResult("makeLightIon output",thisLightIon);
  return true;
}

References A, G4InuclNuclei::clear(), clusterType(), G4InuclParticle::Coalescence, G4InuclNuclei::fill(), getClusterMomentum(), reportArgs(), reportResult(), thisLightIon, verboseLevel, and Z.

Referenced by createNuclei().

◆ maxDeltaP()

G4double G4CascadeCoalescence::maxDeltaP ( const ClusterCandidate & aCluster ) const

private

Definition at line 226 of file G4CascadeCoalescence.cc.

                                                                               {
  if (verboseLevel>1) reportArgs("maxDeltaP", aCluster);
 
  G4ThreeVector boost = getClusterMomentum(aCluster).boostVector();
 
  G4double dp, maxDP = -1.;
  for (size_t i=0; i<aCluster.size(); i++) {
    const G4InuclElementaryParticle& nucl = getHadron(aCluster[i]);
 
    // NOTE:  getMomentum() returns by value, event kinematics are not changed
    if ((dp = nucl.getMomentum().boost(-boost).rho()) > maxDP) maxDP = dp;
  }
 
  if (verboseLevel>1) G4cout << " maxDP = " << maxDP << G4endl;
 
  return maxDP;
}

References CLHEP::HepLorentzVector::boost(), CLHEP::HepLorentzVector::boostVector(), G4cout, G4endl, getClusterMomentum(), getHadron(), G4InuclParticle::getMomentum(), reportArgs(), CLHEP::HepLorentzVector::rho(), and verboseLevel.

Referenced by goodCluster().

◆ nucleonUsed()

bool G4CascadeCoalescence::nucleonUsed ( size_t idx ) const

inlineprivate

Definition at line 96 of file G4CascadeCoalescence.hh.

                                     {
    return usedNucleons.find(idx) != usedNucleons.end();
  }

References usedNucleons.

Referenced by tryClusters().

◆ removeNucleons()

void G4CascadeCoalescence::removeNucleons ( )

private

Definition at line 199 of file G4CascadeCoalescence.cc.

                                          {
  if (verboseLevel>1)
    G4cout << " >>> G4CascadeCoalescence::removeNucleons()" << G4endl;
 
  // Remove nucleons from output from last to first (to preserve indexing)
  std::set<size_t>::reverse_iterator usedIter;
  for (usedIter = usedNucleons.rbegin(); usedIter != usedNucleons.rend(); ++usedIter)
    thisFinalState->removeOutgoingParticle(*usedIter);
 
  usedNucleons.clear();
}

References G4cout, G4endl, G4CollisionOutput::removeOutgoingParticle(), thisFinalState, usedNucleons, and verboseLevel.

Referenced by FindClusters().

◆ reportArgs()

void G4CascadeCoalescence::reportArgs	(	const G4String &	name,
		const ClusterCandidate &	clus
	)		const

private

Definition at line 348 of file G4CascadeCoalescence.cc.

                                                              {
  G4cout << " >>> G4CascadeCoalescence::" << name << " ";
  std::copy(aCluster.begin(), aCluster.end(),
        std::ostream_iterator<size_t>(G4cout, " "));
  G4cout << G4endl;
 
  if (verboseLevel>2) {
    for (size_t i=0; i<aCluster.size(); i++)
      G4cout << getHadron(aCluster[i]) << G4endl;
  }
}

References field_utils::copy(), G4cout, G4endl, getHadron(), G4InuclParticleNames::name(), and verboseLevel.

Referenced by goodCluster(), makeLightIon(), maxDeltaP(), and tryClusters().

◆ reportResult()

void G4CascadeCoalescence::reportResult	(	const G4String &	name,
		const G4InuclNuclei &	nucl
	)		const

private

Definition at line 361 of file G4CascadeCoalescence.cc.

                                                     {
  G4cout << " >>> G4CascadeCoalescence::" << name << G4endl << nucl << G4endl;
}

References G4cout, G4endl, and G4InuclParticleNames::name().

Referenced by makeLightIon().

◆ selectCandidates()

void G4CascadeCoalescence::selectCandidates ( )

private

Definition at line 96 of file G4CascadeCoalescence.cc.

                                            {
  if (verboseLevel)
    G4cout << " >>> G4CascadeCoalescence::selectCandidates()" << G4endl;
 
  allClusters.clear();
  usedNucleons.clear();
 
  size_t nHad = thisHadrons->size();
  for (size_t idx1=0; idx1<nHad; idx1++) {
    if (!getHadron(idx1).nucleon()) continue;
    for (size_t idx2=idx1+1; idx2<nHad; idx2++) {
      if (!getHadron(idx2).nucleon()) continue;
      for (size_t idx3=idx2+1; idx3<nHad; idx3++) {
    if (!getHadron(idx3).nucleon()) continue;
    for (size_t idx4=idx3+1; idx4<nHad; idx4++) {
      if (!getHadron(idx4).nucleon()) continue;
      tryClusters(idx1, idx2, idx3, idx4);
    }
    tryClusters(idx1, idx2, idx3);      // If idx4 loop was empty
      }
      tryClusters(idx1, idx2);          // If idx3 loop was empty
    }
  }
 
  // All potential candidates built; report statistics
  if (verboseLevel>1) {
    G4cout << " Found " << allClusters.size() << " candidates, using "
       << usedNucleons.size() << " nucleons" << G4endl;
  }
}

References allClusters, G4cout, G4endl, getHadron(), G4InuclParticleNames::nucleon(), thisHadrons, tryClusters(), usedNucleons, and verboseLevel.

Referenced by FindClusters().

◆ setVerboseLevel()

void G4CascadeCoalescence::setVerboseLevel ( G4int verbose )

inline

Definition at line 60 of file G4CascadeCoalescence.hh.

60{ verboseLevel = verbose; }

References verboseLevel.

Referenced by G4IntraNucleiCascader::finishCascade(), and G4IntraNucleiCascader::setVerboseLevel().

◆ tryClusters() [1/3]

void G4CascadeCoalescence::tryClusters	(	size_t	idx1,
		size_t	idx2
	)

private

Definition at line 163 of file G4CascadeCoalescence.cc.

                                                          {
  if (nucleonUsed(idx1) || nucleonUsed(idx2)) return;
 
  fillCluster(idx1,idx2);
  if (verboseLevel>1) reportArgs("tryClusters",thisCluster);
 
  if (goodCluster(thisCluster)) {
    allClusters.push_back(thisCluster);
    usedNucleons.insert(idx1);
    usedNucleons.insert(idx2);
  }
}

References allClusters, fillCluster(), goodCluster(), nucleonUsed(), reportArgs(), thisCluster, usedNucleons, and verboseLevel.

Referenced by selectCandidates().

◆ tryClusters() [2/3]

void G4CascadeCoalescence::tryClusters	(	size_t	idx1,
		size_t	idx2,
		size_t	idx3
	)

private

Definition at line 148 of file G4CascadeCoalescence.cc.

                                                                       {
  if (nucleonUsed(idx1) || nucleonUsed(idx2) || nucleonUsed(idx3)) return;
 
  fillCluster(idx1,idx2,idx3);
  if (verboseLevel>1) reportArgs("tryClusters",thisCluster);
 
  if (goodCluster(thisCluster)) {
    allClusters.push_back(thisCluster);
    usedNucleons.insert(idx1);
    usedNucleons.insert(idx2);
    usedNucleons.insert(idx3);
  }
}

References allClusters, fillCluster(), goodCluster(), nucleonUsed(), reportArgs(), thisCluster, usedNucleons, and verboseLevel.

◆ tryClusters() [3/3]

void G4CascadeCoalescence::tryClusters	(	size_t	idx1,
		size_t	idx2,
		size_t	idx3,
		size_t	idx4
	)

private

Definition at line 130 of file G4CascadeCoalescence.cc.

                                                 {
  if (nucleonUsed(idx1) || nucleonUsed(idx2) ||
      nucleonUsed(idx3) || nucleonUsed(idx4)) return;
 
  fillCluster(idx1,idx2,idx3,idx4);
  if (verboseLevel>1) reportArgs("tryClusters",thisCluster);
 
  if (goodCluster(thisCluster)) {
    allClusters.push_back(thisCluster);
    usedNucleons.insert(idx1);
    usedNucleons.insert(idx2);
    usedNucleons.insert(idx3);
    usedNucleons.insert(idx4);
  }
}

References allClusters, fillCluster(), goodCluster(), nucleonUsed(), reportArgs(), thisCluster, usedNucleons, and verboseLevel.

Field Documentation

◆ allClusters

std::vector<ClusterCandidate> G4CascadeCoalescence::allClusters

private

Definition at line 67 of file G4CascadeCoalescence.hh.

Referenced by createNuclei(), selectCandidates(), and tryClusters().

◆ dpMaxAlpha

const G4double G4CascadeCoalescence::dpMaxAlpha

private

Definition at line 78 of file G4CascadeCoalescence.hh.

Referenced by goodCluster().

◆ dpMaxDoublet

const G4double G4CascadeCoalescence::dpMaxDoublet

private

Definition at line 76 of file G4CascadeCoalescence.hh.

Referenced by goodCluster().

◆ dpMaxTriplet

const G4double G4CascadeCoalescence::dpMaxTriplet

private

Definition at line 77 of file G4CascadeCoalescence.hh.

Referenced by goodCluster().

◆ pCluster

G4LorentzVector G4CascadeCoalescence::pCluster

mutableprivate

Definition at line 115 of file G4CascadeCoalescence.hh.

Referenced by getClusterMomentum().

◆ thisCluster

ClusterCandidate G4CascadeCoalescence::thisCluster

private

Definition at line 73 of file G4CascadeCoalescence.hh.

Referenced by fillCluster(), and tryClusters().

◆ thisFinalState

G4CollisionOutput* G4CascadeCoalescence::thisFinalState

private

Definition at line 70 of file G4CascadeCoalescence.hh.

Referenced by createNuclei(), FindClusters(), and removeNucleons().

◆ thisHadrons

const std::vector<G4InuclElementaryParticle>* G4CascadeCoalescence::thisHadrons

private

Definition at line 71 of file G4CascadeCoalescence.hh.

Referenced by FindClusters(), getHadron(), and selectCandidates().

◆ thisLightIon

G4InuclNuclei G4CascadeCoalescence::thisLightIon

private

Definition at line 74 of file G4CascadeCoalescence.hh.

Referenced by createNuclei(), and makeLightIon().

◆ usedNucleons

std::set<size_t> G4CascadeCoalescence::usedNucleons

private

Definition at line 68 of file G4CascadeCoalescence.hh.

Referenced by createNuclei(), nucleonUsed(), removeNucleons(), selectCandidates(), and tryClusters().

◆ verboseLevel

G4int G4CascadeCoalescence::verboseLevel

private

Definition at line 65 of file G4CascadeCoalescence.hh.

Referenced by createNuclei(), FindClusters(), goodCluster(), makeLightIon(), maxDeltaP(), removeNucleons(), reportArgs(), selectCandidates(), setVerboseLevel(), and tryClusters().

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

source/processes/hadronic/models/cascade/cascade/include/G4CascadeCoalescence.hh
source/processes/hadronic/models/cascade/cascade/src/G4CascadeCoalescence.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClusterCandidate

Constructor & Destructor Documentation

◆ G4CascadeCoalescence()

◆ ~G4CascadeCoalescence()

Member Function Documentation

◆ allNucleons()

◆ clusterType()

◆ createNuclei()

◆ fillCluster() [1/3]

◆ fillCluster() [2/3]

◆ fillCluster() [3/3]

◆ FindClusters()

◆ getClusterMomentum()

◆ getHadron()

◆ goodCluster()

◆ makeLightIon()

◆ maxDeltaP()

◆ nucleonUsed()

◆ removeNucleons()

◆ reportArgs()

◆ reportResult()

◆ selectCandidates()

◆ setVerboseLevel()

◆ tryClusters() [1/3]

◆ tryClusters() [2/3]

◆ tryClusters() [3/3]

Field Documentation

◆ allClusters

◆ dpMaxAlpha

◆ dpMaxDoublet

◆ dpMaxTriplet

◆ pCluster

◆ thisCluster

◆ thisFinalState

◆ thisHadrons

◆ thisLightIon

◆ usedNucleons

◆ verboseLevel