G4SafetyHelper Class Reference

#include <G4SafetyHelper.hh>

Public Member Functions
G4double	CheckNextStep (const G4ThreeVector &position, const G4ThreeVector &direction, const G4double currentMaxStep, G4double &newSafety)
G4double	ComputeSafety (const G4ThreeVector &pGlobalPoint, G4double maxRadius=DBL_MAX)
void	EnableParallelNavigation (G4bool parallel)
	G4SafetyHelper ()
G4VPhysicalVolume *	GetWorldVolume ()
void	InitialiseHelper ()
void	InitialiseNavigator ()
void	Locate (const G4ThreeVector &pGlobalPoint, const G4ThreeVector &direction)
void	ReLocateWithinVolume (const G4ThreeVector &pGlobalPoint)
void	SetCurrentSafety (G4double val, const G4ThreeVector &pos)
G4int	SetVerboseLevel (G4int lev)
	~G4SafetyHelper ()

Private Attributes
G4bool	fFirstCall = true
G4double	fLastSafety = 0.0
G4ThreeVector	fLastSafetyPosition
G4int	fMassNavigatorId = -1
G4Navigator *	fpMassNavigator = nullptr
G4PathFinder *	fpPathFinder = nullptr
G4bool	fUseParallelGeometries = false
G4int	fVerbose = 0

Detailed Description

Definition at line 46 of file G4SafetyHelper.hh.

Constructor & Destructor Documentation

G4SafetyHelper()

G4SafetyHelper::G4SafetyHelper

(

)

Definition at line 38 of file G4SafetyHelper.cc.

  : fLastSafetyPosition(0.0,0.0,0.0)
{
}

~G4SafetyHelper()

G4SafetyHelper::~G4SafetyHelper

(

)

Definition at line 73 of file G4SafetyHelper.cc.

{
}

Member Function Documentation

CheckNextStep()

G4double G4SafetyHelper::CheckNextStep	(	const G4ThreeVector &	position,
		const G4ThreeVector &	direction,
		const G4double	currentMaxStep,
		G4double &	newSafety
	)

Definition at line 78 of file G4SafetyHelper.cc.

{  
  // Distance in the Mass geometry
  //
  G4double linstep = fpMassNavigator->CheckNextStep( position,
                                                     direction,
                                                     currentMaxStep,
                                                     newSafety);
  fLastSafetyPosition = position;
  fLastSafety         = newSafety;
 
  // TO-DO: Can replace this with a call to PathFinder 
  //        giving id of Mass Geometry --> this avoid doing the work twice
 
  return linstep;
}

References G4Navigator::CheckNextStep(), fLastSafety, fLastSafetyPosition, fpMassNavigator, and position.

Referenced by G4VMscModel::ComputeGeomLimit().

ComputeSafety()

G4double G4SafetyHelper::ComputeSafety	(	const G4ThreeVector &	pGlobalPoint,
		G4double	maxRadius = DBL_MAX
	)

Definition at line 98 of file G4SafetyHelper.cc.

{
  G4double newSafety;
  
  // Only recompute (calling Navigator/PathFinder) if 'position'
  // is  *not* the safety location and has moved 'significantly'
  //
  G4double moveLengthSq = (position-fLastSafetyPosition).mag2();
  if(   (moveLengthSq > 0.0 ) )
  {
    if( !fUseParallelGeometries )
    {
      // Safety for mass geometry
      newSafety = fpMassNavigator->ComputeSafety(position, maxLength, true);
 
      // Only store a 'true' safety - one that was not restricted by maxLength
      if( newSafety < maxLength )
      {
         fLastSafety= newSafety;
         fLastSafetyPosition = position;
      }
    }
    else
    {
      // Safety for all geometries
      newSafety = fpPathFinder->ComputeSafety(position);
 
      fLastSafety= newSafety;
      fLastSafetyPosition = position;
    } 
 
  }
  else
  {
    // return last value if position is not (significantly) changed
    //
    // G4double moveLength = 0;
    // if( moveLengthSq > 0.0 ) { moveLength= std::sqrt(moveLengthSq); }
    newSafety = fLastSafety; // -moveLength;
  }
  
  return newSafety;
}

References G4PathFinder::ComputeSafety(), G4Navigator::ComputeSafety(), fLastSafety, fLastSafetyPosition, fpMassNavigator, fpPathFinder, fUseParallelGeometries, and position.

Referenced by G4VMultipleScattering::AlongStepDoIt(), and G4VMscModel::ComputeSafety().

EnableParallelNavigation()

void G4SafetyHelper::EnableParallelNavigation ( G4bool  parallel )

inline

Definition at line 129 of file G4SafetyHelper.hh.

{
  fUseParallelGeometries = parallel;
} 

References fUseParallelGeometries.

Referenced by G4PathFinder::EnableParallelNavigation().

GetWorldVolume()

G4VPhysicalVolume * G4SafetyHelper::GetWorldVolume ( )

inline

Definition at line 135 of file G4SafetyHelper.hh.

{
  return fpMassNavigator->GetWorldVolume();
}

References fpMassNavigator, and G4Navigator::GetWorldVolume().

InitialiseHelper()

void G4SafetyHelper::InitialiseHelper

(

)

Definition at line 65 of file G4SafetyHelper.cc.

{
  fLastSafetyPosition = G4ThreeVector(0.0,0.0,0.0);
  fLastSafety         = 0.0;
  if (fFirstCall) { InitialiseNavigator(); }
  fFirstCall = false;
}

References fFirstCall, fLastSafety, fLastSafetyPosition, and InitialiseNavigator().

Referenced by G4VEnergyLossProcess::BuildPhysicsTable(), G4ElNeutrinoNucleusProcess::G4ElNeutrinoNucleusProcess(), G4MuNeutrinoNucleusProcess::G4MuNeutrinoNucleusProcess(), G4NeutrinoElectronProcess::G4NeutrinoElectronProcess(), G4VMscModel::GetParticleChangeForMSC(), G4PathFinder::PrepareNewTrack(), and G4VMultipleScattering::PreparePhysicsTable().

InitialiseNavigator()

void G4SafetyHelper::InitialiseNavigator

(

)

Definition at line 43 of file G4SafetyHelper.cc.

{
  fpPathFinder = G4PathFinder::GetInstance();
 
  G4TransportationManager* pTransportMgr= 
    G4TransportationManager::GetTransportationManager();
 
  fpMassNavigator = pTransportMgr->GetNavigatorForTracking(); 
 
  // Check
  //
  G4VPhysicalVolume* worldPV = fpMassNavigator->GetWorldVolume(); 
  if( worldPV == nullptr )
  { 
    G4Exception("G4SafetyHelper::InitialiseNavigator",
                "GeomNav0003", FatalException, 
                "Found that existing tracking Navigator has NULL world"); 
  }
 
  fMassNavigatorId = pTransportMgr->ActivateNavigator( fpMassNavigator ); 
}

References G4TransportationManager::ActivateNavigator(), FatalException, fMassNavigatorId, fpMassNavigator, fpPathFinder, G4Exception(), G4PathFinder::GetInstance(), G4TransportationManager::GetNavigatorForTracking(), G4TransportationManager::GetTransportationManager(), and G4Navigator::GetWorldVolume().

Referenced by InitialiseHelper().

Locate()

void G4SafetyHelper::Locate	(	const G4ThreeVector &	pGlobalPoint,
		const G4ThreeVector &	direction
	)

Definition at line 177 of file G4SafetyHelper.cc.

{
  if( !fUseParallelGeometries )
  {
    fpMassNavigator->LocateGlobalPointAndSetup(newPosition, &newDirection,
                                               true, false); 
  }
  else
  {
    fpPathFinder->Locate( newPosition, newDirection ); 
  }
}

References fpMassNavigator, fpPathFinder, fUseParallelGeometries, G4PathFinder::Locate(), and G4Navigator::LocateGlobalPointAndSetup().

ReLocateWithinVolume()

void G4SafetyHelper::ReLocateWithinVolume

(

const G4ThreeVector &

pGlobalPoint

)

Definition at line 143 of file G4SafetyHelper.cc.

{
#ifdef G4VERBOSE
  if( fVerbose > 0 )
  {
    // There is an opportunity - and need - to check whether
    // the proposed move is safe
    G4ThreeVector moveVec = newPosition - fLastSafetyPosition;
    if( moveVec.mag2() > sqr(fLastSafety) )
    {
      // A problem exists - we are proposing to move outside 'Safety Sphere'
      G4ExceptionDescription ed;
      ed << "Unsafe Move> Asked to relocate beyond 'Safety sphere'.  Details: "
         << G4endl;
      ed << " Safety Sphere:  Radius = " << fLastSafety;
      ed << " Center   = " << fLastSafetyPosition << G4endl;
      ed << " New Location :  Move   = " << moveVec.mag();
      ed << " Position = " << newPosition << G4endl;
      G4Exception("G4SafetyHelper::ReLocateWithinVolume",
                  "GeomNav1001", JustWarning, ed);
    }
  }
#endif
   
  if( !fUseParallelGeometries )
  {
    fpMassNavigator->LocateGlobalPointWithinVolume( newPosition ); 
  }
  else
  {
    fpPathFinder->ReLocate( newPosition ); 
  }
}

References fLastSafety, fLastSafetyPosition, fpMassNavigator, fpPathFinder, fUseParallelGeometries, fVerbose, G4endl, G4Exception(), JustWarning, G4Navigator::LocateGlobalPointWithinVolume(), CLHEP::Hep3Vector::mag(), CLHEP::Hep3Vector::mag2(), G4PathFinder::ReLocate(), and sqr().

Referenced by G4VMultipleScattering::AlongStepDoIt(), G4NeutrinoElectronProcess::PostStepDoIt(), G4ElNeutrinoNucleusProcess::PostStepDoIt(), and G4MuNeutrinoNucleusProcess::PostStepDoIt().

SetCurrentSafety()

void G4SafetyHelper::SetCurrentSafety ( G4double  val, const G4ThreeVector &  pos  )

inline

Definition at line 141 of file G4SafetyHelper.hh.

{
  fLastSafety = val;
  fLastSafetyPosition = pos;
}

References fLastSafety, fLastSafetyPosition, and pos.

Referenced by G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), and G4Transportation::AlongStepGetPhysicalInteractionLength().

SetVerboseLevel()

G4int G4SafetyHelper::SetVerboseLevel ( G4int  lev )

inline

Definition at line 121 of file G4SafetyHelper.hh.

{
  G4int oldlv = fVerbose;
  fVerbose = lev;
  return oldlv;
} 

References fVerbose.

Field Documentation

fFirstCall

G4bool G4SafetyHelper::fFirstCall = true

private

Definition at line 100 of file G4SafetyHelper.hh.

Referenced by InitialiseHelper().

fLastSafety

G4double G4SafetyHelper::fLastSafety = 0.0

private

Definition at line 108 of file G4SafetyHelper.hh.

Referenced by CheckNextStep(), ComputeSafety(), InitialiseHelper(), ReLocateWithinVolume(), and SetCurrentSafety().

fLastSafetyPosition

G4ThreeVector G4SafetyHelper::fLastSafetyPosition

private

Definition at line 107 of file G4SafetyHelper.hh.

Referenced by CheckNextStep(), ComputeSafety(), InitialiseHelper(), ReLocateWithinVolume(), and SetCurrentSafety().

fMassNavigatorId

G4int G4SafetyHelper::fMassNavigatorId = -1

private

Definition at line 95 of file G4SafetyHelper.hh.

Referenced by InitialiseNavigator().

fpMassNavigator

G4Navigator* G4SafetyHelper::fpMassNavigator = nullptr

private

Definition at line 94 of file G4SafetyHelper.hh.

Referenced by CheckNextStep(), ComputeSafety(), GetWorldVolume(), InitialiseNavigator(), Locate(), and ReLocateWithinVolume().

fpPathFinder

G4PathFinder* G4SafetyHelper::fpPathFinder = nullptr

private

Definition at line 93 of file G4SafetyHelper.hh.

Referenced by ComputeSafety(), InitialiseNavigator(), Locate(), and ReLocateWithinVolume().

fUseParallelGeometries

G4bool G4SafetyHelper::fUseParallelGeometries = false

private

Definition at line 97 of file G4SafetyHelper.hh.

Referenced by ComputeSafety(), EnableParallelNavigation(), Locate(), and ReLocateWithinVolume().

fVerbose

G4int G4SafetyHelper::fVerbose = 0

private

Definition at line 102 of file G4SafetyHelper.hh.

Referenced by ReLocateWithinVolume(), and SetVerboseLevel().

---

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

• source/geometry/navigation/include/G4SafetyHelper.hh
• source/geometry/navigation/src/G4SafetyHelper.cc