larg4::ISCalcSeparate Class Reference

#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
Public Member Functions inherited from larg4::ISCalc
virtual	~ISCalc ()=default

Private Member Functions
double	CalcIon (detinfo::DetectorPropertiesData const &detProp, sim::SimEnergyDeposit const &edep)
std::pair< double, double >	CalcScint (sim::SimEnergyDeposit const &edep)
double	GetScintYieldRatio (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
const detinfo::LArProperties *	fLArProp

Detailed Description

Definition at line 31 of file ISCalcSeparate.h.

Constructor & Destructor Documentation

larg4::ISCalcSeparate::ISCalcSeparate

(

)

Definition at line 22 of file ISCalcSeparate.cxx.

  {
    fSCE = lar::providerFrom<spacecharge::SpaceChargeService>();
    fLArProp = lar::providerFrom<detinfo::LArPropertiesService>();

    // 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 43 of file ISCalcSeparate.cxx.

  {
    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 118 of file ISCalcSeparate.cxx.

  {
    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 82 of file ISCalcSeparate.cxx.

  {
    float const e = edep.Energy();
    int const pdg = edep.PdgCode();

    double numScintPhotons{};
    double scintYield = fLArProp->ScintYield(true);
    if (fLArProp->ScintByParticleType()) {
      MF_LOG_DEBUG("ISCalcSeparate") << "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);
      }

      numScintPhotons = scintYield * e;
    }
    else {
      numScintPhotons = scint_yield_factor * scintYield * e;
    }

    return {numScintPhotons, GetScintYieldRatio(edep)};
  }

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

overridevirtual

Implements larg4::ISCalc.

Definition at line 127 of file ISCalcSeparate.cxx.

  {
    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::ISCalcSeparate::GetScintYieldRatio ( sim::SimEnergyDeposit const &  edep )

private

Definition at line 137 of file ISCalcSeparate.cxx.

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

void larg4::ISCalcSeparate::Reset

(

)

Member Data Documentation

double larg4::ISCalcSeparate::fGeVToElectrons

private

from LArG4Parameters service

Definition at line 43 of file ISCalcSeparate.h.

const detinfo::LArProperties* larg4::ISCalcSeparate::fLArProp

private

Definition at line 51 of file ISCalcSeparate.h.

double larg4::ISCalcSeparate::fModBoxA

private

from LArG4Parameters service

Definition at line 46 of file ISCalcSeparate.h.

double larg4::ISCalcSeparate::fModBoxB

private

from LArG4Parameters service

Definition at line 47 of file ISCalcSeparate.h.

double larg4::ISCalcSeparate::fRecombA

private

from LArG4Parameters service

Definition at line 44 of file ISCalcSeparate.h.

double larg4::ISCalcSeparate::fRecombk

private

from LArG4Parameters service

Definition at line 45 of file ISCalcSeparate.h.

const spacecharge::SpaceCharge* larg4::ISCalcSeparate::fSCE

private

Definition at line 50 of file ISCalcSeparate.h.

bool larg4::ISCalcSeparate::fUseModBoxRecomb

private

from LArG4Parameters service

Definition at line 48 of file ISCalcSeparate.h.

---

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

• larsim/larsim/IonizationScintillation/ISCalcSeparate.h
• larsim/larsim/IonizationScintillation/ISCalcSeparate.cxx