G4TheoFSGenerator Class Reference

#include <G4TheoFSGenerator.hh>

Inheritance diagram for G4TheoFSGenerator:

Public Member Functions
	G4TheoFSGenerator (const G4String &name="TheoFSGenerator")
	~G4TheoFSGenerator () override
	G4TheoFSGenerator (const G4TheoFSGenerator &right)=delete
const G4TheoFSGenerator &	operator= (const G4TheoFSGenerator &right)=delete
G4bool	operator== (const G4TheoFSGenerator &right) const =delete
G4bool	operator!= (const G4TheoFSGenerator &right) const =delete
G4HadFinalState *	ApplyYourself (const G4HadProjectile &thePrimary, G4Nucleus &theNucleus) override
void	SetTransport (G4VIntraNuclearTransportModel *const value)
void	SetHighEnergyGenerator (G4VHighEnergyGenerator *const value)
void	SetQuasiElasticChannel (G4QuasiElasticChannel *const value)
const G4VIntraNuclearTransportModel *	GetTransport () const
const G4VHighEnergyGenerator *	GetHighEnergyGenerator () const
const G4QuasiElasticChannel *	GetQuasiElasticChannel () const
std::pair< G4double, G4double >	GetEnergyMomentumCheckLevels () const override
void	ModelDescription (std::ostream &outFile) const override
Public Member Functions inherited from G4HadronicInteraction
	G4HadronicInteraction (const G4String &modelName="HadronicModel")
virtual	~G4HadronicInteraction ()
virtual G4double	SampleInvariantT (const G4ParticleDefinition *p, G4double plab, G4int Z, G4int A)
virtual G4bool	IsApplicable (const G4HadProjectile &aTrack, G4Nucleus &targetNucleus)
G4double	GetMinEnergy () const
G4double	GetMinEnergy (const G4Material *aMaterial, const G4Element *anElement) const
void	SetMinEnergy (G4double anEnergy)
void	SetMinEnergy (G4double anEnergy, const G4Element *anElement)
void	SetMinEnergy (G4double anEnergy, const G4Material *aMaterial)
G4double	GetMaxEnergy () const
G4double	GetMaxEnergy (const G4Material *aMaterial, const G4Element *anElement) const
void	SetMaxEnergy (const G4double anEnergy)
void	SetMaxEnergy (G4double anEnergy, const G4Element *anElement)
void	SetMaxEnergy (G4double anEnergy, const G4Material *aMaterial)
G4int	GetVerboseLevel () const
void	SetVerboseLevel (G4int value)
const G4String &	GetModelName () const
void	DeActivateFor (const G4Material *aMaterial)
void	ActivateFor (const G4Material *aMaterial)
void	DeActivateFor (const G4Element *anElement)
void	ActivateFor (const G4Element *anElement)
G4bool	IsBlocked (const G4Material *aMaterial) const
G4bool	IsBlocked (const G4Element *anElement) const
void	SetRecoilEnergyThreshold (G4double val)
G4double	GetRecoilEnergyThreshold () const
virtual const std::pair< G4double, G4double >	GetFatalEnergyCheckLevels () const
void	SetEnergyMomentumCheckLevels (G4double relativeLevel, G4double absoluteLevel)
virtual void	BuildPhysicsTable (const G4ParticleDefinition &)
virtual void	InitialiseModel ()
	G4HadronicInteraction (const G4HadronicInteraction &right)=delete
const G4HadronicInteraction &	operator= (const G4HadronicInteraction &right)=delete
G4bool	operator== (const G4HadronicInteraction &right) const =delete
G4bool	operator!= (const G4HadronicInteraction &right) const =delete

Additional Inherited Members
Protected Member Functions inherited from G4HadronicInteraction
void	SetModelName (const G4String &nam)
G4bool	IsBlocked () const
void	Block ()
Protected Attributes inherited from G4HadronicInteraction
G4HadFinalState	theParticleChange
G4int	verboseLevel
G4double	theMinEnergy
G4double	theMaxEnergy
G4bool	isBlocked

Detailed Description

Definition at line 52 of file G4TheoFSGenerator.hh.

Constructor & Destructor Documentation

G4TheoFSGenerator() [1/2]

G4TheoFSGenerator::G4TheoFSGenerator ( const G4String & name = "TheoFSGenerator" )

explicit

Definition at line 43 of file G4TheoFSGenerator.cc.

    : G4HadronicInteraction( name )
    , theTransport( nullptr ), theHighEnergyGenerator( nullptr )
    , theQuasielastic( nullptr ), theCosmicCoalescence( nullptr )
    , theStringModelID( -1 ), theFTFQuasiElasticID( -1 ), theFTFDiffractiveID( -1 )
{
  theParticleChange = new G4HadFinalState;
  theStringModelID     = G4PhysicsModelCatalog::GetModelID( "model_" + name );
  theFTFQuasiElasticID = G4PhysicsModelCatalog::GetModelID( "model_QuasiElastic_FTF" );
  theFTFDiffractiveID  = G4PhysicsModelCatalog::GetModelID( "model_Diffractive_FTF" );
}

Referenced by G4TheoFSGenerator(), operator!=(), operator=(), and operator==().

~G4TheoFSGenerator()

G4TheoFSGenerator::~G4TheoFSGenerator ( )

override

Definition at line 56 of file G4TheoFSGenerator.cc.

{
  delete theParticleChange;
}

G4TheoFSGenerator() [2/2]

G4TheoFSGenerator::G4TheoFSGenerator ( const G4TheoFSGenerator & right )

delete

Member Function Documentation

ApplyYourself()

G4HadFinalState * G4TheoFSGenerator::ApplyYourself ( const G4HadProjectile & thePrimary, G4Nucleus & theNucleus )

overridevirtual

Reimplemented from G4HadronicInteraction.

Definition at line 77 of file G4TheoFSGenerator.cc.

{
  // init particle change
  theParticleChange->Clear();
  theParticleChange->SetStatusChange( stopAndKill );
  G4double timePrimary = thePrimary.GetGlobalTime();
 
  // Temporarily dummy treatment of heavy (charm and bottom) hadron projectiles at low energies.
  // Cascade models are currently not applicable for heavy hadrons and string models cannot
  // handle them properly at low energies - let's say safely below ~100 MeV.
  // In these cases, we return as final state the initial state unchanged.
  // For most applications, this is a safe simplification, giving that the nearly all
  // slowly moving charm and bottom hadrons decay before any hadronic interaction can occur.
  // Note that we prefer not to use G4HadronicParameters::GetMinEnergyTransitionFTF_Cascade()
  // (typically ~3 GeV) because FTFP works reasonably well below such a value.
  const G4double energyThresholdForCharmAndBottomHadrons = 100.0*CLHEP::MeV;
  if ( thePrimary.GetKineticEnergy() < energyThresholdForCharmAndBottomHadrons  &&
       ( thePrimary.GetDefinition()->GetQuarkContent( 4 )     != 0  ||    // Has charm       constituent quark
     thePrimary.GetDefinition()->GetAntiQuarkContent( 4 ) != 0  ||    // Has anti-charm  constituent anti-quark
     thePrimary.GetDefinition()->GetQuarkContent( 5 )     != 0  ||    // Has bottom      constituent quark
     thePrimary.GetDefinition()->GetAntiQuarkContent( 5 ) != 0 ) ) {  // Has anti-bottom constituent anti-quark
    theParticleChange->SetStatusChange( isAlive );
    theParticleChange->SetEnergyChange( thePrimary.GetKineticEnergy() );
    theParticleChange->SetMomentumChange( thePrimary.Get4Momentum().vect().unit() );
    return theParticleChange;
  }
 
  // Temporarily dummy treatment of light hypernuclei projectiles at low energies.
  // Bertini and Binary intra-nuclear cascade models are currently not applicable
  // for hypernuclei and string models cannot handle them properly at low energies -
  // let's say safely below ~100 MeV.
  // In these cases, we return as final state the initial state unchanged.
  // For most applications, this is a safe simplification, giving that the nearly all
  // slowly moving hypernuclei decay before any hadronic interaction can occur.
  // Note that we prefer not to use G4HadronicParameters::GetMinEnergyTransitionFTF_Cascade()
  // (typically ~3 GeV) because FTFP works reasonably well below such a value.
  // Note that for anti-hypernuclei, FTF model works fine down to zero kinetic energy,
  // so there is no need of any extra, dummy treatment.
  const G4double energyThresholdForHyperNuclei = 100.0*CLHEP::MeV;
  if ( thePrimary.GetKineticEnergy() < energyThresholdForHyperNuclei  &&
       thePrimary.GetDefinition()->IsHypernucleus() ) {
    theParticleChange->SetStatusChange( isAlive );
    theParticleChange->SetEnergyChange( thePrimary.GetKineticEnergy() );
    theParticleChange->SetMomentumChange( thePrimary.Get4Momentum().vect().unit() );
    return theParticleChange;
  }
 
  // check if models have been registered, and use default, in case this is not true @@
  
  const G4DynamicParticle aPart( thePrimary.GetDefinition(), thePrimary.Get4Momentum().vect() );
 
  if ( theQuasielastic ) 
  {
    if ( theQuasielastic->GetFraction( theNucleus, aPart ) > G4UniformRand() )
    {
      //G4cout<<"___G4TheoFSGenerator: before Scatter (1) QE=" << theQuasielastic<<G4endl;
      G4KineticTrackVector* result= theQuasielastic->Scatter( theNucleus, aPart );
      //G4cout << "^^G4TheoFSGenerator: after Scatter (1) " << G4endl;
      if ( result )
      {
        for ( auto & ptr : *result )
    {
      G4DynamicParticle* aNew = new G4DynamicParticle( ptr->GetDefinition(),
                                                       ptr->Get4Momentum().e(),
                                                       ptr->Get4Momentum().vect() );
      theParticleChange->AddSecondary( aNew, ptr->GetCreatorModelID() );
      delete ptr;
    }
    delete result;     
      } 
      else 
      {
        theParticleChange->SetStatusChange( isAlive );
    theParticleChange->SetEnergyChange( thePrimary.GetKineticEnergy() );
    theParticleChange->SetMomentumChange( thePrimary.Get4Momentum().vect().unit() );
      }
      return theParticleChange;
    }
  }
 
  // get result from high energy model
  G4KineticTrackVector* theInitialResult = theHighEnergyGenerator->Scatter( theNucleus, aPart );
 
  // Assign the creator model ID.
  // Only for the FTF string model, an inelastic interaction can be classified as quasi-elastic
  // or diffractive. For the QGS model, the two boolean methods below return always "false".
  G4int theModelID = theStringModelID;
  if ( theHighEnergyGenerator->IsQuasiElasticInteraction() ) {
    theModelID = theFTFQuasiElasticID;
  } else if ( theHighEnergyGenerator->IsDiffractiveInteraction() ) {
    theModelID = theFTFDiffractiveID;
  }
  for ( auto & ptr : *theInitialResult ) {
    ptr->SetCreatorModelID( theModelID );
  }
 
  //#define DEBUG_initial_result
  #ifdef DEBUG_initial_result
      G4double E_out( 0 );
      G4IonTable* ionTable = G4ParticleTable::GetParticleTable()->GetIonTable();
      for ( auto & ptr : *theInitialResult )
      {
         //G4cout << "TheoFS secondary, mom " << ptr->GetDefinition()->GetParticleName() 
             //         << " " << ptr->Get4Momentum() << G4endl;
         E_out += ptr->Get4Momentum().e();
      }
      G4double init_mass = ionTable->GetIonMass( theNucleus.GetZ_asInt(), theNucleus.GetA_asInt() );
          G4double init_E = aPart.Get4Momentum().e();
      // residual nucleus
 
      const std::vector< G4Nucleon >& thy = theHighEnergyGenerator->GetWoundedNucleus()->GetNucleons();
 
      G4int resZ( 0 ), resA( 0 );
      G4double delta_m( 0.0 );
      for ( auto & nuc : thy )
      {
        if ( nuc.AreYouHit() ) {
          ++resA;
          if ( nuc.GetDefinition() == G4Proton::Proton() ) {
            ++resZ;
        delta_m += CLHEP::proton_mass_c2;
          } else {
        delta_m += CLHEP::neutron_mass_c2;
          }  
        }
      }
 
      G4double final_mass( 0.0 );
      if ( theNucleus.GetA_asInt() ) {
        final_mass = ionTable->GetIonMass( theNucleus.GetZ_asInt() - resZ,theNucleus.GetA_asInt() - resA );
      }
      G4double E_excit = init_mass + init_E - final_mass - E_out;
      G4cout << " Corrected delta mass " << init_mass - final_mass - delta_m << G4endl;
      G4cout << "initial E, mass = " << init_E << ", " << init_mass << G4endl;
      G4cout << "  final E, mass = " << E_out <<", " << final_mass << "  excitation_E " << E_excit << G4endl;
  #endif
 
  G4ReactionProductVector* theTransportResult = nullptr;
 
  G4V3DNucleus* theProjectileNucleus = theHighEnergyGenerator->GetProjectileNucleus(); 
  if ( theProjectileNucleus == nullptr )
  {
    G4int hitCount = 0;
    const std::vector< G4Nucleon >& they = theHighEnergyGenerator->GetWoundedNucleus()->GetNucleons();
    for ( auto & nuc : they )
    {
      if ( nuc.AreYouHit() ) ++hitCount;
    }
    if ( hitCount != theHighEnergyGenerator->GetWoundedNucleus()->GetMassNumber() )
    {
      theTransport->SetPrimaryProjectile( thePrimary );
      theTransportResult = theTransport->Propagate( theInitialResult,
                                theHighEnergyGenerator->GetWoundedNucleus() );
      if ( theTransportResult == nullptr ) {
        G4cout << "G4TheoFSGenerator: null ptr from transport propagate " << G4endl;
        throw G4HadronicException( __FILE__, __LINE__, "Null ptr from transport propagate" );
      }
    }
    else
    {
      theTransportResult = theDecay.Propagate( theInitialResult, 
                                 theHighEnergyGenerator->GetWoundedNucleus() );
      if ( theTransportResult == nullptr ) {
         G4cout << "G4TheoFSGenerator: null ptr from decay propagate " << G4endl;
         throw G4HadronicException( __FILE__, __LINE__, "Null ptr from decay propagate" );
      }
    }
  }
  else 
  {
    theTransport->SetPrimaryProjectile( thePrimary );
    theTransportResult = theTransport->PropagateNuclNucl( theInitialResult, 
                            theHighEnergyGenerator->GetWoundedNucleus(),
                            theProjectileNucleus );
    if ( theTransportResult == nullptr ) {
       G4cout << "G4TheoFSGenerator: null ptr from transport propagate " << G4endl;
       throw G4HadronicException( __FILE__, __LINE__, "Null ptr from transport propagate" );
    }
  }
 
  // If enabled, apply the Cosmic Rays (CR) coalescence to the list of secondaries produced so far.
  // This algorithm can form deuterons and antideuterons by coalescence of, respectively,
  // proton-neutron and antiproton-antineutron pairs close in momentum space.
  // This can be useful in particular for Cosmic Ray applications.
  if ( G4HadronicParameters::Instance()->EnableCRCoalescence() ) {
    if ( theCosmicCoalescence == nullptr ) {
      theCosmicCoalescence = (G4CRCoalescence*)
        G4HadronicInteractionRegistry::Instance()->FindModel( "G4CRCoalescence" );
      if ( theCosmicCoalescence == nullptr ) {
        theCosmicCoalescence = new G4CRCoalescence;
      }
    }
    theCosmicCoalescence->SetP0Coalescence( thePrimary, theHighEnergyGenerator->GetModelName() );
    theCosmicCoalescence->GenerateDeuterons( theTransportResult );
  }
    
  // Fill particle change
  for ( auto & ptr : *theTransportResult )
  {
    G4DynamicParticle* aNewDP = new G4DynamicParticle( ptr->GetDefinition(),
                                                       ptr->GetTotalEnergy(),
                                                       ptr->GetMomentum() );
    G4HadSecondary aNew = G4HadSecondary( aNewDP );
    G4double time = std::max( ptr->GetFormationTime(), 0.0 );
    aNew.SetTime( timePrimary + time );
    aNew.SetCreatorModelID( ptr->GetCreatorModelID() );
    aNew.SetParentResonanceDef( ptr->GetParentResonanceDef() );
    aNew.SetParentResonanceID( ptr->GetParentResonanceID() );
    theParticleChange->AddSecondary( aNew );
    delete ptr;
  }
  
  // some garbage collection
  delete theTransportResult;
  
  // Done
  return theParticleChange;
}

GetEnergyMomentumCheckLevels()

std::pair< G4double, G4double > G4TheoFSGenerator::GetEnergyMomentumCheckLevels ( ) const

overridevirtual

Reimplemented from G4HadronicInteraction.

Definition at line 297 of file G4TheoFSGenerator.cc.

{
  if ( theHighEnergyGenerator ) {
    return theHighEnergyGenerator->GetEnergyMomentumCheckLevels();
  } else {
    return std::pair<G4double, G4double>( DBL_MAX, DBL_MAX );
  }
}

GetHighEnergyGenerator()

const G4VHighEnergyGenerator * G4TheoFSGenerator::GetHighEnergyGenerator ( ) const

inline

Definition at line 108 of file G4TheoFSGenerator.hh.

{
  return theHighEnergyGenerator; 
}

GetQuasiElasticChannel()

const G4QuasiElasticChannel * G4TheoFSGenerator::GetQuasiElasticChannel ( ) const

inline

Definition at line 113 of file G4TheoFSGenerator.hh.

{
  return theQuasielastic;
}

GetTransport()

const G4VIntraNuclearTransportModel * G4TheoFSGenerator::GetTransport ( ) const

inline

Definition at line 103 of file G4TheoFSGenerator.hh.

{
  return theTransport;
}

ModelDescription()

void G4TheoFSGenerator::ModelDescription ( std::ostream & outFile ) const

overridevirtual

Reimplemented from G4HadronicInteraction.

Definition at line 62 of file G4TheoFSGenerator.cc.

{
  outFile << GetModelName() <<" consists of a " << theHighEnergyGenerator->GetModelName()
      << " string model and a stage to de-excite the excited nuclear fragment.\n<p>"
      << "The string model simulates the interaction of\n"
          << "an incident hadron with a nucleus, forming \n"
          << "excited strings, decays these strings into hadrons,\n"
          << "and leaves an excited nucleus. \n"
          << "<p>The string model:\n";
  theHighEnergyGenerator->ModelDescription( outFile );
  outFile << "\n<p>";
  theTransport->PropagateModelDescription( outFile );
}

operator!=()

G4bool G4TheoFSGenerator::operator!= ( const G4TheoFSGenerator & right ) const

delete

operator=()

const G4TheoFSGenerator & G4TheoFSGenerator::operator= ( const G4TheoFSGenerator & right )

delete

operator==()

G4bool G4TheoFSGenerator::operator== ( const G4TheoFSGenerator & right ) const

delete

SetHighEnergyGenerator()

void G4TheoFSGenerator::SetHighEnergyGenerator ( G4VHighEnergyGenerator *const value )

inline

Definition at line 93 of file G4TheoFSGenerator.hh.

{
  theHighEnergyGenerator= value;
}

Referenced by G4FTFBuilder::BuildModel(), G4QGSBuilder::BuildModel(), LBE::ConstructHad(), G4HadronicAbsorptionFritiof::G4HadronicAbsorptionFritiof(), and G4HadronicAbsorptionFritiofWithBinaryCascade::G4HadronicAbsorptionFritiofWithBinaryCascade().

SetQuasiElasticChannel()

void G4TheoFSGenerator::SetQuasiElasticChannel ( G4QuasiElasticChannel *const value )

inline

Definition at line 98 of file G4TheoFSGenerator.hh.

{
  theQuasielastic = value;
}

Referenced by G4QGSBuilder::BuildModel().

SetTransport()

void G4TheoFSGenerator::SetTransport ( G4VIntraNuclearTransportModel *const value )

inline

Definition at line 88 of file G4TheoFSGenerator.hh.

{
  theTransport = value;
}

Referenced by G4FTFBuilder::BuildModel(), G4QGSBuilder::BuildModel(), LBE::ConstructHad(), G4HadronicAbsorptionFritiof::G4HadronicAbsorptionFritiof(), and G4HadronicAbsorptionFritiofWithBinaryCascade::G4HadronicAbsorptionFritiofWithBinaryCascade().

---

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

• G4TheoFSGenerator.hh
• G4TheoFSGenerator.cc