larg4::ISCalcCorrelated Class Reference

#include <ISCalcCorrelated.h>

Inheritance diagram for larg4::ISCalcCorrelated:

Public Member Functions
	ISCalcCorrelated (detinfo::DetectorPropertiesData const &detProp)
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
void	CalcIon (sim::SimEnergyDeposit const &edep)
void	CalcScint (sim::SimEnergyDeposit const &edep)
double	GetScintYieldRatio (sim::SimEnergyDeposit const &edep)
double	EscapingEFraction (double const dEdx)
double	FieldCorrection (double const EF, double const dEdx)

Private Attributes
double	fGeVToElectrons
	from LArG4Parameters service More...
double	fWion
	W_ion (23.6 eV) == 1/fGeVToElectrons. More...
double	fWph
	W_ph (19.5 eV) More...
double	fScintPreScale
	scintillation pre-scaling factor from LArProperties 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...
double	fLarqlChi0A
	from LArG4Parameters service More...
double	fLarqlChi0B
	from LArG4Parameters service More...
double	fLarqlChi0C
	from LArG4Parameters service More...
double	fLarqlChi0D
	from LArG4Parameters service More...
double	fLarqlAlpha
	from LArG4Parameters service More...
double	fLarqlBeta
	from LArG4Parameters service More...
bool	fUseModBoxRecomb
	from LArG4Parameters service More...
bool	fUseModLarqlRecomb
	from LArG4Parameters service More...
const spacecharge::SpaceCharge *	fSCE
const detinfo::LArProperties *	fLArProp
ISTPC	fISTPC

Detailed Description

Definition at line 35 of file ISCalcCorrelated.h.

Constructor & Destructor Documentation

larg4::ISCalcCorrelated::ISCalcCorrelated

(

detinfo::DetectorPropertiesData const &

detProp

)

Definition at line 21 of file ISCalcCorrelated.cxx.

    : fISTPC{*(lar::providerFrom<geo::Geometry>())}
  {
    std::cout << "IonizationAndScintillation/ISCalcCorrelated Initialize." << std::endl;
    art::ServiceHandle<sim::LArG4Parameters const> LArG4PropHandle;

    fSCE = lar::providerFrom<spacecharge::SpaceChargeService>();
    fLArProp = lar::providerFrom<detinfo::LArPropertiesService>();
    fScintPreScale = fLArProp->ScintPreScale();

    //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.
    fRecombA = LArG4PropHandle->RecombA();
    fRecombk = LArG4PropHandle->Recombk() / detProp.Density(detProp.Temperature());
    fModBoxA = LArG4PropHandle->ModBoxA();
    fModBoxB = LArG4PropHandle->ModBoxB() / detProp.Density(detProp.Temperature());
    fUseModBoxRecomb = (bool)LArG4PropHandle->UseModBoxRecomb();
    fUseModLarqlRecomb  = (bool)LArG4PropHandle->UseModLarqlRecomb();
    fLarqlChi0A = LArG4PropHandle->LarqlChi0A();
    fLarqlChi0B = LArG4PropHandle->LarqlChi0B();
    fLarqlChi0C = LArG4PropHandle->LarqlChi0C();
    fLarqlChi0D = LArG4PropHandle->LarqlChi0D();
    fLarqlAlpha = LArG4PropHandle->LarqlAlpha();
    fLarqlBeta  = LArG4PropHandle->LarqlBeta();
    fGeVToElectrons = LArG4PropHandle->GeVToElectrons();

    // ionization work function
    fWion = 1. / fGeVToElectrons * 1e3; // MeV

    // ion+excitation work function (\todo: get from LArG4Parameters or LArProperties?)
    fWph = 19.5 * 1e-6; // MeV
  }

Member Function Documentation

void larg4::ISCalcCorrelated::CalcIon ( sim::SimEnergyDeposit const &  edep )

private

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

overridevirtual

Implements larg4::ISCalc.

Definition at line 56 of file ISCalcCorrelated.cxx.

  {
    double const energy_deposit = edep.Energy();

    // calculate total quanta (ions + excitons)
    double Nq = energy_deposit / fWph;

    float ds = edep.StepLength();
    double dEdx = (ds <= 0.0) ? 0.0 : energy_deposit / ds;
    double EFieldStep = EFieldAtStep(detProp.Efield(), edep);
    double recomb = 0.;

    //calculate recombination survival fraction value inside, otherwise zero

    if(EFieldStep > 0) {
      // Guard against spurious values of dE/dx. Note: assumes density of LAr
      if (dEdx < 1.) dEdx = 1.;

      // calculate recombination survival fraction
      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);
      }

    }//Efield

    if(fUseModLarqlRecomb){ //Use corrections from LArQL model
      recomb += EscapingEFraction(dEdx)*FieldCorrection(EFieldStep, dEdx); //Correction for low EF
    }


   

    // using this recombination, calculate number of ionization electrons
    double const num_electrons = (energy_deposit / fWion) * recomb;

    // calculate scintillation photons
    double const num_photons = (Nq - num_electrons) * fScintPreScale;

    MF_LOG_DEBUG("ISCalcCorrelated")
      << " Electrons produced for " << energy_deposit << " MeV deposited with " << recomb
      << " recombination: " << num_electrons << std::endl;
    MF_LOG_DEBUG("ISCalcCorrelated") << "number photons: " << num_photons;

    return {energy_deposit, num_electrons, num_photons, GetScintYieldRatio(edep)};
  }

void larg4::ISCalcCorrelated::CalcScint ( sim::SimEnergyDeposit const &  edep )

private

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

overridevirtual

Implements larg4::ISCalc.

Definition at line 143 of file ISCalcCorrelated.cxx.

   {
     //electric field outside active volume set to zero                                                                                                                                                      
     if(!fISTPC.isScintInActiveVolume(edep.MidPoint())) return 0;

     //electric field inside active volume                                                                                                                                                                   
     if (!fSCE->EnableSimEfieldSCE()) return efield;

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

double larg4::ISCalcCorrelated::EscapingEFraction ( double const  dEdx )

private

Definition at line 157 of file ISCalcCorrelated.cxx.

                                                             { //LArQL chi0 function = fraction of escaping electrons
    return fLarqlChi0A/(fLarqlChi0B+exp(fLarqlChi0C+fLarqlChi0D*dEdx));
  }

double larg4::ISCalcCorrelated::FieldCorrection ( double const  EF, double const  dEdx  )

private

Definition at line 161 of file ISCalcCorrelated.cxx.

                                                                            { //LArQL f_corr function = correction factor for electric field dependence
    return exp(-EF/(fLarqlAlpha*log(dEdx)+fLarqlBeta));
  }

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

private

Definition at line 114 of file ISCalcCorrelated.cxx.

  {
    // For ISCalcCorrelated, the ScintByParticleType option only controls
    // the scintillation yield ratio, which is the ratio of fast light (singlet
    // component) to the total light (singlet+triplet components).
    //
    // TODO: move this to ISCalc, since it is the same function used in the
    //       other ionization/scintillation calculation algs

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

Member Data Documentation

double larg4::ISCalcCorrelated::fGeVToElectrons

private

from LArG4Parameters service

Definition at line 46 of file ISCalcCorrelated.h.

ISTPC larg4::ISCalcCorrelated::fISTPC

private

Definition at line 71 of file ISCalcCorrelated.h.

const detinfo::LArProperties* larg4::ISCalcCorrelated::fLArProp

private

Definition at line 64 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlAlpha

private

from LArG4Parameters service

Definition at line 58 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlBeta

private

from LArG4Parameters service

Definition at line 59 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0A

private

from LArG4Parameters service

Definition at line 54 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0B

private

from LArG4Parameters service

Definition at line 55 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0C

private

from LArG4Parameters service

Definition at line 56 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0D

private

from LArG4Parameters service

Definition at line 57 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fModBoxA

private

from LArG4Parameters service

Definition at line 52 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fModBoxB

private

from LArG4Parameters service

Definition at line 53 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fRecombA

private

from LArG4Parameters service

Definition at line 50 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fRecombk

private

from LArG4Parameters service

Definition at line 51 of file ISCalcCorrelated.h.

const spacecharge::SpaceCharge* larg4::ISCalcCorrelated::fSCE

private

Definition at line 63 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fScintPreScale

private

scintillation pre-scaling factor from LArProperties service

Definition at line 49 of file ISCalcCorrelated.h.

bool larg4::ISCalcCorrelated::fUseModBoxRecomb

private

from LArG4Parameters service

Definition at line 60 of file ISCalcCorrelated.h.

bool larg4::ISCalcCorrelated::fUseModLarqlRecomb

private

from LArG4Parameters service

Definition at line 61 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fWion

private

W_ion (23.6 eV) == 1/fGeVToElectrons.

Definition at line 47 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fWph

private

W_ph (19.5 eV)

Definition at line 48 of file ISCalcCorrelated.h.

---

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

• larsim/larsim/IonizationScintillation/ISCalcCorrelated.h
• larsim/larsim/IonizationScintillation/ISCalcCorrelated.cxx