larg4::ISCalculationNEST Class Reference

#include "ISCalculationNEST.h"

Inheritance diagram for larg4::ISCalculationNEST:

Public Member Functions
	ISCalculationNEST (CLHEP::HepRandomEngine &engine)
virtual	~ISCalculationNEST ()
void	Initialize ()
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 Attributes
NestAlg *	fNest
	the fast optical simulation process More...
double	fStepSize
	maximum step to take More...
CLHEP::HepRandomEngine &	fEngine
	random engine More...

Detailed Description

Definition at line 19 of file ISCalculationNEST.h.

Constructor & Destructor Documentation

larg4::ISCalculationNEST::ISCalculationNEST

(

CLHEP::HepRandomEngine &

engine

)

Definition at line 19 of file ISCalculationNEST.cxx.

    : fNest(0)
    , fEngine(engine)
  {
    return;
  }

larg4::ISCalculationNEST::~ISCalculationNEST ( )

virtual

Definition at line 27 of file ISCalculationNEST.cxx.

References fNest.

  {
    if(fNest) delete fNest;

    return;
  }

Member Function Documentation

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

virtual

Implements larg4::ISCalculation.

Definition at line 61 of file ISCalculationNEST.cxx.

References NestAlg::CalculateIonizationAndScintillation(), NestAlg::EnergyDeposition(), larg4::ISCalculation::fEnergyDeposit, fNest, larg4::ISCalculation::fNumIonElectrons, larg4::ISCalculation::fNumScintPhotons, larg4::ISCalculation::fVisibleEnergyDeposition, NestAlg::NumberIonizationElectrons(), NestAlg::NumberScintillationPhotons(), and track.

  {
    // get a const representation of the track for this step
    const G4Track track(*(step->GetTrack()));
    
    fNest->CalculateIonizationAndScintillation(track, *step);

    // compare the energy deposition of this step to what is in the fNest object
    if(fNest->EnergyDeposition() != step->GetTotalEnergyDeposit()/CLHEP::MeV)
      mf::LogWarning("ISCalculationNest") << "NEST and G4 step depositions do not agree!\n"
                                          << fNest->EnergyDeposition() << " vs " 
                                          << step->GetTotalEnergyDeposit()/CLHEP::MeV;

    // Nest uses Geant units, LArSoft assumes energy is in units of MeV here
    fEnergyDeposit   = fNest->EnergyDeposition()/CLHEP::MeV;
    fNumIonElectrons = fNest->NumberIonizationElectrons();
    fNumScintPhotons = fNest->NumberScintillationPhotons();
    fVisibleEnergyDeposition = 0.; //Not implimented for NEST.

    return;
  }

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

inherited

Definition at line 30 of file ISCalculation.cxx.

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

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

double larg4::ISCalculation::EnergyDeposit ( ) const

inlineinherited

Definition at line 29 of file ISCalculation.h.

References larg4::ISCalculation::fEnergyDeposit.

Referenced by larg4::IonizationAndScintillation::Reset().

{ return fEnergyDeposit;   }

void larg4::ISCalculationNEST::Initialize ( )

virtual

Implements larg4::ISCalculation.

Definition at line 35 of file ISCalculationNEST.cxx.

References fEngine, fNest, and fStepSize.

  {
    // \todo should ideally make the yield factor passed to the NestAlg ctor a parameter
    if(!fNest) fNest = new NestAlg(1., fEngine);

    // Set the step size to small value if NEST is chosen, per Matthew Szydagis, 
    // "because without delta rays, the yields are wrong.  The ICARUS model that is 
    // in LArSoft uses a fudge factor to compensate, but NEST is "purer" -- no 
    // fudge factor. "
    fStepSize = 0.05 * CLHEP::micrometer;

    return;
  }

double larg4::ISCalculation::NumberIonizationElectrons ( ) const

inlineinherited

Definition at line 30 of file ISCalculation.h.

References larg4::ISCalculation::fNumIonElectrons.

Referenced by larg4::IonizationAndScintillation::Reset().

{ return fNumIonElectrons; }

double larg4::ISCalculation::NumberScintillationPhotons ( ) const

inlineinherited

Definition at line 31 of file ISCalculation.h.

References larg4::ISCalculation::fNumScintPhotons.

Referenced by larg4::IonizationAndScintillation::Reset().

{ return fNumScintPhotons; }

void larg4::ISCalculationNEST::Reset ( )

virtual

Implements larg4::ISCalculation.

Definition at line 50 of file ISCalculationNEST.cxx.

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

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

    return;
  }

double larg4::ISCalculationNEST::StepSizeLimit ( ) const

inlinevirtual

Implements larg4::ISCalculation.

Definition at line 29 of file ISCalculationNEST.h.

{ return fStepSize;        }

double larg4::ISCalculation::VisibleEnergyDeposit ( ) const

inlineinherited

Definition at line 32 of file ISCalculation.h.

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

{ return fVisibleEnergyDeposition; }

Member Data Documentation

double larg4::ISCalculation::fEnergyDeposit

protectedinherited

total energy deposited in the step

Definition at line 39 of file ISCalculation.h.

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

CLHEP::HepRandomEngine& larg4::ISCalculationNEST::fEngine

private

random engine

Definition at line 35 of file ISCalculationNEST.h.

Referenced by Initialize().

NestAlg* larg4::ISCalculationNEST::fNest

private

the fast optical simulation process

Definition at line 33 of file ISCalculationNEST.h.

Referenced by CalculateIonizationAndScintillation(), Initialize(), and ~ISCalculationNEST().

double larg4::ISCalculation::fNumIonElectrons

protectedinherited

number of ionization electrons for this step

Definition at line 40 of file ISCalculation.h.

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

double larg4::ISCalculation::fNumScintPhotons

protectedinherited

number of scintillation photons for this step

Definition at line 41 of file ISCalculation.h.

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

double larg4::ISCalculationNEST::fStepSize

private

maximum step to take

Definition at line 34 of file ISCalculationNEST.h.

Referenced by Initialize().

double larg4::ISCalculation::fVisibleEnergyDeposition

protectedinherited

Definition at line 42 of file ISCalculation.h.

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

---

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

• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/LArG4/ISCalculationNEST.h
• /cvmfs/larsoft.opensciencegrid.org/products/larsim/v07_09_00/source/larsim/LArG4/ISCalculationNEST.cxx