G4PSTrackLength Class Reference

#include <G4PSTrackLength.hh>

Inheritance diagram for G4PSTrackLength:

Public Member Functions
	G4PSTrackLength (const G4String &name, G4int depth=0)
	G4PSTrackLength (const G4String &name, const G4String &unit, G4int depth=0)
	~G4PSTrackLength () override=default
void	Weighted (G4bool flg=true)
void	MultiplyKineticEnergy (G4bool flg=true)
void	DivideByVelocity (G4bool flg=true)
void	Initialize (G4HCofThisEvent *) override
void	clear () override
void	PrintAll () override
virtual void	SetUnit (const G4String &unit)
Public Member Functions inherited from G4VPrimitiveScorer
	G4VPrimitiveScorer (const G4String &name, G4int depth=0)
virtual	~G4VPrimitiveScorer ()=default
G4int	GetCollectionID (G4int)
virtual void	EndOfEvent (G4HCofThisEvent *)
virtual void	DrawAll ()
void	SetUnit (const G4String &unit)
const G4String &	GetUnit () const
G4double	GetUnitValue () const
void	SetMultiFunctionalDetector (G4MultiFunctionalDetector *d)
G4MultiFunctionalDetector *	GetMultiFunctionalDetector () const
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)

Protected Member Functions
G4bool	ProcessHits (G4Step *, G4TouchableHistory *) override
virtual void	DefineUnitAndCategory ()
Protected Member Functions inherited from G4VPrimitiveScorer
G4VSolid *	ComputeSolid (G4Step *aStep, G4int replicaIdx)
G4VSolid *	ComputeCurrentSolid (G4Step *aStep)
virtual G4int	GetIndex (G4Step *)
void	CheckAndSetUnit (const G4String &unit, const G4String &category)

Additional Inherited Members
Protected Attributes inherited from G4VPrimitiveScorer
G4String	primitiveName
G4MultiFunctionalDetector *	detector {nullptr}
G4VSDFilter *	filter {nullptr}
G4int	verboseLevel {0}
G4int	indexDepth
G4String	unitName {"NoUnit"}
G4double	unitValue {1.0}
G4int	fNi {0}
G4int	fNj {0}
G4int	fNk {0}

Detailed Description

Definition at line 48 of file G4PSTrackLength.hh.

Constructor & Destructor Documentation

G4PSTrackLength() [1/2]

G4PSTrackLength::G4PSTrackLength	(	const G4String &	name,
		G4int	depth = 0 )

Definition at line 43 of file G4PSTrackLength.cc.

  : G4PSTrackLength(name, "mm", depth)
{}

Referenced by G4PSTrackLength(), and G4PSTrackLength3D::G4PSTrackLength3D().

G4PSTrackLength() [2/2]

G4PSTrackLength::G4PSTrackLength	(	const G4String &	name,
		const G4String &	unit,
		G4int	depth = 0 )

Definition at line 47 of file G4PSTrackLength.cc.

  : G4VPrimitiveScorer(name, depth)
  , HCID(-1)
  , EvtMap(nullptr)
  , weighted(false)
  , multiplyKinE(false)
  , divideByVelocity(false)
{
  DefineUnitAndCategory();
  SetUnit(unit);
}

~G4PSTrackLength()

G4PSTrackLength::~G4PSTrackLength ( )

overridedefault

Member Function Documentation

clear()

void G4PSTrackLength::clear ( )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 100 of file G4PSTrackLength.cc.

{ EvtMap->clear(); }

DefineUnitAndCategory()

void G4PSTrackLength::DefineUnitAndCategory ( )

protectedvirtual

Definition at line 183 of file G4PSTrackLength.cc.

{
  // EnergyFlux
  new G4UnitDefinition("eV_second", "eV_s", "EnergyFlux", (eV * second));
  new G4UnitDefinition("keV_second", "keV_s", "EnergyFlux", (keV * second));
  new G4UnitDefinition("MeV_second", "MeV_s", "EnergyFlux", (MeV * second));
  new G4UnitDefinition("eV_millisecond", "eV_ms", "EnergyFlux", (eV * ms));
  new G4UnitDefinition("keV_millisecond", "keV_ms", "EnergyFlux", (keV * ms));
  new G4UnitDefinition("MeV_millisecond", "MeV_ms", "EnergyFlux", (MeV * ms));
  // EnergyFlow
  new G4UnitDefinition("eV_millimeter", "eV_mm", "EnergyFlow", (eV * mm));
  new G4UnitDefinition("keV_millimeter", "keV_mm", "EnergyFlow", (keV * mm));
  new G4UnitDefinition("MeV_millimeter", "MeV_mm", "EnergyFlow", (MeV * mm));
  new G4UnitDefinition("eV_centimeter", "eV_cm", "EnergyFlow", (eV * cm));
  new G4UnitDefinition("keV_centimeter", "keV_cm", "EnergyFlow", (keV * cm));
  new G4UnitDefinition("MeV_centimeter", "MeV_cm", "EnergyFlow", (MeV * cm));
  new G4UnitDefinition("eV_meter", "eV_m", "EnergyFlow", (eV * m));
  new G4UnitDefinition("keV_meter", "keV_m", "EnergyFlow", (keV * m));
  new G4UnitDefinition("MeV_meter", "MeV_m", "EnergyFlow", (MeV * m));
}

Referenced by G4PSTrackLength().

DivideByVelocity()

void G4PSTrackLength::DivideByVelocity

(

G4bool

flg = true

)

Definition at line 67 of file G4PSTrackLength.cc.

{
  divideByVelocity = flg;
  // Default unit is set according to flags.
  SetUnit("");
}

Initialize()

void G4PSTrackLength::Initialize ( G4HCofThisEvent * HCE )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 90 of file G4PSTrackLength.cc.

{
  EvtMap = new G4THitsMap<G4double>(detector->GetName(), GetName());
  if(HCID < 0)
  {
    HCID = GetCollectionID(0);
  }
  HCE->AddHitsCollection(HCID, (G4VHitsCollection*) EvtMap);
}

MultiplyKineticEnergy()

void G4PSTrackLength::MultiplyKineticEnergy

(

G4bool

flg = true

)

Definition at line 60 of file G4PSTrackLength.cc.

{
  multiplyKinE = flg;
  // Default unit is set according to flags.
  SetUnit("");
}

PrintAll()

void G4PSTrackLength::PrintAll ( )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 102 of file G4PSTrackLength.cc.

{
  G4cout << " MultiFunctionalDet  " << detector->GetName() << G4endl;
  G4cout << " PrimitiveScorer " << GetName() << G4endl;
  G4cout << " Number of entries " << EvtMap->entries() << G4endl;
  for(const auto& [copy, length] : *(EvtMap->GetMap()))
  {
    G4cout << "  copy no.: " << copy;
    if(multiplyKinE)
    {
      if(divideByVelocity)
        G4cout << " EnergyFlux: ";
      else
        G4cout << " EnergyFlow: ";
    }
    else
    {
      if(divideByVelocity)
        G4cout << " Time: ";
      else
        G4cout << " Length: ";
    }
    G4cout << *(length) / GetUnitValue() << " [" << GetUnit() << "]";
    G4cout << G4endl;
  }
}

ProcessHits()

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

overrideprotectedvirtual

Implements G4VPrimitiveScorer.

Definition at line 74 of file G4PSTrackLength.cc.

{
  G4double trklength = aStep->GetStepLength();
  if(trklength == 0.)
    return false;
  if(weighted)
    trklength *= aStep->GetPreStepPoint()->GetWeight();
  if(multiplyKinE)
    trklength *= aStep->GetPreStepPoint()->GetKineticEnergy();
  if(divideByVelocity)
    trklength /= aStep->GetPreStepPoint()->GetVelocity();
  G4int index = GetIndex(aStep);
  EvtMap->add(index, trklength);
  return true;
}

SetUnit()

void G4PSTrackLength::SetUnit ( const G4String & unit )

virtual

Definition at line 129 of file G4PSTrackLength.cc.

{
  if(multiplyKinE)
  {
    if(divideByVelocity)
    {
      if(unit.empty())
      {
        CheckAndSetUnit("MeV_second", "EnergyFlux");
      }
      else
      {
        CheckAndSetUnit(unit, "EnergyFlux");
      }
    }
    else
    {
      if(unit.empty())
      {
        CheckAndSetUnit("MeV_mm", "EnergyFlow");
      }
      else
      {
        CheckAndSetUnit(unit, "EnergyFlow");
      }
    }
  }
  else
  {
    if(divideByVelocity)
    {
      if(unit.empty())
      {
        CheckAndSetUnit("second", "Time");
      }
      else
      {
        CheckAndSetUnit(unit, "Time");
      }
    }
    else
    {
      if(unit.empty())
      {
        CheckAndSetUnit("mm", "Length");
      }
      else
      {
        CheckAndSetUnit(unit, "Length");
      }
    }
  }
}

Referenced by DivideByVelocity(), G4PSTrackLength(), G4PSTrackLength3D::G4PSTrackLength3D(), and MultiplyKineticEnergy().

Weighted()

void G4PSTrackLength::Weighted ( G4bool flg = true )

inline

Definition at line 55 of file G4PSTrackLength.hh.

{ weighted = flg; }

Referenced by G4ScoreQuantityMessenger::SetNewValue().

---

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

• G4PSTrackLength.hh
• G4PSTrackLength.cc