#include <ISCalculationSeparate.h>

Inheritance diagram for larg4::ISCalculationSeparate:

Public Member Functions
	ISCalculationSeparate ()

void	Reset () override

void	CalculateIonizationAndScintillation (const G4Step *step) override

double	StepSizeLimit () const override

Public Member Functions inherited from larg4::ISCalculation
virtual	~ISCalculation ()=default

double	EnergyDeposit () const

double	NumberIonizationElectrons () const

double	NumberScintillationPhotons () const

double	VisibleEnergyDeposit () const

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

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

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

double	fGeVToElectrons
	conversion 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...

bool	fUseModBoxRecomb
	from LArG4Parameters service More...

bool	fScintByParticleType
	from LArProperties service More...

double	fScintYieldFactor
	scintillation yield factor More...

G4EmSaturation *	fEMSaturation
	pointer to EM saturation More...

Additional Inherited Members
Protected Attributes inherited from larg4::ISCalculation
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

Detailed Description

Definition at line 20 of file ISCalculationSeparate.h.

Constructor & Destructor Documentation

larg4::ISCalculationSeparate::ISCalculationSeparate ( )

Definition at line 26 of file ISCalculationSeparate.cxx.

   {
     art::ServiceHandle<sim::LArG4Parameters const> lgpHandle;
     const detinfo::LArProperties* larp = lar::providerFrom<detinfo::LArPropertiesService>();
     auto const detProp =
       art::ServiceHandle<detinfo::DetectorPropertiesService const>()->DataForJob();
 
     double density = detProp.Density(detProp.Temperature());
     fEfield = detProp.Efield();
     fScintByParticleType = larp->ScintByParticleType();
     fGeVToElectrons = lgpHandle->GeVToElectrons();
 
     // \todo get scintillation yield from LArG4Parameters or LArProperties
     fScintYieldFactor = 1.;
 
     // 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;
     fUseModBoxRecomb = lgpHandle->UseModBoxRecomb();
 
     // Use Birks Correction in the Scintillation process
     fEMSaturation = G4LossTableManager::Instance()->EmSaturation();
 
     // 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::ISCalculationSeparate::CalculateIonizationAndScintillation ( const G4Step * step )

overridevirtual

Implements larg4::ISCalculation.

Definition at line 75 of file ISCalculationSeparate.cxx.

   {
     fEnergyDeposit = step->GetTotalEnergyDeposit() / CLHEP::MeV;
 
     // 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 recomb = 0.;
     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.;
 
     if (fUseModBoxRecomb) {
       if (dx) {
         double Xi = fModBoxB * dEdx / EFieldStep;
         recomb = log(fModBoxA + Xi) / Xi;
       }
       else
         recomb = 0;
     }
     else {
       recomb = fRecombA / (1. + dEdx * fRecombk / EFieldStep);
     }
 
     // 1.e-3 converts fEnergyDeposit to GeV
     fNumIonElectrons = fGeVToElectrons * 1.e-3 * fEnergyDeposit * recomb;
 
     MF_LOG_DEBUG("ISCalculationSeparate")
       << " Electrons produced for " << fEnergyDeposit << " MeV deposited with " << recomb
       << " recombination: " << fNumIonElectrons;
 
     // Now do the scintillation
     G4MaterialPropertiesTable* mpt = step->GetTrack()->GetMaterial()->GetMaterialPropertiesTable();
     if (!mpt)
       throw cet::exception("ISCalculationSeparate")
         << "Cannot find materials property table"
         << " for this step! " << step->GetTrack()->GetMaterial() << "\n";
 
     // if not doing the scintillation by particle type, use the saturation
     double scintYield = mpt->GetConstProperty("SCINTILLATIONYIELD");
 
     if (fScintByParticleType) {
 
       MF_LOG_DEBUG("ISCalculationSeparate") << "scintillating by particle type";
 
       // Get the definition of the current particle
       G4ParticleDefinition* pDef = step->GetTrack()->GetDynamicParticle()->GetDefinition();
 
       // Obtain the G4MaterialPropertyVectory containing the
       // scintillation light yield as a function of the deposited
       // energy for the current particle type
 
       // Protons
       if (pDef == G4Proton::ProtonDefinition()) {
         scintYield = mpt->GetConstProperty("PROTONSCINTILLATIONYIELD");
       }
       // Muons
       else if (pDef == G4MuonPlus::MuonPlusDefinition() ||
                pDef == G4MuonMinus::MuonMinusDefinition()) {
         scintYield = mpt->GetConstProperty("MUONSCINTILLATIONYIELD");
       }
       // Pions
       else if (pDef == G4PionPlus::PionPlusDefinition() ||
                pDef == G4PionMinus::PionMinusDefinition()) {
         scintYield = mpt->GetConstProperty("PIONSCINTILLATIONYIELD");
       }
       // Kaons
       else if (pDef == G4KaonPlus::KaonPlusDefinition() ||
                pDef == G4KaonMinus::KaonMinusDefinition()) {
         scintYield = mpt->GetConstProperty("KAONSCINTILLATIONYIELD");
       }
       // Alphas
       else if (pDef == G4Alpha::AlphaDefinition()) {
         scintYield = mpt->GetConstProperty("ALPHASCINTILLATIONYIELD");
       }
       // Electrons (must also account for shell-binding energy
       // attributed to gamma from standard PhotoElectricEffect)
       else if (pDef == G4Electron::ElectronDefinition() || pDef == G4Gamma::GammaDefinition()) {
         scintYield = mpt->GetConstProperty("ELECTRONSCINTILLATIONYIELD");
       }
       // Default for particles not enumerated/listed above
       else {
         scintYield = mpt->GetConstProperty("ELECTRONSCINTILLATIONYIELD");
       }
 
       // If the user has not specified yields for (p,d,t,a,carbon)
       // then these unspecified particles will default to the
       // electron's scintillation yield
 
       // Throw an exception if no scintillation yield is found
       if (!scintYield)
         throw cet::exception("ISCalculationSeparate")
           << "Request for scintillation yield for energy "
           << "deposit and particle type without correct "
           << "entry in MaterialPropertiesTable\n"
           << "ScintillationByParticleType requires at "
           << "minimum that ELECTRONSCINTILLATIONYIELD is "
           << "set by the user\n";
 
       fNumScintPhotons = scintYield * fEnergyDeposit;
     }
     else if (fEMSaturation) {
       // The default linear scintillation process
       fVisibleEnergyDeposition = fEMSaturation->VisibleEnergyDepositionAtAStep(step);
       fNumScintPhotons = fScintYieldFactor * scintYield * fVisibleEnergyDeposition;
     }
     else {
       fNumScintPhotons = fScintYieldFactor * scintYield * fEnergyDeposit;
     }
 
     MF_LOG_DEBUG("ISCalculationSeparate")
       << "number photons: " << fNumScintPhotons << " energy: " << fEnergyDeposit / CLHEP::MeV
       << " saturation: " << fEMSaturation->VisibleEnergyDepositionAtAStep(step)
       << " step length: " << step->GetStepLength() / CLHEP::cm;
   }

void larg4::ISCalculationSeparate::Reset ( void )

overridevirtual

Implements larg4::ISCalculation.

Definition at line 65 of file ISCalculationSeparate.cxx.

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

double larg4::ISCalculationSeparate::StepSizeLimit ( ) const

inlineoverridevirtual

Implements larg4::ISCalculation.

Definition at line 26 of file ISCalculationSeparate.h.

     {
       return fStepSize;
     }

Member Data Documentation

double larg4::ISCalculationSeparate::fEfield

private

value of electric field from LArProperties service

Definition at line 33 of file ISCalculationSeparate.h.

G4EmSaturation* larg4::ISCalculationSeparate::fEMSaturation

private

pointer to EM saturation

Definition at line 42 of file ISCalculationSeparate.h.

double larg4::ISCalculationSeparate::fGeVToElectrons

private

conversion factor from LArProperties service

Definition at line 34 of file ISCalculationSeparate.h.

double larg4::ISCalculationSeparate::fModBoxA

private

from LArG4Parameters service

Definition at line 37 of file ISCalculationSeparate.h.

double larg4::ISCalculationSeparate::fModBoxB

private

from LArG4Parameters service

Definition at line 38 of file ISCalculationSeparate.h.

double larg4::ISCalculationSeparate::fRecombA

private

from LArG4Parameters service

Definition at line 35 of file ISCalculationSeparate.h.

double larg4::ISCalculationSeparate::fRecombk

private

from LArG4Parameters service

Definition at line 36 of file ISCalculationSeparate.h.

bool larg4::ISCalculationSeparate::fScintByParticleType

private

from LArProperties service

Definition at line 40 of file ISCalculationSeparate.h.

double larg4::ISCalculationSeparate::fScintYieldFactor

private

scintillation yield factor

Definition at line 41 of file ISCalculationSeparate.h.

double larg4::ISCalculationSeparate::fStepSize

private

maximum step to take

Definition at line 32 of file ISCalculationSeparate.h.

bool larg4::ISCalculationSeparate::fUseModBoxRecomb

private

from LArG4Parameters service

Definition at line 39 of file ISCalculationSeparate.h.

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

larsim/larsim/LegacyLArG4/ISCalculationSeparate.h
larsim/larsim/LegacyLArG4/ISCalculationSeparate.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation