GGS(GenericGEANT4Simulation)Software  2.7.0
 All Data Structures Namespaces Files Functions Variables Typedefs Macros
Public Member Functions | Data Fields
GGSTLostEnergyInfo Class Reference

A simple class to carry informations about lost energy. More...

#include <GGSTLostEnergyInfo.h>

Inheritance diagram for GGSTLostEnergyInfo:
Inheritance graph
[legend]
Collaboration diagram for GGSTLostEnergyInfo:
Collaboration graph
[legend]

Public Member Functions

 GGSTLostEnergyInfo ()
 Constructor.
 
void Reset ()
 Resets all the members.
 
Float_t GetTotal () const
 Get the total lost energy. More...
 
Float_t GetTotalCharged () const
 Get the total lost energy due to escaping charged particles. More...
 
Float_t GetTotalNeutral () const
 Get the total lost energy due to escaping neutral particles. More...
 

Data Fields

Float_t chargedTop
 Energy lost due to charged particles escaping the world volume from top (positive Z).
 
Float_t chargedBottom
 Energy lost due to charged particles escaping the world volume from bottom (negative Z).
 
Float_t chargedRight
 Energy lost due to charged particles escaping the world volume from right (positive Y).
 
Float_t chargedLeft
 Energy lost due to charged particles escaping the world volume from left (negative Y).
 
Float_t chargedFront
 Energy lost due to charged particles escaping the world volume from front (positive X).
 
Float_t chargedBack
 Energy lost due to charged particles escaping the world volume from back (negative X).
 
Float_t neutralTop
 Energy lost due to neutral particles escaping the world volume from top (positive Z).
 
Float_t neutralBottom
 Energy lost due to neutral particles escaping the world volume from bottom (negative Z).
 
Float_t neutralRight
 Energy lost due to neutral particles escaping the world volume from right (positive Y).
 
Float_t neutralLeft
 Energy lost due to neutral particles escaping the world volume from left (negative Y).
 
Float_t neutralFront
 Energy lost due to neutral particles escaping the world volume from front (positive X).
 
Float_t neutralBack
 Energy lost due to neutral particles escaping the world volume from back (negative X).
 
UInt_t nCharged
 Total number of escaped charged particles.
 
UInt_t nNeutrals
 Total number of escaped neutral particles.
 
Int_t energyType
 Type of lost energy: 0 = total, 1 = kinetic.
 

Detailed Description

A simple class to carry informations about lost energy.

This class is simply a ROOT container for lost energy information. Here "lost energy" means energy escaping the world volume and thus not detected. It doesn't include energy deposited in non-sensitive volumes. The "top", "left", "front"etc. attributes in properties' names are referred to an observer watching towards negative X direction and with Z axis pointing upwards.

Definition at line 23 of file GGSTLostEnergyInfo.h.

Member Function Documentation

Float_t GGSTLostEnergyInfo::GetTotal ( ) const

Get the total lost energy.

Returns
The total lost energy.

Definition at line 42 of file GGSTLostEnergyInfo.cpp.

42 { return GetTotalCharged() + GetTotalNeutral(); }
Float_t GetTotalCharged() const
Get the total lost energy due to escaping charged particles.
Float_t GetTotalNeutral() const
Get the total lost energy due to escaping neutral particles.
Float_t GGSTLostEnergyInfo::GetTotalCharged ( ) const

Get the total lost energy due to escaping charged particles.

Returns
The total lost energy due to charged particles.

Definition at line 44 of file GGSTLostEnergyInfo.cpp.

44  {
46 }
Float_t chargedRight
Energy lost due to charged particles escaping the world volume from right (positive Y)...
Float_t chargedLeft
Energy lost due to charged particles escaping the world volume from left (negative Y)...
Float_t chargedBack
Energy lost due to charged particles escaping the world volume from back (negative X)...
Float_t chargedFront
Energy lost due to charged particles escaping the world volume from front (positive X)...
Float_t chargedBottom
Energy lost due to charged particles escaping the world volume from bottom (negative Z)...
Float_t chargedTop
Energy lost due to charged particles escaping the world volume from top (positive Z)...
Float_t GGSTLostEnergyInfo::GetTotalNeutral ( ) const

Get the total lost energy due to escaping neutral particles.

Returns
The total lost energy due to neutral particles.

Definition at line 48 of file GGSTLostEnergyInfo.cpp.

48  {
50 }
Float_t neutralBack
Energy lost due to neutral particles escaping the world volume from back (negative X)...
Float_t neutralBottom
Energy lost due to neutral particles escaping the world volume from bottom (negative Z)...
Float_t neutralRight
Energy lost due to neutral particles escaping the world volume from right (positive Y)...
Float_t neutralTop
Energy lost due to neutral particles escaping the world volume from top (positive Z)...
Float_t neutralLeft
Energy lost due to neutral particles escaping the world volume from left (negative Y)...
Float_t neutralFront
Energy lost due to neutral particles escaping the world volume from front (positive X)...

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