G4FastSimulationManager Class Reference

#include <G4FastSimulationManager.hh>

Public Member Functions
G4bool	ActivateFastSimulationModel (const G4String &)
void	AddFastSimulationModel (G4VFastSimulationModel *)
G4bool	AtRestGetFastSimulationManagerTrigger (const G4Track &, const G4Navigator *a=0)
	G4FastSimulationManager (G4Envelope *anEnvelope, G4bool IsUnique=FALSE)
const G4Envelope *	GetEnvelope () const
G4VFastSimulationModel *	GetFastSimulationModel (const G4String &modelName, const G4VFastSimulationModel *previousFound, bool &foundPrevious) const
const std::vector< G4VFastSimulationModel * > &	GetFastSimulationModelList () const
G4bool	InActivateFastSimulationModel (const G4String &)
G4VParticleChange *	InvokeAtRestDoIt ()
G4VParticleChange *	InvokePostStepDoIt ()
void	ListModels () const
void	ListModels (const G4ParticleDefinition *) const
void	ListModels (const G4String &aName) const
void	ListTitle () const
G4bool	operator== (const G4FastSimulationManager &) const
G4bool	PostStepGetFastSimulationManagerTrigger (const G4Track &, const G4Navigator *a=0)
void	RemoveFastSimulationModel (G4VFastSimulationModel *)
	~G4FastSimulationManager ()

Private Attributes
G4FastSimulationVector< G4VFastSimulationModel >	fApplicableModelList
G4FastStep	fFastStep
G4FastTrack	fFastTrack
G4FastSimulationVector< G4VFastSimulationModel >	fInactivatedModels
G4ParticleDefinition *	fLastCrossedParticle
G4VFastSimulationModel *	fTriggedFastSimulationModel
G4FastSimulationVector< G4Transform3D >	GhostPlacements
G4FastSimulationVector< G4VFastSimulationModel >	ModelList

Detailed Description

Definition at line 77 of file G4FastSimulationManager.hh.

Constructor & Destructor Documentation

G4FastSimulationManager()

G4FastSimulationManager::G4FastSimulationManager	(	G4Envelope *	anEnvelope,
		G4bool	IsUnique = FALSE
	)

Definition at line 51 of file G4FastSimulationManager.cc.

                             :
  fFastTrack(anEnvelope,IsUnique),fTriggedFastSimulationModel(0),
  fLastCrossedParticle(0)
{
  // Communicates to the region that it becomes a
  // envelope and with this fast simulation manager.
  anEnvelope->SetFastSimulationManager(this);
 
  // Add itself to the GlobalFastSimulationManager 
  G4GlobalFastSimulationManager::GetGlobalFastSimulationManager()->
    AddFastSimulationManager(this);
}

References G4GlobalFastSimulationManager::GetGlobalFastSimulationManager(), and G4Region::SetFastSimulationManager().

~G4FastSimulationManager()

G4FastSimulationManager::~G4FastSimulationManager

(

)

Definition at line 69 of file G4FastSimulationManager.cc.

{
  //
  // Check out the Envelope about this pointer. If in use, 
  // resets the Logical Volume IsEnvelope flag to avoid clash.
  //
  if(fFastTrack.GetEnvelope()->GetFastSimulationManager()==this)
    fFastTrack.GetEnvelope()->ClearFastSimulationManager();
  // Remove itself from the GlobalFastSimulationManager 
  G4GlobalFastSimulationManager::GetGlobalFastSimulationManager()->
    RemoveFastSimulationManager(this);
}

References G4Region::ClearFastSimulationManager(), fFastTrack, G4FastTrack::GetEnvelope(), G4Region::GetFastSimulationManager(), and G4GlobalFastSimulationManager::GetGlobalFastSimulationManager().

Member Function Documentation

ActivateFastSimulationModel()

G4bool G4FastSimulationManager::ActivateFastSimulationModel

(

const G4String &

aName

)

Definition at line 87 of file G4FastSimulationManager.cc.

{
  size_t iModel;
 
  // If the model is already active, do nothing.
  for (iModel=0; iModel<ModelList.size(); iModel++)
    if(ModelList[iModel]->GetName() == aName)
      return true;
  
  // Look for in the fInactivatedModels list, if found push_back it back to 
  // the ModelList
  for (iModel=0; iModel<fInactivatedModels.size(); iModel++)
    if(fInactivatedModels[iModel]->GetName() == aName) {
      ModelList.
    push_back (fInactivatedModels.removeAt(iModel));
      // forces the fApplicableModelList to be rebuild
      fLastCrossedParticle=0;
      return true;
    }
  return false;
}

References fInactivatedModels, fLastCrossedParticle, ModelList, and G4FastSimulationVector< T >::removeAt().

AddFastSimulationModel()

void G4FastSimulationManager::AddFastSimulationModel ( G4VFastSimulationModel *  fsm )

inline

Definition at line 178 of file G4FastSimulationManager.hh.

{
  ModelList.push_back(fsm);
  // forces the fApplicableModelList to be rebuild
  fLastCrossedParticle = 0;
}

References fLastCrossedParticle, and ModelList.

Referenced by G4VFastSimulationModel::G4VFastSimulationModel().

AtRestGetFastSimulationManagerTrigger()

G4bool G4FastSimulationManager::AtRestGetFastSimulationManagerTrigger	(	const G4Track &	track,
		const G4Navigator *	a = 0
	)

Definition at line 248 of file G4FastSimulationManager.cc.

{
  size_t iModel;
  
  // If particle type changed re-build the fApplicableModelList.
  if(fLastCrossedParticle!=track.GetDefinition()) {
    fLastCrossedParticle=track.GetDefinition();
    fApplicableModelList.clear();
    // If Model List is empty, do nothing !
    if(ModelList.size()==0) return false;
    for (iModel=0; iModel<ModelList.size(); iModel++)
      if(ModelList[iModel]->IsApplicable(*(track.GetDefinition())))
    fApplicableModelList.push_back (ModelList[iModel]);
  }
  
  // If Applicable Model List is empty, do nothing !
  if(fApplicableModelList.size()==0) return false;
 
  // -- Register current track
  fFastTrack.SetCurrentTrack(track,theNavigator);
  
  // -- (note: compared to the PostStepGetFastSimulationManagerTrigger,
  // --  the test to see if the particle is on the boundary but leaving
  // --  is irrelevant here)
  
  // Loops on the models to see if one of them wants to trigger:
  for (iModel=0; iModel < fApplicableModelList.size(); iModel++)
    if(fApplicableModelList[iModel]->AtRestModelTrigger(fFastTrack))
      {
    fFastStep.Initialize(fFastTrack);
    fTriggedFastSimulationModel=fApplicableModelList[iModel];
    return true;
      }
  
  //--------------------------------------------
  // Nobody asks to gain control, returns false
  //--------------------------------------------
  return false;
}

References fApplicableModelList, fFastStep, fFastTrack, fLastCrossedParticle, fTriggedFastSimulationModel, G4Track::GetDefinition(), G4FastStep::Initialize(), ModelList, and G4FastTrack::SetCurrentTrack().

Referenced by G4FastSimulationManagerProcess::AtRestGetPhysicalInteractionLength().

GetEnvelope()

const G4Envelope * G4FastSimulationManager::GetEnvelope ( ) const

inline

Definition at line 200 of file G4FastSimulationManager.hh.

{
  return fFastTrack.GetEnvelope();
}

References fFastTrack, and G4FastTrack::GetEnvelope().

GetFastSimulationModel()

G4VFastSimulationModel * G4FastSimulationManager::GetFastSimulationModel	(	const G4String &	modelName,
		const G4VFastSimulationModel *	previousFound,
		bool &	foundPrevious
	)		const

Definition at line 126 of file G4FastSimulationManager.cc.

{
  G4VFastSimulationModel* model = 0;
  for (size_t iModel=0; iModel<ModelList.size(); iModel++)
    {
      if(ModelList[iModel]->GetName() == modelName)
    {
      if (previousFound == 0)
        {
          model = ModelList[iModel];
          break;
        }
      else
        {
          if (ModelList[iModel] == previousFound)
        {
          foundPrevious = true;
          continue;
        }
          if (foundPrevious)
        {
          model = ModelList[iModel];
          break;
        }
        }
    }
    }
  return model;
}

References ModelList.

GetFastSimulationModelList()

const std::vector< G4VFastSimulationModel * > & G4FastSimulationManager::GetFastSimulationModelList ( ) const

inline

Definition at line 140 of file G4FastSimulationManager.hh.

  {return ModelList;}

References ModelList.

Referenced by G4GlobalFastSimulationManager::DisplayRegion().

InActivateFastSimulationModel()

G4bool G4FastSimulationManager::InActivateFastSimulationModel

(

const G4String &

aName

)

Definition at line 110 of file G4FastSimulationManager.cc.

{
  // Look for in the ModelList, if found remove from it and keep the pointer 
  // on the fInactivatedModels list.
  for (size_t iModel=0; iModel<ModelList.size(); iModel++)
    if(ModelList[iModel]->GetName() == aName) {
      fInactivatedModels.
    push_back (ModelList.removeAt(iModel));
      // forces the fApplicableModelList to be rebuild
      fLastCrossedParticle=0;
      return true;
    }
  return false;
}

References fInactivatedModels, fLastCrossedParticle, ModelList, and G4FastSimulationVector< T >::removeAt().

InvokeAtRestDoIt()

G4VParticleChange * G4FastSimulationManager::InvokeAtRestDoIt

(

)

Definition at line 289 of file G4FastSimulationManager.cc.

{
  fTriggedFastSimulationModel->AtRestDoIt(fFastTrack,fFastStep);
  return &fFastStep;
}

References G4VFastSimulationModel::AtRestDoIt(), fFastStep, fFastTrack, and fTriggedFastSimulationModel.

Referenced by G4FastSimulationManagerProcess::AtRestDoIt().

InvokePostStepDoIt()

G4VParticleChange * G4FastSimulationManager::InvokePostStepDoIt

(

)

Definition at line 237 of file G4FastSimulationManager.cc.

{
  //  const G4FastTrack& parFastTrack=fFastTrack;
  fTriggedFastSimulationModel->DoIt(fFastTrack,fFastStep);
  return &fFastStep;
}

References G4VFastSimulationModel::DoIt(), fFastStep, fFastTrack, and fTriggedFastSimulationModel.

Referenced by G4FastSimulationManagerProcess::PostStepDoIt().

ListModels() [1/3]

void G4FastSimulationManager::ListModels

(

)

const

Definition at line 306 of file G4FastSimulationManager.cc.

{
  size_t iModel;
 
  G4cout << "Current Models for the ";
  ListTitle();
  G4cout << " envelope:\n";
 
  for (iModel=0; iModel<ModelList.size(); iModel++) 
    G4cout << "   " << ModelList[iModel]->GetName() << "\n";
 
  for (iModel=0; iModel<fInactivatedModels.size(); iModel++)
    G4cout << "   " << fInactivatedModels[iModel]->GetName() 
       << "(inactivated)\n";
}

References fInactivatedModels, G4cout, ListTitle(), and ModelList.

ListModels() [2/3]

void G4FastSimulationManager::ListModels

(

const G4ParticleDefinition *

particleDefinition

)

const

Definition at line 377 of file G4FastSimulationManager.cc.

{
  size_t iModel;
  G4bool unique = true;
  
  // Active Models
  for ( iModel=0; iModel<ModelList.size(); iModel++ )
    if ( ModelList[iModel]->IsApplicable(*particleDefinition) )
      {
    G4cout << "Envelope ";
    ListTitle();
    G4cout << ", Model " 
           << ModelList[iModel]->GetName() 
           << "." << G4endl;
    // -- Verify unicity of model attached to particleDefinition:
    for ( auto jModel = iModel + 1; jModel < ModelList.size(); jModel++ )
      if ( ModelList[jModel]->IsApplicable(*particleDefinition) ) unique = false;
      }
  
  // Inactive Models
  for ( iModel=0; iModel<fInactivatedModels.size(); iModel++ )
    if( fInactivatedModels[iModel]->IsApplicable(*particleDefinition) )
      {
    G4cout << "Envelope ";
    ListTitle();
    G4cout << ", Model " 
           << fInactivatedModels[iModel]->GetName() 
           << " (inactivated)." << G4endl;
      }
  
  if( !unique )
    {
      G4ExceptionDescription ed;
      ed << "Two or more active Models are available for the same particle type, in the same envelope/region." << G4endl;
      G4Exception("G4FastSimulationManager::ListModels(const G4ParticleDefinition* particleDefinition) const",
          "FastSim001",
          JustWarning, ed,
          "Models risk to exclude each other.");
    }
  unique=false;
}

References fInactivatedModels, G4cout, G4endl, G4Exception(), JustWarning, ListTitle(), and ModelList.

ListModels() [3/3]

void G4FastSimulationManager::ListModels

(

const G4String &

aName

)

const

Definition at line 322 of file G4FastSimulationManager.cc.

{
  size_t iModel;
  G4int titled = 0;
  G4ParticleTable* theParticleTable = G4ParticleTable::GetParticleTable();
  
  // Active Models
  for ( iModel=0; iModel<ModelList.size(); iModel++ )
    if( ModelList[iModel]->GetName() == modelName || modelName == "all" )
      {
    if( !(titled++) )
      {
        G4cout << "In the envelope ";
        ListTitle();
        G4cout << ",\n";
      }
    G4cout << "  the model " << ModelList[iModel]->GetName()
           << " is applicable for :\n     ";
    
    G4int list_started=0;
    for ( G4int iParticle = 0; iParticle<theParticleTable->entries(); iParticle++)
      if( ModelList[iModel] -> IsApplicable( *(theParticleTable->GetParticle(iParticle))) )
        {
          if(list_started++) G4cout << ", ";
          G4cout << theParticleTable->
        GetParticle(iParticle)->GetParticleName();
        }
    G4cout <<G4endl;
      }
  
  // Inactive Models
  for (iModel=0; iModel<fInactivatedModels.size(); iModel++)
    if(fInactivatedModels[iModel]->GetName() == modelName || modelName == "all" )
      {
    if( !(titled++) )
      {
        G4cout << "In the envelope ";
        ListTitle();
        G4cout << ",\n";
      }
    G4cout << "  the model " << fInactivatedModels[iModel]->GetName()
           << " (inactivated) is applicable for :\n     ";
    
    G4int list_started=0;
    for ( G4int iParticle=0; iParticle<theParticleTable->entries(); iParticle++ )
      if( fInactivatedModels[iModel] -> IsApplicable( *(theParticleTable->GetParticle(iParticle))) )
        {
          if(list_started++) G4cout << ", ";
          G4cout << theParticleTable->
        GetParticle(iParticle)->GetParticleName();
        }
    G4cout <<G4endl;
      }
}

References G4ParticleTable::entries(), fInactivatedModels, G4cout, G4endl, G4ParticleTable::GetParticle(), G4ParticleTable::GetParticleName(), G4ParticleTable::GetParticleTable(), ListTitle(), and ModelList.

ListTitle()

void G4FastSimulationManager::ListTitle

(

)

const

Definition at line 296 of file G4FastSimulationManager.cc.

{
  G4cout << fFastTrack.GetEnvelope()->GetName();
  //  if(GhostPlacements.size()!=0) G4cout << " (ghost)";
  if (fFastTrack.GetEnvelope()->GetWorldPhysical() == G4TransportationManager::GetTransportationManager()->GetNavigatorForTracking()->GetWorldVolume()) G4cout << " (mass geom.)";
  else G4cout << " (// geom.)";
                                                                              
}

References fFastTrack, G4cout, G4FastTrack::GetEnvelope(), G4Region::GetName(), G4TransportationManager::GetNavigatorForTracking(), G4TransportationManager::GetTransportationManager(), G4Region::GetWorldPhysical(), and G4Navigator::GetWorldVolume().

Referenced by ListModels().

operator==()

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

inline

Definition at line 194 of file G4FastSimulationManager.hh.

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

PostStepGetFastSimulationManagerTrigger()

G4bool G4FastSimulationManager::PostStepGetFastSimulationManagerTrigger	(	const G4Track &	track,
		const G4Navigator *	a = 0
	)

Definition at line 182 of file G4FastSimulationManager.cc.

{
  size_t iModel;
  
  // If particle type changed re-build the fApplicableModelList.
  if(fLastCrossedParticle!=track.GetDefinition()) {
    fLastCrossedParticle=track.GetDefinition();
    fApplicableModelList.clear();
    // If Model List is empty, do nothing !
    if(ModelList.size()==0) return false;
    for (iModel=0; iModel<ModelList.size(); iModel++)
      if(ModelList[iModel]->IsApplicable(*(track.GetDefinition())))
    fApplicableModelList.push_back (ModelList[iModel]);
  }
 
  // If Applicable Model List is empty, do nothing !
  if(fApplicableModelList.size()==0) return false;
 
  // -- Register current track
  fFastTrack.SetCurrentTrack(track,theNavigator);
 
  // tests if particle are on the boundary and leaving,
  // in this case do nothing !
  if(fFastTrack.OnTheBoundaryButExiting()) return false;
  
  // Loops on the ModelTrigger() methods
  for (iModel=0; iModel<fApplicableModelList.size(); iModel++)
    
    //---------------------------------------------------
    // Asks the ModelTrigger method if it must be trigged now.
    //---------------------------------------------------
    
    if(fApplicableModelList[iModel]->ModelTrigger(fFastTrack)) {
      //--------------------------------------------------
      // The model will be applied. Initializes the G4FastStep 
      // with the current state of the G4Track and 
      // same usefull parameters.
      // In particular it does SetLocalEnergyDeposit(0.0).
      //--------------------------------------------------  
      fFastStep.Initialize(fFastTrack);
      
      // Keeps the FastSimulationModel pointer to call the
      // DoIt() method.
      fTriggedFastSimulationModel=fApplicableModelList[iModel];
      return true;
    }
 
  //--------------------------------------------
  // Nobody asks to gain control, returns false
  //--------------------------------------------
  return false;
}

References fApplicableModelList, fFastStep, fFastTrack, fLastCrossedParticle, fTriggedFastSimulationModel, G4Track::GetDefinition(), G4FastStep::Initialize(), ModelList, G4FastTrack::OnTheBoundaryButExiting(), and G4FastTrack::SetCurrentTrack().

Referenced by G4FastSimulationManagerProcess::PostStepGetPhysicalInteractionLength().

RemoveFastSimulationModel()

void G4FastSimulationManager::RemoveFastSimulationModel ( G4VFastSimulationModel *  fsm )

inline

Definition at line 186 of file G4FastSimulationManager.hh.

{
  if(!ModelList.remove(fsm)) fInactivatedModels.remove(fsm);
  // forces the fApplicableModelList to be rebuild
  fLastCrossedParticle = 0;
}

References fInactivatedModels, fLastCrossedParticle, ModelList, and G4FastSimulationVector< T >::remove().

Field Documentation

fApplicableModelList

G4FastSimulationVector<G4VFastSimulationModel> G4FastSimulationManager::fApplicableModelList

private

Definition at line 171 of file G4FastSimulationManager.hh.

Referenced by AtRestGetFastSimulationManagerTrigger(), and PostStepGetFastSimulationManagerTrigger().

fFastStep

G4FastStep G4FastSimulationManager::fFastStep

private

Definition at line 165 of file G4FastSimulationManager.hh.

Referenced by AtRestGetFastSimulationManagerTrigger(), InvokeAtRestDoIt(), InvokePostStepDoIt(), and PostStepGetFastSimulationManagerTrigger().

fFastTrack

G4FastTrack G4FastSimulationManager::fFastTrack

private

Definition at line 164 of file G4FastSimulationManager.hh.

Referenced by AtRestGetFastSimulationManagerTrigger(), GetEnvelope(), InvokeAtRestDoIt(), InvokePostStepDoIt(), ListTitle(), PostStepGetFastSimulationManagerTrigger(), and ~G4FastSimulationManager().

fInactivatedModels

G4FastSimulationVector<G4VFastSimulationModel> G4FastSimulationManager::fInactivatedModels

private

Definition at line 168 of file G4FastSimulationManager.hh.

Referenced by ActivateFastSimulationModel(), InActivateFastSimulationModel(), ListModels(), and RemoveFastSimulationModel().

fLastCrossedParticle

G4ParticleDefinition* G4FastSimulationManager::fLastCrossedParticle

private

Definition at line 170 of file G4FastSimulationManager.hh.

Referenced by ActivateFastSimulationModel(), AddFastSimulationModel(), AtRestGetFastSimulationManagerTrigger(), InActivateFastSimulationModel(), PostStepGetFastSimulationManagerTrigger(), and RemoveFastSimulationModel().

fTriggedFastSimulationModel

G4VFastSimulationModel* G4FastSimulationManager::fTriggedFastSimulationModel

private

Definition at line 166 of file G4FastSimulationManager.hh.

Referenced by AtRestGetFastSimulationManagerTrigger(), InvokeAtRestDoIt(), InvokePostStepDoIt(), and PostStepGetFastSimulationManagerTrigger().

GhostPlacements

G4FastSimulationVector<G4Transform3D> G4FastSimulationManager::GhostPlacements

private

Definition at line 174 of file G4FastSimulationManager.hh.

ModelList

G4FastSimulationVector<G4VFastSimulationModel> G4FastSimulationManager::ModelList

private

Definition at line 167 of file G4FastSimulationManager.hh.

Referenced by ActivateFastSimulationModel(), AddFastSimulationModel(), AtRestGetFastSimulationManagerTrigger(), GetFastSimulationModel(), GetFastSimulationModelList(), InActivateFastSimulationModel(), ListModels(), PostStepGetFastSimulationManagerTrigger(), and RemoveFastSimulationModel().

---

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

• source/processes/parameterisation/include/G4FastSimulationManager.hh
• source/processes/parameterisation/src/G4FastSimulationManager.cc