ISCalcCorrelated.h

Go to the documentation of this file.

// Class:       ISCalcCorrelated
// Plugin Type: algorithm
// File:        ISCalcCorrelated.h and ISCalcCorrelated.cxx
// Description: Interface to algorithm class for a specific calculation of
//              ionization electrons and scintillation photons, based on
//              simple microphysics arguments to establish an anticorrelation
//              between these two quantities.
// Input: 'sim::SimEnergyDeposit'
// Output: Number of Photons and Electrons
// May 2020 by W Foreman
// Modified: Adding corrections for low electric field (LArQL model)
// Jun 2020 by L. Paulucci and F. Marinho

#ifndef IS_ISCALCCORRELATED_H
#define IS_ISCALCCORRELATED_H

#include "larsim/IonizationScintillation/ISCalc.h"
#include "larsim/IonizationScintillation/ISTPC.h"

#include "CLHEP/Random/RandBinomial.h"

namespace spacecharge {
  class SpaceCharge;
}

namespace CLHEP {
  class HepRandomEngine;
}

namespace larg4 {
  class ISCalcCorrelated : public ISCalc {
  public:
    ISCalcCorrelated(detinfo::DetectorPropertiesData const& detProp,
                     CLHEP::HepRandomEngine& Engine);

    double EFieldAtStep(double efield,
                        sim::SimEnergyDeposit const& edep)
      override; //value of field with any corrections for this step
    double AngleToEFieldAtStep(double efield, sim::SimEnergyDeposit const& edep);
    ISCalcData CalcIonAndScint(detinfo::DetectorPropertiesData const& detProp,
                               sim::SimEnergyDeposit const& edep) override;

  private:
    ISTPC fISTPC;
    const spacecharge::SpaceCharge* fSCE;
    CLHEP::RandBinomial fBinomialGen;

    double fGeVToElectrons;      
    double fWion;                
    double fWph;                 
    double fScintPreScale;       
    double fRecombA;             
    double fRecombk;             
    double fModBoxA;             
    double fModBoxB;             
    double fEllipsModBoxA;       
    double fEllipsModBoxB;       
    double fEllipsModBoxR;       
    double fLarqlChi0A;          
    double fLarqlChi0B;          
    double fLarqlChi0C;          
    double fLarqlChi0D;          
    double fLarqlAlpha;          
    double fLarqlBeta;           
    double fQAlpha;              
    bool fUseModBoxRecomb;       
    bool fUseEllipsModBoxRecomb; 
    bool fUseModLarqlRecomb;     
    bool fUseBinomialFlucts;     

    double EscapingEFraction(
      double const dEdx) const; //LArQL chi0 function = fraction of escaping electrons
    double FieldCorrection(double const EF, double const dEdx)
      const; //LArQL f_corr function = correction factor for electric field dependence
  };
}
#endif