G4PSCellFlux Class Reference

#include <G4PSCellFlux.hh>

Inheritance diagram for G4PSCellFlux:

Public Member Functions
	G4PSCellFlux (const G4String &name, G4int depth=0)
	G4PSCellFlux (const G4String &name, const G4String &unit, G4int depth=0)
	~G4PSCellFlux () override=default
void	Weighted (G4bool flg=true)
void	Initialize (G4HCofThisEvent *) override
void	clear () override
void	PrintAll () override
virtual void	SetUnit (const G4String &unit)
Public Member Functions inherited from G4VPrimitivePlotter
	~G4VPrimitivePlotter () override=default
void	Plot (G4int copyNo, G4int histID)
G4int	GetNumberOfHist () const
	G4VPrimitiveScorer (const G4String &name, G4int depth=0)
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	ScoreWeighted (G4bool flg=false)
G4bool	IsScoreWeighted () const
void	SetMultiFunctionalDetector (G4MultiFunctionalDetector *d)
G4MultiFunctionalDetector *	GetMultiFunctionalDetector () const
const G4String &	GetName () const
void	SetFilter (G4VSDFilter *f)
G4VSDFilter *	GetFilter () const
void	SetScoreWeightCalculator (G4ScoreWeightCalculator calculator)
void	SetVerboseLevel (G4int vl)
G4int	GetVerboseLevel () const
void	SetNijk (G4int i, G4int j, G4int k)

Protected Member Functions
G4bool	ProcessHits (G4Step *, G4TouchableHistory *) override
virtual G4double	ComputeVolume (G4Step *, G4int idx)
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 G4VPrimitivePlotter
std::map< G4int, G4int >	hitIDMap
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}
G4bool	scoreWeighted {false}
G4ScoreWeightCalculator	fScoreWeightCalculator

Detailed Description

Definition at line 57 of file G4PSCellFlux.hh.

Constructor & Destructor Documentation

G4PSCellFlux() [1/2]

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

Definition at line 58 of file G4PSCellFlux.cc.

  : G4PSCellFlux(name, "percm2", depth)
{}

Referenced by G4PSCellFlux(), and G4PSCellFlux3D::G4PSCellFlux3D().

G4PSCellFlux() [2/2]

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

Definition at line 62 of file G4PSCellFlux.cc.

  : G4VPrimitivePlotter(name, depth)
  , HCID(-1)
  , EvtMap(nullptr)
  , weighted(true)
{
  DefineUnitAndCategory();
  SetUnit(unit);
}

~G4PSCellFlux()

G4PSCellFlux::~G4PSCellFlux ( )

overridedefault

Member Function Documentation

clear()

void G4PSCellFlux::clear ( )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 117 of file G4PSCellFlux.cc.

{ EvtMap->clear(); }

ComputeVolume()

G4double G4PSCellFlux::ComputeVolume ( G4Step * aStep, G4int idx )

protectedvirtual

Reimplemented in G4PSCellFluxForCylinder3D.

Definition at line 147 of file G4PSCellFlux.cc.

{
  G4VSolid* solid = ComputeSolid(aStep, idx);
  assert(solid);
  return solid->GetCubicVolume();
}

Referenced by ProcessHits().

DefineUnitAndCategory()

void G4PSCellFlux::DefineUnitAndCategory ( )

protectedvirtual

Definition at line 137 of file G4PSCellFlux.cc.

{
  // Per Unit Surface
  new G4UnitDefinition("percentimeter2", "percm2", "Per Unit Surface",
                       (1. / cm2));
  new G4UnitDefinition("permillimeter2", "permm2", "Per Unit Surface",
                       (1. / mm2));
  new G4UnitDefinition("permeter2", "perm2", "Per Unit Surface", (1. / m2));
}

Referenced by G4PSCellFlux().

Initialize()

void G4PSCellFlux::Initialize ( G4HCofThisEvent * HCE )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 109 of file G4PSCellFlux.cc.

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

PrintAll()

void G4PSCellFlux::PrintAll ( )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 119 of file G4PSCellFlux.cc.

{
  G4cout << " MultiFunctionalDet  " << detector->GetName() << G4endl;
  G4cout << " PrimitiveScorer " << GetName() << G4endl;
  G4cout << " Number of entries " << EvtMap->entries() << G4endl;
  for(const auto& [copy, flux]: *(EvtMap->GetMap()))
  {
    G4cout << "  copy no.: " << copy
           << "  cell flux : " << *(flux) / GetUnitValue() << " ["
           << GetUnit() << "]" << G4endl;
  }
}

ProcessHits()

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

overrideprotectedvirtual

Implements G4VPrimitiveScorer.

Definition at line 72 of file G4PSCellFlux.cc.

{
  G4double stepLength = aStep->GetStepLength();
  if(stepLength == 0.)
    return false;
 
  G4int idx = ((G4TouchableHistory*) (aStep->GetPreStepPoint()->GetTouchable()))
                ->GetReplicaNumber(indexDepth);
  G4double cubicVolume = ComputeVolume(aStep, idx);
  G4double CellFlux = stepLength / cubicVolume;
  if (scoreWeighted) {
    CellFlux *= fScoreWeightCalculator(aStep);
  }
  if(weighted)
    CellFlux *= aStep->GetPreStepPoint()->GetWeight();
  G4int index = GetIndex(aStep);
  EvtMap->add(index, CellFlux);
 
  if(!hitIDMap.empty() && hitIDMap.find(index) != hitIDMap.end())
  {
    auto filler = G4VScoreHistFiller::Instance();
    if(filler == nullptr)
    {
      G4Exception(
        "G4PSCellFlux::ProcessHits", "SCORER0123", JustWarning,
        "G4TScoreHistFiller is not instantiated!! Histogram is not filled.");
    }
    else
    {
      filler->FillH1(hitIDMap[index],
                     aStep->GetPreStepPoint()->GetKineticEnergy(), CellFlux);
    }
  }
 
  return true;
}

SetUnit()

void G4PSCellFlux::SetUnit ( const G4String & unit )

virtual

Definition at line 132 of file G4PSCellFlux.cc.

{
  CheckAndSetUnit(unit, "Per Unit Surface");
}

Referenced by G4PSCellFlux(), G4PSCellFlux3D::G4PSCellFlux3D(), and G4ScoreQuantityMessenger::SetNewValue().

Weighted()

void G4PSCellFlux::Weighted ( G4bool flg = true )

inline

Definition at line 64 of file G4PSCellFlux.hh.

{ weighted = flg; }

---

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

• G4PSCellFlux.hh
• G4PSCellFlux.cc