PrimaryKiller Class Reference

#include <PrimaryKiller.hh>

Inheritance diagram for PrimaryKiller:

Collaboration diagram for PrimaryKiller:

Public Member Functions
	PrimaryKiller (G4String name, G4int depth=0)
virtual	~PrimaryKiller ()
void	SetEnergyThreshold (double energy)
void	SetMinLossEnergyLimit (double energy)
void	SetMaxLossEnergyLimit (double energy)
virtual void	SetNewValue (G4UIcommand *command, G4String newValue)
virtual void	Initialize (G4HCofThisEvent *)
virtual void	EndOfEvent (G4HCofThisEvent *)
virtual void	clear ()
virtual void	DrawAll ()
virtual void	PrintAll ()
Public Member Functions inherited from G4VPrimitiveScorer
	G4VPrimitiveScorer (G4String name, G4int depth=0)
virtual	~G4VPrimitiveScorer ()
G4int	GetCollectionID (G4int)
void	SetUnit (const G4String &unit)
const G4String &	GetUnit () const
G4double	GetUnitValue () const
void	SetMultiFunctionalDetector (G4MultiFunctionalDetector *d)
G4MultiFunctionalDetector *	GetMultiFunctionalDetector () const
G4String	GetName () const
void	SetFilter (G4VSDFilter *f)
G4VSDFilter *	GetFilter () const
void	SetVerboseLevel (G4int vl)
G4int	GetVerboseLevel () const
void	SetNijk (G4int i, G4int j, G4int k)
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	operator== (const G4UImessenger &messenger) const
G4bool	CommandsShouldBeInMaster () const

Protected Member Functions
virtual G4bool	ProcessHits (G4Step *, G4TouchableHistory *)
Protected Member Functions inherited from G4VPrimitiveScorer
virtual G4int	GetIndex (G4Step *)
void	CheckAndSetUnit (const G4String &unit, const G4String &category)
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (G4String s)
G4double	StoD (G4String s)
G4bool	StoB (G4String s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T >
T *	CreateCommand (const G4String &cname, const G4String &dsc)

Additional Inherited Members
Protected Attributes inherited from G4VPrimitiveScorer
G4String	primitiveName
G4MultiFunctionalDetector *	detector
G4VSDFilter *	filter
G4int	verboseLevel
G4int	indexDepth
G4String	unitName
G4double	unitValue
G4int	fNi
G4int	fNj
G4int	fNk
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir
G4String	baseDirName
G4bool	commandsShouldBeInMaster

Detailed Description

Kill the primary particle:

• either after a given energy loss
• or after the primary particle has reached a given energy

Definition at line 52 of file PrimaryKiller.hh.

Constructor & Destructor Documentation

PrimaryKiller::PrimaryKiller	(	G4String	name,
		G4int	depth = 0
	)

Definition at line 56 of file PrimaryKiller.cc.

: G4VPrimitiveScorer(name,depth),
  G4UImessenger()
{
  fELoss = 0.; // cumulated energy for current event
  
  fELossRange_Min = DBL_MAX; // fELoss from which the primary is killed
  fELossRange_Max = DBL_MAX; // fELoss from which the event is aborted
  fKineticE_Min = 0; // kinetic energy below which the primary is killed
  
  fpELossUI = new G4UIcmdWithADoubleAndUnit("/primaryKiller/eLossMin",this);
  fpAbortEventIfELossUpperThan =
    new G4UIcmdWithADoubleAndUnit("/primaryKiller/eLossMax", this);
  fpMinKineticE =
   new G4UIcmdWithADoubleAndUnit("/primaryKiller/minKineticE", this);
}

PrimaryKiller::~PrimaryKiller ( )

virtual

Definition at line 75 of file PrimaryKiller.cc.

{;}

Member Function Documentation

void PrimaryKiller::clear ( void  )

virtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 158 of file PrimaryKiller.cc.

{
  fELoss = 0.;
}

Here is the caller graph for this function:

void PrimaryKiller::DrawAll ( void  )

virtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 165 of file PrimaryKiller.cc.

{;}

void PrimaryKiller::EndOfEvent ( G4HCofThisEvent *  )

virtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 152 of file PrimaryKiller.cc.

{
}

void PrimaryKiller::Initialize ( G4HCofThisEvent *  )

virtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 145 of file PrimaryKiller.cc.

{
  clear();
}

Here is the call graph for this function:

void PrimaryKiller::PrintAll ( void  )

virtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 170 of file PrimaryKiller.cc.

{}

G4bool PrimaryKiller::ProcessHits ( G4Step *  aStep, G4TouchableHistory *    )

protectedvirtual

Implements G4VPrimitiveScorer.

Definition at line 94 of file PrimaryKiller.cc.

{
  const G4Track* track = aStep->GetTrack();
  
  if(track->GetTrackID() != 1) return FALSE;
  
  //-------------------
  
  double kineticE = aStep->GetPostStepPoint()->GetKineticEnergy();
  
  G4double eLoss = aStep->GetPreStepPoint()->GetKineticEnergy()
                  - kineticE;

  if ( eLoss == 0. ) return FALSE;
  
  //-------------------

  fELoss+=eLoss;
  
  if(fELoss > fELossRange_Max){
    G4RunManager::GetRunManager()->AbortEvent();
    int eventID =
     G4EventManager::GetEventManager()->GetConstCurrentEvent()->GetEventID();
    G4cout << " * PrimaryKiller: aborts event " << eventID <<", energy loss "
              "is too large. \n"
           << " * Energy loss by primary is: "
           << G4BestUnit(fELoss, "Energy")
           << ". Event is aborted if the Eloss is > "
           << G4BestUnit(fELossRange_Max, "Energy")
           << G4endl;
    
  }
  
  if(fELoss >= fELossRange_Min || kineticE <= fKineticE_Min){
    ((G4Track*)track)->SetTrackStatus(fStopAndKill);
//     G4cout << "kill track at : "
//           << G4BestUnit(kineticE, "Energy")
//           << ", E loss is: "
//           << G4BestUnit(fELoss, "Energy")
//           << " /fELossMax: "
//           << G4BestUnit(fELossMax, "Energy")
//           << ", EThreshold is: "
//           << G4BestUnit(fEThreshold, "Energy")
//           << G4endl;
  }

  return TRUE;
}

Here is the call graph for this function:

void PrimaryKiller::SetEnergyThreshold ( double  energy )

inline

Set energy under which the particle should be killed

Definition at line 73 of file PrimaryKiller.hh.

                                               {
    fKineticE_Min = energy;
  }

Here is the call graph for this function:

void PrimaryKiller::SetMaxLossEnergyLimit ( double  energy )

inline

Set the energy loss from which the event is aborted

Definition at line 85 of file PrimaryKiller.hh.

                                                  {
    fELossRange_Max = energy;
  }

Here is the call graph for this function:

void PrimaryKiller::SetMinLossEnergyLimit ( double  energy )

inline

Set the energy loss from which the primary is killed

Definition at line 79 of file PrimaryKiller.hh.

                                                  {
    fELossRange_Min = energy;
  }

Here is the call graph for this function:

void PrimaryKiller::SetNewValue ( G4UIcommand *  command, G4String  newValue  )

virtual

Method related to G4UImessenger used to control energy cuts through macro file

Reimplemented from G4UImessenger.

Definition at line 80 of file PrimaryKiller.cc.

{
  if(command == fpELossUI){
    fELossRange_Min = fpELossUI->GetNewDoubleValue(newValue);
  }
  else if(command == fpAbortEventIfELossUpperThan){
    fELossRange_Max =
      fpAbortEventIfELossUpperThan->GetNewDoubleValue(newValue);
  }
}

Here is the call graph for this function:

---

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

• source/geant4.10.03.p03/examples/extended/medical/dna/chem4/include/PrimaryKiller.hh
• source/geant4.10.03.p03/examples/extended/medical/dna/chem4/src/PrimaryKiller.cc