detsim::ISCalculationSeparate Class Reference

#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.

    : 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 59 of file ISCalculationSeparate.cc.

  {
    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 130 of file ISCalculationSeparate.cc.

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

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

private

Definition at line 98 of file ISCalculationSeparate.cc.

  {
    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 138 of file ISCalculationSeparate.cc.

  {
    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 144 of file ISCalculationSeparate.cc.

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

Member Data Documentation

double detsim::ISCalculationSeparate::fGeVToElectrons

private

from LArG4Parameters service

Definition at line 53 of file ISCalculationSeparate.h.

const detinfo::LArProperties* detsim::ISCalculationSeparate::fLArProp

private

Definition at line 57 of file ISCalculationSeparate.h.

double detsim::ISCalculationSeparate::fModBoxA

private

Definition at line 50 of file ISCalculationSeparate.h.

double detsim::ISCalculationSeparate::fModBoxB

private

Definition at line 51 of file ISCalculationSeparate.h.

double detsim::ISCalculationSeparate::fRecombA

private

Definition at line 48 of file ISCalculationSeparate.h.

double detsim::ISCalculationSeparate::fRecombk

private

Definition at line 49 of file ISCalculationSeparate.h.

const spacecharge::SpaceCharge* detsim::ISCalculationSeparate::fSCE

private

Definition at line 58 of file ISCalculationSeparate.h.

bool detsim::ISCalculationSeparate::fUseModBoxRecomb

private

Definition at line 52 of file ISCalculationSeparate.h.

---

The documentation for this class was generated from the following files:

• larsim/larsim/ElectronDrift/ISCalculationSeparate.h
• larsim/larsim/ElectronDrift/ISCalculationSeparate.cc