#include "ISCalculationSeparate.h"

Classes
struct	Data

Public Member Functions
	ISCalculationSeparate (fhicl::ParameterSet const &pset)

Data	CalculateIonizationAndScintillation (detinfo::DetectorPropertiesData const &detProp, sim::SimEnergyDeposit const &edep) const

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

Private Member Functions
double	EFieldAtStep (double efield, float x, float y, float z) const

double	CalculateIonization (detinfo::DetectorPropertiesData const &detProp, sim::SimEnergyDeposit const &edep) const

double	CalculateScintillation (sim::SimEnergyDeposit const &edep) const

Private Attributes
double	fRecombA

double	fRecombk

double	fModBoxA

double	fModBoxB

bool	fUseModBoxRecomb

double	fGeVToElectrons
	from LArG4Parameters service More...

const detinfo::LArProperties *	fLArProp

const spacecharge::SpaceCharge *	fSCE

Detailed Description

Definition at line 33 of file ISCalculationSeparate.h.

Constructor & Destructor Documentation

detsim::ISCalculationSeparate::ISCalculationSeparate ( fhicl::ParameterSet const & pset )

explicit

Definition at line 37 of file ISCalculationSeparate.cc.

References fGeVToElectrons, fLArProp, fModBoxA, fModBoxB, fRecombk, fSCE, fUseModBoxRecomb, and fhicl::ParameterSet::get().

     : fRecombA{pset.get<double>("RecombA")}
     , fRecombk{pset.get<double>("Recombk")}
     , fModBoxA{pset.get<double>("ModBoxA")}
     , fModBoxB{pset.get<double>("ModBoxB")}
     , fUseModBoxRecomb{pset.get<bool>("UseModBoxRecomb")}
     , fGeVToElectrons{pset.get<double>("GeVToElectrons")}
   {
     fLArProp = lar::providerFrom<detinfo::LArPropertiesService>();
     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.  FIXME: is this being done?
 
     std::cout << "fLArG4Prop->GeVToElectrons(): " << fGeVToElectrons << std::endl;
   }

Member Function Documentation

double detsim::ISCalculationSeparate::CalculateIonization	(	detinfo::DetectorPropertiesData const &	detProp,
		sim::SimEnergyDeposit const &	edep
	)		const

private

Definition at line 58 of file ISCalculationSeparate.cc.

References tca::dEdx(), e, detinfo::DetectorPropertiesData::Efield(), EFieldAtStep(), sim::SimEnergyDeposit::Energy(), fGeVToElectrons, fModBoxA, fModBoxB, fRecombA, fRecombk, fUseModBoxRecomb, MF_LOG_DEBUG, sim::SimEnergyDeposit::MidPointX(), sim::SimEnergyDeposit::MidPointY(), sim::SimEnergyDeposit::MidPointZ(), sim::SimEnergyDeposit::StepLength(), x, y, and z.

Referenced by CalculateIonizationAndScintillation().

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

ISCalculationSeparate::Data detsim::ISCalculationSeparate::CalculateIonizationAndScintillation	(	detinfo::DetectorPropertiesData const &	detProp,
		sim::SimEnergyDeposit const &	edep
	)		const

Definition at line 127 of file ISCalculationSeparate.cc.

References CalculateIonization(), CalculateScintillation(), and sim::SimEnergyDeposit::Energy().

Referenced by detsim::DriftElectronstoPlane::produce().

   {
     return {edep.Energy(), CalculateIonization(detProp, edep), CalculateScintillation(edep)};
   }

double detsim::ISCalculationSeparate::CalculateScintillation ( sim::SimEnergyDeposit const & edep ) const

private

Definition at line 96 of file ISCalculationSeparate.cc.

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

Referenced by CalculateIonizationAndScintillation().

   {
     float const e = edep.Energy();
     int const pdg = edep.PdgCode();
     double scintYield = fLArProp->ScintYield(true);
     if (fLArProp->ScintByParticleType()) {
 
       MF_LOG_DEBUG("ISCalculationSeparate") << "scintillating by particle type";
 
       switch (pdg) {
 
       case 2212: scintYield = fLArProp->ProtonScintYield(true); break;
       case 13:
       case -13: scintYield = fLArProp->MuonScintYield(true); break;
       case 211:
       case -211: scintYield = fLArProp->PionScintYield(true); break;
       case 321:
       case -321: scintYield = fLArProp->KaonScintYield(true); break;
       case 1000020040: scintYield = fLArProp->AlphaScintYield(true); break;
       case 11:
       case -11:
       case 22: scintYield = fLArProp->ElectronScintYield(true); break;
       default: scintYield = fLArProp->ElectronScintYield(true);
       }
 
       return scintYield * e;
     }
 
     return scint_yield_factor * scintYield * e;
   }

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

Definition at line 134 of file ISCalculationSeparate.cc.

References sim::SimEnergyDeposit::MidPointX(), sim::SimEnergyDeposit::MidPointY(), and sim::SimEnergyDeposit::MidPointZ().

Referenced by CalculateIonization().

   {
     return EFieldAtStep(efield, edep.MidPointX(), edep.MidPointY(), edep.MidPointZ());
   }

double detsim::ISCalculationSeparate::EFieldAtStep	(	double	efield,
		float	x,
		float	y,
		float	z
	)		const

private

Definition at line 140 of file ISCalculationSeparate.cc.

References spacecharge::SpaceCharge::EnableSimEfieldSCE(), fSCE, spacecharge::SpaceCharge::GetEfieldOffsets(), x, and y.

   {
     if (not fSCE->EnableSimEfieldSCE()) { return efield; }
 
     auto const offsets = fSCE->GetEfieldOffsets(geo::Point_t{x, y, z});
     return std::hypot(efield + efield * offsets.X(), efield * offsets.Y(), efield * offsets.Z());
   }