#include "ISCalculationCorrelated.h"

Inheritance diagram for larg4::ISCalculationCorrelated:

Public Member Functions
	ISCalculationCorrelated (detinfo::DetectorPropertiesData const &detProp)

void	Reset ()

void	CalculateIonizationAndScintillation (const G4Step *step)

double	StepSizeLimit () const

double	EnergyDeposit () const

double	NumberIonizationElectrons () const

double	NumberScintillationPhotons () const

double	VisibleEnergyDeposit () const

double	EFieldAtStep (double fEfield, const G4Step *step) const

Protected Attributes
double	fEnergyDeposit
	total energy deposited in the step More...

double	fNumIonElectrons
	number of ionization electrons for this step More...

double	fNumScintPhotons
	number of scintillation photons for this step More...

double	fVisibleEnergyDeposition

Private Member Functions
double	EscapingEFraction (double const dEdx)

double	FieldCorrection (double const EF, double const dEdx)

Private Attributes
double	fStepSize
	maximum step to take More...

double	fEfield
	value of electric field from LArProperties service More...

double	fWion
	W_ion (23.6 eV) == 1/fGeVToElectrons. More...

double	fWph
	W_ph (19.5 eV) More...

double	fScintPreScale
	scintillation pre-scale 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...

double	fEllipsModBoxA
	from LArG4Parameters service More...

double	fEllipsModBoxB
	from LArG4Parameters service More...

double	fEllipsModBoxR
	from LArG4Parameters service More...

bool	fUseEllipsModBoxRecomb
	from LArG4Parameters service More...

bool	fUseModBoxRecomb
	from LArG4Parameters service More...

bool	fUseModLarqlRecomb
	from LArG4Parameters service More...

Detailed Description

Definition at line 30 of file ISCalculationCorrelated.h.

Constructor & Destructor Documentation

larg4::ISCalculationCorrelated::ISCalculationCorrelated ( detinfo::DetectorPropertiesData const & detProp )

explicit

Definition at line 39 of file ISCalculationCorrelated.cxx.

   {
     std::cout << "LegacyLArG4/ISCalculationCorrelated Initialize." << std::endl;
     art::ServiceHandle<sim::LArG4Parameters const> lgpHandle;
     const detinfo::LArProperties* larp = lar::providerFrom<detinfo::LArPropertiesService>();
 
     double density = detProp.Density(detProp.Temperature());
     fEfield = detProp.Efield();
     fScintPreScale = larp->ScintPreScale();
 
     // ionization work function
     fWion = 1. / lgpHandle->GeVToElectrons() * 1e3; // MeV
 
     // ion+excitation work function (\todo: get from LArG4Parameters or LArProperties?)
     fWph = 19.5 * 1e-6; // MeV
 
     // 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 = lgpHandle->RecombA();
     fRecombk = lgpHandle->Recombk() / density;
     fModBoxA = lgpHandle->ModBoxA();
     fModBoxB = lgpHandle->ModBoxB() / density;
     fEllipsModBoxA = lgpHandle->EllipsModBoxA();
     fEllipsModBoxB = lgpHandle->EllipsModBoxB() / detProp.Density(detProp.Temperature());
     fEllipsModBoxR = lgpHandle->EllipsModBoxR();
     fLarqlChi0A = lgpHandle->LarqlChi0A();
     fLarqlChi0B = lgpHandle->LarqlChi0B();
     fLarqlChi0C = lgpHandle->LarqlChi0C();
     fLarqlChi0D = lgpHandle->LarqlChi0D();
     fLarqlAlpha = lgpHandle->LarqlAlpha();
     fLarqlBeta = lgpHandle->LarqlBeta();
     fUseModBoxRecomb = lgpHandle->UseModBoxRecomb();
     fUseEllipsModBoxRecomb = (bool)lgpHandle->UseEllipsModBoxRecomb();
 
     fUseModLarqlRecomb = lgpHandle->UseModLarqlRecomb();
 
     // determine the step size using the voxel sizes
     art::ServiceHandle<sim::LArVoxelCalculator const> lvc;
     double maxsize =
       std::max(lvc->VoxelSizeX(), std::max(lvc->VoxelSizeY(), lvc->VoxelSizeZ())) * CLHEP::cm;
 
     fStepSize = 0.1 * maxsize;
   }

Member Function Documentation

void larg4::ISCalculationCorrelated::CalculateIonizationAndScintillation ( const G4Step * step )

virtual

Implements larg4::ISCalculation.

Definition at line 98 of file ISCalculationCorrelated.cxx.

References util::abs(), tca::dEdx(), larg4::ISCalculation::EFieldAtStep(), EscapingEFraction(), fEfield, fEllipsModBoxA, fEllipsModBoxB, fEllipsModBoxR, larg4::ISCalculation::fEnergyDeposit, FieldCorrection(), fModBoxA, fModBoxB, larg4::ISCalculation::fNumIonElectrons, larg4::ISCalculation::fNumScintPhotons, fRecombA, fRecombk, fScintPreScale, fUseEllipsModBoxRecomb, fUseModBoxRecomb, fUseModLarqlRecomb, fWion, fWph, and MF_LOG_DEBUG.

   {
     fEnergyDeposit = step->GetTotalEnergyDeposit() / CLHEP::MeV;
 
     // calculate total quanta (ions + excitons)
     double Nq = fEnergyDeposit / fWph;
 
     // Get the recombination factor for this voxel - Nucl.Instrum.Meth.A523:275-286,2004
     // R = A/(1 + (dE/dx)*k)
     // dE/dx is given by the voxel energy deposition, but have to convert it to MeV/cm
     // from GeV/voxel width
     // A = 0.800 +/- 0.003
     // k = (0.097+/-0.001) g/(MeVcm^2)
     // the dx depends on the trajectory of the step
     // k should be divided by the density as our dE/dx is in MeV/cm,
     // the division is handled in the constructor when we set fRecombk
     // B.Baller: Add Modified Box recombination - ArgoNeuT result submitted to JINST
 
     G4ThreeVector totstep = step->GetPostStepPoint()->GetPosition();
     totstep -= step->GetPreStepPoint()->GetPosition();
     double dx = totstep.mag() / CLHEP::cm;
     double dEdx = (dx == 0.0) ? 0.0 : fEnergyDeposit / dx;
     double EFieldStep = EFieldAtStep(fEfield, step);
 
     // Guard against spurious values of dE/dx. Note: assumes density of LAr
     if (dEdx < 1.) dEdx = 1.;
 
     // calculate the recombination survival fraction
     double recomb = 0.;
     if (fUseModBoxRecomb) {
       if (dx) {
         double Xi = fModBoxB * dEdx / EFieldStep;
         recomb = log(fModBoxA + Xi) / Xi;
       }
       else
         recomb = 0;
     }
     else if (fUseEllipsModBoxRecomb) {
 
       double phi = std::acos(abs(step->GetPreStepPoint()->GetPosition().x() -
                                  step->GetPostStepPoint()->GetPosition().x()) /
                              step->GetStepLength());
 
       if (phi > std::atan(1) * 2) { phi = std::atan(1) * 4 - phi; }
 
       if (phi != phi) {
         double Xi = fModBoxB * dEdx / EFieldStep;
         recomb = std::log(fModBoxA + Xi) / Xi;
       }
       else {
         double B_ellips = fEllipsModBoxB * dEdx /
                           (EFieldStep * std::hypot(std::sin(phi), std::cos(phi) / fEllipsModBoxR));
 
         recomb = std::log(fEllipsModBoxA + B_ellips) / B_ellips;
       }
     }
     else {
       recomb = fRecombA / (1. + dEdx * fRecombk / EFieldStep);
     }
 
     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
     fNumIonElectrons = (fEnergyDeposit / fWion) * recomb;
 
     // calculate scintillation photons
     fNumScintPhotons = Nq - fNumIonElectrons;
 
     // apply the scintillation pre-scaling (normally this is already folded into
     // the particle-specific scintillation yields)
     fNumScintPhotons *= fScintPreScale;
 
     MF_LOG_DEBUG("ISCalculationCorrelated")
       << " Electrons produced for " << fEnergyDeposit << " MeV deposited with " << recomb
       << " recombination: " << fNumIonElectrons;
     MF_LOG_DEBUG("ISCalculationCorrelated") << "number photons: " << fNumScintPhotons;
 
     return;
   }

double larg4::ISCalculation::EFieldAtStep	(	double	fEfield,
		const G4Step *	step
	)		const

inherited

Definition at line 18 of file ISCalculation.cxx.

Referenced by larg4::ISCalculationSeparate::CalculateIonizationAndScintillation(), CalculateIonizationAndScintillation(), and larg4::ISCalculation::VisibleEnergyDeposit().

   {
     auto const* SCE = lar::providerFrom<spacecharge::SpaceChargeService>();
     if (!SCE->EnableSimEfieldSCE()) return efield;
     geo::Point_t midPoint{
       (step->GetPreStepPoint()->GetPosition() + step->GetPostStepPoint()->GetPosition()) * 0.5 /
       CLHEP::cm};
     auto const eFieldOffsets = SCE->GetEfieldOffsets(midPoint);
     return efield * std::hypot(1 + eFieldOffsets.X(), eFieldOffsets.Y(), eFieldOffsets.Z());
   }

double larg4::ISCalculation::EnergyDeposit ( ) const

inlineinherited

Definition at line 22 of file ISCalculation.h.

References larg4::ISCalculation::fEnergyDeposit.

22 { return fEnergyDeposit; }

larg4::ISCalculation::fEnergyDeposit

double fEnergyDeposit

total energy deposited in the step

Definition: ISCalculation.h:32

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

private

Definition at line 180 of file ISCalculationCorrelated.cxx.

References fLarqlChi0A, fLarqlChi0B, fLarqlChi0C, and fLarqlChi0D.

Referenced by CalculateIonizationAndScintillation().

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

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

private

Definition at line 185 of file ISCalculationCorrelated.cxx.

References fLarqlAlpha, and fLarqlBeta.

Referenced by CalculateIonizationAndScintillation().

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

double larg4::ISCalculation::NumberIonizationElectrons ( ) const

inlineinherited

Definition at line 23 of file ISCalculation.h.

References larg4::ISCalculation::fNumIonElectrons.

23 { return fNumIonElectrons; }

larg4::ISCalculation::fNumIonElectrons

double fNumIonElectrons

number of ionization electrons for this step

Definition: ISCalculation.h:33

double larg4::ISCalculation::NumberScintillationPhotons ( ) const

inlineinherited

Definition at line 24 of file ISCalculation.h.

References larg4::ISCalculation::fNumScintPhotons.

24 { return fNumScintPhotons; }

larg4::ISCalculation::fNumScintPhotons

double fNumScintPhotons

number of scintillation photons for this step

Definition: ISCalculation.h:34

void larg4::ISCalculationCorrelated::Reset ( )

virtual

Implements larg4::ISCalculation.

Definition at line 87 of file ISCalculationCorrelated.cxx.

References larg4::ISCalculation::fEnergyDeposit, larg4::ISCalculation::fNumIonElectrons, and larg4::ISCalculation::fNumScintPhotons.

   {
     fEnergyDeposit = 0.;
     fNumScintPhotons = 0.;
     fNumIonElectrons = 0.;
 
     return;
   }

double larg4::ISCalculationCorrelated::StepSizeLimit ( ) const

inlinevirtual

Implements larg4::ISCalculation.

Definition at line 36 of file ISCalculationCorrelated.h.

36 { return fStepSize; }

larg4::ISCalculationCorrelated::fStepSize

double fStepSize

maximum step to take

Definition: ISCalculationCorrelated.h:39

double larg4::ISCalculation::VisibleEnergyDeposit ( ) const

inlineinherited

Definition at line 25 of file ISCalculation.h.

References larg4::ISCalculation::EFieldAtStep(), and larg4::ISCalculation::fVisibleEnergyDeposition.

25 { return fVisibleEnergyDeposition; }

larg4::ISCalculation::fVisibleEnergyDeposition

double fVisibleEnergyDeposition

Definition: ISCalculation.h:35

Member Data Documentation

double larg4::ISCalculationCorrelated::fEfield

private

value of electric field from LArProperties service

Definition at line 40 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fEllipsModBoxA

private

from LArG4Parameters service

Definition at line 54 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fEllipsModBoxB

private

from LArG4Parameters service

Definition at line 55 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fEllipsModBoxR

private

from LArG4Parameters service

Definition at line 56 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculation::fEnergyDeposit

protectedinherited

total energy deposited in the step

Definition at line 32 of file ISCalculation.h.

Referenced by larg4::ISCalculationSeparate::CalculateIonizationAndScintillation(), larg4::ISCalculationNEST::CalculateIonizationAndScintillation(), CalculateIonizationAndScintillation(), larg4::ISCalculation::EnergyDeposit(), larg4::ISCalculationSeparate::Reset(), larg4::ISCalculationNEST::Reset(), and Reset().

double larg4::ISCalculationCorrelated::fLarqlAlpha

private

from LArG4Parameters service

Definition at line 52 of file ISCalculationCorrelated.h.

Referenced by FieldCorrection(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fLarqlBeta

private

from LArG4Parameters service

Definition at line 53 of file ISCalculationCorrelated.h.

Referenced by FieldCorrection(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fLarqlChi0A

private

from LArG4Parameters service

Definition at line 48 of file ISCalculationCorrelated.h.

Referenced by EscapingEFraction(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fLarqlChi0B

private

from LArG4Parameters service

Definition at line 49 of file ISCalculationCorrelated.h.

Referenced by EscapingEFraction(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fLarqlChi0C

private

from LArG4Parameters service

Definition at line 50 of file ISCalculationCorrelated.h.

Referenced by EscapingEFraction(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fLarqlChi0D

private

from LArG4Parameters service

Definition at line 51 of file ISCalculationCorrelated.h.

Referenced by EscapingEFraction(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fModBoxA

private

from LArG4Parameters service

Definition at line 46 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fModBoxB

private

from LArG4Parameters service

Definition at line 47 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculation::fNumIonElectrons

protectedinherited

number of ionization electrons for this step

Definition at line 33 of file ISCalculation.h.

Referenced by larg4::ISCalculationSeparate::CalculateIonizationAndScintillation(), larg4::ISCalculationNEST::CalculateIonizationAndScintillation(), CalculateIonizationAndScintillation(), larg4::ISCalculation::NumberIonizationElectrons(), larg4::ISCalculationSeparate::Reset(), larg4::ISCalculationNEST::Reset(), and Reset().

double larg4::ISCalculation::fNumScintPhotons

protectedinherited

number of scintillation photons for this step

Definition at line 34 of file ISCalculation.h.

Referenced by larg4::ISCalculationSeparate::CalculateIonizationAndScintillation(), larg4::ISCalculationNEST::CalculateIonizationAndScintillation(), CalculateIonizationAndScintillation(), larg4::ISCalculation::NumberScintillationPhotons(), larg4::ISCalculationSeparate::Reset(), larg4::ISCalculationNEST::Reset(), and Reset().

double larg4::ISCalculationCorrelated::fRecombA

private

from LArG4Parameters service

Definition at line 44 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fRecombk

private

from LArG4Parameters service

Definition at line 45 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fScintPreScale

private

scintillation pre-scale from LArProperties service

Definition at line 43 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fStepSize

private

maximum step to take

Definition at line 39 of file ISCalculationCorrelated.h.

Referenced by ISCalculationCorrelated().

bool larg4::ISCalculationCorrelated::fUseEllipsModBoxRecomb

private

from LArG4Parameters service

Definition at line 57 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

bool larg4::ISCalculationCorrelated::fUseModBoxRecomb

private

from LArG4Parameters service

Definition at line 58 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

bool larg4::ISCalculationCorrelated::fUseModLarqlRecomb

private

from LArG4Parameters service

Definition at line 59 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculation::fVisibleEnergyDeposition

protectedinherited

Definition at line 35 of file ISCalculation.h.

Referenced by larg4::ISCalculationSeparate::CalculateIonizationAndScintillation(), larg4::ISCalculationNEST::CalculateIonizationAndScintillation(), larg4::ISCalculationNEST::Reset(), and larg4::ISCalculation::VisibleEnergyDeposit().

double larg4::ISCalculationCorrelated::fWion

private

W_ion (23.6 eV) == 1/fGeVToElectrons.

Definition at line 41 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

double larg4::ISCalculationCorrelated::fWph

private

W_ph (19.5 eV)

Definition at line 42 of file ISCalculationCorrelated.h.

Referenced by CalculateIonizationAndScintillation(), and ISCalculationCorrelated().

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

larsim/v09_43_00/source/larsim/LegacyLArG4/ISCalculationCorrelated.h
larsim/v09_43_00/source/larsim/LegacyLArG4/ISCalculationCorrelated.cxx

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation