G4ErrorPropagationNavigator Class Reference

G4ErrorPropagationNavigator is a class for performing double navigation in the detector geometry and on the target surface for error propagation. It overloads ComputeStep() and ComputeSafety() methods. More...

#include <G4ErrorPropagationNavigator.hh>

Inheritance diagram for G4ErrorPropagationNavigator:

Public Member Functions
	G4ErrorPropagationNavigator ()=default
	~G4ErrorPropagationNavigator () override=default
G4double	ComputeStep (const G4ThreeVector &pGlobalPoint, const G4ThreeVector &pDirection, const G4double pCurrentProposedStepLength, G4double &pNewSafety) override
G4double	ComputeSafety (const G4ThreeVector &globalpoint, const G4double pProposedMaxLength=DBL_MAX, const G4bool keepState=true) override
G4ThreeVector	GetGlobalExitNormal (const G4ThreeVector &point, G4bool *valid) override
G4double	TargetSafetyFromPoint (const G4ThreeVector &pGlobalpoint)
Public Member Functions inherited from G4Navigator
	G4Navigator ()
	G4Navigator (const G4Navigator &)=delete
G4Navigator &	operator= (const G4Navigator &)=delete
virtual	~G4Navigator ()
G4double	CheckNextStep (const G4ThreeVector &pGlobalPoint, const G4ThreeVector &pDirection, const G4double pCurrentProposedStepLength, G4double &pNewSafety)
virtual G4VPhysicalVolume *	ResetHierarchyAndLocate (const G4ThreeVector &point, const G4ThreeVector &direction, const G4TouchableHistory &h)
virtual G4VPhysicalVolume *	LocateGlobalPointAndSetup (const G4ThreeVector &point, const G4ThreeVector *direction=nullptr, const G4bool pRelativeSearch=true, const G4bool ignoreDirection=true)
virtual void	LocateGlobalPointWithinVolume (const G4ThreeVector &position)
void	LocateGlobalPointAndUpdateTouchableHandle (const G4ThreeVector &position, const G4ThreeVector &direction, G4TouchableHandle &oldTouchableToUpdate, const G4bool RelativeSearch=true)
void	LocateGlobalPointAndUpdateTouchable (const G4ThreeVector &position, const G4ThreeVector &direction, G4VTouchable *touchableToUpdate, const G4bool RelativeSearch=true)
void	LocateGlobalPointAndUpdateTouchable (const G4ThreeVector &position, G4VTouchable *touchableToUpdate, const G4bool RelativeSearch=true)
void	SetGeometricallyLimitedStep ()
G4VPhysicalVolume *	GetWorldVolume () const
void	SetWorldVolume (G4VPhysicalVolume *pWorld)
G4TouchableHistory *	CreateTouchableHistory () const
G4TouchableHistory *	CreateTouchableHistory (const G4NavigationHistory *h) const
virtual G4TouchableHandle	CreateTouchableHistoryHandle () const
virtual G4ThreeVector	GetLocalExitNormal (G4bool *valid)
virtual G4ThreeVector	GetLocalExitNormalAndCheck (const G4ThreeVector &point, G4bool *valid)
G4int	GetVerboseLevel () const
void	SetVerboseLevel (G4int level)
G4bool	IsActive () const
void	Activate (G4bool flag)
G4bool	EnteredDaughterVolume () const
G4bool	ExitedMotherVolume () const
void	CheckMode (G4bool mode)
G4bool	IsCheckModeActive () const
void	SetPushVerbosity (G4bool mode)
void	PrintState () const
const G4AffineTransform &	GetGlobalToLocalTransform () const
const G4AffineTransform	GetLocalToGlobalTransform () const
G4AffineTransform	GetMotherToDaughterTransform (G4VPhysicalVolume *dVolume, G4int dReplicaNo, EVolume dVolumeType)
void	ResetStackAndState ()
G4int	SeverityOfZeroStepping (G4int *noZeroSteps) const
G4ThreeVector	GetCurrentLocalCoordinate () const
G4ThreeVector	NetTranslation () const
G4RotationMatrix	NetRotation () const
void	EnableBestSafety (G4bool value=false)
G4VExternalNavigation *	GetExternalNavigation () const
void	SetExternalNavigation (G4VExternalNavigation *externalNav)
G4VoxelNavigation &	GetVoxelNavigator ()
void	SetVoxelNavigation (G4VoxelNavigation *voxelNav)
G4Navigator *	Clone () const
G4ThreeVector	GetLastStepEndPoint () const
void	InformLastStep (G4double lastStep, G4bool entersDaughtVol, G4bool exitsMotherVol)

Additional Inherited Members
Protected Member Functions inherited from G4Navigator
void	SetSavedState ()
void	RestoreSavedState ()
virtual void	ResetState ()
G4ThreeVector	ComputeLocalPoint (const G4ThreeVector &rGlobP) const
G4ThreeVector	ComputeLocalAxis (const G4ThreeVector &pVec) const
EVolume	VolumeType (const G4VPhysicalVolume *pVol) const
EVolume	CharacteriseDaughters (const G4LogicalVolume *pLog) const
G4int	GetDaughtersRegularStructureId (const G4LogicalVolume *pLv) const
virtual void	SetupHierarchy ()
G4bool	CheckOverlapsIterative (G4VPhysicalVolume *vol)
Protected Attributes inherited from G4Navigator
G4double	kCarTolerance
G4double	fMinStep
G4double	fSqTol
G4NavigationHistory	fHistory
G4ThreeVector	fStepEndPoint
G4ThreeVector	fLastStepEndPointLocal
G4int	fVerbose = 0
G4bool	fEnteredDaughter
G4bool	fExitedMother
G4bool	fWasLimitedByGeometry = false

Detailed Description

G4ErrorPropagationNavigator is a class for performing double navigation in the detector geometry and on the target surface for error propagation. It overloads ComputeStep() and ComputeSafety() methods.

Definition at line 48 of file G4ErrorPropagationNavigator.hh.

Constructor & Destructor Documentation

G4ErrorPropagationNavigator()

G4ErrorPropagationNavigator::G4ErrorPropagationNavigator ( )

default

Constructor and Destructor.

~G4ErrorPropagationNavigator()

G4ErrorPropagationNavigator::~G4ErrorPropagationNavigator ( )

overridedefault

Member Function Documentation

ComputeSafety()

G4double G4ErrorPropagationNavigator::ComputeSafety ( const G4ThreeVector & globalpoint, const G4double pProposedMaxLength = DBL_MAX, const G4bool keepState = true )

overridevirtual

Calls the navigation in the detector geometry and then checks if the distance to surface is smaller than the proposed safety.

Parameters

[in]	globalpoint	The point in global coordinates system. The point must be within the current volume.
[in]	pProposedMaxLength	The proposed maximum length is used to avoid volume safety calculations.
[in]	keepState	Flag to instruct keeping the state (default true) to ensure minimum side effects from the call.

Returns

Length from current point to closest boundary surface. The value returned is usually an underestimate.

Reimplemented from G4Navigator.

Definition at line 137 of file G4ErrorPropagationNavigator.cc.

{
  G4double safetyGeom = G4Navigator::ComputeSafety(pGlobalPoint,
                                                  pMaxLength, keepState);
 
  G4double safetyTarget = TargetSafetyFromPoint( pGlobalPoint ); 
 
  return std::min(safetyGeom, safetyTarget); 
}

ComputeStep()

G4double G4ErrorPropagationNavigator::ComputeStep ( const G4ThreeVector & pGlobalPoint, const G4ThreeVector & pDirection, const G4double pCurrentProposedStepLength, G4double & pNewSafety )

overridevirtual

Calls the navigation in the detector geometry and then checks if the distance to surface is smaller than the proposed step.

Parameters

[in]	pGlobalPoint	The point in global coordinates system.
[in]	pDirection	The normalised vector direction.
[in]	pCurrentProposedStepLength	Current proposed step length.
[in,out]	newSafety	New safety.

Returns

Length from current point to next boundary surface along pDirection.

Reimplemented from G4Navigator.

Definition at line 41 of file G4ErrorPropagationNavigator.cc.

{
  G4double safetyGeom = DBL_MAX;
   
  G4double Step = G4Navigator::ComputeStep(pGlobalPoint, pDirection,
                                           pCurrentProposedStepLength,
                                           safetyGeom);
  
  G4ErrorPropagatorData* g4edata
    = G4ErrorPropagatorData::GetErrorPropagatorData();
 
  if ( g4edata != nullptr )
  {
    const G4ErrorTarget* target = g4edata->GetTarget();
    if( target != nullptr )
    {
      G4double StepPlane=target->GetDistanceFromPoint(pGlobalPoint,pDirection);
 
      if( StepPlane < 0. ) // Negative means target is crossed,
      {                    // will not be found
        StepPlane = DBL_MAX; 
      }
#ifdef G4VERBOSE
      if( G4ErrorPropagatorData::verbose() >= 4 )
      {
        G4cout << "G4ErrorPropagationNavigator::ComputeStep()" << G4endl
               << "  Target step: " << StepPlane
               << ", Transportation step: " << Step << G4endl;
        target->Dump( "G4ErrorPropagationNavigator::ComputeStep Target " );
      }
#endif
 
      if( StepPlane < Step )
      {
#ifdef G4VERBOSE
        if( G4ErrorPropagatorData::verbose() >= 2 )
        {
          G4cout << "G4ErrorPropagationNavigator::ComputeStep()" << G4endl
                 << "  TargetCloserThanBoundary: " << StepPlane << " < "
                 << Step << G4endl;
        }
#endif
        Step = StepPlane;
        g4edata->SetState(G4ErrorState_TargetCloserThanBoundary);
      }
      else
      {
        g4edata->SetState(G4ErrorState_Propagating);
      }
    }
  }
  G4double safetyTarget = TargetSafetyFromPoint(pGlobalPoint);
 
  // Avoid call to G4Navigator::ComputeSafety - which could have side effects
  //
  pNewSafety = std::min(safetyGeom, safetyTarget); 
 
#ifdef G4VERBOSE
  if( G4ErrorPropagatorData::verbose() >= 3 )
  {
    G4cout << "G4ErrorPropagationNavigator::ComputeStep()" << G4endl
           << "  Step: " << Step << ", ComputeSafety: " << pNewSafety
           << G4endl;
  }
#endif
 
  return Step;
}

GetGlobalExitNormal()

G4ThreeVector G4ErrorPropagationNavigator::GetGlobalExitNormal ( const G4ThreeVector & point, G4bool * valid )

overridevirtual

Returns Exit Surface Normal and validity too. Can only be called if the Navigator's last Step has crossed a volume geometrical boundary. Normal points out of the volume exited and/or into the volume entered.

Parameters

[in]	point	Point in global coordinates system to compare to.
[in,out]	valid	Flag indicating if normal is valid.

Returns

A Exit Surface Normal vector and validity too.

Reimplemented from G4Navigator.

Definition at line 152 of file G4ErrorPropagationNavigator.cc.

{
  G4ErrorPropagatorData* g4edata
        = G4ErrorPropagatorData::GetErrorPropagatorData();
  const G4ErrorTarget* target = nullptr;
 
  G4ThreeVector normal(0.0, 0.0, 0.0);
  G4double      distance= 0;
  
  // Determine which 'geometry' limited the step
  if ( g4edata != nullptr )
  {
    target = g4edata->GetTarget();
    if( target != nullptr )
    {
      distance = target->GetDistanceFromPoint(point);
    }
  }
  
  if( distance > kCarTolerance || (target == nullptr) )
    // Not reached the target or if a target does not exist,
    // this seems the best we can do
  {
    normal = G4Navigator::GetGlobalExitNormal(point, valid);
  }
  else
  {
    switch( target->GetType() )
    {
      case G4ErrorTarget_GeomVolume:
        // The volume is in the 'real' mass geometry
        normal = G4Navigator::GetGlobalExitNormal(point, valid);
        break;
      case G4ErrorTarget_TrkL:
        normal = G4ThreeVector( 0.0, 0.0, 0.0);
        *valid = false;
        G4Exception("G4ErrorPropagationNavigator::GetGlobalExitNormal",
                    "Geometry1003",
                    JustWarning, "Unexpected value of Target type");
        break;
      case G4ErrorTarget_PlaneSurface:
      case G4ErrorTarget_CylindricalSurface:
        const auto surfTarget= static_cast<const G4ErrorSurfaceTarget*>(target);
        normal = surfTarget->GetTangentPlane(point).normal().unit();
        *valid = true;
        break;
 
//      default:
//        normal= G4ThreeVector( 0.0, 0.0, 0.0 );
//        *valid = false;
//        G4Exception("G4ErrorPropagationNavigator::GetGlobalExitNormal",
//                    "Geometry:003",
//                    FatalException, "Impossible value of Target type");
//        break;
    }
  }
  return normal;
}

TargetSafetyFromPoint()

G4double G4ErrorPropagationNavigator::TargetSafetyFromPoint

(

const G4ThreeVector &

pGlobalpoint

)

Computes the isotropic safety for 'Target'.

Parameters

[in]

pGlobalpoint

Point in global coordinates system.

Returns

The isotropic safety value.

Definition at line 116 of file G4ErrorPropagationNavigator.cc.

{
  G4double safety = DBL_MAX;
 
  G4ErrorPropagatorData* g4edata
    = G4ErrorPropagatorData::GetErrorPropagatorData();
 
  if ( g4edata != nullptr )
  {
    const G4ErrorTarget* target = g4edata->GetTarget();
    if( target != nullptr )
    {
       safety = target->GetDistanceFromPoint(pGlobalpoint);
    }
  }
  return safety;
}

Referenced by ComputeSafety(), and ComputeStep().

---

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

• G4ErrorPropagationNavigator.hh
• G4ErrorPropagationNavigator.cc