G4PSFlatSurfaceFlux Class Reference

#include <G4PSFlatSurfaceFlux.hh>

Inheritance diagram for G4PSFlatSurfaceFlux:

Public Member Functions
	G4PSFlatSurfaceFlux (G4String name, G4int direction, G4int depth=0)
	G4PSFlatSurfaceFlux (G4String name, G4int direction, const G4String &unit, G4int depth=0)
	~G4PSFlatSurfaceFlux () override=default
void	Weighted (G4bool flg=true)
void	DivideByArea (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 (G4String name, G4int depth=0)
Public Member Functions inherited from G4VPrimitiveScorer
	G4VPrimitiveScorer (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
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
G4int	IsSelectedSurface (G4Step *, G4Box *)
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}

Detailed Description

Definition at line 63 of file G4PSFlatSurfaceFlux.hh.

Constructor & Destructor Documentation

G4PSFlatSurfaceFlux() [1/2]

G4PSFlatSurfaceFlux::G4PSFlatSurfaceFlux	(	G4String	name,
		G4int	direction,
		G4int	depth = 0 )

Definition at line 63 of file G4PSFlatSurfaceFlux.cc.

  : G4PSFlatSurfaceFlux(name, direction, "percm2", depth) 
{}

G4PSFlatSurfaceFlux() [2/2]

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

Definition at line 68 of file G4PSFlatSurfaceFlux.cc.

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

~G4PSFlatSurfaceFlux()

G4PSFlatSurfaceFlux::~G4PSFlatSurfaceFlux ( )

overridedefault

Member Function Documentation

clear()

void G4PSFlatSurfaceFlux::clear ( )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 211 of file G4PSFlatSurfaceFlux.cc.

{ EvtMap->clear(); }

DefineUnitAndCategory()

void G4PSFlatSurfaceFlux::DefineUnitAndCategory ( )

protectedvirtual

Definition at line 249 of file G4PSFlatSurfaceFlux.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 G4PSFlatSurfaceFlux().

DivideByArea()

void G4PSFlatSurfaceFlux::DivideByArea ( G4bool flg = true )

inline

Definition at line 74 of file G4PSFlatSurfaceFlux.hh.

{ divideByArea = flg; }

Initialize()

void G4PSFlatSurfaceFlux::Initialize ( G4HCofThisEvent * HCE )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 202 of file G4PSFlatSurfaceFlux.cc.

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

IsSelectedSurface()

G4int G4PSFlatSurfaceFlux::IsSelectedSurface ( G4Step * aStep, G4Box * boxSolid )

protected

Definition at line 168 of file G4PSFlatSurfaceFlux.cc.

{
  G4TouchableHandle theTouchable =
    aStep->GetPreStepPoint()->GetTouchableHandle();
  G4double kCarTolerance =
    G4GeometryTolerance::GetInstance()->GetSurfaceTolerance();
 
  if(aStep->GetPreStepPoint()->GetStepStatus() == fGeomBoundary)
  {
    // Entering Geometry
    G4ThreeVector stppos1 = aStep->GetPreStepPoint()->GetPosition();
    G4ThreeVector localpos1 =
      theTouchable->GetHistory()->GetTopTransform().TransformPoint(stppos1);
    if(std::fabs(localpos1.z() + boxSolid->GetZHalfLength()) < kCarTolerance)
    {
      return fFlux_In;
    }
  }
 
  if(aStep->GetPostStepPoint()->GetStepStatus() == fGeomBoundary)
  {
    // Exiting Geometry
    G4ThreeVector stppos2 = aStep->GetPostStepPoint()->GetPosition();
    G4ThreeVector localpos2 =
      theTouchable->GetHistory()->GetTopTransform().TransformPoint(stppos2);
    if(std::fabs(localpos2.z() + boxSolid->GetZHalfLength()) < kCarTolerance)
    {
      return fFlux_Out;
    }
  }
 
  return -1;
}

Referenced by ProcessHits().

PrintAll()

void G4PSFlatSurfaceFlux::PrintAll ( )

overridevirtual

Reimplemented from G4VPrimitiveScorer.

Definition at line 213 of file G4PSFlatSurfaceFlux.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
           << "  flux  : " << *(flux) / GetUnitValue() << " ["
           << GetUnit() << "]" << G4endl;
  }
}

ProcessHits()

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

overrideprotectedvirtual

Implements G4VPrimitiveScorer.

Definition at line 81 of file G4PSFlatSurfaceFlux.cc.

{
  G4StepPoint* preStep             = aStep->GetPreStepPoint();
  G4VPhysicalVolume* physVol       = preStep->GetPhysicalVolume();
  G4VPVParameterisation* physParam = physVol->GetParameterisation();
  G4VSolid* solid                  = nullptr;
  if(physParam != nullptr)
  {  // for parameterized volume
    G4int idx =
      ((G4TouchableHistory*) (aStep->GetPreStepPoint()->GetTouchable()))
        ->GetReplicaNumber(indexDepth);
    solid = physParam->ComputeSolid(idx, physVol);
    solid->ComputeDimensions(physParam, idx, physVol);
  }
  else
  {  // for ordinary volume
    solid = physVol->GetLogicalVolume()->GetSolid();
  }
 
  auto  boxSolid = (G4Box*) (solid);
 
  G4int dirFlag = IsSelectedSurface(aStep, boxSolid);
  if(dirFlag > 0)
  {
    if(fDirection == fFlux_InOut || fDirection == dirFlag)
    {
      G4StepPoint* thisStep = nullptr;
      if(dirFlag == fFlux_In)
      {
        thisStep = preStep;
      }
      else if(dirFlag == fFlux_Out)
      {
        thisStep = aStep->GetPostStepPoint();
      }
      else
      {
        return false;
      }
 
      G4TouchableHandle theTouchable = thisStep->GetTouchableHandle();
      G4ThreeVector pdirection       = thisStep->GetMomentumDirection();
      G4ThreeVector localdir =
        theTouchable->GetHistory()->GetTopTransform().TransformAxis(pdirection);
      //
      G4double angleFactor = localdir.z();
      if(angleFactor < 0)
        angleFactor *= -1.;
      G4double flux = 1.0;
      if(weighted)
        flux *= preStep->GetWeight();  // Current (Particle Weight)
      //
      G4double square =
        4. * boxSolid->GetXHalfLength() * boxSolid->GetYHalfLength();
      //
      flux = flux / angleFactor;  // Flux with angle.
      if(divideByArea)
        flux /= square;
      //
      G4int index = GetIndex(aStep);
      EvtMap->add(index, flux);
 
      if(!hitIDMap.empty() && hitIDMap.find(index) != hitIDMap.cend())
      {
        auto filler = G4VScoreHistFiller::Instance();
        if(filler == nullptr)
        {
          G4Exception("G4PSFlatSurfaceFlux::ProcessHits", "SCORER0123",
                      JustWarning,
                      "G4TScoreHistFiller is not instantiated!! Histogram is "
                      "not filled.");
        }
        else
        {
          filler->FillH1(hitIDMap[index], preStep->GetKineticEnergy(), flux);
        }
      }
    }
  }
#ifdef debug
  G4cout << " PASSED vol " << index << " trk " << trkid << " len "
         << fFlatSurfaceFlux << G4endl;
#endif
 
  return true;
}

SetUnit()

void G4PSFlatSurfaceFlux::SetUnit ( const G4String & unit )

virtual

Definition at line 226 of file G4PSFlatSurfaceFlux.cc.

{
  if(divideByArea)
  {
    CheckAndSetUnit(unit, "Per Unit Surface");
  }
  else
  {
    if(unit.empty())
    {
      unitName  = unit;
      unitValue = 1.0;
    }
    else
    {
      G4String msg = "Invalid unit [" + unit + "] (Current  unit is [" +
                     GetUnit() + "] ) for " + GetName();
      G4Exception("G4PSFlatSurfaceFlux::SetUnit", "DetPS0008", JustWarning,
                  msg);
    }
  }
}

Referenced by G4PSFlatSurfaceFlux(), and G4PSFlatSurfaceFlux3D::G4PSFlatSurfaceFlux3D().

Weighted()

void G4PSFlatSurfaceFlux::Weighted ( G4bool flg = true )

inline

Definition at line 71 of file G4PSFlatSurfaceFlux.hh.

{ weighted = flg; }

Referenced by G4ScoreQuantityMessenger::SetNewValue().

---

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

• G4PSFlatSurfaceFlux.hh
• G4PSFlatSurfaceFlux.cc