GGSLostEnergyAction Class Reference

Computes the lost energy due to particles escaping the world volume. More...

#include <GGSLostEnergyAction.h>

Inheritance diagram for GGSLostEnergyAction:

Collaboration diagram for GGSLostEnergyAction:

Public Member Functions
	GGSLostEnergyAction ()
	Constructor.
virtual	~GGSLostEnergyAction ()
	Destructor.
void	PostUserTrackingAction (const G4Track *track)
	Check the track end. More...
void	BeginOfEventAction (const G4Event *event)
	Resets the GGSTLostEnergyInfo buffer. More...
void	EndOfEventAction (const G4Event *event)
	Converts energies to GeV and fills the tree. More...
void	BeginOfRunAction (const G4Run *run)
	Opens the output file for the current run and prepares the output tree. More...
void	EndOfRunAction (const G4Run *run)
	Closes the output file for the current run. More...
void	SetOutputFileBase (const std::string &outFileBase)
	Sets the output file base name. More...
void	SetOutputTreeName (const std::string &outTreeName)
	Sets the output tree name. More...
void	SetKineticAsLostEnergy ()
	Sets the kinetic energy as lost energy. More...
void	SetTotalAsLostEnergy ()
	Sets the total energy as lost energy. More...
Public Member Functions inherited from GGSUserAction
	GGSUserAction ()
	Constructor. More...
virtual	~GGSUserAction ()
	Destructor.
G4ClassificationOfNewTrack	ClassifyNewTrack (const G4Track *)
	Override of the ClassifyNewTrack method. More...

Detailed Description

Computes the lost energy due to particles escaping the world volume.

At the end of each track, this action checks if the particle reached the borders of the world volume. If so, its kinetic energy is recorded as "missing", in the sense that it escapes from the world volume. It is also possible to use total energy instead of kinetic (using the SetTotalAsLostEnergy method). This action assumes that the solid of the world volume is G4Box and that the physical world is non-rotated (but possibly translated). Note that energy deposited in non-sensitive volumes is NOT taken into account. The output will be written on a ROOT file, in a tree with one branch containing a GGSTLostEnergyInfo object. All the energies will be in GeV.

Definition at line 46 of file GGSLostEnergyAction.h.

Member Function Documentation

void GGSLostEnergyAction::BeginOfEventAction

(

const G4Event *

event

)

Resets the GGSTLostEnergyInfo buffer.

Parameters

event

The current event.

Definition at line 144 of file GGSLostEnergyAction.cpp.

                                                            {

  _lostEnergyInfo->Reset();
}

void GGSLostEnergyAction::BeginOfRunAction

(

const G4Run *

run

)

Opens the output file for the current run and prepares the output tree.

Parameters

run	The current run.

Definition at line 176 of file GGSLostEnergyAction.cpp.

                                                           {

  _outRootFile = GGSRootFileService::GetInstance().GetFileForThisRun(_outBase, run);
  if (_outTreeName == "") {
    _outTree = GGSRootFileService::GetInstance().GetDefaultTree(_outRootFile);
    _outTree->SetTitle(TString(_outTree->GetTitle()) + "LostEn ");
  }
  else
    _outTree = new TTree(_outTreeName.data(), "Energy lost by escaping particles");

  _outTree->Branch("lostEnergyInfo", "GGSTLostEnergyInfo", &_lostEnergyInfo);
}

void GGSLostEnergyAction::EndOfEventAction

(

const G4Event *

event

)

Converts energies to GeV and fills the tree.

Parameters

event

The current event.

Definition at line 151 of file GGSLostEnergyAction.cpp.

                                                          {

  // Convert energies to GeV
  _lostEnergyInfo->chargedTop /= GeV;
  _lostEnergyInfo->chargedBottom /= GeV;
  _lostEnergyInfo->chargedLeft /= GeV;
  _lostEnergyInfo->chargedRight /= GeV;
  _lostEnergyInfo->chargedFront /= GeV;
  _lostEnergyInfo->chargedBack /= GeV;
  _lostEnergyInfo->neutralTop /= GeV;
  _lostEnergyInfo->neutralBottom /= GeV;
  _lostEnergyInfo->neutralLeft /= GeV;
  _lostEnergyInfo->neutralRight /= GeV;
  _lostEnergyInfo->neutralFront /= GeV;
  _lostEnergyInfo->neutralBack /= GeV;

  if (_outTreeName != "") {
    // Call fill only if not using the default tree
    _outRootFile->cd();
    _outTree->Fill();
  }
}

void GGSLostEnergyAction::EndOfRunAction

(

const G4Run *

run

)

Closes the output file for the current run.

Parameters

run	The current run.

Definition at line 191 of file GGSLostEnergyAction.cpp.

                                                      {

  if (_outTreeName != "") {
    // Write the tree if we are not using the default one
    _outRootFile->cd();
    _outTree->Write();
  }
  GGSRootFileService::GetInstance().CloseFileForThisRun(_outBase);
  _outRootFile = NULL;
  _outTree = NULL;
}

void GGSLostEnergyAction::PostUserTrackingAction

(

const G4Track *

track

)

Check the track end.

At the end of the track, this routine checks if the track's end is due to transportation process. If so, it adds its energy to the lost energy counter if the end of the track is on a side of the world volume.

Parameters

track

The current track.

Definition at line 57 of file GGSLostEnergyAction.cpp.

                                                                     {

  const G4StepPoint *stepPoint = track->GetStep()->GetPostStepPoint();

  // Check only tracks ending because of transportation
  if (stepPoint->GetProcessDefinedStep()->GetProcessType() == fTransportation) {
    const G4ThreeVector position = stepPoint->GetPosition();
    bool charged = track->GetParticleDefinition()->GetPDGCharge() != 0;
    Double_t energy;
    if (_kinetic) {
      energy = stepPoint->GetKineticEnergy();
      _lostEnergyInfo->energyType = 1;
    }
    else {
      energy = stepPoint->GetTotalEnergy();
      _lostEnergyInfo->energyType = 0;
    }

    // Check the escape side. The sequence of checks is done to minimize the checks
    // (ie., supposing that particles are shot towards negative Z the most likely leakage
    //  is from bottom, so bottom is checked first and top last).
    // Bottom
    if (fabs(position[2] - _worldZMin) < _tolerance)
      if (charged) {
        _lostEnergyInfo->chargedBottom += energy;
        _lostEnergyInfo->nCharged++;
      }
      else {
        _lostEnergyInfo->neutralBottom += energy;
        _lostEnergyInfo->nNeutrals++;
      }
    // Front
    else if (fabs(position[0] - _worldXMax) < _tolerance)
      if (charged) {
        _lostEnergyInfo->chargedFront += energy;
        _lostEnergyInfo->nCharged++;
      }
      else {
        _lostEnergyInfo->neutralFront += energy;
        _lostEnergyInfo->nNeutrals++;
      }
    // Back
    else if (fabs(position[0] - _worldXMin) < _tolerance)
      if (charged) {
        _lostEnergyInfo->chargedBack += energy;
        _lostEnergyInfo->nCharged++;
      }
      else {
        _lostEnergyInfo->neutralBack += energy;
        _lostEnergyInfo->nNeutrals++;
      }
    // Right
    else if (fabs(position[1] - _worldYMax) < _tolerance)
      if (charged) {
        _lostEnergyInfo->chargedRight += energy;
        _lostEnergyInfo->nCharged++;
      }
      else {
        _lostEnergyInfo->neutralRight += energy;
        _lostEnergyInfo->nNeutrals++;
      }
    // Left
    else if (fabs(position[1] - _worldYMin) < _tolerance)
      if (charged) {
        _lostEnergyInfo->chargedLeft += energy;
        _lostEnergyInfo->nCharged++;
      }
      else {
        _lostEnergyInfo->neutralLeft += energy;
        _lostEnergyInfo->nNeutrals++;
      }
    // Top
    else if (fabs(position[2] - _worldZMax) < _tolerance) {
      if (charged) {
        _lostEnergyInfo->chargedTop += energy;
        _lostEnergyInfo->nCharged++;
      }
      else {
        _lostEnergyInfo->neutralTop += energy;
        _lostEnergyInfo->nNeutrals++;
      }
    }
  }
}

void GGSLostEnergyAction::SetKineticAsLostEnergy ( )

inline

Sets the kinetic energy as lost energy.

Invoking this method, kinetic energy will be tracked as lost energy. This is the default behavior.

See Also

SetTotalAsLostEnergy

Definition at line 123 of file GGSLostEnergyAction.h.

                                {
    _kinetic = true;
  }

void GGSLostEnergyAction::SetOutputFileBase ( const std::string &  outFileBase )

inline

Sets the output file base name.

The file base name can be with or without extension (.root will be automatically used as extension). For each run, the run number will be appended to the base name before the .root extension. If no value is provided the file base name will fallback to the default value set in GSRootFileservice.

Parameters

outFileBase

The output file base name.

See Also

GGSRootFileservice

Definition at line 102 of file GGSLostEnergyAction.h.

                                                       {
    _outBase = outFileBase;
  }

void GGSLostEnergyAction::SetOutputTreeName ( const std::string &  outTreeName )

inline

Sets the output tree name.

This name will be used for the TTree object where th hits for each event will be stored. By default, this value is set to "GCDG4" in constructor.

Parameters

outTreeName

The output tree name.

Definition at line 112 of file GGSLostEnergyAction.h.

                                                       {
    _outTreeName = outTreeName;
  }

void GGSLostEnergyAction::SetTotalAsLostEnergy ( )

inline

Sets the total energy as lost energy.

If this method is called, total energy of escaping particles will be considered as lost energy. Note that this may lead to energy unbalance when summing up detected and lost energies, since eg. masses of nuclear fragments coming from detector's material will not be produced by the primary's energy. This is not the default behavior and has to be explicitly set.

See Also

SetKineticAsLostEnergy

Definition at line 136 of file GGSLostEnergyAction.h.

                              {
    _kinetic = false;
  }

---

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

• GGSLostEnergyAction.h
• GGSLostEnergyAction.cpp