#include "ISCalcSeparate.h"

Inheritance diagram for larg4::ISCalcSeparate:

Public Member Functions
	ISCalcSeparate ()

void	Reset ()

double	EFieldAtStep (double efield, sim::SimEnergyDeposit const &edep) override

ISCalcData	CalcIonAndScint (detinfo::DetectorPropertiesData const &detProp, sim::SimEnergyDeposit const &edep) override

double	GetScintYield (sim::SimEnergyDeposit const &edep, bool prescale)

double	GetScintYieldRatio (sim::SimEnergyDeposit const &edep)

Private Member Functions
double	CalcIon (detinfo::DetectorPropertiesData const &detProp, sim::SimEnergyDeposit const &edep)

std::pair< double, double >	CalcScint (sim::SimEnergyDeposit const &edep)

Private Attributes
double	fGeVToElectrons
	from LArG4Parameters service More...

double	fRecombA
	from LArG4Parameters service More...

double	fRecombk
	from LArG4Parameters service More...

double	fModBoxA
	from LArG4Parameters service More...

double	fModBoxB
	from LArG4Parameters service More...

bool	fUseModBoxRecomb
	from LArG4Parameters service More...

const spacecharge::SpaceCharge *	fSCE

Detailed Description

Definition at line 25 of file ISCalcSeparate.h.

Constructor & Destructor Documentation

larg4::ISCalcSeparate::ISCalcSeparate ( )

Definition at line 29 of file ISCalcSeparate.cxx.

References fGeVToElectrons, fModBoxA, fModBoxB, fRecombA, fRecombk, fSCE, and fUseModBoxRecomb.

   {
     fSCE = lar::providerFrom<spacecharge::SpaceChargeService>();
 
     // the recombination coefficient is in g/(MeVcm^2), but we report
     // energy depositions in MeV/cm, need to divide Recombk from the
     // LArG4Parameters service by the density of the argon we got
     // above; this is done in 'CalcIon' function below.
     art::ServiceHandle<sim::LArG4Parameters const> LArG4PropHandle;
     fRecombA = LArG4PropHandle->RecombA();
     fRecombk = LArG4PropHandle->Recombk();
     fModBoxA = LArG4PropHandle->ModBoxA();
     fModBoxB = LArG4PropHandle->ModBoxB();
     fUseModBoxRecomb = (bool)LArG4PropHandle->UseModBoxRecomb();
     fGeVToElectrons = LArG4PropHandle->GeVToElectrons();
   }

Member Function Documentation

double larg4::ISCalcSeparate::CalcIon	(	detinfo::DetectorPropertiesData const &	detProp,
		sim::SimEnergyDeposit const &	edep
	)

private

Definition at line 48 of file ISCalcSeparate.cxx.

References tca::dEdx(), detinfo::DetectorPropertiesData::Density(), e, edep, detinfo::DetectorPropertiesData::Efield(), EFieldAtStep(), sim::SimEnergyDeposit::Energy(), fGeVToElectrons, fModBoxA, fModBoxB, fRecombA, fRecombk, fUseModBoxRecomb, MF_LOG_DEBUG, sim::SimEnergyDeposit::StepLength(), and detinfo::DetectorPropertiesData::Temperature().

Referenced by CalcIonAndScint().

   {
     float e = edep.Energy();
     float ds = edep.StepLength();
 
     double recomb = 0.;
     double dEdx = (ds <= 0.0) ? 0.0 : e / ds;
     double EFieldStep = EFieldAtStep(detProp.Efield(), edep);
 
     // Guard against spurious values of dE/dx. Note: assumes density of LAr
     if (dEdx < 1.) { dEdx = 1.; }
 
     if (fUseModBoxRecomb) {
       if (ds > 0) {
         double const scaled_modboxb = fModBoxB / detProp.Density(detProp.Temperature());
         double const Xi = scaled_modboxb * dEdx / EFieldStep;
         recomb = log(fModBoxA + Xi) / Xi;
       }
       else {
         recomb = 0;
       }
     }
     else {
       double const scaled_recombk = fRecombk / detProp.Density(detProp.Temperature());
       recomb = fRecombA / (1. + dEdx * scaled_recombk / EFieldStep);
     }
 
     // 1.e-3 converts fEnergyDeposit to GeV
     auto const numIonElectrons = fGeVToElectrons * 1.e-3 * e * recomb;
 
     MF_LOG_DEBUG("ISCalcSeparate")
       << " Electrons produced for " << edep.Energy() << " MeV deposited with " << recomb
       << " recombination: " << numIonElectrons << std::endl;
     return numIonElectrons;
   }

ISCalcData larg4::ISCalcSeparate::CalcIonAndScint	(	detinfo::DetectorPropertiesData const &	detProp,
		sim::SimEnergyDeposit const &	edep
	)

overridevirtual

Implements larg4::ISCalc.

Definition at line 93 of file ISCalcSeparate.cxx.

References CalcIon(), CalcScint(), and sim::SimEnergyDeposit::Energy().

Referenced by spacecharge::ShiftEdepSCE::produce(), and phot::PhotonLibraryPropagation::produce().

   {
     auto const numElectrons = CalcIon(detProp, edep);
     auto const [numPhotons, scintYieldRatio] = CalcScint(edep);
     return {edep.Energy(), numElectrons, numPhotons, scintYieldRatio};
   }

std::pair< double, double > larg4::ISCalcSeparate::CalcScint ( sim::SimEnergyDeposit const & edep )

private

Definition at line 86 of file ISCalcSeparate.cxx.

References sim::SimEnergyDeposit::Energy(), larg4::ISCalc::GetScintYield(), and larg4::ISCalc::GetScintYieldRatio().

Referenced by CalcIonAndScint().

   {
     double numScintPhotons = GetScintYield(edep, true) * edep.Energy();
     return {numScintPhotons, GetScintYieldRatio(edep)};
   }

double larg4::ISCalcSeparate::EFieldAtStep	(	double	efield,
		sim::SimEnergyDeposit const &	edep
	)

overridevirtual

Implements larg4::ISCalc.

Definition at line 101 of file ISCalcSeparate.cxx.

References spacecharge::SpaceCharge::EnableSimEfieldSCE(), fSCE, spacecharge::SpaceCharge::GetEfieldOffsets(), and sim::SimEnergyDeposit::MidPoint().

Referenced by CalcIon().

   {
     if (not fSCE->EnableSimEfieldSCE()) { return efield; }
 
     auto const eFieldOffsets = fSCE->GetEfieldOffsets(edep.MidPoint());
     return std::hypot(
       efield + efield * eFieldOffsets.X(), efield * eFieldOffsets.Y(), efield * eFieldOffsets.Z());
   }

double larg4::ISCalc::GetScintYield	(	sim::SimEnergyDeposit const &	edep,
		bool	prescale
	)

inherited

Definition at line 21 of file ISCalc.cxx.

References detinfo::LArProperties::AlphaScintYield(), detinfo::LArProperties::ElectronScintYield(), larg4::ISCalc::fLArProp, detinfo::LArProperties::KaonScintYield(), detinfo::LArProperties::MuonScintYield(), sim::SimEnergyDeposit::PdgCode(), detinfo::LArProperties::PionScintYield(), detinfo::LArProperties::ProtonScintYield(), detinfo::LArProperties::ScintByParticleType(), and detinfo::LArProperties::ScintYield().

Referenced by CalcScint().

   {
     if (!fLArProp->ScintByParticleType()) return fLArProp->ScintYield(true);
     switch (edep.PdgCode()) {
     case 2212: return fLArProp->ProtonScintYield(true);
     case 13:
     case -13: return fLArProp->MuonScintYield(true);
     case 211:
     case -211: return fLArProp->PionScintYield(true);
     case 321:
     case -321: return fLArProp->KaonScintYield(true);
     case 1000020040: return fLArProp->AlphaScintYield(true);
     case 11:
     case -11:
     case 22: return fLArProp->ElectronScintYield(true);
     default: return fLArProp->ElectronScintYield(true);
     }
   }

double larg4::ISCalc::GetScintYieldRatio ( sim::SimEnergyDeposit const & edep )

inherited

Definition at line 41 of file ISCalc.cxx.

References detinfo::LArProperties::AlphaScintYieldRatio(), detinfo::LArProperties::ElectronScintYieldRatio(), larg4::ISCalc::fLArProp, detinfo::LArProperties::KaonScintYieldRatio(), detinfo::LArProperties::MuonScintYieldRatio(), sim::SimEnergyDeposit::PdgCode(), detinfo::LArProperties::PionScintYieldRatio(), detinfo::LArProperties::ProtonScintYieldRatio(), detinfo::LArProperties::ScintByParticleType(), and detinfo::LArProperties::ScintYieldRatio().

Referenced by larg4::ISCalcNESTLAr::CalcIonAndScint(), larg4::ISCalcCorrelated::CalcIonAndScint(), and CalcScint().

   {
     // ScintByParticleType option only controls the scintillation
     // yield ratio, which is the ratio of fast light (singlet
     // component) to the total light (singlet+triplet components).
 
     if (!fLArProp->ScintByParticleType()) return fLArProp->ScintYieldRatio();
 
     switch (edep.PdgCode()) {
     case 2212: return fLArProp->ProtonScintYieldRatio();
     case 13:
     case -13: return fLArProp->MuonScintYieldRatio();
     case 211:
     case -211: return fLArProp->PionScintYieldRatio();
     case 321:
     case -321: return fLArProp->KaonScintYieldRatio();
     case 1000020040: return fLArProp->AlphaScintYieldRatio();
     case 11:
     case -11:
     case 22: return fLArProp->ElectronScintYieldRatio();
     default: return fLArProp->ElectronScintYieldRatio();
     }
   }