G4BiasingHelper Class Reference

#include <G4BiasingHelper.hh>

Static Public Member Functions
static void	ActivateNonPhysicsBiasing (G4ProcessManager *pmanager, G4String nonPhysicsProcessName="")
static G4bool	ActivatePhysicsBiasing (G4ProcessManager *pmanager, G4String physicsProcessToBias, G4String wrappedName="")
static G4ParallelGeometriesLimiterProcess *	AddLimiterProcess (G4ProcessManager *pmanager, const G4String &processName="biasLimiter")

Detailed Description

Definition at line 52 of file G4BiasingHelper.hh.

Member Function Documentation

ActivateNonPhysicsBiasing()

void G4BiasingHelper::ActivateNonPhysicsBiasing ( G4ProcessManager *  pmanager, G4String  nonPhysicsProcessName = ""  )

static

Definition at line 95 of file G4BiasingHelper.cc.

{
  G4BiasingProcessInterface* biasingNonPhys(0);
  if ( nonPhysicsProcessName == "" ) biasingNonPhys = new G4BiasingProcessInterface();
  else                               biasingNonPhys = new G4BiasingProcessInterface(nonPhysicsProcessName );
  pmanager->AddProcess( biasingNonPhys,
            ordInActive,
            ordInActive,
            ordDefault);
}

References G4ProcessManager::AddProcess(), ordDefault, and ordInActive.

Referenced by G4GenericBiasingPhysics::ConstructProcess().

ActivatePhysicsBiasing()

G4bool G4BiasingHelper::ActivatePhysicsBiasing ( G4ProcessManager *  pmanager, G4String  physicsProcessToBias, G4String  wrappedName = ""  )

static

Definition at line 32 of file G4BiasingHelper.cc.

{
  G4VProcess* physicsProcess(0);
  
  G4ProcessVector* vprocess = pmanager->GetProcessList();
  for (std::size_t ip = 0 ; ip < vprocess->size() ; ++ip)
    {
      if ( (*vprocess)[ip]->GetProcessName() == physicsProcessToBias )
    {
      physicsProcess = (*vprocess)[ip];
      break;
    }
    }
  
  // -- process not found, return "false" to tell about failure
  if ( physicsProcess == 0 ) return false;
  
  // -- process is not a physics one, return "false" to tell about failure
  G4int processType = physicsProcess->GetProcessType();
  if ( ( processType != 2 ) &&  // EM
       ( processType != 3 ) &&  // Optical
       ( processType != 4 ) &&  // Hadronic
       ( processType != 6 ) )   // Decay
    return false;
 
  // -- prevent wrapper of wrapper...
  if ( dynamic_cast< G4BiasingProcessInterface* >( physicsProcess ) ) return false;
 
  // -- remember process indeces:
  G4int    atRestIndex = pmanager->GetProcessOrdering(physicsProcess, idxAtRest   );
  G4int alongStepIndex = pmanager->GetProcessOrdering(physicsProcess, idxAlongStep);
  G4int  postStepIndex = pmanager->GetProcessOrdering(physicsProcess, idxPostStep );
 
  // -- now remove the physic process, that will be replaced by a wrapped version:
  G4VProcess* removed = pmanager->RemoveProcess(physicsProcess);
  if ( removed != physicsProcess )
    {
      G4ExceptionDescription ed;
      ed << "Internal inconsistency in processes handling. Please report !" << G4endl;
      G4Exception("G4BiasingHelper::ActivatePhysicsBiasing(...)",
          "BIAS.GEN.01",
          FatalException,
          ed);
    }
  
  G4BiasingProcessInterface* biasingWrapper = new G4BiasingProcessInterface( physicsProcess,
                                         atRestIndex    != ordInActive,
                                         alongStepIndex != ordInActive,
                                         postStepIndex  != ordInActive,
                                         wrappedName);
 
  if ( alongStepIndex == -1 ) alongStepIndex = ordDefault;
  
  pmanager->AddProcess( biasingWrapper,
            atRestIndex,
            alongStepIndex,
            postStepIndex);
 
  return true;
}

References G4ProcessManager::AddProcess(), FatalException, G4endl, G4Exception(), G4ProcessManager::GetProcessList(), G4ProcessManager::GetProcessOrdering(), G4VProcess::GetProcessType(), idxAlongStep, idxAtRest, idxPostStep, ordDefault, ordInActive, G4ProcessManager::RemoveProcess(), and G4ProcessVector::size().

Referenced by G4GenericBiasingPhysics::ConstructProcess().

AddLimiterProcess()

G4ParallelGeometriesLimiterProcess * G4BiasingHelper::AddLimiterProcess ( G4ProcessManager *  pmanager, const G4String &  processName = "biasLimiter"  )

static

Definition at line 107 of file G4BiasingHelper.cc.

{
  G4ParallelGeometriesLimiterProcess* toReturn = nullptr;
  
  G4ProcessVector* processList = pmanager->GetProcessList();
  G4bool noInstance = true;
  for (std::size_t i = 0 ; i < processList->size() ; ++i)
    {
      G4VProcess* process = (*processList)[i];
      if ( dynamic_cast< G4ParallelGeometriesLimiterProcess* >( process ) )
    {
      noInstance = false;
      
      G4ExceptionDescription ed;
      ed << "Trying to re-add a G4ParallelGeometriesLimiterProcess process to the process manager for '"<<
        pmanager->GetParticleType()->GetParticleName() << " (PDG : " <<  pmanager->GetParticleType()->GetPDGEncoding() << " )"
         << " while one is already present." << G4endl;
      G4Exception("G4BiasingHelper::AddBiasingProcessLimiter(G4ProcessManager* pmanager)",
              "BIAS.GEN.28",
              JustWarning, ed,
              "Call ignored.");
      break;
    }
    }
  
  if ( noInstance )
    {
      G4ParallelGeometriesLimiterProcess* biasingLimiter = new G4ParallelGeometriesLimiterProcess(processName);
      pmanager->AddProcess                ( biasingLimiter );
      pmanager->SetProcessOrderingToSecond( biasingLimiter, idxAlongStep );
      pmanager->SetProcessOrderingToLast  ( biasingLimiter, idxPostStep  );
      
      toReturn = biasingLimiter;
    }
  
  return toReturn;
  
}

References G4ProcessManager::AddProcess(), G4endl, G4Exception(), G4ParticleDefinition::GetParticleName(), G4ProcessManager::GetParticleType(), G4ParticleDefinition::GetPDGEncoding(), G4ProcessManager::GetProcessList(), idxAlongStep, idxPostStep, JustWarning, G4ProcessManager::SetProcessOrderingToLast(), G4ProcessManager::SetProcessOrderingToSecond(), and G4ProcessVector::size().

Referenced by G4GenericBiasingPhysics::AssociateParallelGeometries().

---

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

• source/processes/biasing/generic/include/G4BiasingHelper.hh
• source/processes/biasing/generic/src/G4BiasingHelper.cc