#include <GflashHadronShowerModel.h>

Inheritance diagram for GflashHadronShowerModel:

Public Member Functions
void	DoIt (const G4FastTrack &, G4FastStep &) override

	GflashHadronShowerModel (G4String modelName, G4Region *envelope, const edm::ParameterSet &parSet)

G4bool	IsApplicable (const G4ParticleDefinition &) override

G4bool	ModelTrigger (const G4FastTrack &) override

	~GflashHadronShowerModel () override

Private Member Functions
G4bool	excludeDetectorRegion (const G4FastTrack &fastTrack)

G4bool	isFirstInelasticInteraction (const G4FastTrack &fastTrack)

void	makeHits (const G4FastTrack &fastTrack)

void	updateGflashStep (const G4ThreeVector &position, G4double time)

Private Attributes
GflashAntiProtonShowerProfile *	theAntiProtonProfile

G4Navigator *	theGflashNavigator

G4Step *	theGflashStep

G4TouchableHandle	theGflashTouchableHandle

GflashHistogram *	theHisto

GflashKaonMinusShowerProfile *	theKaonMinusProfile

GflashKaonPlusShowerProfile *	theKaonPlusProfile

edm::ParameterSet	theParSet

GflashPiKShowerProfile *	thePiKProfile

GflashHadronShowerProfile *	theProfile

GflashProtonShowerProfile *	theProtonProfile

G4bool	theWatcherOn

Detailed Description

Definition at line 19 of file GflashHadronShowerModel.h.

Constructor & Destructor Documentation

GflashHadronShowerModel::GflashHadronShowerModel	(	G4String	modelName,
		G4Region *	envelope,
		const edm::ParameterSet &	parSet
	)

Definition at line 35 of file GflashHadronShowerModel.cc.

References edm::ParameterSet::getParameter(), GflashHistogram::instance(), theAntiProtonProfile, theGflashNavigator, theGflashStep, theGflashTouchableHandle, theHisto, theKaonMinusProfile, theKaonPlusProfile, thePiKProfile, theProfile, theProtonProfile, and theWatcherOn.

   : G4VFastSimulationModel(modelName, envelope), theParSet(parSet)
 {
   theWatcherOn = parSet.getParameter<bool>("watcherOn");
 
   theProfile = new GflashHadronShowerProfile(parSet);
   thePiKProfile = new GflashPiKShowerProfile(parSet);
   theKaonPlusProfile = new GflashKaonPlusShowerProfile(parSet);
   theKaonMinusProfile = new GflashKaonMinusShowerProfile(parSet);
   theProtonProfile = new GflashProtonShowerProfile(parSet);
   theAntiProtonProfile = new GflashAntiProtonShowerProfile(parSet);
   theHisto = GflashHistogram::instance();
 
   theGflashStep = new G4Step();
   theGflashTouchableHandle = new G4TouchableHistory();
   theGflashNavigator = new G4Navigator();
 
 }

GflashHadronShowerModel::~GflashHadronShowerModel ( )

override

Definition at line 54 of file GflashHadronShowerModel.cc.

References theGflashStep, and theProfile.

 {
   if(theProfile) delete theProfile;
   if(theGflashStep) delete theGflashStep;
 }

Member Function Documentation

void GflashHadronShowerModel::DoIt	(	const G4FastTrack &	fastTrack,
		G4FastStep &	fastStep
	)

override

Definition at line 102 of file GflashHadronShowerModel.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, Gflash::findShowerType(), GeV, GflashHadronShowerProfile::hadronicParameterization(), GflashHadronShowerProfile::initialize(), GflashHadronShowerProfile::loadParameters(), makeHits(), objects.autophobj::particleType, position, theAntiProtonProfile, theKaonMinusProfile, theKaonPlusProfile, thePiKProfile, theProfile, and theProtonProfile.

 {
   // kill the particle
   fastStep.KillPrimaryTrack();
   fastStep.ProposePrimaryTrackPathLength(0.0);
 
   // parameterize energy depostion by the particle type
   G4ParticleDefinition* particleType = fastTrack.GetPrimaryTrack()->GetDefinition();
   
   theProfile = thePiKProfile;
   if(particleType == G4KaonMinus::KaonMinusDefinition()) theProfile = theKaonMinusProfile;
   else if(particleType == G4KaonPlus::KaonPlusDefinition()) theProfile = theKaonPlusProfile;
   else if(particleType == G4AntiProton::AntiProtonDefinition()) theProfile = theAntiProtonProfile;
   else if(particleType == G4Proton::ProtonDefinition()) theProfile = theProtonProfile;
 
   //input variables for GflashHadronShowerProfile
   G4double energy = fastTrack.GetPrimaryTrack()->GetKineticEnergy()/GeV;
   G4double globalTime = fastTrack.GetPrimaryTrack()->GetStep()->GetPostStepPoint()->GetGlobalTime();
   G4double charge = fastTrack.GetPrimaryTrack()->GetStep()->GetPreStepPoint()->GetCharge();
   G4ThreeVector position = fastTrack.GetPrimaryTrack()->GetPosition()/cm;
   G4ThreeVector momentum = fastTrack.GetPrimaryTrack()->GetMomentum()/GeV;
   G4int showerType = Gflash::findShowerType(position);
 
   theProfile->initialize(showerType,energy,globalTime,charge,position,momentum);
   theProfile->loadParameters();
   theProfile->hadronicParameterization();
 
   // make hits
   makeHits(fastTrack);
 
 }

G4bool GflashHadronShowerModel::excludeDetectorRegion ( const G4FastTrack & fastTrack )

private

Definition at line 251 of file GflashHadronShowerModel.cc.

References gather_cfg::cout, PVValHelper::eta, Gflash::EtaMin, Gflash::getCalorimeterNumber(), edm::ParameterSet::getUntrackedParameter(), GeV, Gflash::kENCA, Gflash::kHB, Gflash::kHE, Gflash::MinDistanceToOut, Gflash::Rmax, theParSet, HIPAlignmentAlgorithm_cfi::verbosity, Gflash::Zmax, and Gflash::Zmin.

Referenced by ModelTrigger().

 {
   G4bool isExcluded=false;
   int verbosity = theParSet.getUntrackedParameter<int>("Verbosity");
   
   //exclude regions where geometry are complicated
   //+- one supermodule around the EB/EE boundary: 1.479 +- 0.0174*5
   G4double eta =   fastTrack.GetPrimaryTrack()->GetPosition().pseudoRapidity() ;
   if(std::fabs(eta) > 1.392 && std::fabs(eta) < 1.566) {
     if(verbosity>0) {
        edm::LogInfo("SimGeneralGFlash") << "GflashHadronShowerModel: excluding region of eta = " << eta;
     }
     return true;  
   }
   else {
     G4StepPoint* postStep = fastTrack.GetPrimaryTrack()->GetStep()->GetPostStepPoint();
 
     Gflash::CalorimeterNumber kCalor = Gflash::getCalorimeterNumber(postStep->GetPosition()/cm);
     G4double distOut = 9999.0;
 
     //exclude the region where the shower starting point is inside the preshower
     if( std::fabs(eta) > Gflash::EtaMin[Gflash::kENCA] &&
         std::fabs((postStep->GetPosition()).getZ()/cm) < Gflash::Zmin[Gflash::kENCA]) {
       return true;
     }
 
     //<---the shower starting point is always inside envelopes
     //@@@exclude the region where the shower starting point is too close to the end of
     //the hadronic envelopes (may need to be optimized further!)
     //@@@if we extend parameterization including Magnet/HO, we need to change this strategy
     if(kCalor == Gflash::kHB) {
       distOut =  Gflash::Rmax[Gflash::kHB] - postStep->GetPosition().getRho()/cm;
       if (distOut < Gflash::MinDistanceToOut ) isExcluded = true;
     }
     else if(kCalor == Gflash::kHE) {
       distOut =  Gflash::Zmax[Gflash::kHE] - std::fabs(postStep->GetPosition().getZ()/cm);
       if (distOut < Gflash::MinDistanceToOut ) isExcluded = true;
     }
 
     //@@@remove this print statement later
     if(isExcluded && verbosity > 0) {
       std::cout << "GflashHadronShowerModel: skipping kCalor = " << kCalor << 
     " DistanceToOut " << distOut << " from (" <<  (postStep->GetPosition()).getRho()/cm << 
     ":" << (postStep->GetPosition()).getZ()/cm << ") of KE = " << fastTrack.GetPrimaryTrack()->GetKineticEnergy()/GeV << std::endl;
     }
   }
 
   return isExcluded;
 }

G4bool GflashHadronShowerModel::IsApplicable ( const G4ParticleDefinition & particleType )

override

Definition at line 60 of file GflashHadronShowerModel.cc.

 {
   return 
     &particleType == G4PionMinus::PionMinusDefinition() ||
     &particleType == G4PionPlus::PionPlusDefinition() ||
     &particleType == G4KaonMinus::KaonMinusDefinition() ||
     &particleType == G4KaonPlus::KaonPlusDefinition() ||
     &particleType == G4AntiProton::AntiProtonDefinition() ||
     &particleType == G4Proton::ProtonDefinition() ;
 }

G4bool GflashHadronShowerModel::isFirstInelasticInteraction ( const G4FastTrack & fastTrack )

private

Definition at line 194 of file GflashHadronShowerModel.cc.

References GflashHistogram::deltaStep, GflashHistogram::energyLoss, GflashHistogram::energyRatio, GflashHistogram::getStoreFlag(), GeV, cuy::isFirst, GflashHistogram::kineticEnergy, objects.autophobj::particleType, GflashHistogram::postStepPosition, GflashHistogram::preStepPosition, Gflash::QuasiElasticLike, and theHisto.

Referenced by ModelTrigger().

 {
   G4bool isFirst=false;
 
   G4StepPoint* preStep = fastTrack.GetPrimaryTrack()->GetStep()->GetPreStepPoint();
   G4StepPoint* postStep = fastTrack.GetPrimaryTrack()->GetStep()->GetPostStepPoint();
 
   G4String procName = postStep->GetProcessDefinedStep()->GetProcessName();  
   G4ParticleDefinition* particleType = fastTrack.GetPrimaryTrack()->GetDefinition();
 
   //@@@ this part is still temporary and the cut for the variable ratio should be optimized later
 
   if((particleType == G4PionPlus::PionPlusDefinition() && procName == "WrappedPionPlusInelastic") || 
      (particleType == G4PionMinus::PionMinusDefinition() && procName == "WrappedPionMinusInelastic") ||
      (particleType == G4KaonPlus::KaonPlusDefinition() && procName == "WrappedKaonPlusInelastic") ||
      (particleType == G4KaonMinus::KaonMinusDefinition() && procName == "WrappedKaonMinusInelastic") ||
      (particleType == G4AntiProton::AntiProtonDefinition() && procName == "WrappedAntiProtonInelastic") ||
      (particleType == G4Proton::ProtonDefinition() && procName == "WrappedProtonInelastic")) {
 
     //skip to the second interaction if the first inelastic is a quasi-elastic like interaction
     //@@@ the cut may be optimized later
 
     const G4TrackVector* fSecondaryVector = fastTrack.GetPrimaryTrack()->GetStep()->GetSecondary();
     G4double leadingEnergy = 0.0;
 
     //loop over 'all' secondaries including those produced by continuous processes.
     //@@@may require an additional condition only for hadron interaction with the process name,
     //but it will not change the result anyway
 
     for (unsigned int isec = 0 ; isec < fSecondaryVector->size() ; isec++) {
       G4Track* fSecondaryTrack = (*fSecondaryVector)[isec];
       G4double secondaryEnergy = fSecondaryTrack->GetKineticEnergy();
 
       if(secondaryEnergy > leadingEnergy ) {
         leadingEnergy = secondaryEnergy;
       }
     }
 
     if((preStep->GetTotalEnergy()!=0) && 
        (leadingEnergy/preStep->GetTotalEnergy() < Gflash::QuasiElasticLike)) isFirst = true;
 
     //Fill debugging histograms and check information on secondaries -
     //remove after final implimentation
 
     if(theHisto->getStoreFlag()) {
       theHisto->preStepPosition->Fill(preStep->GetPosition().getRho()/cm);
       theHisto->postStepPosition->Fill(postStep->GetPosition().getRho()/cm);
       theHisto->deltaStep->Fill((postStep->GetPosition() - preStep->GetPosition()).getRho()/cm);
       theHisto->kineticEnergy->Fill(fastTrack.GetPrimaryTrack()->GetKineticEnergy()/GeV);
       theHisto->energyLoss->Fill(fabs(fastTrack.GetPrimaryTrack()->GetStep()->GetDeltaEnergy()/GeV));
       theHisto->energyRatio->Fill(leadingEnergy/preStep->GetTotalEnergy());
     }
 
  }
   return isFirst;
 } 

void GflashHadronShowerModel::makeHits ( const G4FastTrack & fastTrack )

private

Definition at line 134 of file GflashHadronShowerModel.cc.

References GflashHadronShowerProfile::getGflashHitList(), SteppingAction::m_g4StepSignal, Gflash::scaleSensitiveHB, Gflash::scaleSensitiveHE, theGflashNavigator, theGflashStep, theGflashTouchableHandle, theProfile, theWatcherOn, and updateGflashStep().

Referenced by DoIt().

                                                                    {
 
   std::vector<GflashHit>& gflashHitList = theProfile->getGflashHitList();
 
   theGflashStep->SetTrack(const_cast<G4Track*>(fastTrack.GetPrimaryTrack()));
   theGflashStep->GetPostStepPoint()->SetProcessDefinedStep(const_cast<G4VProcess*>
     (fastTrack.GetPrimaryTrack()->GetStep()->GetPostStepPoint()->GetProcessDefinedStep()));
   theGflashNavigator->SetWorldVolume(G4TransportationManager::GetTransportationManager()->GetNavigatorForTracking()->GetWorldVolume());
 
   std::vector<GflashHit>::const_iterator spotIter    = gflashHitList.begin();
   std::vector<GflashHit>::const_iterator spotIterEnd = gflashHitList.end();
 
   for( ; spotIter != spotIterEnd; spotIter++){
 
     theGflashNavigator->LocateGlobalPointAndUpdateTouchableHandle(spotIter->getPosition(),G4ThreeVector(0,0,0),
                                   theGflashTouchableHandle, false);
     updateGflashStep(spotIter->getPosition(),spotIter->getTime());
 
     // if there is a watcher defined in a job and the flag is turned on
     if(theWatcherOn) {
       theGflashStep->SetTotalEnergyDeposit(spotIter->getEnergy());
       SteppingAction* userSteppingAction = (SteppingAction*) G4EventManager::GetEventManager()->GetUserSteppingAction();
       userSteppingAction->m_g4StepSignal(theGflashStep);
     }
 
     G4VPhysicalVolume* aCurrentVolume = theGflashStep->GetPreStepPoint()->GetPhysicalVolume();
     if( aCurrentVolume == nullptr ) continue;
 
     G4LogicalVolume* lv = aCurrentVolume->GetLogicalVolume();
     if(lv->GetRegion()->GetName() != "CaloRegion") continue;
       
     theGflashStep->GetPreStepPoint()->SetSensitiveDetector(aCurrentVolume->GetLogicalVolume()->GetSensitiveDetector());
     G4VSensitiveDetector* aSensitive = theGflashStep->GetPreStepPoint()->GetSensitiveDetector();
 
     if( aSensitive == nullptr ) continue;
     
     G4String nameCalor = aCurrentVolume->GetName();
     nameCalor.assign(nameCalor,0,2);
     G4double samplingWeight = 1.0; 
     if(nameCalor == "HB" ) {
       samplingWeight = Gflash::scaleSensitiveHB;
     }
     else if(nameCalor=="HE" || nameCalor == "HT") {
       samplingWeight = Gflash::scaleSensitiveHE;
     }
     theGflashStep->SetTotalEnergyDeposit(spotIter->getEnergy()*samplingWeight);
 
     aSensitive->Hit(theGflashStep);
 
   }
 }

G4bool GflashHadronShowerModel::ModelTrigger ( const G4FastTrack & fastTrack )

override

Definition at line 71 of file GflashHadronShowerModel.cc.

References Gflash::energyCutOff, excludeDetectorRegion(), GeV, and isFirstInelasticInteraction().

 {
   // ModelTrigger returns false for Gflash Hadronic Shower Model if it is not
   // tested from the corresponding wrapper process, GflashHadronWrapperProcess. 
   // Temporarily the track status is set to fPostponeToNextEvent at the wrapper
   // process before ModelTrigger is really tested for the second time through 
   // PostStepGPIL of enviaged parameterization processes.  The better 
   // implmentation may be using via G4VUserTrackInformation of each track, which
   // requires to modify a geant source code of stepping (G4SteppingManager2)
 
   G4bool trigger = false;
 
   // mininum energy cutoff to parameterize
   if (fastTrack.GetPrimaryTrack()->GetKineticEnergy()/GeV < Gflash::energyCutOff) return trigger;
 
   // check whether this is called from the normal GPIL or the wrapper process GPIL
   if(fastTrack.GetPrimaryTrack()->GetTrackStatus() == fPostponeToNextEvent ) {
 
     // Shower pameterization start at the first inelastic interaction point
     G4bool isInelastic  = isFirstInelasticInteraction(fastTrack);
     
     // Other conditions
     if(isInelastic) {
       trigger = (!excludeDetectorRegion(fastTrack));
     }
   }
 
   return trigger;
 
 }

void GflashHadronShowerModel::updateGflashStep	(	const G4ThreeVector &	position,
		G4double	time
	)

private

Definition at line 186 of file GflashHadronShowerModel.cc.

References theGflashStep, and theGflashTouchableHandle.

Referenced by makeHits().

 {
   theGflashStep->GetPostStepPoint()->SetGlobalTime(timeGlobal);
   theGflashStep->GetPreStepPoint()->SetPosition(spotPosition);
   theGflashStep->GetPostStepPoint()->SetPosition(spotPosition);
   theGflashStep->GetPreStepPoint()->SetTouchableHandle(theGflashTouchableHandle);
 }