G4TouchableHistory Class Reference

G4TouchableHistory is an object representing a touchable detector element, and its history in the geometrical hierarchy, including its net resultant local->global transform. A touchable is a geometrical volume (solid) which has a unique placement in a detector description. More...

#include <G4TouchableHistory.hh>

Inheritance diagram for G4TouchableHistory:

Public Member Functions
	G4TouchableHistory ()
virtual	~G4TouchableHistory ()=default
	G4TouchableHistory (const G4NavigationHistory &history)
G4VPhysicalVolume *	GetVolume (G4int depth=0) const
G4VSolid *	GetSolid (G4int depth=0) const
const G4ThreeVector &	GetTranslation (G4int depth=0) const
const G4RotationMatrix *	GetRotation (G4int depth=0) const
G4int	GetReplicaNumber (G4int depth=0) const
G4int	GetCopyNumber (G4int depth=0) const
G4int	GetHistoryDepth () const
G4int	MoveUpHistory (G4int num_levels=1)
void	UpdateYourself (G4VPhysicalVolume *pPhysVol, const G4NavigationHistory *history=nullptr)
const G4NavigationHistory *	GetHistory () const
void *	operator new (std::size_t)
void	operator delete (void *aTH)

Detailed Description

G4TouchableHistory is an object representing a touchable detector element, and its history in the geometrical hierarchy, including its net resultant local->global transform. A touchable is a geometrical volume (solid) which has a unique placement in a detector description.

Definition at line 106 of file G4TouchableHistory.hh.

Constructor & Destructor Documentation

G4TouchableHistory() [1/2]

G4TouchableHistory::G4TouchableHistory

(

)

Default Constructor. It produces a touchable-history of 'zero-depth', i.e. an "unphysical" and not very usable one; for initialisation only.

Definition at line 39 of file G4TouchableHistory.cc.

  : ftlate(G4ThreeVector(0.,0.,0.))
    
{ 
  fhistory.SetFirstEntry(nullptr);
}

~G4TouchableHistory()

virtual G4TouchableHistory::~G4TouchableHistory ( )

virtualdefault

Default Destructor. Virtual, as it is a reference-counted object, but there is no provision for this class to be subclassed; if subclassed, it may fail and not give explicit errors!

G4TouchableHistory() [2/2]

G4TouchableHistory::G4TouchableHistory

(

const G4NavigationHistory &

history

)

Copy constructor.

Definition at line 46 of file G4TouchableHistory.cc.

  : fhistory(history)
{
  const G4AffineTransform& tf = fhistory.GetTopTransform();
  ftlate = tf.InverseNetTranslation();
  frot = tf.InverseNetRotation();
}

Member Function Documentation

GetCopyNumber()

G4int G4TouchableHistory::GetCopyNumber ( G4int depth = 0 ) const

inline

Referenced by G4RayTrajectory::AppendStep(), and G4RTSteppingAction::UserSteppingAction().

GetHistory()

const G4NavigationHistory * G4TouchableHistory::GetHistory ( ) const

inline

Returns a pointer to the navigation history; used in G4Navigator::LocateGlobalPointAndSetup().

Referenced by G4ITPathFinder::CreateTouchableHandle(), G4PathFinder::CreateTouchableHandle(), G4ITMultiNavigator::CreateTouchableHistoryHandle(), G4MultiNavigator::CreateTouchableHistoryHandle(), G4DrawVoxels::DrawVoxels(), G4CoherentPairProduction::GetMeanFreePath(), G4PSCylinderSurfaceCurrent::IsSelectedSurface(), G4PSCylinderSurfaceFlux::IsSelectedSurface(), G4PSFlatSurfaceCurrent::IsSelectedSurface(), G4PSFlatSurfaceFlux::IsSelectedSurface(), G4PSSphereSurfaceCurrent::IsSelectedSurface(), G4PSSphereSurfaceFlux::IsSelectedSurface(), G4ITNavigator2::NewNavigatorState(), G4CoherentPairProduction::PostStepDoIt(), G4PSCylinderSurfaceFlux::ProcessHits(), G4PSFlatSurfaceFlux::ProcessHits(), G4PSSphereSurfaceFlux::ProcessHits(), G4PSVolumeFlux::ProcessHits(), G4ITNavigator1::ResetHierarchyAndLocate(), G4ITNavigator2::ResetHierarchyAndLocate(), and G4Navigator::ResetHierarchyAndLocate().

GetHistoryDepth()

G4int G4TouchableHistory::GetHistoryDepth ( ) const

inline

Referenced by G4RayTrajectory::AppendStep(), and G4RTSteppingAction::UserSteppingAction().

GetReplicaNumber()

G4int G4TouchableHistory::GetReplicaNumber ( G4int depth = 0 ) const

inline

Accessors for touchables with history.

Referenced by G4PSCellCharge3D::GetIndex(), G4PSCellFlux3D::GetIndex(), G4PSCylinderSurfaceCurrent3D::GetIndex(), G4PSCylinderSurfaceFlux3D::GetIndex(), G4PSDoseDeposit3D::GetIndex(), G4PSEnergyDeposit3D::GetIndex(), G4PSFlatSurfaceCurrent3D::GetIndex(), G4PSFlatSurfaceFlux3D::GetIndex(), G4PSMinKinEAtGeneration3D::GetIndex(), G4PSNofCollision3D::GetIndex(), G4PSNofSecondary3D::GetIndex(), G4PSNofStep3D::GetIndex(), G4PSPassageCellCurrent3D::GetIndex(), G4PSPassageCellFlux3D::GetIndex(), G4PSPassageTrackLength3D::GetIndex(), G4PSPopulation3D::GetIndex(), G4PSSphereSurfaceCurrent3D::GetIndex(), G4PSSphereSurfaceFlux3D::GetIndex(), G4PSStepChecker3D::GetIndex(), G4PSTermination3D::GetIndex(), G4PSTrackCounter3D::GetIndex(), G4PSTrackLength3D::GetIndex(), G4PSVolumeFlux3D::GetIndex(), G4ImportanceProcess::PostStepDoIt(), G4WeightCutOffProcess::PostStepDoIt(), G4WeightWindowProcess::PostStepDoIt(), G4ITSteppingVerbose::PostStepVerbose(), and G4ITSteppingVerbose::PreStepVerbose().

GetRotation()

const G4RotationMatrix * G4TouchableHistory::GetRotation

(

G4int

depth = 0

)

const

Definition at line 71 of file G4TouchableHistory.cc.

{ 
  // The value returned will change at the next call
  // Copy it if you want to use it!
  //
  static G4ThreadLocal G4RotationMatrix* rotM = nullptr;
  if ( rotM == nullptr )  { rotM = new G4RotationMatrix; }
 
  if(depth==0.0)
  {
    return &frot;
  }
  *rotM = fhistory.GetTransform(CalculateHistoryIndex(depth)).NetRotation();
  return rotM;
}

Referenced by G4Channeling::PosToLattice(), G4Channeling::PostStepDoIt(), G4ElNeutrinoNucleusProcess::PostStepDoIt(), G4MuNeutrinoNucleusProcess::PostStepDoIt(), G4NeutrinoElectronProcess::PostStepDoIt(), G4TauNeutrinoNucleusProcess::PostStepDoIt(), and G4VXTRenergyLoss::PostStepDoIt().

GetSolid()

G4VSolid * G4TouchableHistory::GetSolid ( G4int depth = 0 ) const

inline

Referenced by G4DNAMolecularDissociation::DecayIt(), and G4VIntersectionLocator::LocateGlobalPointWithinVolumeAndCheck().

GetTranslation()

const G4ThreeVector & G4TouchableHistory::GetTranslation

(

G4int

depth = 0

)

const

Definition at line 55 of file G4TouchableHistory.cc.

{ 
  // The value returned will change at the next call
  // Copy it if you want to use it!
  //
  static G4ThreadLocal G4ThreeVector* ctrans = nullptr;
  if ( ctrans == nullptr )  { ctrans = new G4ThreeVector; }
  if(depth==0.0)
  {
    return ftlate;
  }
  *ctrans = fhistory.GetTransform(CalculateHistoryIndex(depth)).NetTranslation();
  return *ctrans;
}

Referenced by G4Channeling::PosToLattice(), G4ElNeutrinoNucleusProcess::PostStepDoIt(), G4MuNeutrinoNucleusProcess::PostStepDoIt(), G4NeutrinoElectronProcess::PostStepDoIt(), G4TauNeutrinoNucleusProcess::PostStepDoIt(), and G4VXTRenergyLoss::PostStepDoIt().

GetVolume()

G4VPhysicalVolume * G4TouchableHistory::GetVolume ( G4int depth = 0 ) const

inline

Accessors.

Referenced by G4DNABrownianTransportation::AlongStepGetPhysicalInteractionLength(), G4RayTrajectory::AppendStep(), G4AdjointCrossSurfChecker::CrossingAnInterfaceBetweenTwoVolumes(), G4DNAMolecularDissociation::DecayIt(), G4PSDoseDeposit3D::GetIndex(), G4PSEnergyDeposit3D::GetIndex(), G4AdjointCrossSurfChecker::GoingInOrOutOfaVolume(), G4AdjointCrossSurfChecker::GoingInOrOutOfaVolumeByExtSurface(), G4VIntersectionLocator::LocateGlobalPointWithinVolumeAndCheck(), G4ITTransportation::PostStepDoIt(), G4ITSteppingVerbose::PostStepVerbose(), G4ITSteppingVerbose::PreStepVerbose(), G4Transportation::SetTouchableInformation(), and G4RTSteppingAction::UserSteppingAction().

MoveUpHistory()

G4int G4TouchableHistory::MoveUpHistory

(

G4int

num_levels = 1

)

Referenced by G4ITNavigator1::SetupHierarchy(), G4ITNavigator2::SetupHierarchy(), and G4Navigator::SetupHierarchy().

operator delete()

void G4TouchableHistory::operator delete ( void * aTH )

inline

operator new()

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

inline

Operators overriding new/delete for use by G4Allocator.

UpdateYourself()

void G4TouchableHistory::UpdateYourself	(	G4VPhysicalVolume *	pPhysVol,
		const G4NavigationHistory *	history = nullptr )

Update method for touchables with history.

Referenced by G4DNABrownianTransportation::AlongStepGetPhysicalInteractionLength(), G4ITPathFinder::CreateTouchableHandle(), G4PathFinder::CreateTouchableHandle(), G4ITMultiNavigator::CreateTouchableHistoryHandle(), and G4MultiNavigator::CreateTouchableHistoryHandle().

---

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

• G4TouchableHistory.hh
• G4TouchableHistory.cc