#include <G4ITSafetyHelper.hh>

Inheritance diagram for G4ITSafetyHelper:

Data Structures
class	State

Public Types
typedef G4ITSafetyHelper	ClassType

typedef G4TrackState< G4ITSafetyHelper >	StateType

typedef G4shared_ptr< StateType >	StateTypeHandle

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)

virtual StateTypeHandle	CreateTrackState () const

void	EnableParallelNavigation (G4bool parallel)

	G4ITSafetyHelper ()

virtual StateTypeHandle	GetConcreteTrackState () const

virtual G4VTrackStateHandle	GetTrackState () const

G4VPhysicalVolume *	GetWorldVolume ()

void	InitialiseHelper ()

void	InitialiseNavigator ()

virtual void	LoadTrackState (G4TrackStateManager &manager)

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

virtual void	NewTrackState ()

virtual G4VTrackStateHandle	PopTrackState ()

void	ReLocateWithinVolume (const G4ThreeVector &pGlobalPoint)

virtual void	ResetTrackState ()

virtual void	SaveTrackState (G4TrackStateManager &manager)

void	SetCurrentSafety (G4double val, const G4ThreeVector &pos)

virtual void	SetTrackState (G4shared_ptr< StateType > state)

G4int	SetVerboseLevel (G4int lev)

	~G4ITSafetyHelper ()

Protected Attributes
StateTypeHandle	fpTrackState

Private Attributes
G4bool	fFirstCall

G4int	fMassNavigatorId

G4ITNavigator *	fpMassNavigator

G4PathFinder *	fpPathFinder

G4bool	fUseParallelGeometries

G4int	fVerbose

Detailed Description

Definition at line 54 of file G4ITSafetyHelper.hh.

Member Typedef Documentation

◆ ClassType

typedef G4ITSafetyHelper G4TrackStateDependent< G4ITSafetyHelper >::ClassType

inherited

Definition at line 238 of file G4TrackState.hh.

◆ StateType

typedef G4TrackState<G4ITSafetyHelper > G4TrackStateDependent< G4ITSafetyHelper >::StateType

inherited

Definition at line 239 of file G4TrackState.hh.

◆ StateTypeHandle

typedef G4shared_ptr<StateType> G4TrackStateDependent< G4ITSafetyHelper >::StateTypeHandle

inherited

Definition at line 240 of file G4TrackState.hh.

Constructor & Destructor Documentation

◆ G4ITSafetyHelper()

G4ITSafetyHelper::G4ITSafetyHelper ( )

Definition at line 41 of file G4ITSafetyHelper.cc.

                                   :
    G4TrackStateDependent<G4ITSafetyHelper>(), fUseParallelGeometries(false), // By default, one geometry only
    fFirstCall(true), fVerbose(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;
}

References fMassNavigatorId, fpMassNavigator, and fpPathFinder.

◆ ~G4ITSafetyHelper()

G4ITSafetyHelper::~G4ITSafetyHelper ( )

Definition at line 89 of file G4ITSafetyHelper.cc.

90{

91}

Member Function Documentation

◆ CheckNextStep()

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

Definition at line 93 of file G4ITSafetyHelper.cc.

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

References fpMassNavigator, G4TrackStateDependent< G4ITSafetyHelper >::fpTrackState, and position.

Referenced by G4DNABrownianTransportation::ComputeGeomLimit().

◆ ComputeSafety()

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

Definition at line 111 of file G4ITSafetyHelper.cc.

{
  G4double newSafety;
 
  // Only recompute (calling Navigator/PathFinder) if 'position'
  // is  *not* the safety location and has moved 'significantly'
  //
  G4double moveLengthSq = (position - fpTrackState->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)
    {
      fpTrackState->fLastSafety = newSafety;
      fpTrackState->fLastSafetyPosition = position;
    }
  }
  else
  {
    // return last value if position is not (significantly) changed
    //
    // G4double moveLength = 0;
    // if( moveLengthSq > 0.0 ) { moveLength= std::sqrt(moveLengthSq); }
    newSafety = fpTrackState->fLastSafety; // -moveLength;
  }
  return newSafety;
}

References G4PathFinder::ComputeSafety(), fpMassNavigator, fpPathFinder, G4TrackStateDependent< G4ITSafetyHelper >::fpTrackState, fUseParallelGeometries, and position.

◆ CreateTrackState()

virtual StateTypeHandle G4TrackStateDependent< G4ITSafetyHelper >::CreateTrackState ( ) const

inlinevirtualinherited

Definition at line 290 of file G4TrackState.hh.

  {
    return StateTypeHandle(new StateType());
  }

◆ EnableParallelNavigation()

void G4ITSafetyHelper::EnableParallelNavigation ( G4bool parallel )

inline

Referenced by G4ITPathFinder::EnableParallelNavigation().

◆ GetConcreteTrackState()

virtual StateTypeHandle G4TrackStateDependent< G4ITSafetyHelper >::GetConcreteTrackState ( ) const

inlinevirtualinherited

Definition at line 264 of file G4TrackState.hh.

  {
    return fpTrackState;
  }

◆ GetTrackState()

virtual G4VTrackStateHandle G4TrackStateDependent< G4ITSafetyHelper >::GetTrackState ( ) const

inlinevirtualinherited

Implements G4VTrackStateDependent.

Definition at line 257 of file G4TrackState.hh.

  {
    G4VTrackStateHandle output =
      G4dynamic_pointer_cast<G4VTrackState>(fpTrackState);
    return output;
  }

◆ GetWorldVolume()

G4VPhysicalVolume * G4ITSafetyHelper::GetWorldVolume ( )

inline

Definition at line 154 of file G4ITSafetyHelper.hh.

{
  return fpMassNavigator->GetWorldVolume();
}

References fpMassNavigator.

Referenced by G4DNABrownianTransportation::ComputeGeomLimit().

◆ InitialiseHelper()

void G4ITSafetyHelper::InitialiseHelper ( )

Definition at line 79 of file G4ITSafetyHelper.cc.

{
  NewTrackState();
  if (fFirstCall)
  {
    InitialiseNavigator();
  }
  fFirstCall = false;
}

References fFirstCall, InitialiseNavigator(), and G4TrackStateDependent< G4ITSafetyHelper >::NewTrackState().

Referenced by G4ITTransportation::BuildPhysicsTable(), G4DNABrownianTransportation::BuildPhysicsTable(), and G4ITPathFinder::PrepareNewTrack().

◆ InitialiseNavigator()

void G4ITSafetyHelper::InitialiseNavigator ( )

Definition at line 55 of file G4ITSafetyHelper.cc.

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

References FatalException, fpMassNavigator, fpPathFinder, G4Exception(), G4PathFinder::GetInstance(), G4ITTransportationManager::GetNavigatorForTracking(), and G4ITTransportationManager::GetTransportationManager().

Referenced by InitialiseHelper().

◆ LoadTrackState()

virtual void G4TrackStateDependent< G4ITSafetyHelper >::LoadTrackState ( G4TrackStateManager & manager )

inlinevirtualinherited

Implements G4VTrackStateDependent.

Definition at line 269 of file G4TrackState.hh.

  {
    fpTrackState =
      ConvertToConcreteTrackState<ClassType>(manager.GetTrackState(this));
    if (fpTrackState == nullptr)
    {
      NewTrackState();
      SaveTrackState(manager);
    }
  }

◆ Locate()

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

Definition at line 183 of file G4ITSafetyHelper.cc.

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

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

◆ NewTrackState()

virtual void G4TrackStateDependent< G4ITSafetyHelper >::NewTrackState ( )

inlinevirtualinherited

Implements G4VTrackStateDependent.

Definition at line 285 of file G4TrackState.hh.

  {
    fpTrackState = StateTypeHandle(new StateType());
  }

◆ PopTrackState()

virtual G4VTrackStateHandle G4TrackStateDependent< G4ITSafetyHelper >::PopTrackState ( )

inlinevirtualinherited

Implements G4VTrackStateDependent.

Definition at line 249 of file G4TrackState.hh.

  {
    G4VTrackStateHandle output =
      G4dynamic_pointer_cast<G4VTrackState>(fpTrackState);
    fpTrackState.reset();
    return output;
  }

◆ ReLocateWithinVolume()

void G4ITSafetyHelper::ReLocateWithinVolume ( const G4ThreeVector & pGlobalPoint )

Definition at line 151 of file G4ITSafetyHelper.cc.

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

References fpMassNavigator, fpPathFinder, G4TrackStateDependent< G4ITSafetyHelper >::fpTrackState, fUseParallelGeometries, fVerbose, G4endl, G4Exception(), JustWarning, CLHEP::Hep3Vector::mag2(), G4PathFinder::ReLocate(), and sqr().

◆ ResetTrackState()

virtual void G4TrackStateDependent< G4ITSafetyHelper >::ResetTrackState ( )

inlinevirtualinherited

Implements G4VTrackStateDependent.

Definition at line 295 of file G4TrackState.hh.

  {
    fpTrackState.reset();
  }

◆ SaveTrackState()

virtual void G4TrackStateDependent< G4ITSafetyHelper >::SaveTrackState ( G4TrackStateManager & manager )

inlinevirtualinherited

Implements G4VTrackStateDependent.

Definition at line 280 of file G4TrackState.hh.

  {
    manager.SetTrackState(this, ConvertToAbstractTrackState(fpTrackState));
  }

◆ SetCurrentSafety()

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

inline

Definition at line 160 of file G4ITSafetyHelper.hh.

{
  fpTrackState->fLastSafety = val;
  fpTrackState->fLastSafetyPosition = pos;
}

References G4TrackStateDependent< G4ITSafetyHelper >::fpTrackState, and pos.

Referenced by G4ITTransportation::AlongStepGetPhysicalInteractionLength().

◆ SetTrackState()

virtual void G4TrackStateDependent< G4ITSafetyHelper >::SetTrackState ( G4shared_ptr< StateType > state )

inlinevirtualinherited

Definition at line 244 of file G4TrackState.hh.

  {
    fpTrackState = state;
  }

◆ SetVerboseLevel()

G4int G4ITSafetyHelper::SetVerboseLevel ( G4int lev )

inline

Definition at line 97 of file G4ITSafetyHelper.hh.

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

G4int

int G4int

Definition: G4Types.hh:85

References fVerbose.

Field Documentation

◆ fFirstCall

G4bool G4ITSafetyHelper::fFirstCall

private

Definition at line 115 of file G4ITSafetyHelper.hh.

Referenced by InitialiseHelper().

◆ fMassNavigatorId

G4int G4ITSafetyHelper::fMassNavigatorId

private

Definition at line 111 of file G4ITSafetyHelper.hh.

Referenced by G4ITSafetyHelper().

◆ fpMassNavigator

G4ITNavigator* G4ITSafetyHelper::fpMassNavigator

private

Definition at line 110 of file G4ITSafetyHelper.hh.

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

◆ fpPathFinder

G4PathFinder* G4ITSafetyHelper::fpPathFinder

private

Definition at line 109 of file G4ITSafetyHelper.hh.

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

◆ fpTrackState

StateTypeHandle G4TrackStateDependent< G4ITSafetyHelper >::fpTrackState

protectedinherited

Definition at line 305 of file G4TrackState.hh.

◆ fUseParallelGeometries

G4bool G4ITSafetyHelper::fUseParallelGeometries

private

Definition at line 113 of file G4ITSafetyHelper.hh.

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

◆ fVerbose

G4int G4ITSafetyHelper::fVerbose

private

Definition at line 117 of file G4ITSafetyHelper.hh.

Referenced by ReLocateWithinVolume(), and SetVerboseLevel().

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

source/processes/electromagnetic/dna/management/include/G4ITSafetyHelper.hh
source/processes/electromagnetic/dna/management/src/G4ITSafetyHelper.cc

Data Structures

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ClassType

◆ StateType

◆ StateTypeHandle

Constructor & Destructor Documentation

◆ G4ITSafetyHelper()

◆ ~G4ITSafetyHelper()

Member Function Documentation

◆ CheckNextStep()

◆ ComputeSafety()

◆ CreateTrackState()

◆ EnableParallelNavigation()

◆ GetConcreteTrackState()

◆ GetTrackState()

◆ GetWorldVolume()

◆ InitialiseHelper()

◆ InitialiseNavigator()

◆ LoadTrackState()

◆ Locate()

◆ NewTrackState()

◆ PopTrackState()

◆ ReLocateWithinVolume()

◆ ResetTrackState()

◆ SaveTrackState()

◆ SetCurrentSafety()

◆ SetTrackState()

◆ SetVerboseLevel()

Field Documentation

◆ fFirstCall

◆ fMassNavigatorId

◆ fpMassNavigator

◆ fpPathFinder

◆ fpTrackState

◆ fUseParallelGeometries

◆ fVerbose