Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
G4VNavigation Class Referenceabstract

G4VNavigation class holds the common navigation interface for all geometry navigator types. More...

#include <G4VNavigation.hh>

Inheritance diagram for G4VNavigation:

Public Member Functions

virtual ~G4VNavigation ()=default
virtual G4bool LevelLocate (G4NavigationHistory &history, const G4VPhysicalVolume *blockedVol, const G4int blockedNum, const G4ThreeVector &globalPoint, const G4ThreeVector *globalDirection, const G4bool pLocatedOnEdge, G4ThreeVector &localPoint)=0
virtual G4double ComputeStep (const G4ThreeVector &localPoint, const G4ThreeVector &localDirection, const G4double currentProposedStepLength, G4double &newSafety, G4NavigationHistory &history, G4bool &validExitNormal, G4ThreeVector &exitNormal, G4bool &exiting, G4bool &entering, G4VPhysicalVolume *(*pBlockedPhysical), G4int &blockedReplicaNo)=0
virtual G4double ComputeSafety (const G4ThreeVector &localpoint, const G4NavigationHistory &history, const G4double pMaxLength=DBL_MAX)=0
virtual void RelocateWithinVolume (G4VPhysicalVolume *, const G4ThreeVector &)
virtual G4int GetVerboseLevel () const
virtual void SetVerboseLevel (G4int level)
void CheckMode (G4bool mode)

Protected Attributes

G4int fVerbose = 0
G4bool fCheck = false

Detailed Description

G4VNavigation class holds the common navigation interface for all geometry navigator types.

Definition at line 48 of file G4VNavigation.hh.

Constructor & Destructor Documentation

◆ ~G4VNavigation()

virtual G4VNavigation::~G4VNavigation ( )
virtualdefault

Virtual Destructor.

Member Function Documentation

◆ CheckMode()

void G4VNavigation::CheckMode ( G4bool mode)
inline

Sets check mode. When enabled, forces navigator to run in "check mode", hence using additional verifications and stricter condictions for ensuring correctness. Effective only when G4VERBOSE is enabled.

Definition at line 150 of file G4VNavigation.hh.

150{ fCheck = mode; }

◆ ComputeSafety()

virtual G4double G4VNavigation::ComputeSafety ( const G4ThreeVector & localpoint,
const G4NavigationHistory & history,
const G4double pMaxLength = DBL_MAX )
pure virtual

Computes the distance to the closest surface.

Parameters
[in]localPointLocal point.
[in]historyNavigation history.
[in]pMaxLengthMaximum step length beyond which volumes need not be checked.
Returns
Length from current point to closest surface.

Implemented in G4NormalNavigation, G4ParameterisedNavigation, G4RegularNavigation, and G4VoxelNavigation.

◆ ComputeStep()

virtual G4double G4VNavigation::ComputeStep ( const G4ThreeVector & localPoint,
const G4ThreeVector & localDirection,
const G4double currentProposedStepLength,
G4double & newSafety,
G4NavigationHistory & history,
G4bool & validExitNormal,
G4ThreeVector & exitNormal,
G4bool & exiting,
G4bool & entering,
G4VPhysicalVolume ** pBlockedPhysical,
G4int & blockedReplicaNo )
pure virtual

Computes the length of a step to the next boundary. Do not test against pBlockedPhysical. Identify the next candidate volume (if a daughter of current volume), and return it in: pBlockedPhysical, blockedReplicaNo.

Parameters
[in]localPointLocal point.
[in]localDirectionLocal vector direction.
[in]currentProposedStepLengthCurrent proposed step length.
[in,out]newSafetyNew safety.
[in,out]historyNavigation history.
[in,out]validExitNormalFlag to indicate whether exit normal is valid or not.
[in,out]exitNormalExit normal.
[in,out]enteringFlag to indicate whether entering a volume.
[in,out]exitingFlag to indicate whether exiting a volume.
[in,out]pBlockedPhysicalBlocked physical volume that should be ignored in queries.
[in,out]blockedReplicaNoCopy number for blocked replica volumes.
Returns
Length from current point to next boundary surface along localDirection.

Implemented in G4NormalNavigation, G4ParameterisedNavigation, G4RegularNavigation, and G4VoxelNavigation.

◆ GetVerboseLevel()

virtual G4int G4VNavigation::GetVerboseLevel ( ) const
inlinevirtual

Gets current verbosity level.

Reimplemented in G4NormalNavigation, and G4VoxelNavigation.

Definition at line 137 of file G4VNavigation.hh.

137{ return fVerbose; }

◆ LevelLocate()

virtual G4bool G4VNavigation::LevelLocate ( G4NavigationHistory & history,
const G4VPhysicalVolume * blockedVol,
const G4int blockedNum,
const G4ThreeVector & globalPoint,
const G4ThreeVector * globalDirection,
const G4bool pLocatedOnEdge,
G4ThreeVector & localPoint )
pure virtual

Searches positioned volumes in mother at current top level of history for volume containing globalPoint. Do not test against blockedVol. If a containing volume is found, push it onto navigation history state.

Parameters
[in,out]historyNavigation history.
[in,out]blockedVolBlocked volume to be ignored in queries.
[in,out]blockedNumCopy number for blocked replica volumes.
[in,out]globalPointPoint in global coordinates system.
[in,out]globalDirectionPointer to global direction or null.
[in,out]localPointPoint in local coordinates system.
Returns
Whether a containing volume has been found.

Implemented in G4NormalNavigation, G4ParameterisedNavigation, G4RegularNavigation, and G4VoxelNavigation.

◆ RelocateWithinVolume()

virtual void G4VNavigation::RelocateWithinVolume ( G4VPhysicalVolume * ,
const G4ThreeVector &  )
inlinevirtual

Updates internal navigation state to take into account that location has been moved, but remains within the motherPhysical volume.

Parameters
[in]motherPhysicalCurrent physical volume.
[in]localPointLocal point.

Reimplemented in G4ParameterisedNavigation, G4VExternalNavigation, and G4VoxelNavigation.

Definition at line 128 of file G4VNavigation.hh.

130 {
131 /* do nothing by default */
132 }

◆ SetVerboseLevel()

virtual void G4VNavigation::SetVerboseLevel ( G4int level)
inlinevirtual

Sets current verbosity level.

Reimplemented in G4NormalNavigation, and G4VoxelNavigation.

Definition at line 142 of file G4VNavigation.hh.

142{ fVerbose = level; }

Member Data Documentation

◆ fCheck

G4bool G4VNavigation::fCheck = false
protected

Definition at line 155 of file G4VNavigation.hh.

Referenced by CheckMode(), G4NormalNavigation::ComputeSafety(), G4VoxelNavigation::ComputeSafety(), G4NormalNavigation::ComputeStep(), G4ParameterisedNavigation::ComputeStep(), and G4VoxelNavigation::ComputeStep().

◆ fVerbose

G4int G4VNavigation::fVerbose = 0
protected

Definition at line 154 of file G4VNavigation.hh.

Referenced by GetVerboseLevel(), and SetVerboseLevel().

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