larg4::ISCalcCorrelated Class Reference

#include <ISCalcCorrelated.h>

Inheritance diagram for larg4::ISCalcCorrelated:

Public Member Functions
	ISCalcCorrelated (detinfo::DetectorPropertiesData const &detProp, CLHEP::HepRandomEngine &Engine)
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
	ISCalc ()
virtual	~ISCalc ()=default
double	GetScintYield (sim::SimEnergyDeposit const &edep, bool prescale)
double	GetScintYieldRatio (sim::SimEnergyDeposit const &edep)

Private Member Functions
double	EscapingEFraction (double const dEdx) const
double	FieldCorrection (double const EF, double const dEdx) const

Private Attributes
ISTPC	fISTPC
const spacecharge::SpaceCharge *	fSCE
CLHEP::RandBinomial	fBinomialGen
double	fGeVToElectrons
	from LArG4Parameters service More...
double	fWion
	W_ion (23.6 eV) == 1/fGeVToElectrons. More...
double	fWph
	from LArG4Parameters service 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...
bool	fUseBinomialFlucts
	from LArG4Parameters service More...

Detailed Description

Definition at line 33 of file ISCalcCorrelated.h.

Constructor & Destructor Documentation

larg4::ISCalcCorrelated::ISCalcCorrelated	(	detinfo::DetectorPropertiesData const &	detProp,
		CLHEP::HepRandomEngine &	Engine
	)

Definition at line 34 of file ISCalcCorrelated.cxx.

    : fISTPC{*(lar::providerFrom<geo::Geometry>())}
    , fSCE(lar::providerFrom<spacecharge::SpaceChargeService>())
    , fBinomialGen{CLHEP::RandBinomial(Engine)}
  {
    MF_LOG_INFO("ISCalcCorrelated") << "IonizationAndScintillation/ISCalcCorrelated Initialize.";

    fScintPreScale = lar::providerFrom<detinfo::LArPropertiesService>()->ScintPreScale();

    art::ServiceHandle<sim::LArG4Parameters const> LArG4PropHandle;

    // 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();
    fUseBinomialFlucts  = (bool)LArG4PropHandle->UseBinomialFlucts();
    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
    fWph = LArG4PropHandle->Wph() * 1e-6; // MeV
  }

Member Function Documentation

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

overridevirtual

Implements larg4::ISCalc.

Definition at line 73 of file ISCalcCorrelated.cxx.

  {

    double const energy_deposit = edep.Energy();

    // calculate total quanta (ions + excitons)
    double num_ions = energy_deposit / fWion;
    double num_quanta = energy_deposit / fWph;

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

    //calculate recombination survival fraction value inside, otherwise zero
    if(EFieldStep > 0.) {
      // calculate recombination survival fraction
      // ...using Modified Box model
      if (fUseModBoxRecomb) {
        double Xi = fModBoxB * dEdx / EFieldStep;
        recomb = std::log(fModBoxA + Xi) / Xi;
      }
      // ... or using Birks/Doke
      else {
        recomb = fRecombA / (1. + dEdx * fRecombk / EFieldStep);
      }
    }

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

    // Guard against unphysical recombination values
    if (recomb < 0.){
      mf::LogWarning("ISCalcCorrelated")
        << "Recombination survival fraction is lower than 0.: " << recomb
        << ", fixing it to 0.";
      recomb = 0.;
    }
    else if (recomb > 1.){
      mf::LogWarning("ISCalcCorrelated")
        << "Recombination survival fraction is higher than 1.: " << recomb
        << ", fixing it to 1.";
      recomb = 1.;
    }

    // using this recombination, calculate number of ionization electrons
    double num_electrons = (fUseBinomialFlucts) ?
      fBinomialGen.fire(num_ions, recomb) : (num_ions * recomb);

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

    MF_LOG_DEBUG("ISCalcCorrelated")
      << "With " << energy_deposit << " MeV of deposited energy, "
      << "and a recombination of " << recomb << ", \nthere are "
      << num_electrons << " electrons, and " << num_photons   <<  " photons.";

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

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

overridevirtual

Implements larg4::ISCalc.

Definition at line 138 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 ) const

private

Definition at line 155 of file ISCalcCorrelated.cxx.

  {
    return fLarqlChi0A/(fLarqlChi0B+std::exp(fLarqlChi0C+fLarqlChi0D*dEdx));
  }

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

private

Definition at line 162 of file ISCalcCorrelated.cxx.

  {
    return std::exp(-EF/(fLarqlAlpha*std::log(dEdx)+fLarqlBeta));
  }

Member Data Documentation

CLHEP::RandBinomial larg4::ISCalcCorrelated::fBinomialGen

private

Definition at line 46 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fGeVToElectrons

private

from LArG4Parameters service

Definition at line 48 of file ISCalcCorrelated.h.

ISTPC larg4::ISCalcCorrelated::fISTPC

private

Definition at line 44 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlAlpha

private

from LArG4Parameters service

Definition at line 60 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlBeta

private

from LArG4Parameters service

Definition at line 61 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0A

private

from LArG4Parameters service

Definition at line 56 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0B

private

from LArG4Parameters service

Definition at line 57 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0C

private

from LArG4Parameters service

Definition at line 58 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fLarqlChi0D

private

from LArG4Parameters service

Definition at line 59 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fModBoxA

private

from LArG4Parameters service

Definition at line 54 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fModBoxB

private

from LArG4Parameters service

Definition at line 55 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fRecombA

private

from LArG4Parameters service

Definition at line 52 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fRecombk

private

from LArG4Parameters service

Definition at line 53 of file ISCalcCorrelated.h.

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

private

Definition at line 45 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fScintPreScale

private

scintillation pre-scaling factor from LArProperties service

Definition at line 51 of file ISCalcCorrelated.h.

bool larg4::ISCalcCorrelated::fUseBinomialFlucts

private

from LArG4Parameters service

Definition at line 64 of file ISCalcCorrelated.h.

bool larg4::ISCalcCorrelated::fUseModBoxRecomb

private

from LArG4Parameters service

Definition at line 62 of file ISCalcCorrelated.h.

bool larg4::ISCalcCorrelated::fUseModLarqlRecomb

private

from LArG4Parameters service

Definition at line 63 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fWion

private

W_ion (23.6 eV) == 1/fGeVToElectrons.

Definition at line 49 of file ISCalcCorrelated.h.

double larg4::ISCalcCorrelated::fWph

private

from LArG4Parameters service

Definition at line 50 of file ISCalcCorrelated.h.

---

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

• ISCalcCorrelated.h
• ISCalcCorrelated.cxx