G4SafetyHelper Class Reference

#include <G4SafetyHelper.hh>

Collaboration diagram for G4SafetyHelper:

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

Private Attributes
G4PathFinder *	fpPathFinder
G4Navigator *	fpMassNavigator
G4int	fMassNavigatorId
G4bool	fUseParallelGeometries
G4bool	fFirstCall
G4int	fVerbose
G4ThreeVector	fLastSafetyPosition
G4double	fLastSafety

Detailed Description

Definition at line 53 of file G4SafetyHelper.hh.

Constructor & Destructor Documentation

G4SafetyHelper()

G4SafetyHelper::G4SafetyHelper

(

)

Definition at line 42 of file G4SafetyHelper.cc.

 : fUseParallelGeometries(false),     // By default, one geometry only
   fFirstCall(true),
   fVerbose(0), 
   fLastSafetyPosition(0.0,0.0,0.0),
   fLastSafety(0.0)
   // fRecomputeFactor(0.0)
{
  fpPathFinder= 0; //  Cannot initialise this yet - a loop results

  // Initialization of the Navigator pointer is postponed, and must
  // be undertaken by another class calling InitialiseHelper()
  //
  fpMassNavigator= 0;  
  fMassNavigatorId= -1; 
}

~G4SafetyHelper()

G4SafetyHelper::~G4SafetyHelper

(

)

Definition at line 89 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 94 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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ComputeSafety()

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

Definition at line 114 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);
    }
    else
    {
      // Safety for all geometries
      newSafety = fpPathFinder->ComputeSafety(position); 
    } 
 
    // We can only store a 'true' safety - one that was not restricted by maxLength
    if( newSafety < maxLength )
    {
       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;
}

Here is the call graph for this function:

Here is the caller graph for this function:

EnableParallelNavigation()

void G4SafetyHelper::EnableParallelNavigation ( G4bool  parallel )

inline

Definition at line 146 of file G4SafetyHelper.hh.

{
  fUseParallelGeometries = parallel;
} 

Here is the caller graph for this function:

GetWorldVolume()

G4VPhysicalVolume * G4SafetyHelper::GetWorldVolume ( )

inline

Definition at line 152 of file G4SafetyHelper.hh.

{
  return fpMassNavigator->GetWorldVolume();
}

Here is the call graph for this function:

Here is the caller graph for this function:

InitialiseHelper()

void G4SafetyHelper::InitialiseHelper

(

)

Definition at line 81 of file G4SafetyHelper.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

InitialiseNavigator()

void G4SafetyHelper::InitialiseNavigator

(

)

Definition at line 59 of file G4SafetyHelper.cc.

{
  fpPathFinder= G4PathFinder::GetInstance();
 
  G4TransportationManager* pTransportMgr= 
    G4TransportationManager::GetTransportationManager();

  fpMassNavigator = pTransportMgr->GetNavigatorForTracking(); 

  // Check
  //
  G4VPhysicalVolume* worldPV = fpMassNavigator->GetWorldVolume(); 
  if( worldPV == 0 )
  { 
    G4Exception("G4SafetyHelper::InitialiseNavigator",
                "InvalidNavigatorWorld", FatalException, 
                "Found that existing tracking Navigator has NULL world"); 
  }

  fMassNavigatorId = pTransportMgr->ActivateNavigator( fpMassNavigator ); 
}

Here is the call graph for this function:

Here is the caller graph for this function:

Locate()

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

Definition at line 183 of file G4SafetyHelper.cc.

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

Here is the call graph for this function:

RecheckDistanceToCurrentBoundary()

G4bool G4SafetyHelper::RecheckDistanceToCurrentBoundary	(	const G4ThreeVector &	pGlobalPoint,
		const G4ThreeVector &	pDirection,
		const G4double	pCurrentProposedStepLength,
		G4double *	prDistance,
		G4double *	prNewSafety = 0
	)		const

Definition at line 197 of file G4SafetyHelper.cc.

{
  G4bool retval;
  if( !fUseParallelGeometries)
  {
    retval= fpMassNavigator->RecheckDistanceToCurrentBoundary(
                                                              pGlobalPoint,
                                                              pDirection,
                                                              aProposedMove,
                                                              prDistance,
                                                              prNewSafety);
  }
  else
  {
    //G4Exception("G4Navigator::RecheckDistanceToCurrentBoundary()", "GeomNav0001",
    //  JustWarning, "Method NOT Available (yet) in case of Multiple Geometries (where PathFinder is involved.).");
    retval= fpPathFinder->RecheckDistanceToCurrentBoundary(
                                                              pGlobalPoint,
                                                               pDirection,
                                                              aProposedMove,
                                                              prDistance,
                                                              prNewSafety);
  }
  return retval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ReLocateWithinVolume()

void G4SafetyHelper::ReLocateWithinVolume

(

const G4ThreeVector &

pGlobalPoint

)

Definition at line 153 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 << " Safety Sphere:  Radius = " << fLastSafety;
      ed << " Center   = " << fLastSafetyPosition << G4endl;
      ed << " New Location :  Move   = " << moveVec.mag2();
      ed << " Position = " << newPosition << G4endl;
      G4Exception("G4SafetyHelper::ReLocateWithinVolume", "GeomNav999", JustWarning,
                 "Unsafe Move> Asked to relocate beyond 'Safety sphere'.");
    }
  }
#endif
   
  if( !fUseParallelGeometries )
  {
    fpMassNavigator->LocateGlobalPointWithinVolume( newPosition ); 
  }
  else
  {
    fpPathFinder->ReLocate( newPosition ); 
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetCurrentSafety()

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

inline

Definition at line 158 of file G4SafetyHelper.hh.

{
  fLastSafety = val;
  fLastSafetyPosition = pos;
}

Here is the caller graph for this function:

SetVerboseLevel()

G4int G4SafetyHelper::SetVerboseLevel ( G4int  lev )

inline

Definition at line 112 of file G4SafetyHelper.hh.

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

Here is the call graph for this function:

Member Data Documentation

fFirstCall

G4bool G4SafetyHelper::fFirstCall

private

Definition at line 129 of file G4SafetyHelper.hh.

fLastSafety

G4double G4SafetyHelper::fLastSafety

private

Definition at line 136 of file G4SafetyHelper.hh.

fLastSafetyPosition

G4ThreeVector G4SafetyHelper::fLastSafetyPosition

private

Definition at line 135 of file G4SafetyHelper.hh.

fMassNavigatorId

G4int G4SafetyHelper::fMassNavigatorId

private

Definition at line 125 of file G4SafetyHelper.hh.

fpMassNavigator

G4Navigator* G4SafetyHelper::fpMassNavigator

private

Definition at line 124 of file G4SafetyHelper.hh.

fpPathFinder

G4PathFinder* G4SafetyHelper::fpPathFinder

private

Definition at line 123 of file G4SafetyHelper.hh.

fUseParallelGeometries

G4bool G4SafetyHelper::fUseParallelGeometries

private

Definition at line 127 of file G4SafetyHelper.hh.

fVerbose

G4int G4SafetyHelper::fVerbose

private

Definition at line 131 of file G4SafetyHelper.hh.

---

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

• G4SafetyHelper.hh
• G4SafetyHelper.cc