G4NavigationHistory Class Reference

G4NavigationHistory is a class responsible for the maintenance of the history of the path taken through the geometrical hierarchy. More...

#include <G4NavigationHistory.hh>

Public Member Functions
	G4NavigationHistory ()
	~G4NavigationHistory ()
	G4NavigationHistory (const G4NavigationHistory &h)
G4NavigationHistory &	operator= (const G4NavigationHistory &h)
void	Reset ()
void	Clear ()
void	SetFirstEntry (G4VPhysicalVolume *pVol)
const G4AffineTransform &	GetTopTransform () const
const G4AffineTransform *	GetPtrTopTransform () const
G4int	GetTopReplicaNo () const
EVolume	GetTopVolumeType () const
G4VPhysicalVolume *	GetTopVolume () const
std::size_t	GetDepth () const
std::size_t	GetMaxDepth () const
const G4AffineTransform &	GetTransform (G4int n) const
G4int	GetReplicaNo (G4int n) const
EVolume	GetVolumeType (G4int n) const
G4VPhysicalVolume *	GetVolume (G4int n) const
void	NewLevel (G4VPhysicalVolume *pNewMother, EVolume vType=kNormal, G4int nReplica=-1)
void	BackLevel ()
void	BackLevel (G4int n)
void *	operator new (std::size_t)
void	operator delete (void *aHistory)

Friends
std::ostream &	operator<< (std::ostream &os, const G4NavigationHistory &h)

Detailed Description

G4NavigationHistory is a class responsible for the maintenance of the history of the path taken through the geometrical hierarchy.

Definition at line 57 of file G4NavigationHistory.hh.

Constructor & Destructor Documentation

G4NavigationHistory() [1/2]

G4NavigationHistory::G4NavigationHistory

(

)

Constructor. Sizes history lists & resets histories.

Definition at line 40 of file G4NavigationHistory.cc.

{
  fNavHistory = G4NavigationHistoryPool::GetInstance()->GetLevels();
  Clear();
}

Referenced by G4NavigationHistory(), operator<<, and operator=().

~G4NavigationHistory()

G4NavigationHistory::~G4NavigationHistory

(

)

Default Destructor.

Definition at line 61 of file G4NavigationHistory.cc.

{
  G4NavigationHistoryPool::GetInstance()->DeRegister(fNavHistory);
}

G4NavigationHistory() [2/2]

G4NavigationHistory::G4NavigationHistory

(

const G4NavigationHistory &

h

)

Copy contructor and assigment operator.

Definition at line 46 of file G4NavigationHistory.cc.

{
  fNavHistory = G4NavigationHistoryPool::GetInstance()->GetLevels();
  if( GetMaxDepth() != h.GetMaxDepth() )
  {
    fNavHistory->resize( h.GetMaxDepth() );
  }
 
  for ( auto ilev=G4long(h.fStackDepth); ilev>=0; --ilev )
  { 
    (*fNavHistory)[ilev] = (*h.fNavHistory)[ilev];
  }
  fStackDepth = h.fStackDepth;
}

Member Function Documentation

BackLevel() [1/2]

void G4NavigationHistory::BackLevel ( )

inline

Backs up one level in history: from mother to grandmother. It does not erase the history record of the current mother.

Referenced by G4ReplicaNavigation::BackLocate(), and G4ParameterisedNavigation::LevelLocate().

BackLevel() [2/2]

void G4NavigationHistory::BackLevel ( G4int n )

inline

Backs up the specified number of levels in history.

Parameters

[in]

n

The history level.

Clear()

void G4NavigationHistory::Clear ( )

inline

Clears entries, zeroing transforms, matrices & negating replica history.

Referenced by G4NavigationHistory().

GetDepth()

std::size_t G4NavigationHistory::GetDepth ( ) const

inline

Returns the current history depth.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), G4RegularNavigation::ComputeStepSkippingEqualMaterials(), and operator<<.

GetMaxDepth()

std::size_t G4NavigationHistory::GetMaxDepth ( ) const

inline

Returns the current maximum size of the history. The maximum depth is set to 16, meaning history entries [0..15] inclusive.

Referenced by G4NavigationHistory().

GetPtrTopTransform()

const G4AffineTransform * G4NavigationHistory::GetPtrTopTransform ( ) const

inline

Returns a pointer to the topmost transformation.

GetReplicaNo()

G4int G4NavigationHistory::GetReplicaNo ( G4int n ) const

inline

Returns the specified replica number record.

Parameters

[in]

n

The history level.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), and operator<<.

GetTopReplicaNo()

G4int G4NavigationHistory::GetTopReplicaNo ( ) const

inline

Returns the topmost replica number record.

Referenced by G4ReplicaNavigation::ComputeSafety(), and G4ReplicaNavigation::ComputeStep().

GetTopTransform()

const G4AffineTransform & G4NavigationHistory::GetTopTransform ( ) const

inline

Returns the topmost transformation.

Referenced by G4RegularNavigation::ComputeStep(), G4ReplicaNavigation::ComputeStep(), G4DrawVoxels::DrawVoxels(), G4PSCylinderSurfaceCurrent::IsSelectedSurface(), G4PSCylinderSurfaceFlux::IsSelectedSurface(), G4PSFlatSurfaceCurrent::IsSelectedSurface(), G4PSFlatSurfaceFlux::IsSelectedSurface(), G4PSSphereSurfaceCurrent::IsSelectedSurface(), G4PSSphereSurfaceFlux::IsSelectedSurface(), G4ParameterisedNavigation::LevelLocate(), G4RegularNavigation::LevelLocate(), G4PSCylinderSurfaceFlux::ProcessHits(), G4PSFlatSurfaceFlux::ProcessHits(), G4PSSphereSurfaceFlux::ProcessHits(), and G4PSVolumeFlux::ProcessHits().

GetTopVolume()

G4VPhysicalVolume * G4NavigationHistory::GetTopVolume ( ) const

inline

Returns the topmost physical volume pointer.

Referenced by G4NormalNavigation::ComputeSafety(), G4ParameterisedNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeSafety(), G4VoxelNavigation::ComputeSafety(), G4NormalNavigation::ComputeStep(), G4ParameterisedNavigation::ComputeStep(), G4RegularNavigation::ComputeStep(), G4ReplicaNavigation::ComputeStep(), G4VoxelNavigation::ComputeStep(), G4ParameterisedNavigation::LevelLocate(), and G4RegularNavigation::LevelLocate().

GetTopVolumeType()

EVolume G4NavigationHistory::GetTopVolumeType ( ) const

inline

Returns the topmost volume type.

GetTransform()

const G4AffineTransform & G4NavigationHistory::GetTransform ( G4int n ) const

inline

Returns the specified transformation.

Parameters

[in]

n

The history level.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), and G4RegularNavigation::ComputeStepSkippingEqualMaterials().

GetVolume()

G4VPhysicalVolume * G4NavigationHistory::GetVolume ( G4int n ) const

inline

Returns the specified physical volume pointer.

Parameters

[in]

n

The history level.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), and operator<<.

GetVolumeType()

EVolume G4NavigationHistory::GetVolumeType ( G4int n ) const

inline

Returns the specified volume type.

Parameters

[in]

n

The history level.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), and operator<<.

NewLevel()

void G4NavigationHistory::NewLevel ( G4VPhysicalVolume * pNewMother, EVolume vType = kNormal, G4int nReplica = -1 )

inline

Changes the navigation level to that of the new mother.

Parameters

[in]	pNewMother	Pointer to the mother physical volume
[in]	vType	The volume type.
[in]	nReplica	The replica number.

Referenced by G4ParameterisedNavigation::LevelLocate(), and G4RegularNavigation::LevelLocate().

operator delete()

void G4NavigationHistory::operator delete ( void * aHistory )

inline

operator new()

void * G4NavigationHistory::operator new ( std::size_t )

inline

New/delete override for "G4Allocator".

operator=()

G4NavigationHistory & G4NavigationHistory::operator= ( const G4NavigationHistory & h )

inline

Reset()

void G4NavigationHistory::Reset ( )

inline

Resets history. It does clear most entries. Level 0 is preserved.

SetFirstEntry()

void G4NavigationHistory::SetFirstEntry ( G4VPhysicalVolume * pVol )

inline

Setups the initial entry in stack: copies through volume transform and rotarion matrix. The volume 'pVol' is assumed to be unrotated.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const G4NavigationHistory & h )

friend

Streaming operator.

Definition at line 66 of file G4NavigationHistory.cc.

{
  os << "History depth=" << nav.GetDepth() << G4endl;
  for ( G4int i=0; i<=(G4int)nav.GetDepth(); ++i )
  {
    os << "Level=["<<i<<"]: ";
    if( nav.GetVolume(i) != nullptr )
    {
      os << "Phys Name=["<< nav.GetVolume(i)->GetName()
         << "] Type=[";
      switch(nav.GetVolumeType(i))
      {
        case kNormal:
          os << "N";
          break;
        case kReplica:
          os << "R" << nav.GetReplicaNo(i);
          break;
        case kParameterised:
          os << "P" << nav.GetReplicaNo(i);
          break;
        case kExternal:
          os << "E" << nav.GetReplicaNo(i);
          break;
      }
      os << "]";
    }
    else
    {
      os << "Phys = <Null>";
    }
    os << G4endl;
  }
  return os;
}

---

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

• G4NavigationHistory.hh
• G4NavigationHistory.cc