G4Track Class Reference

#include <G4Track.hh>

Public Member Functions
	G4Track ()
	G4Track (G4DynamicParticle *apValueDynamicParticle, G4double aValueTime, const G4ThreeVector &aValuePosition)
	G4Track (const G4Track &)
	~G4Track ()
void *	operator new (size_t)
void	operator delete (void *aTrack)
G4bool	operator== (const G4Track &)
void	CopyTrackInfo (const G4Track &)
G4int	GetTrackID () const
void	SetTrackID (const G4int aValue)
G4int	GetParentID () const
void	SetParentID (const G4int aValue)
const G4DynamicParticle *	GetDynamicParticle () const
const G4ParticleDefinition *	GetParticleDefinition () const
G4ParticleDefinition *	GetDefinition () const
const G4ThreeVector &	GetPosition () const
void	SetPosition (const G4ThreeVector &aValue)
G4double	GetGlobalTime () const
void	SetGlobalTime (const G4double aValue)
G4double	GetLocalTime () const
void	SetLocalTime (const G4double aValue)
G4double	GetProperTime () const
void	SetProperTime (const G4double aValue)
G4VPhysicalVolume *	GetVolume () const
G4VPhysicalVolume *	GetNextVolume () const
G4Material *	GetMaterial () const
G4Material *	GetNextMaterial () const
const G4MaterialCutsCouple *	GetMaterialCutsCouple () const
const G4MaterialCutsCouple *	GetNextMaterialCutsCouple () const
const G4VTouchable *	GetTouchable () const
const G4TouchableHandle &	GetTouchableHandle () const
void	SetTouchableHandle (const G4TouchableHandle &apValue)
const G4VTouchable *	GetNextTouchable () const
const G4TouchableHandle &	GetNextTouchableHandle () const
void	SetNextTouchableHandle (const G4TouchableHandle &apValue)
const G4VTouchable *	GetOriginTouchable () const
const G4TouchableHandle &	GetOriginTouchableHandle () const
void	SetOriginTouchableHandle (const G4TouchableHandle &apValue)
G4double	GetKineticEnergy () const
void	SetKineticEnergy (const G4double aValue)
G4double	GetTotalEnergy () const
const G4ThreeVector &	GetMomentumDirection () const
void	SetMomentumDirection (const G4ThreeVector &aValue)
G4ThreeVector	GetMomentum () const
G4double	GetVelocity () const
void	SetVelocity (G4double val)
G4double	CalculateVelocity () const
G4double	CalculateVelocityForOpticalPhoton () const
G4bool	UseGivenVelocity () const
void	UseGivenVelocity (G4bool val)
const G4ThreeVector &	GetPolarization () const
void	SetPolarization (const G4ThreeVector &aValue)
G4TrackStatus	GetTrackStatus () const
void	SetTrackStatus (const G4TrackStatus aTrackStatus)
G4bool	IsBelowThreshold () const
void	SetBelowThresholdFlag (G4bool value=true)
G4bool	IsGoodForTracking () const
void	SetGoodForTrackingFlag (G4bool value=true)
G4double	GetTrackLength () const
void	AddTrackLength (const G4double aValue)
const G4Step *	GetStep () const
void	SetStep (const G4Step *aValue)
G4int	GetCurrentStepNumber () const
void	IncrementCurrentStepNumber ()
G4double	GetStepLength () const
void	SetStepLength (G4double value)
const G4ThreeVector &	GetVertexPosition () const
void	SetVertexPosition (const G4ThreeVector &aValue)
const G4ThreeVector &	GetVertexMomentumDirection () const
void	SetVertexMomentumDirection (const G4ThreeVector &aValue)
G4double	GetVertexKineticEnergy () const
void	SetVertexKineticEnergy (const G4double aValue)
const G4LogicalVolume *	GetLogicalVolumeAtVertex () const
void	SetLogicalVolumeAtVertex (const G4LogicalVolume *)
const G4VProcess *	GetCreatorProcess () const
void	SetCreatorProcess (const G4VProcess *aValue)
void	SetCreatorModelIndex (G4int idx)
const G4String &	GetCreatorModelName () const
G4int	GetCreatorModelID () const
G4double	GetWeight () const
void	SetWeight (G4double aValue)
G4VUserTrackInformation *	GetUserInformation () const
void	SetUserInformation (G4VUserTrackInformation *aValue) const
void	SetAuxiliaryTrackInformation (G4int idx, G4VAuxiliaryTrackInformation *info) const
G4VAuxiliaryTrackInformation *	GetAuxiliaryTrackInformation (G4int idx) const
std::map< G4int, G4VAuxiliaryTrackInformation * > *	GetAuxiliaryTrackInformationMap () const
void	RemoveAuxiliaryTrackInformation (G4int idx)
void	RemoveAuxiliaryTrackInformation (G4String &name)

Static Public Member Functions
static void	SetVelocityTableProperties (G4double t_max, G4double t_min, G4int nbin)
static G4double	GetMaxTOfVelocityTable ()
static G4double	GetMinTOfVelocityTable ()
static G4int	GetNbinOfVelocityTable ()

Detailed Description

Definition at line 76 of file G4Track.hh.

Constructor & Destructor Documentation

G4Track::G4Track

(

)

Definition at line 98 of file G4Track.cc.

  : fCurrentStepNumber(0),    
    fGlobalTime(0),           fLocalTime(0.),
    fTrackLength(0.),
    fParentID(0),             fTrackID(0),
    fVelocity(c_light),
    fpDynamicParticle(0),
    fTrackStatus(fAlive),
    fBelowThreshold(false),   fGoodForTracking(false),
    fStepLength(0.0),         fWeight(1.0),
    fpStep(0),
    fVtxKineticEnergy(0.0),
    fpLVAtVertex(0),          fpCreatorProcess(0),
    fCreatorModelIndex(-1),
    fpUserInformation(0),
    prev_mat(0),  groupvel(0),
    prev_velocity(0.0), prev_momentum(0.0),
    is_OpticalPhoton(false),
    useGivenVelocity(false),
    fpAuxiliaryTrackInformationMap(0)
{
}

G4Track::G4Track	(	G4DynamicParticle *	apValueDynamicParticle,
		G4double	aValueTime,
		const G4ThreeVector &	aValuePosition
	)

Definition at line 57 of file G4Track.cc.

  : fCurrentStepNumber(0),    fPosition(aValuePosition),
    fGlobalTime(aValueTime),  fLocalTime(0.),
    fTrackLength(0.),
    fParentID(0),             fTrackID(0),
    fVelocity(c_light),
    fpDynamicParticle(apValueDynamicParticle),
    fTrackStatus(fAlive),
    fBelowThreshold(false),   fGoodForTracking(false),
    fStepLength(0.0),         fWeight(1.0),
    fpStep(0),
    fVtxKineticEnergy(0.0),
    fpLVAtVertex(0),          fpCreatorProcess(0),
    fCreatorModelIndex(-1),
    fpUserInformation(0),
    prev_mat(0),  groupvel(0),
    prev_velocity(0.0), prev_momentum(0.0),
    is_OpticalPhoton(false),
    useGivenVelocity(false),
    fpAuxiliaryTrackInformationMap(0)
{
  static G4ThreadLocal G4bool isFirstTime = true;
  static G4ThreadLocal G4ParticleDefinition* fOpticalPhoton =0;
  if ( isFirstTime ) {
    isFirstTime = false;
    // set  fOpticalPhoton
    fOpticalPhoton = G4ParticleTable::GetParticleTable()->FindParticle("opticalphoton");
  }
  // check if the particle type is Optical Photon
  is_OpticalPhoton = (fpDynamicParticle->GetDefinition() == fOpticalPhoton);

  if (velTable ==0 ) velTable = G4VelocityTable::GetVelocityTable();

  fVelocity = CalculateVelocity();

}

Here is the call graph for this function:

G4Track::G4Track

(

const G4Track &

right

)

Definition at line 123 of file G4Track.cc.

  : fCurrentStepNumber(0),    
    fGlobalTime(0),           fLocalTime(0.),
    fTrackLength(0.),
    fParentID(0),             fTrackID(0),
    fVelocity(c_light),
    fpDynamicParticle(0),
    fTrackStatus(fAlive),
    fBelowThreshold(false),   fGoodForTracking(false),
    fStepLength(0.0),         fWeight(1.0),
    fpStep(0),
    fVtxKineticEnergy(0.0),
    fpLVAtVertex(0),          fpCreatorProcess(0),
    fCreatorModelIndex(-1),
    fpUserInformation(0),
    prev_mat(0),  groupvel(0),
    prev_velocity(0.0), prev_momentum(0.0),
    is_OpticalPhoton(false),
    useGivenVelocity(false),
    fpAuxiliaryTrackInformationMap(0)
{
  *this = right;
}

G4Track::~G4Track

(

)

Definition at line 149 of file G4Track.cc.

{
   delete fpDynamicParticle;
   delete fpUserInformation;
   ClearAuxiliaryTrackInformation();
}

Member Function Documentation

void G4Track::AddTrackLength

(

const G4double

aValue

)

Here is the caller graph for this function:

G4double G4Track::CalculateVelocity

(

)

const

Definition at line 222 of file G4Track.cc.

{
  if (useGivenVelocity) return fVelocity;    

  G4double velocity = c_light ;
  
  G4double mass = fpDynamicParticle->GetMass();

  // special case for photons
  if ( is_OpticalPhoton ) return CalculateVelocityForOpticalPhoton();

  // particles other than optical photon
  if (mass<DBL_MIN) {
    // Zero Mass
    velocity = c_light;
  } else {
    G4double T = (fpDynamicParticle->GetKineticEnergy())/mass;
    if (T > GetMaxTOfVelocityTable()) {
      velocity = c_light;
    } else if (T<DBL_MIN) {
      velocity =0.;
    } else if (T<GetMinTOfVelocityTable()) {
      velocity = c_light*std::sqrt(T*(T+2.))/(T+1.0);
    } else {    
      velocity = velTable->Value(T);
    }
    
  }                                                                             
  return velocity ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4Track::CalculateVelocityForOpticalPhoton

(

)

const

Definition at line 255 of file G4Track.cc.

{
    
  G4double velocity = c_light ;
  

  G4Material* mat=0; 
  G4bool update_groupvel = false;
  if ( fpStep !=0  ){
    mat= this->GetMaterial();         //   Fix for repeated volumes
  }else{
    if (fpTouchable!=0){ 
      mat=fpTouchable->GetVolume()->GetLogicalVolume()->GetMaterial();
    }
  }
  // check if previous step is in the same volume
    //  and get new GROUPVELOCITY table if necessary 
  if ((mat != 0) && ((mat != prev_mat)||(groupvel==0))) {
    groupvel = 0;
    if(mat->GetMaterialPropertiesTable() != 0)
      groupvel = mat->GetMaterialPropertiesTable()->GetProperty("GROUPVEL");
    update_groupvel = true;
  }
  prev_mat = mat;
  
  if  (groupvel != 0 ) {
    // light velocity = c/(rindex+d(rindex)/d(log(E_phot)))
    // values stored in GROUPVEL material properties vector
    velocity =  prev_velocity;
    
    // check if momentum is same as in the previous step
    //  and calculate group velocity if necessary 
    G4double current_momentum = fpDynamicParticle->GetTotalMomentum();
    if( update_groupvel || (current_momentum != prev_momentum) ) {
      velocity =
    groupvel->Value(current_momentum);
      prev_velocity = velocity;
      prev_momentum = current_momentum;
    }
  }   
  
  return velocity ;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4Track::CopyTrackInfo

(

const G4Track &

right

)

Definition at line 215 of file G4Track.cc.

{
  *this = right;
}

G4VAuxiliaryTrackInformation * G4Track::GetAuxiliaryTrackInformation

(

G4int

idx

)

const

Definition at line 340 of file G4Track.cc.

{
  if(!fpAuxiliaryTrackInformationMap) return 0;
  std::map<G4int,G4VAuxiliaryTrackInformation*>::iterator itr
   = fpAuxiliaryTrackInformationMap->find(idx);
  if(itr==fpAuxiliaryTrackInformationMap->end()) return 0;
  else return (*itr).second;
}

std::map<G4int,G4VAuxiliaryTrackInformation*>* G4Track::GetAuxiliaryTrackInformationMap ( ) const

inline

Definition at line 338 of file G4Track.hh.

   { return fpAuxiliaryTrackInformationMap; }

G4int G4Track::GetCreatorModelID ( ) const

inline

Here is the caller graph for this function:

const G4String& G4Track::GetCreatorModelName ( ) const

inline

const G4VProcess* G4Track::GetCreatorProcess

(

)

const

Here is the caller graph for this function:

G4int G4Track::GetCurrentStepNumber

(

)

const

G4ParticleDefinition* G4Track::GetDefinition

(

)

const

const G4DynamicParticle* G4Track::GetDynamicParticle

(

)

const

G4double G4Track::GetGlobalTime

(

)

const

G4double G4Track::GetKineticEnergy

(

)

const

G4double G4Track::GetLocalTime

(

)

const

Here is the caller graph for this function:

const G4LogicalVolume* G4Track::GetLogicalVolumeAtVertex

(

)

const

Here is the caller graph for this function:

G4Material* G4Track::GetMaterial

(

)

const

const G4MaterialCutsCouple* G4Track::GetMaterialCutsCouple

(

)

const

G4double G4Track::GetMaxTOfVelocityTable ( )

static

Definition at line 309 of file G4Track.cc.

{ return G4VelocityTable::GetMaxTOfVelocityTable(); }

Here is the call graph for this function:

Here is the caller graph for this function:

G4double G4Track::GetMinTOfVelocityTable ( )

static

Definition at line 314 of file G4Track.cc.

{ return G4VelocityTable::GetMinTOfVelocityTable(); }

Here is the call graph for this function:

Here is the caller graph for this function:

G4ThreeVector G4Track::GetMomentum

(

)

const

Here is the caller graph for this function:

const G4ThreeVector& G4Track::GetMomentumDirection

(

)

const

G4int G4Track::GetNbinOfVelocityTable ( )

static

Definition at line 319 of file G4Track.cc.

{ return G4VelocityTable::GetNbinOfVelocityTable(); }

Here is the call graph for this function:

G4Material* G4Track::GetNextMaterial

(

)

const

const G4MaterialCutsCouple* G4Track::GetNextMaterialCutsCouple

(

)

const

const G4VTouchable* G4Track::GetNextTouchable

(

)

const

const G4TouchableHandle& G4Track::GetNextTouchableHandle

(

)

const

Here is the caller graph for this function:

G4VPhysicalVolume* G4Track::GetNextVolume

(

)

const

Here is the caller graph for this function:

const G4VTouchable* G4Track::GetOriginTouchable

(

)

const

const G4TouchableHandle& G4Track::GetOriginTouchableHandle

(

)

const

G4int G4Track::GetParentID

(

)

const

const G4ParticleDefinition* G4Track::GetParticleDefinition

(

)

const

Here is the caller graph for this function:

const G4ThreeVector& G4Track::GetPolarization

(

)

const

Here is the caller graph for this function:

const G4ThreeVector& G4Track::GetPosition

(

)

const

G4double G4Track::GetProperTime

(

)

const

Here is the caller graph for this function:

const G4Step* G4Track::GetStep

(

)

const

Here is the caller graph for this function:

G4double G4Track::GetStepLength

(

)

const

Here is the caller graph for this function:

G4double G4Track::GetTotalEnergy

(

)

const

Here is the caller graph for this function:

const G4VTouchable* G4Track::GetTouchable

(

)

const

Here is the caller graph for this function:

const G4TouchableHandle& G4Track::GetTouchableHandle

(

)

const

Here is the caller graph for this function:

G4int G4Track::GetTrackID

(

)

const

G4double G4Track::GetTrackLength

(

)

const

Here is the caller graph for this function:

G4TrackStatus G4Track::GetTrackStatus

(

)

const

G4VUserTrackInformation* G4Track::GetUserInformation

(

)

const

Here is the caller graph for this function:

G4double G4Track::GetVelocity

(

)

const

Here is the caller graph for this function:

G4double G4Track::GetVertexKineticEnergy

(

)

const

Here is the caller graph for this function:

const G4ThreeVector& G4Track::GetVertexMomentumDirection

(

)

const

Here is the caller graph for this function:

const G4ThreeVector& G4Track::GetVertexPosition

(

)

const

Here is the caller graph for this function:

G4VPhysicalVolume* G4Track::GetVolume

(

)

const

G4double G4Track::GetWeight

(

)

const

Here is the caller graph for this function:

void G4Track::IncrementCurrentStepNumber

(

)

Here is the caller graph for this function:

G4bool G4Track::IsBelowThreshold

(

)

const

G4bool G4Track::IsGoodForTracking

(

)

const

Here is the caller graph for this function:

void G4Track::operator delete ( void *  aTrack )

inline

void* G4Track::operator new ( size_t  )

inline

G4bool G4Track::operator==

(

const G4Track &

)

void G4Track::RemoveAuxiliaryTrackInformation

(

G4int

idx

)

Definition at line 351 of file G4Track.cc.

{
  if(fpAuxiliaryTrackInformationMap && idx>=0 && idx<G4PhysicsModelCatalog::Entries())
      fpAuxiliaryTrackInformationMap->erase(idx);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4Track::RemoveAuxiliaryTrackInformation

(

G4String &

name

)

Definition at line 359 of file G4Track.cc.

{
  if(fpAuxiliaryTrackInformationMap) 
  {
    G4int idx = G4PhysicsModelCatalog::GetIndex(name);
    RemoveAuxiliaryTrackInformation(idx);
  }
}

Here is the call graph for this function:

void G4Track::SetAuxiliaryTrackInformation	(	G4int	idx,
		G4VAuxiliaryTrackInformation *	info
	)		const

Definition at line 324 of file G4Track.cc.

{
  if(!fpAuxiliaryTrackInformationMap)
  { fpAuxiliaryTrackInformationMap = new std::map<G4int,G4VAuxiliaryTrackInformation*>; }
  if(idx<0 || idx>=G4PhysicsModelCatalog::Entries())
  {
    G4ExceptionDescription ED;
    ED << "Process/model index <" << idx << "> is invalid.";
    G4Exception("G4VAuxiliaryTrackInformation::G4VAuxiliaryTrackInformation()","TRACK0982",
    FatalException, ED);
  }
  (*fpAuxiliaryTrackInformationMap)[idx] = info;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void G4Track::SetBelowThresholdFlag

(

G4bool

value = true

)

void G4Track::SetCreatorModelIndex ( G4int  idx )

inline

Here is the caller graph for this function:

void G4Track::SetCreatorProcess

(

const G4VProcess *

aValue

)

Here is the caller graph for this function:

void G4Track::SetGlobalTime

(

const G4double

aValue

)

void G4Track::SetGoodForTrackingFlag

(

G4bool

value = true

)

Here is the caller graph for this function:

void G4Track::SetKineticEnergy

(

const G4double

aValue

)

Here is the caller graph for this function:

void G4Track::SetLocalTime

(

const G4double

aValue

)

void G4Track::SetLogicalVolumeAtVertex

(

const G4LogicalVolume *

)

Here is the caller graph for this function:

void G4Track::SetMomentumDirection

(

const G4ThreeVector &

aValue

)

Here is the caller graph for this function:

void G4Track::SetNextTouchableHandle

(

const G4TouchableHandle &

apValue

)

Here is the caller graph for this function:

void G4Track::SetOriginTouchableHandle

(

const G4TouchableHandle &

apValue

)

Here is the caller graph for this function:

void G4Track::SetParentID

(

const G4int

aValue

)

Here is the caller graph for this function:

void G4Track::SetPolarization

(

const G4ThreeVector &

aValue

)

void G4Track::SetPosition

(

const G4ThreeVector &

aValue

)

void G4Track::SetProperTime

(

const G4double

aValue

)

void G4Track::SetStep

(

const G4Step *

aValue

)

Here is the caller graph for this function:

void G4Track::SetStepLength

(

G4double

value

)

Here is the caller graph for this function:

void G4Track::SetTouchableHandle

(

const G4TouchableHandle &

apValue

)

Here is the caller graph for this function:

void G4Track::SetTrackID

(

const G4int

aValue

)

Here is the caller graph for this function:

void G4Track::SetTrackStatus

(

const G4TrackStatus

aTrackStatus

)

Here is the caller graph for this function:

void G4Track::SetUserInformation

(

G4VUserTrackInformation *

aValue

)

const

Here is the caller graph for this function:

void G4Track::SetVelocity

(

G4double

val

)

Here is the caller graph for this function:

void G4Track::SetVelocityTableProperties ( G4double  t_max, G4double  t_min, G4int  nbin  )

static

Definition at line 301 of file G4Track.cc.

{
  G4VelocityTable::SetVelocityTableProperties(t_max, t_min, nbin);
  velTable = G4VelocityTable::GetVelocityTable();
}

Here is the call graph for this function:

void G4Track::SetVertexKineticEnergy

(

const G4double

aValue

)

Here is the caller graph for this function:

void G4Track::SetVertexMomentumDirection

(

const G4ThreeVector &

aValue

)

Here is the caller graph for this function:

void G4Track::SetVertexPosition

(

const G4ThreeVector &

aValue

)

Here is the caller graph for this function:

void G4Track::SetWeight

(

G4double

aValue

)

Here is the caller graph for this function:

G4bool G4Track::UseGivenVelocity

(

)

const

Here is the caller graph for this function:

void G4Track::UseGivenVelocity

(

G4bool

val

)

---

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

• source/geant4.10.03.p02/source/track/include/G4Track.hh
• source/geant4.10.03.p02/source/track/src/G4Track.cc