#include "ISCalcSeparate.h"

Public Member Functions
	ISCalcSeparate ()

virtual	~ISCalcSeparate ()

void	Initialize (const detinfo::LArProperties larp, const detinfo::DetectorProperties detp, const sim::LArG4Parameters lgp, const spacecharge::SpaceCharge sce)

void	Reset ()

void	CalculateIonizationAndScintillation (sim::SimEnergyDeposit const &edep)

double	EnergyDeposit () const

double	NumberIonizationElectrons () const

double	NumberScintillationPhotons () const

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

Private Member Functions
double	EFieldAtStep (double efield, float x, float y, float z)

void	CalculateIonization (float e, float ds, float x, float y, float z)

void	CalculateIonization (sim::SimEnergyDeposit const &edep)

void	CalculateScintillation (float e, int pdg)

void	CalculateScintillation (sim::SimEnergyDeposit const &edep)

Private Attributes
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...

double	fGeVToElectrons
	from LArG4Parameters service More...

double	fScintYieldFactor
	scintillation yield factor More...

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...

geo::Vector_t	fEfieldOffsets

const detinfo::LArProperties *	fLArProp

const spacecharge::SpaceCharge *	fSCE

const detinfo::DetectorProperties *	fDetProp

const sim::LArG4Parameters *	fLArG4Prop

Detailed Description

Definition at line 26 of file ISCalcSeparate.h.

Constructor & Destructor Documentation

larg4::ISCalcSeparate::ISCalcSeparate ( )

Definition at line 35 of file ISCalcSeparate.cxx.

36 {

37 }

larg4::ISCalcSeparate::~ISCalcSeparate ( )

virtual

Definition at line 40 of file ISCalcSeparate.cxx.

41 {

42 }

Member Function Documentation

void larg4::ISCalcSeparate::CalculateIonization	(	float	e,
		float	ds,
		float	x,
		float	y,
		float	z
	)

private

Definition at line 91 of file ISCalcSeparate.cxx.

References detinfo::DetectorProperties::Efield(), EFieldAtStep(), fDetProp, fEnergyDeposit, fGeVToElectrons, fModBoxA, fModBoxB, fNumIonElectrons, fRecombA, fRecombk, fUseModBoxRecomb, LOG_DEBUG, x, y, and z.

Referenced by CalculateIonization(), and CalculateIonizationAndScintillation().

                                                                      {
 
     //TRACEN(TNAME,3,"Calculate ionization called with e=%f, ds=%f, (x,y,z)=(%f,%f,%f)",
     //       e,ds,x,y,z);
     //TRACEN(TNAME,3,"Initialized values: RecombA=%lf, Recombk=%lf, ModBoxA=%lf, ModBoxB=%lf, UseModBoxRecomb=%d",
     //     fRecombA, fRecombk, fModBoxA, fModBoxB, fUseModBoxRecomb);
 
     double recomb = 0.;
     double dEdx   = (ds<=0.0)? 0.0: e/ds;
     double EFieldStep = EFieldAtStep(fDetProp->Efield(),x,y,z);
     
     // Guard against spurious values of dE/dx. Note: assumes density of LAr
     if(dEdx < 1.) dEdx = 1.;
     
     //TRACEN(TNAME,3,"dEdx=%f, EFieldStep=%f",dEdx,EFieldStep);
     
     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);
     }
     
     //TRACEN(TNAME,3,"recomb=%f",recomb);
     
     // 1.e-3 converts fEnergyDeposit to GeV
     fNumIonElectrons = fGeVToElectrons * 1.e-3 * e * recomb;
     
     //TRACEN(TNAME,3,"n_electrons=%f",fNumIonElectrons);
     
     LOG_DEBUG("ISCalcSeparate") 
       << " Electrons produced for " << fEnergyDeposit 
       << " MeV deposited with "     << recomb 
       << " recombination: "         << fNumIonElectrons << std::endl; 
   }

void larg4::ISCalcSeparate::CalculateIonization ( sim::SimEnergyDeposit const & edep )

private

Definition at line 135 of file ISCalcSeparate.cxx.

References CalculateIonization(), sim::SimEnergyDeposit::Energy(), sim::SimEnergyDeposit::MidPointX(), sim::SimEnergyDeposit::MidPointY(), sim::SimEnergyDeposit::MidPointZ(), and sim::SimEnergyDeposit::StepLength().

                                                                          {
     CalculateIonization(edep.Energy(),edep.StepLength(),
                         edep.MidPointX(),edep.MidPointY(),edep.MidPointZ());
   }

void larg4::ISCalcSeparate::CalculateIonizationAndScintillation ( sim::SimEnergyDeposit const & edep )

Definition at line 192 of file ISCalcSeparate.cxx.

References CalculateIonization(), CalculateScintillation(), sim::SimEnergyDeposit::Energy(), and fEnergyDeposit.

Referenced by larg4::ISCalculationAna::analyze(), spacecharge::ShiftEdepSCE::produce(), detsim::SimDriftElectrons::produce(), and phot::PhotonLibraryPropagation::produce().

   {
     fEnergyDeposit = edep.Energy();
     CalculateIonization(edep);
     CalculateScintillation(edep);
   }

void larg4::ISCalcSeparate::CalculateScintillation	(	float	e,
		int	pdg
	)

private

Definition at line 141 of file ISCalcSeparate.cxx.

References detinfo::LArProperties::AlphaScintYield(), e, detinfo::LArProperties::ElectronScintYield(), fLArProp, fNumScintPhotons, fScintYieldFactor, detinfo::LArProperties::KaonScintYield(), LOG_DEBUG, detinfo::LArProperties::MuonScintYield(), detinfo::LArProperties::PionScintYield(), detinfo::LArProperties::ProtonScintYield(), detinfo::LArProperties::ScintByParticleType(), and detinfo::LArProperties::ScintYield().

Referenced by CalculateIonizationAndScintillation(), and CalculateScintillation().

   {
     double scintYield = fLArProp->ScintYield(true);
     if(fLArProp->ScintByParticleType()){
 
       LOG_DEBUG("ISCalcSeparate") << "scintillating by particle type";
 
       switch(pdg) {
 
       case 2212:
         scintYield = fLArProp->ProtonScintYield(true);
         break;
       case 13:
       case -13:
         scintYield = fLArProp->MuonScintYield(true);
         break;
       case 211:
       case -211:
         scintYield = fLArProp->PionScintYield(true);
         break;
       case 321:
       case -321:
         scintYield = fLArProp->KaonScintYield(true);
         break;
       case 1000020040:
         scintYield = fLArProp->AlphaScintYield(true);
         break;
       case 11:
       case -11:
       case 22:
         scintYield = fLArProp->ElectronScintYield(true);
         break;
       default:
         scintYield = fLArProp->ElectronScintYield(true);
 
       }
 
       fNumScintPhotons =  scintYield * e;
     }
     else
       fNumScintPhotons = fScintYieldFactor * scintYield * e;
     
   }

void larg4::ISCalcSeparate::CalculateScintillation ( sim::SimEnergyDeposit const & edep )

private

Definition at line 186 of file ISCalcSeparate.cxx.

References CalculateScintillation(), sim::SimEnergyDeposit::Energy(), and sim::SimEnergyDeposit::PdgCode().

   {
     CalculateScintillation(edep.Energy(),edep.PdgCode());
   }

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

Definition at line 199 of file ISCalcSeparate.cxx.

References sim::SimEnergyDeposit::MidPointX(), sim::SimEnergyDeposit::MidPointY(), and sim::SimEnergyDeposit::MidPointZ().

Referenced by CalculateIonization().

   {
     return EFieldAtStep(efield,
                         edep.MidPointX(),edep.MidPointY(),edep.MidPointZ());
   }

double larg4::ISCalcSeparate::EFieldAtStep	(	double	efield,
		float	x,
		float	y,
		float	z
	)

private

Definition at line 205 of file ISCalcSeparate.cxx.

References spacecharge::SpaceCharge::EnableSimEfieldSCE(), fEfieldOffsets, fSCE, spacecharge::SpaceCharge::GetEfieldOffsets(), x, and y.

   {
     double EField = efield;
     if (fSCE->EnableSimEfieldSCE())
       {
         fEfieldOffsets = fSCE->GetEfieldOffsets(geo::Point_t{x,y,z});
         EField = std::sqrt( (efield + efield*fEfieldOffsets.X())*(efield + efield*fEfieldOffsets.X()) +
                             (efield*fEfieldOffsets.Y()*efield*fEfieldOffsets.Y()) +
                             (efield*fEfieldOffsets.Z()*efield*fEfieldOffsets.Z()) );
       }
     return EField;
   }

double larg4::ISCalcSeparate::EnergyDeposit ( ) const

inline

Definition at line 39 of file ISCalcSeparate.h.

Referenced by larg4::ISCalculationAna::analyze().

39 { return fEnergyDeposit; }

larg4::ISCalcSeparate::fEnergyDeposit

double fEnergyDeposit

total energy deposited in the step

Definition: ISCalcSeparate.h:56

void larg4::ISCalcSeparate::Initialize	(	const detinfo::LArProperties *	larp,
		const detinfo::DetectorProperties *	detp,
		const sim::LArG4Parameters *	lgp,
		const spacecharge::SpaceCharge *	sce
	)

Definition at line 45 of file ISCalcSeparate.cxx.

References detinfo::DetectorProperties::Density(), fDetProp, fGeVToElectrons, fLArG4Prop, fLArProp, fModBoxA, fModBoxB, fRecombA, fRecombk, fSCE, fScintYieldFactor, fUseModBoxRecomb, sim::LArG4Parameters::GeVToElectrons(), sim::LArG4Parameters::ModBoxA(), sim::LArG4Parameters::ModBoxB(), sim::LArG4Parameters::RecombA(), sim::LArG4Parameters::Recombk(), Reset(), detinfo::DetectorProperties::Temperature(), and sim::LArG4Parameters::UseModBoxRecomb().

Referenced by spacecharge::ShiftEdepSCE::beginJob(), larg4::ISCalculationAna::beginJob(), detsim::SimDriftElectrons::beginJob(), spacecharge::ShiftEdepSCE::produce(), and phot::PhotonLibraryPropagation::produce().

   {
     //TRACEN(TNAME,3,"Initializing called.");
 
     fLArProp = larp;
     fSCE = sce;
     fDetProp = detp;
     fLArG4Prop = lgp;
     
     // \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             = lgp->RecombA();
     fRecombk             = lgp->Recombk()/detp->Density(detp->Temperature());
     fModBoxA             = lgp->ModBoxA();
     fModBoxB             = lgp->ModBoxB()/detp->Density(detp->Temperature());
     fUseModBoxRecomb     = (bool)lgp->UseModBoxRecomb();  
     fGeVToElectrons      = lgp->GeVToElectrons();
 
     this->Reset();
     
     //TRACEN(TNAME,3,"Initialize: RecombA=%f, Recombk=%f, ModBoxA=%f, ModBoxB=%f, UseModBoxRecomb=%d",
     //     fRecombA, fRecombk, fModBoxA, fModBoxB, fUseModBoxRecomb);
     
     return;
   }

double larg4::ISCalcSeparate::NumberIonizationElectrons ( ) const

inline

Definition at line 40 of file ISCalcSeparate.h.

Referenced by larg4::ISCalculationAna::analyze(), spacecharge::ShiftEdepSCE::produce(), and detsim::SimDriftElectrons::produce().

40 { return fNumIonElectrons; }

larg4::ISCalcSeparate::fNumIonElectrons

double fNumIonElectrons

number of ionization electrons for this step

Definition: ISCalcSeparate.h:57

double larg4::ISCalcSeparate::NumberScintillationPhotons ( ) const

inline

Definition at line 41 of file ISCalcSeparate.h.

Referenced by larg4::ISCalculationAna::analyze(), spacecharge::ShiftEdepSCE::produce(), and phot::PhotonLibraryPropagation::produce().

41 { return fNumScintPhotons; }

larg4::ISCalcSeparate::fNumScintPhotons

double fNumScintPhotons

number of scintillation photons for this step

Definition: ISCalcSeparate.h:58

void larg4::ISCalcSeparate::Reset ( )

Definition at line 80 of file ISCalcSeparate.cxx.

References fEnergyDeposit, fNumIonElectrons, and fNumScintPhotons.

Referenced by larg4::ISCalculationAna::analyze(), Initialize(), spacecharge::ShiftEdepSCE::produce(), detsim::SimDriftElectrons::produce(), and phot::PhotonLibraryPropagation::produce().

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

Member Data Documentation

const detinfo::DetectorProperties* larg4::ISCalcSeparate::fDetProp

private

Definition at line 65 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Initialize().

geo::Vector_t larg4::ISCalcSeparate::fEfieldOffsets

private

Definition at line 60 of file ISCalcSeparate.h.

Referenced by EFieldAtStep().

double larg4::ISCalcSeparate::fEnergyDeposit

private

total energy deposited in the step

Definition at line 56 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), CalculateIonizationAndScintillation(), and Reset().

double larg4::ISCalcSeparate::fGeVToElectrons

private

from LArG4Parameters service

Definition at line 52 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Initialize().

const sim::LArG4Parameters* larg4::ISCalcSeparate::fLArG4Prop

private

Definition at line 66 of file ISCalcSeparate.h.

Referenced by Initialize().

const detinfo::LArProperties* larg4::ISCalcSeparate::fLArProp

private

Definition at line 63 of file ISCalcSeparate.h.

Referenced by CalculateScintillation(), and Initialize().

double larg4::ISCalcSeparate::fModBoxA

private

from LArG4Parameters service

Definition at line 49 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Initialize().

double larg4::ISCalcSeparate::fModBoxB

private

from LArG4Parameters service

Definition at line 50 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Initialize().

double larg4::ISCalcSeparate::fNumIonElectrons

private

number of ionization electrons for this step

Definition at line 57 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Reset().

double larg4::ISCalcSeparate::fNumScintPhotons

private

number of scintillation photons for this step

Definition at line 58 of file ISCalcSeparate.h.

Referenced by CalculateScintillation(), and Reset().

double larg4::ISCalcSeparate::fRecombA

private

from LArG4Parameters service

Definition at line 47 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Initialize().

double larg4::ISCalcSeparate::fRecombk

private

from LArG4Parameters service

Definition at line 48 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Initialize().

const spacecharge::SpaceCharge* larg4::ISCalcSeparate::fSCE

private

Definition at line 64 of file ISCalcSeparate.h.

Referenced by EFieldAtStep(), and Initialize().

double larg4::ISCalcSeparate::fScintYieldFactor

private

scintillation yield factor

Definition at line 54 of file ISCalcSeparate.h.

Referenced by CalculateScintillation(), and Initialize().

bool larg4::ISCalcSeparate::fUseModBoxRecomb

private

from LArG4Parameters service

Definition at line 51 of file ISCalcSeparate.h.

Referenced by CalculateIonization(), and Initialize().

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

/cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/IonizationScintillation/ISCalcSeparate.h
/cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/IonizationScintillation/ISCalcSeparate.cxx

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation