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
GflashKaonMinusShowerProfile *	theKaonMinusProfile
GflashKaonPlusShowerProfile *	theKaonPlusProfile
edm::ParameterSet	theParSet
GflashPiKShowerProfile *	thePiKProfile
GflashHadronShowerProfile *	theProfile
GflashProtonShowerProfile *	theProtonProfile
const G4Region *	theRegion
G4bool	theWatcherOn

Detailed Description

Definition at line 20 of file GFlashHadronShowerModel.h.

Constructor & Destructor Documentation

GFlashHadronShowerModel()

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

Definition at line 35 of file GFlashHadronShowerModel.cc.

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

    : G4VFastSimulationModel(modelName, envelope), theParSet(parSet) {
  theWatcherOn = parSet.getParameter<bool>("watcherOn");

  theProfile = nullptr;
  thePiKProfile = new GflashPiKShowerProfile(parSet);
  theKaonPlusProfile = new GflashKaonPlusShowerProfile(parSet);
  theKaonMinusProfile = new GflashKaonMinusShowerProfile(parSet);
  theProtonProfile = new GflashProtonShowerProfile(parSet);
  theAntiProtonProfile = new GflashAntiProtonShowerProfile(parSet);

  theRegion = reinterpret_cast<G4Region*>(envelope);

  theGflashStep = new G4Step();
  theGflashTouchableHandle = new G4TouchableHistory();
  theGflashNavigator = new G4Navigator();
}

~GFlashHadronShowerModel()

GFlashHadronShowerModel::~GFlashHadronShowerModel ( )

override

Definition at line 55 of file GFlashHadronShowerModel.cc.

References theAntiProtonProfile, theGflashStep, theKaonMinusProfile, theKaonPlusProfile, thePiKProfile, and theProtonProfile.

                                                  {
  delete thePiKProfile;
  delete theKaonPlusProfile;
  delete theKaonMinusProfile;
  delete theProtonProfile;
  delete theAntiProtonProfile;
  delete theGflashStep;
}

Member Function Documentation

DoIt()

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

override

Definition at line 98 of file GFlashHadronShowerModel.cc.

References ALCARECOTkAlJpsiMuMu_cff::charge, hcalRecHitTable_cff::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 235 of file GFlashHadronShowerModel.cc.

References PVValHelper::eta, Gflash::EtaMin, Gflash::getCalorimeterNumber(), edm::ParameterSet::getUntrackedParameter(), Gflash::kENCA, Gflash::kHB, Gflash::kHE, Gflash::MinDistanceToOut, Gflash::Rmax, theParSet, 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("SimG4CoreApplication") << "GFlashHadronShowerModel: excluding region of eta = " << eta;
    }
    return true;
  } else {
    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() * invcm) < 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) {
      edm::LogVerbatim("SimG4CoreApplication")
          << "GFlashHadronShowerModel: skipping kCalor = " << kCalor << " DistanceToOut " << distOut << " from ("
          << (postStep->GetPosition()).getRho() * invcm << ":" << (postStep->GetPosition()).getZ() * invcm
          << ") of KE = " << fastTrack.GetPrimaryTrack()->GetKineticEnergy() / CLHEP::GeV;
    }
  }

  return isExcluded;
}

IsApplicable()

G4bool GFlashHadronShowerModel::IsApplicable ( const G4ParticleDefinition &  particleType )

override

Definition at line 64 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 193 of file GFlashHadronShowerModel.cc.

References l1ctLayer1_patternWriters_cff::isec, cuy::isFirst, PbPb_ZMuSkimMuonDPG_cff::particleType, and Gflash::QuasiElasticLike.

                                                                                        {
  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;
  }
  return isFirst;
}

makeHits()

void GFlashHadronShowerModel::makeHits ( const G4FastTrack &  fastTrack )

private

Definition at line 132 of file GFlashHadronShowerModel.cc.

References GflashHadronShowerProfile::getGflashHitList(), SteppingAction::m_g4StepSignal, DD4hep2DDDName::noNameSpace(), Gflash::scaleSensitiveHB, Gflash::scaleSensitiveHE, theGflashNavigator, theGflashStep, theGflashTouchableHandle, theProfile, theRegion, 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() != theRegion) {
      continue;
    }

    theGflashStep->GetPreStepPoint()->SetSensitiveDetector(aCurrentVolume->GetLogicalVolume()->GetSensitiveDetector());
    G4VSensitiveDetector* aSensitive = theGflashStep->GetPreStepPoint()->GetSensitiveDetector();

    if (aSensitive == nullptr)
      continue;

    G4String nameCalor = (G4String)(DD4hep2DDDName::noNameSpace(lv->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 70 of file GFlashHadronShowerModel.cc.

References Gflash::energyCutOff, excludeDetectorRegion(), and theRegion.

                                                                         {
  // 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)

  // mininum energy cutoff to parameterize
  if (fastTrack.GetPrimaryTrack()->GetKineticEnergy() < CLHEP::GeV * Gflash::energyCutOff) {
    return false;
  }

  // This will be changed accordingly when the way
  // dealing with CaloRegion changes later.
  const G4VPhysicalVolume* pCurrentVolume = fastTrack.GetPrimaryTrack()->GetTouchable()->GetVolume();
  if (pCurrentVolume == nullptr) {
    return false;
  }

  const G4LogicalVolume* lv = pCurrentVolume->GetLogicalVolume();
  if (lv->GetRegion() != theRegion) {
    return false;
  }
  return !(excludeDetectorRegion(fastTrack));
}

updateGflashStep()

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

Member Data Documentation

theAntiProtonProfile

GflashAntiProtonShowerProfile* GFlashHadronShowerModel::theAntiProtonProfile

private

Definition at line 50 of file GFlashHadronShowerModel.h.

Referenced by DoIt(), GFlashHadronShowerModel(), and ~GFlashHadronShowerModel().

theGflashNavigator

G4Navigator* GFlashHadronShowerModel::theGflashNavigator

private

Definition at line 55 of file GFlashHadronShowerModel.h.

Referenced by GFlashHadronShowerModel(), and makeHits().

theGflashStep

G4Step* GFlashHadronShowerModel::theGflashStep

private

Definition at line 54 of file GFlashHadronShowerModel.h.

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

theGflashTouchableHandle

G4TouchableHandle GFlashHadronShowerModel::theGflashTouchableHandle

private

Definition at line 56 of file GFlashHadronShowerModel.h.

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

theKaonMinusProfile

GflashKaonMinusShowerProfile* GFlashHadronShowerModel::theKaonMinusProfile

private

Definition at line 48 of file GFlashHadronShowerModel.h.

Referenced by DoIt(), GFlashHadronShowerModel(), and ~GFlashHadronShowerModel().

theKaonPlusProfile

GflashKaonPlusShowerProfile* GFlashHadronShowerModel::theKaonPlusProfile

private

Definition at line 47 of file GFlashHadronShowerModel.h.

Referenced by DoIt(), GFlashHadronShowerModel(), and ~GFlashHadronShowerModel().

theParSet

edm::ParameterSet GFlashHadronShowerModel::theParSet

private

Definition at line 44 of file GFlashHadronShowerModel.h.

Referenced by excludeDetectorRegion().

thePiKProfile

GflashPiKShowerProfile* GFlashHadronShowerModel::thePiKProfile

private

Definition at line 46 of file GFlashHadronShowerModel.h.

Referenced by DoIt(), GFlashHadronShowerModel(), and ~GFlashHadronShowerModel().

theProfile

GflashHadronShowerProfile* GFlashHadronShowerModel::theProfile

private

Definition at line 45 of file GFlashHadronShowerModel.h.

Referenced by DoIt(), GFlashHadronShowerModel(), and makeHits().

theProtonProfile

GflashProtonShowerProfile* GFlashHadronShowerModel::theProtonProfile

private

Definition at line 49 of file GFlashHadronShowerModel.h.

Referenced by DoIt(), GFlashHadronShowerModel(), and ~GFlashHadronShowerModel().

theRegion

const G4Region* GFlashHadronShowerModel::theRegion

private

Definition at line 52 of file GFlashHadronShowerModel.h.

Referenced by GFlashHadronShowerModel(), makeHits(), and ModelTrigger().

theWatcherOn

G4bool GFlashHadronShowerModel::theWatcherOn

private

Definition at line 43 of file GFlashHadronShowerModel.h.

Referenced by GFlashHadronShowerModel(), and makeHits().