GFlashShowerModel Class Reference

#include <GFlashShowerModel.hh>

Inheritance diagram for GFlashShowerModel:

Public Member Functions
virtual void	AtRestDoIt (const G4FastTrack &, G4FastStep &)
virtual G4bool	AtRestModelTrigger (const G4FastTrack &)
void	DoIt (const G4FastTrack &, G4FastStep &)
G4int	GetFlagParamType ()
G4int	GetFlagParticleContainment ()
const G4String	GetName () const
G4double	GetStepInX0 ()
	GFlashShowerModel (G4String)
	GFlashShowerModel (G4String, G4Envelope *)
G4bool	IsApplicable (const G4ParticleDefinition &)
G4bool	ModelTrigger (const G4FastTrack &)
G4bool	operator== (const G4VFastSimulationModel &) const
void	SetFlagParamType (G4int I)
void	SetFlagParticleContainment (G4int I)
void	SetHitMaker (GFlashHitMaker &Maker)
void	SetParameterisation (GVFlashShowerParameterisation &DP)
void	SetParticleBounds (GFlashParticleBounds &SpecificBound)
void	SetStepInX0 (G4double Lenght)
	~GFlashShowerModel ()

Data Fields
GVFlashShowerParameterisation *	Parameterisation
GFlashParticleBounds *	PBound

Private Member Functions
G4bool	CheckContainment (const G4FastTrack &fastTrack)
G4bool	CheckParticleDefAndContainment (const G4FastTrack &fastTrack)
void	ElectronDoIt (const G4FastTrack &, G4FastStep &)

Private Attributes
G4double	EnergyStop
G4int	FlagParamType
G4int	FlagParticleContainment
	0=no GFlash 1=only em showers parametrized More...
GFlashHitMaker *	HMaker
GFlashShowerModelMessenger *	Messenger
G4double	StepInX0
	0=no check ///1=only fully contained... More...
G4String	theModelName

Detailed Description

Definition at line 59 of file GFlashShowerModel.hh.

Constructor & Destructor Documentation

GFlashShowerModel() [1/2]

GFlashShowerModel::GFlashShowerModel	(	G4String	modelName,
		G4Envelope *	envelope
	)

Definition at line 56 of file GFlashShowerModel.cc.

  : G4VFastSimulationModel(modelName, envelope),
    PBound(0), Parameterisation(0), HMaker(0)
{
  FlagParamType           = 0;
  FlagParticleContainment = 1;  
  StepInX0 = 0.1;
  Messenger       = new GFlashShowerModelMessenger(this);
}

References FlagParamType, FlagParticleContainment, Messenger, and StepInX0.

GFlashShowerModel() [2/2]

GFlashShowerModel::GFlashShowerModel

(

G4String

modelName

)

Definition at line 67 of file GFlashShowerModel.cc.

  : G4VFastSimulationModel(modelName),
    PBound(0), Parameterisation(0), HMaker(0)
{
  FlagParamType           =1;
  FlagParticleContainment = 1;  
  StepInX0 = 0.1; 
  Messenger       = new GFlashShowerModelMessenger(this); 
}

References FlagParamType, FlagParticleContainment, Messenger, and StepInX0.

~GFlashShowerModel()

GFlashShowerModel::~GFlashShowerModel

(

)

Definition at line 77 of file GFlashShowerModel.cc.

{
  delete Messenger;
}

References Messenger.

Member Function Documentation

AtRestDoIt()

virtual void G4VFastSimulationModel::AtRestDoIt ( const G4FastTrack &  , G4FastStep &    )

inlinevirtualinherited

Definition at line 126 of file G4VFastSimulationModel.hh.

{}

Referenced by G4FastSimulationManager::InvokeAtRestDoIt().

AtRestModelTrigger()

virtual G4bool G4VFastSimulationModel::AtRestModelTrigger ( const G4FastTrack &  )

inlinevirtualinherited

Definition at line 115 of file G4VFastSimulationModel.hh.

{return false;}

CheckContainment()

G4bool GFlashShowerModel::CheckContainment ( const G4FastTrack &  fastTrack )

private

Definition at line 137 of file GFlashShowerModel.cc.

{
  G4bool filter=false;
  // track informations
  G4ThreeVector DirectionShower=fastTrack.GetPrimaryTrackLocalDirection();
  G4ThreeVector InitialPositionShower=fastTrack.GetPrimaryTrackLocalPosition();
 
  G4ThreeVector OrthoShower, CrossShower; 
  // Returns orthogonal vector 
  OrthoShower = DirectionShower.orthogonal();
  // Shower in direction perpendicular to OrthoShower and DirectionShower
  CrossShower = DirectionShower.cross(OrthoShower);
  
  G4double  R     = Parameterisation->GetAveR90();
  G4double  Z     = Parameterisation->GetAveT90();
  G4int CosPhi[4] = {1,0,-1,0};
  G4int SinPhi[4] = {0,1,0,-1};
  
  G4ThreeVector Position;
  G4int NlateralInside=0;
  // pointer to solid we're in
  G4VSolid *SolidCalo = fastTrack.GetEnvelopeSolid();
  for(int i=0; i<4 ;i++)
  {
    // polar coordinates
    Position = InitialPositionShower       + 
    Z*DirectionShower           +
    R*CosPhi[i]*OrthoShower     +
    R*SinPhi[i]*CrossShower     ;
    
    if(SolidCalo->Inside(Position) != kOutside) 
      NlateralInside++;
  }
  
  // choose to parameterise or flag when all inetc...
  if(NlateralInside==4) filter=true;
  // std::cout << " points =   " <<NlateralInside << std::endl;
  return filter;
}

References CLHEP::Hep3Vector::cross(), GVFlashShowerParameterisation::GetAveR90(), GVFlashShowerParameterisation::GetAveT90(), G4FastTrack::GetEnvelopeSolid(), G4FastTrack::GetPrimaryTrackLocalDirection(), G4FastTrack::GetPrimaryTrackLocalPosition(), G4VSolid::Inside(), kOutside, CLHEP::Hep3Vector::orthogonal(), Parameterisation, and Z.

Referenced by CheckParticleDefAndContainment().

CheckParticleDefAndContainment()

G4bool GFlashShowerModel::CheckParticleDefAndContainment ( const G4FastTrack &  fastTrack )

private

Definition at line 119 of file GFlashShowerModel.cc.

{  
  G4bool filter=false;
  G4ParticleDefinition * ParticleType =
    fastTrack.GetPrimaryTrack()->GetDefinition(); 
  
  if(  ParticleType == G4Electron::ElectronDefinition() || 
    ParticleType == G4Positron::PositronDefinition() )
  {
    filter=true;
    if(FlagParticleContainment == 1)  
    {
      filter=CheckContainment(fastTrack); 
    }
  }
  return filter;  
}

References CheckContainment(), G4Electron::ElectronDefinition(), FlagParticleContainment, G4Track::GetDefinition(), G4FastTrack::GetPrimaryTrack(), and G4Positron::PositronDefinition().

Referenced by ModelTrigger().

DoIt()

void GFlashShowerModel::DoIt ( const G4FastTrack &  fastTrack, G4FastStep &  fastStep  )

virtual

Implements G4VFastSimulationModel.

Definition at line 179 of file GFlashShowerModel.cc.

{
  // parametrise electrons
  if(fastTrack.GetPrimaryTrack()->GetDefinition()
     == G4Electron::ElectronDefinition() || 
     fastTrack.GetPrimaryTrack()->GetDefinition()
     == G4Positron::PositronDefinition() ) 
  ElectronDoIt(fastTrack,fastStep);
}

References G4Electron::ElectronDefinition(), ElectronDoIt(), G4Track::GetDefinition(), G4FastTrack::GetPrimaryTrack(), and G4Positron::PositronDefinition().

ElectronDoIt()

void GFlashShowerModel::ElectronDoIt ( const G4FastTrack &  fastTrack, G4FastStep &  fastStep  )

private

Generate longitudinal profile

Initialisation of long. loop variables

Begin Longitudinal Loop

End Loop

Definition at line 190 of file GFlashShowerModel.cc.

{
  // std::cout<<"--- ElectronDoit --- "<<std::endl;
  
  fastStep.KillPrimaryTrack();
  fastStep.SetPrimaryTrackPathLength(0.0);
  fastStep.SetTotalEnergyDeposited(fastTrack.GetPrimaryTrack()->
                                   GetKineticEnergy());
  
  //-----------------------------
  // Get track parameters 
  //-----------------------------  
  //E,vect{p} and t,vec(x)
  G4double Energy = fastTrack.GetPrimaryTrack()->GetKineticEnergy();
  
  // axis of the shower, in global reference frame:
  G4ThreeVector DirectionShower =
    fastTrack.GetPrimaryTrack()->GetMomentumDirection();
  G4ThreeVector OrthoShower, CrossShower;
  OrthoShower = DirectionShower.orthogonal();
  CrossShower = DirectionShower.cross(OrthoShower);
  
  //--------------------------------
  //--------------------------------
  Parameterisation->GenerateLongitudinalProfile(Energy);
    // performance iteration @@@@@@@
  
  G4VSolid *SolidCalo = fastTrack.GetEnvelopeSolid();
  G4ThreeVector pos   = fastTrack.GetPrimaryTrackLocalPosition();
  G4ThreeVector dir   = fastTrack.GetPrimaryTrackLocalDirection();
  G4double Bound      = SolidCalo->DistanceToOut(pos,dir); 
  
  G4double Dz       = 0.00;     
  G4double ZEndStep = 0.00;
  
  G4double EnergyNow        = Energy;
  G4double EneIntegral      = 0.00;   
  G4double LastEneIntegral  = 0.00;   
  G4double DEne             = 0.00;
  
  G4double NspIntegral      = 0.00;   
  G4double LastNspIntegral  = 0.00;   
  G4double DNsp             = 0.00;
  
  // starting point of the shower:
  G4ThreeVector PositionShower  = fastTrack.GetPrimaryTrack()->GetPosition();
  G4ThreeVector NewPositionShower    = PositionShower;   
  G4double      StepLenght           = 0.00;
  
  G4int NSpotDeposited =0;
  
  //--------------------------
  //-------------------------
  
  do
  {  
    //determine step size=min(1Xo,next boundary)
    G4double stepLength = StepInX0*Parameterisation->GetX0();
    if(Bound < stepLength)
    { 
      Dz    = Bound;
      Bound = 0.00;
    }
    else
    { 
      Dz    = stepLength;
      Bound = Bound-Dz;
    }
    ZEndStep=ZEndStep+Dz;
    
    // Determine Energy Release in Step
    if(EnergyNow > EnergyStop)
    {
      LastEneIntegral  = EneIntegral;
      EneIntegral      = Parameterisation->IntegrateEneLongitudinal(ZEndStep);
      DEne             = std::min( EnergyNow,
                                   (EneIntegral-LastEneIntegral)*Energy);
      LastNspIntegral  = NspIntegral;
      NspIntegral      = Parameterisation->IntegrateNspLongitudinal(ZEndStep);
      DNsp             = std::max(1., std::floor( (NspIntegral-LastNspIntegral)
                                                 *Parameterisation->GetNspot() ));
    }
    // end of the shower
    else
    {    
      DEne = EnergyNow;
      DNsp = std::max(1., std::floor( (1.- NspIntegral)
                                     *Parameterisation->GetNspot() ));
    } 
    EnergyNow  = EnergyNow - DEne;
    
    // Apply sampling fluctuation - only in sampling calorimeters
    //
    GFlashSamplingShowerParameterisation* sp =
      dynamic_cast<GFlashSamplingShowerParameterisation*>(Parameterisation);
    if (sp)
    {
      G4double DEneSampling = sp->ApplySampling(DEne,Energy);
      DEne = DEneSampling;
    }
 
    //move particle in the middle of the step
    StepLenght        = StepLenght + Dz/2.00;  
    NewPositionShower = NewPositionShower + 
    StepLenght*DirectionShower;
    StepLenght        = Dz/2.00;
    
    //generate spots & hits:
    for (int i = 0; i < DNsp; i++)
    { 
      NSpotDeposited++;
      GFlashEnergySpot Spot;      
      
      //Spot energy: the same for all spots
      Spot.SetEnergy( DEne / DNsp );
      G4double PhiSpot = Parameterisation->GeneratePhi(); // phi of spot
      G4double RSpot   = Parameterisation                 // radius of spot
                         ->GenerateRadius(i,Energy,ZEndStep-Dz/2.);
 
      // check reference-> may be need to introduce rot matrix @@@
      // Position: equally spaced in z
      
      G4ThreeVector SpotPosition = NewPositionShower  +
            Dz/DNsp*DirectionShower*(i+1/2.-DNsp/2.)  +
            RSpot*std::cos(PhiSpot)*OrthoShower       +  
            RSpot*std::sin(PhiSpot)*CrossShower;      
      Spot.SetPosition(SpotPosition);
      
      //Generate Hits of this spot      
      HMaker->make(&Spot, &fastTrack);
    }
  }
  while(EnergyNow > 0.0 && Bound> 0.0);     
  
  //---------------
  //--------------- 
}

References CLHEP::Hep3Vector::cross(), G4VSolid::DistanceToOut(), EnergyStop, GVFlashShowerParameterisation::GenerateLongitudinalProfile(), GVFlashShowerParameterisation::GeneratePhi(), GVFlashShowerParameterisation::GenerateRadius(), G4FastTrack::GetEnvelopeSolid(), G4Track::GetKineticEnergy(), G4Track::GetMomentumDirection(), GVFlashShowerParameterisation::GetNspot(), G4Track::GetPosition(), G4FastTrack::GetPrimaryTrack(), G4FastTrack::GetPrimaryTrackLocalDirection(), G4FastTrack::GetPrimaryTrackLocalPosition(), GVFlashShowerParameterisation::GetX0(), HMaker, GVFlashShowerParameterisation::IntegrateEneLongitudinal(), GVFlashShowerParameterisation::IntegrateNspLongitudinal(), G4FastStep::KillPrimaryTrack(), GFlashHitMaker::make(), G4INCL::Math::max(), G4INCL::Math::min(), CLHEP::Hep3Vector::orthogonal(), Parameterisation, pos, GFlashEnergySpot::SetEnergy(), GFlashEnergySpot::SetPosition(), G4FastStep::SetPrimaryTrackPathLength(), G4FastStep::SetTotalEnergyDeposited(), G4InuclParticleNames::sp, and StepInX0.

Referenced by DoIt().

GetFlagParamType()

G4int GFlashShowerModel::GetFlagParamType ( )

inline

Definition at line 90 of file GFlashShowerModel.hh.

      { return FlagParamType; }

References FlagParamType.

Referenced by GFlashShowerModelMessenger::GetCurrentValue().

GetFlagParticleContainment()

G4int GFlashShowerModel::GetFlagParticleContainment ( )

inline

Definition at line 92 of file GFlashShowerModel.hh.

      { return FlagParticleContainment; }  

References FlagParticleContainment.

GetName()

const G4String G4VFastSimulationModel::GetName ( ) const

inlineinherited

Definition at line 146 of file G4VFastSimulationModel.hh.

{
  return theModelName;
}

References G4VFastSimulationModel::theModelName.

GetStepInX0()

G4double GFlashShowerModel::GetStepInX0 ( )

inline

Definition at line 94 of file GFlashShowerModel.hh.

      { return StepInX0; }

References StepInX0.

IsApplicable()

G4bool GFlashShowerModel::IsApplicable ( const G4ParticleDefinition &  particleType )

virtual

Implements G4VFastSimulationModel.

Definition at line 83 of file GFlashShowerModel.cc.

{ 
  return 
  &particleType == G4Electron::ElectronDefinition() ||
  &particleType == G4Positron::PositronDefinition(); 
}

References G4Electron::ElectronDefinition(), and G4Positron::PositronDefinition().

ModelTrigger()

G4bool GFlashShowerModel::ModelTrigger ( const G4FastTrack &  fastTrack )

virtual

Implements G4VFastSimulationModel.

Definition at line 94 of file GFlashShowerModel.cc.

{
  G4bool select = false;
  if(FlagParamType != 0)                  
  {
    G4double  ParticleEnergy = fastTrack.GetPrimaryTrack()->GetKineticEnergy(); 
    G4ParticleDefinition &ParticleType =
      *(fastTrack.GetPrimaryTrack()->GetDefinition()); 
    if(ParticleEnergy > PBound->GetMinEneToParametrise(ParticleType) &&
       ParticleEnergy < PBound->GetMaxEneToParametrise(ParticleType) )
    {
      // check conditions depending on particle flavour
      // performance to be optimized @@@@@@@
      Parameterisation->GenerateLongitudinalProfile(ParticleEnergy);
      select     = CheckParticleDefAndContainment(fastTrack);  
      if (select) EnergyStop= PBound->GetEneToKill(ParticleType);
    }
  }
 
  return select; 
}

References CheckParticleDefAndContainment(), EnergyStop, FlagParamType, GVFlashShowerParameterisation::GenerateLongitudinalProfile(), G4Track::GetDefinition(), GFlashParticleBounds::GetEneToKill(), G4Track::GetKineticEnergy(), GFlashParticleBounds::GetMaxEneToParametrise(), GFlashParticleBounds::GetMinEneToParametrise(), G4FastTrack::GetPrimaryTrack(), Parameterisation, and PBound.

operator==()

G4bool G4VFastSimulationModel::operator== ( const G4VFastSimulationModel &  fsm ) const

inlineinherited

Definition at line 152 of file G4VFastSimulationModel.hh.

{
  return (this==&fsm) ? true : false;
}

SetFlagParamType()

void GFlashShowerModel::SetFlagParamType ( G4int  I )

inline

Definition at line 75 of file GFlashShowerModel.hh.

      { FlagParamType = I; }

References FlagParamType.

Referenced by GFlashShowerModelMessenger::SetNewValue().

SetFlagParticleContainment()

void GFlashShowerModel::SetFlagParticleContainment ( G4int  I )

inline

Definition at line 77 of file GFlashShowerModel.hh.

      { FlagParticleContainment = I; }

References FlagParticleContainment.

Referenced by GFlashShowerModelMessenger::SetNewValue().

SetHitMaker()

void GFlashShowerModel::SetHitMaker ( GFlashHitMaker &  Maker )

inline

Definition at line 83 of file GFlashShowerModel.hh.

      { HMaker=&Maker; }

References HMaker.

SetParameterisation()

void GFlashShowerModel::SetParameterisation ( GVFlashShowerParameterisation &  DP )

inline

Definition at line 81 of file GFlashShowerModel.hh.

      { Parameterisation=&DP;}

References Parameterisation.

SetParticleBounds()

void GFlashShowerModel::SetParticleBounds ( GFlashParticleBounds &  SpecificBound )

inline

Definition at line 85 of file GFlashShowerModel.hh.

      { PBound =&SpecificBound; }

References PBound.

SetStepInX0()

void GFlashShowerModel::SetStepInX0 ( G4double  Lenght )

inline

Definition at line 79 of file GFlashShowerModel.hh.

      { StepInX0=Lenght; } 

References StepInX0.

Referenced by GFlashShowerModelMessenger::SetNewValue().

Field Documentation

EnergyStop

G4double GFlashShowerModel::EnergyStop

private

Definition at line 120 of file GFlashShowerModel.hh.

Referenced by ElectronDoIt(), and ModelTrigger().

FlagParamType

G4int GFlashShowerModel::FlagParamType

private

Definition at line 117 of file GFlashShowerModel.hh.

Referenced by GetFlagParamType(), GFlashShowerModel(), ModelTrigger(), and SetFlagParamType().

FlagParticleContainment

G4int GFlashShowerModel::FlagParticleContainment

private

0=no GFlash 1=only em showers parametrized

Definition at line 118 of file GFlashShowerModel.hh.

Referenced by CheckParticleDefAndContainment(), GetFlagParticleContainment(), GFlashShowerModel(), and SetFlagParticleContainment().

HMaker

GFlashHitMaker* GFlashShowerModel::HMaker

private

Definition at line 113 of file GFlashShowerModel.hh.

Referenced by ElectronDoIt(), and SetHitMaker().

Messenger

GFlashShowerModelMessenger* GFlashShowerModel::Messenger

private

Definition at line 114 of file GFlashShowerModel.hh.

Referenced by GFlashShowerModel(), and ~GFlashShowerModel().

Parameterisation

GVFlashShowerParameterisation* GFlashShowerModel::Parameterisation

Definition at line 101 of file GFlashShowerModel.hh.

Referenced by CheckContainment(), ElectronDoIt(), ModelTrigger(), and SetParameterisation().

PBound

GFlashParticleBounds* GFlashShowerModel::PBound

Definition at line 100 of file GFlashShowerModel.hh.

Referenced by GFlashShowerModelMessenger::GetCurrentValue(), ModelTrigger(), GFlashShowerModelMessenger::SetNewValue(), and SetParticleBounds().

StepInX0

G4double GFlashShowerModel::StepInX0

private

0=no check ///1=only fully contained...

Definition at line 119 of file GFlashShowerModel.hh.

Referenced by ElectronDoIt(), GetStepInX0(), GFlashShowerModel(), and SetStepInX0().

theModelName

G4String G4VFastSimulationModel::theModelName

privateinherited

Definition at line 143 of file G4VFastSimulationModel.hh.

Referenced by G4VFastSimulationModel::GetName().

---

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

• source/parameterisations/gflash/include/GFlashShowerModel.hh
• source/parameterisations/gflash/src/GFlashShowerModel.cc