GflashHadronShowerModel Class Reference

#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::GflashHadronShowerModel	(	G4String	modelName,
		G4Region *	envelope,
		const edm::ParameterSet &	parSet
	)

Definition at line 34 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::~GflashHadronShowerModel ( )

override

Definition at line 53 of file GflashHadronShowerModel.cc.

References theGflashStep, and theProfile.

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

Member Function Documentation

DoIt()

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

override

Definition at line 96 of file GflashHadronShowerModel.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, HCALHighEnergyHPDFilter_cfi::energy, Gflash::findShowerType(), GflashHadronShowerProfile::hadronicParameterization(), GflashHadronShowerProfile::initialize(), GflashHadronShowerProfile::loadParameters(), makeHits(), PbPb_ZMuSkimMuonDPG_cff::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);
}

excludeDetectorRegion()

G4bool GflashHadronShowerModel::excludeDetectorRegion ( const G4FastTrack &  fastTrack )

private

Definition at line 239 of file GflashHadronShowerModel.cc.

References PVValHelper::eta, Gflash::EtaMin, ecalTB2006H4_GenSimDigiReco_cfg::G4cout, Gflash::getCalorimeterNumber(), edm::ParameterSet::getUntrackedParameter(), Gflash::kENCA, Gflash::kHB, Gflash::kHE, Gflash::MinDistanceToOut, Gflash::Rmax, theParSet, ctppsCommonDQMSource_cfi::verbosity, Gflash::Zmax, and Gflash::Zmin.

Referenced by ModelTrigger().

                                                                                  {
  const double invcm = 1.0 / CLHEP::cm;
  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::LogVerbatim("SimGeneralGFlash") << "GflashHadronShowerModel: excluding region of eta = " << eta;
    }
    return true;
  } else {
    const G4StepPoint *postStep = fastTrack.GetPrimaryTrack()->GetStep()->GetPostStepPoint();

    Gflash::CalorimeterNumber kCalor = Gflash::getCalorimeterNumber(postStep->GetPosition() * invcm);
    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() / CLHEP::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() * invcm;
      if (distOut < Gflash::MinDistanceToOut)
        isExcluded = true;
    } else if (kCalor == Gflash::kHE) {
      distOut = Gflash::Zmax[Gflash::kHE] - std::fabs(postStep->GetPosition().getZ() * invcm);
      if (distOut < Gflash::MinDistanceToOut)
        isExcluded = true;
    }

    //@@@remove this print statement later
    if (isExcluded && verbosity > 0) {
      G4cout << "GflashHadronShowerModel: skipping kCalor = " << kCalor << " DistanceToOut " << distOut << " from ("
             << (postStep->GetPosition()).getRho() * invcm << ":" << (postStep->GetPosition()).getZ() * invcm
             << ") of KE = " << fastTrack.GetPrimaryTrack()->GetKineticEnergy() / CLHEP::GeV << G4endl;
    }
  }

  return isExcluded;
}

IsApplicable()

G4bool GflashHadronShowerModel::IsApplicable ( const G4ParticleDefinition &  particleType )

override

Definition at line 60 of file GflashHadronShowerModel.cc.

References PbPb_ZMuSkimMuonDPG_cff::particleType.

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

isFirstInelasticInteraction()

G4bool GflashHadronShowerModel::isFirstInelasticInteraction ( const G4FastTrack &  fastTrack )

private

Definition at line 182 of file GflashHadronShowerModel.cc.

References GflashHistogram::deltaStep, GflashHistogram::energyLoss, GflashHistogram::energyRatio, GflashHistogram::getStoreFlag(), cuy::isFirst, GflashHistogram::kineticEnergy, PbPb_ZMuSkimMuonDPG_cff::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;
}

makeHits()

void GflashHadronShowerModel::makeHits ( const G4FastTrack &  fastTrack )

private

Definition at line 130 of file GflashHadronShowerModel.cc.

References GflashHadronShowerProfile::getGflashHitList(), Gflash::scaleSensitiveHB, Gflash::scaleSensitiveHE, theGflashNavigator, theGflashStep, theGflashTouchableHandle, theProfile, 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());

    const G4VPhysicalVolume *aCurrentVolume = theGflashStep->GetPreStepPoint()->GetPhysicalVolume();
    if (aCurrentVolume == nullptr)
      continue;

    const 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);
  }
}

ModelTrigger()

G4bool GflashHadronShowerModel::ModelTrigger ( const G4FastTrack &  fastTrack )

override

Definition at line 66 of file GflashHadronShowerModel.cc.

References Gflash::energyCutOff, excludeDetectorRegion(), 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() < Gflash::energyCutOff * CLHEP::GeV)
    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;
}

updateGflashStep()

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

private

Definition at line 175 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);
}

Member Data Documentation

theAntiProtonProfile

GflashAntiProtonShowerProfile* GflashHadronShowerModel::theAntiProtonProfile

private

Definition at line 49 of file GflashHadronShowerModel.h.

Referenced by DoIt(), and GflashHadronShowerModel().

theGflashNavigator

G4Navigator* GflashHadronShowerModel::theGflashNavigator

private

Definition at line 52 of file GflashHadronShowerModel.h.

Referenced by GflashHadronShowerModel(), and makeHits().

theGflashStep

G4Step* GflashHadronShowerModel::theGflashStep

private

Definition at line 51 of file GflashHadronShowerModel.h.

Referenced by GflashHadronShowerModel(), makeHits(), updateGflashStep(), and ~GflashHadronShowerModel().

theGflashTouchableHandle

G4TouchableHandle GflashHadronShowerModel::theGflashTouchableHandle

private

Definition at line 53 of file GflashHadronShowerModel.h.

Referenced by GflashHadronShowerModel(), makeHits(), and updateGflashStep().

theHisto

GflashHistogram* GflashHadronShowerModel::theHisto

private

Definition at line 56 of file GflashHadronShowerModel.h.

Referenced by GflashHadronShowerModel(), and isFirstInelasticInteraction().

theKaonMinusProfile

GflashKaonMinusShowerProfile* GflashHadronShowerModel::theKaonMinusProfile

private

Definition at line 47 of file GflashHadronShowerModel.h.

Referenced by DoIt(), and GflashHadronShowerModel().

theKaonPlusProfile

GflashKaonPlusShowerProfile* GflashHadronShowerModel::theKaonPlusProfile

private

Definition at line 46 of file GflashHadronShowerModel.h.

Referenced by DoIt(), and GflashHadronShowerModel().

theParSet

edm::ParameterSet GflashHadronShowerModel::theParSet

private

Definition at line 43 of file GflashHadronShowerModel.h.

Referenced by excludeDetectorRegion().

thePiKProfile

GflashPiKShowerProfile* GflashHadronShowerModel::thePiKProfile

private

Definition at line 45 of file GflashHadronShowerModel.h.

Referenced by DoIt(), and GflashHadronShowerModel().

theProfile

GflashHadronShowerProfile* GflashHadronShowerModel::theProfile

private

Definition at line 44 of file GflashHadronShowerModel.h.

Referenced by DoIt(), GflashHadronShowerModel(), makeHits(), and ~GflashHadronShowerModel().

theProtonProfile

GflashProtonShowerProfile* GflashHadronShowerModel::theProtonProfile

private

Definition at line 48 of file GflashHadronShowerModel.h.

Referenced by DoIt(), and GflashHadronShowerModel().

theWatcherOn

G4bool GflashHadronShowerModel::theWatcherOn

private

Definition at line 42 of file GflashHadronShowerModel.h.

Referenced by GflashHadronShowerModel().