G4BOptrForceCollision Class Reference

#include <G4BOptrForceCollision.hh>

Inheritance diagram for G4BOptrForceCollision:

Public Member Functions
	G4BOptrForceCollision (G4String particleToForce, G4String name="ForceCollision")
	G4BOptrForceCollision (const G4ParticleDefinition *particleToForce, G4String name="ForceCollision")
	~G4BOptrForceCollision ()
virtual void	Configure () final
virtual void	ConfigureForWorker () final
virtual void	StartRun () final
virtual void	StartTracking (const G4Track *track) final
virtual void	ExitBiasing (const G4Track *, const G4BiasingProcessInterface *) final
virtual void	EndTracking () final
void	OperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *operationApplied, const G4VParticleChange *particleChangeProduced) final
void	OperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *occurenceOperationApplied, G4double weightForOccurenceInteraction, G4VBiasingOperation *finalStateOperationApplied, const G4VParticleChange *particleChangeProduced) final
Public Member Functions inherited from G4VBiasingOperator
	G4VBiasingOperator (G4String name)
virtual	~G4VBiasingOperator ()
virtual void	Configure ()
virtual void	ConfigureForWorker ()
virtual void	StartRun ()
virtual void	StartTracking (const G4Track *)
virtual void	EndTracking ()
const G4String	GetName () const
void	AttachTo (const G4LogicalVolume *)
G4BiasingAppliedCase	GetPreviousBiasingAppliedCase () const
G4VBiasingOperation *	GetProposedOccurenceBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
G4VBiasingOperation *	GetProposedFinalStateBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
G4VBiasingOperation *	GetProposedNonPhysicsBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
void	ExitingBiasing (const G4Track *track, const G4BiasingProcessInterface *callingProcess)
void	ReportOperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *operationApplied, const G4VParticleChange *particleChangeProduced)
void	ReportOperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *occurenceOperationApplied, G4double weightForOccurenceInteraction, G4VBiasingOperation *finalStateOperationApplied, const G4VParticleChange *particleChangeProduced)
const G4VBiasingOperation *	GetPreviousNonPhysicsAppliedOperation ()

Additional Inherited Members
Static Public Member Functions inherited from G4VBiasingOperator
static const std::vector< G4VBiasingOperator * > &	GetBiasingOperators ()
static G4VBiasingOperator *	GetBiasingOperator (const G4LogicalVolume *)
virtual G4VBiasingOperation *	ProposeNonPhysicsBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)=0
virtual G4VBiasingOperation *	ProposeOccurenceBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)=0
virtual G4VBiasingOperation *	ProposeFinalStateBiasingOperation (const G4Track *track, const G4BiasingProcessInterface *callingProcess)=0
virtual void	OperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *operationApplied, const G4VParticleChange *particleChangeProduced)
virtual void	OperationApplied (const G4BiasingProcessInterface *callingProcess, G4BiasingAppliedCase biasingCase, G4VBiasingOperation *occurenceOperationApplied, G4double weightForOccurenceInteraction, G4VBiasingOperation *finalStateOperationApplied, const G4VParticleChange *particleChangeProduced)
virtual void	ExitBiasing (const G4Track *track, const G4BiasingProcessInterface *callingProcess)

Detailed Description

Definition at line 58 of file G4BOptrForceCollision.hh.

Constructor & Destructor Documentation

G4BOptrForceCollision() [1/2]

G4BOptrForceCollision::G4BOptrForceCollision	(	G4String	particleToForce,
		G4String	name = "ForceCollision"
	)

Definition at line 46 of file G4BOptrForceCollision.cc.

  : G4VBiasingOperator(name),
    fForceCollisionModelID(-1),
    fCurrentTrack(nullptr),
    fCurrentTrackData(nullptr),
    fInitialTrackWeight(-1.0),
    fSetup(true)
{
  fSharedForceInteractionOperation = new G4BOptnForceCommonTruncatedExp("SharedForceInteraction");
  fCloningOperation                = new G4BOptnCloning("Cloning");
  fParticleToBias = G4ParticleTable::GetParticleTable()->FindParticle(particleName);
  
  if ( fParticleToBias == 0 )
    {
      G4ExceptionDescription ed;
      ed << " Particle `" << particleName << "' not found !" << G4endl;
      G4Exception(" G4BOptrForceCollision::G4BOptrForceCollision(...)",
          "BIAS.GEN.07",
          JustWarning,
          ed);
    }
}

G4BOptrForceCollision() [2/2]

G4BOptrForceCollision::G4BOptrForceCollision	(	const G4ParticleDefinition *	particleToForce,
		G4String	name = "ForceCollision"
	)

Definition at line 70 of file G4BOptrForceCollision.cc.

  : G4VBiasingOperator(name),
    fForceCollisionModelID(-1),
    fCurrentTrack(nullptr),
    fCurrentTrackData(nullptr),
    fInitialTrackWeight(-1.0),
    fSetup(true)
{
  fSharedForceInteractionOperation = new G4BOptnForceCommonTruncatedExp("SharedForceInteraction");
  fCloningOperation                = new G4BOptnCloning("Cloning");
  fParticleToBias                  = particle;
}

~G4BOptrForceCollision()

G4BOptrForceCollision::~G4BOptrForceCollision

(

)

Definition at line 84 of file G4BOptrForceCollision.cc.

{
  for ( std::map< const G4BiasingProcessInterface*, G4BOptnForceFreeFlight* >::iterator it = fFreeFlightOperations.begin() ;
    it != fFreeFlightOperations.end() ;
    it++ ) delete (*it).second;
  delete fSharedForceInteractionOperation;
  delete fCloningOperation;
}

Member Function Documentation

Configure()

void G4BOptrForceCollision::Configure ( )

finalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 94 of file G4BOptrForceCollision.cc.

{
  // -- Create ID for force collision:
  fForceCollisionModelID = G4PhysicsModelCatalog::Register("GenBiasForceCollision");
 
  // -- build free flight operations:
  ConfigureForWorker();
}

ConfigureForWorker()

void G4BOptrForceCollision::ConfigureForWorker ( )

finalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 104 of file G4BOptrForceCollision.cc.

{
  // -- start by remembering processes under biasing, and create needed biasing operations:
  if ( fSetup )
    {
      // -- get back ID created in master thread in case of MT (or reget just created ID in sequential mode):
      fForceCollisionModelID = G4PhysicsModelCatalog::Register("GenBiasForceCollision");
 
      const G4ProcessManager* processManager = fParticleToBias->GetProcessManager();
      const G4BiasingProcessSharedData* interfaceProcessSharedData = G4BiasingProcessInterface::GetSharedData( processManager );
      if ( interfaceProcessSharedData ) // -- sharedData tested, as is can happen a user attaches an operator
                                    // -- to a volume but without defining BiasingProcessInterface processes.
    {
      for ( size_t i = 0 ; i < (interfaceProcessSharedData->GetPhysicsBiasingProcessInterfaces()).size(); i++ )
        {
          const G4BiasingProcessInterface* wrapperProcess =
        (interfaceProcessSharedData->GetPhysicsBiasingProcessInterfaces())[i];
          G4String operationName = "FreeFlight-"+wrapperProcess->GetWrappedProcess()->GetProcessName();
          fFreeFlightOperations[wrapperProcess] = new G4BOptnForceFreeFlight(operationName);
        }
    }
      fSetup = false;
    }
}

Referenced by Configure().

EndTracking()

void G4BOptrForceCollision::EndTracking ( )

finalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 316 of file G4BOptrForceCollision.cc.

{
  // -- check for consistency, operator should have cleaned the track:
  if ( fCurrentTrackData != nullptr )
    {
      if ( !fCurrentTrackData->IsFreeFromBiasing() )
    {
      if ( (fCurrentTrack->GetTrackStatus() == fStopAndKill) || (fCurrentTrack->GetTrackStatus() == fKillTrackAndSecondaries) )
        {
          G4ExceptionDescription ed;
          ed << "Current track deleted while under biasing by " << GetName() << ". Will result in inconsistencies.";
          G4Exception(" G4BOptrForceCollision::EndTracking()",
              "BIAS.GEN.18",
              JustWarning,
              ed);
        }
    }
    } 
}

ExitBiasing()

virtual void G4BOptrForceCollision::ExitBiasing ( const G4Track *  , const G4BiasingProcessInterface *    )

inlinefinalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 75 of file G4BOptrForceCollision.hh.

{};

OperationApplied() [1/2]

void G4BOptrForceCollision::OperationApplied ( const G4BiasingProcessInterface *  callingProcess, G4BiasingAppliedCase  biasingCase, G4VBiasingOperation *  occurenceOperationApplied, G4double  weightForOccurenceInteraction, G4VBiasingOperation *  finalStateOperationApplied, const G4VParticleChange *  particleChangeProduced  )

finalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 407 of file G4BOptrForceCollision.cc.

{
  
  if ( fCurrentTrackData->fForceCollisionState == ForceCollisionState::toBeForced )
    {
      if ( finalStateOperationApplied != fSharedForceInteractionOperation )
    {
      G4ExceptionDescription ed;
      ed << " Internal inconsistency : please submit bug report. " << G4endl;
      G4Exception(" G4BOptrForceCollision::OperationApplied(...)",
              "BIAS.GEN.20.5",
              JustWarning,
              ed); 
    }
      if ( fSharedForceInteractionOperation->GetInteractionOccured() ) fCurrentTrackData->Reset(); // -- off biasing for this track
    }
  else
    {
      G4ExceptionDescription ed;
      ed << " Internal inconsistency : please submit bug report. " << G4endl;
      G4Exception(" G4BOptrForceCollision::OperationApplied(...)",
          "BIAS.GEN.20.6",
          JustWarning,
          ed);   
    }
  
}

OperationApplied() [2/2]

void G4BOptrForceCollision::OperationApplied ( const G4BiasingProcessInterface *  callingProcess, G4BiasingAppliedCase  biasingCase, G4VBiasingOperation *  operationApplied, const G4VParticleChange *  particleChangeProduced  )

finalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 337 of file G4BOptrForceCollision.cc.

{
  
  if ( fCurrentTrackData == nullptr )
    {
      if ( BAC != BAC_None )
    {
      G4ExceptionDescription ed;
      ed << " Internal inconsistency : please submit bug report. " << G4endl;
      G4Exception(" G4BOptrForceCollision::OperationApplied(...)",
              "BIAS.GEN.20.1",
              JustWarning,
              ed); 
    }
      return;
    }
  
  if      ( fCurrentTrackData->fForceCollisionState == ForceCollisionState::toBeCloned )
    {
      fCurrentTrackData->fForceCollisionState = ForceCollisionState::toBeFreeFlight;
      auto cloneData                  = new G4BOptrForceCollisionTrackData( this );
      cloneData->fForceCollisionState = ForceCollisionState::toBeForced;
      fCloningOperation->GetCloneTrack()->SetAuxiliaryTrackInformation(fForceCollisionModelID, cloneData);
    }
  else if ( fCurrentTrackData->fForceCollisionState == ForceCollisionState::toBeFreeFlight )
    {
      if ( fFreeFlightOperations[callingProcess]->OperationComplete() ) fCurrentTrackData->Reset(); // -- off biasing for this track
    }
  else if ( fCurrentTrackData->fForceCollisionState == ForceCollisionState::toBeForced )
    {
      if ( operationApplied != fSharedForceInteractionOperation )
    {
      G4ExceptionDescription ed;
      ed << " Internal inconsistency : please submit bug report. " << G4endl;
      G4Exception(" G4BOptrForceCollision::OperationApplied(...)",
              "BIAS.GEN.20.2",
              JustWarning,
              ed); 
    }
      if ( fSharedForceInteractionOperation->GetInteractionOccured() )
    {
      if ( operationApplied != fSharedForceInteractionOperation )
        {
          G4ExceptionDescription ed;
          ed << " Internal inconsistency : please submit bug report. " << G4endl;
          G4Exception(" G4BOptrForceCollision::OperationApplied(...)",
              "BIAS.GEN.20.3",
              JustWarning,
              ed); 
        } 
    }
    }
  else
    {
      if ( fCurrentTrackData->fForceCollisionState != ForceCollisionState::free )
    {
      G4ExceptionDescription ed;
      ed << " Internal inconsistency : please submit bug report. " << G4endl;
      G4Exception(" G4BOptrForceCollision::OperationApplied(...)",
              "BIAS.GEN.20.4",
              JustWarning,
              ed); 
    }
    }
}

StartRun()

void G4BOptrForceCollision::StartRun ( )

finalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 130 of file G4BOptrForceCollision.cc.

{
}

StartTracking()

void G4BOptrForceCollision::StartTracking ( const G4Track *  track )

finalvirtual

Reimplemented from G4VBiasingOperator.

Definition at line 309 of file G4BOptrForceCollision.cc.

{
  fCurrentTrack     = track;
  fCurrentTrackData = nullptr; 
}

---

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

• G4BOptrForceCollision.hh
• G4BOptrForceCollision.cc