GB05BOptrSplitAndKillByCrossSection Class Reference

#include <Doxymodules_biasing.h>

Inheritance diagram for GB05BOptrSplitAndKillByCrossSection:

Public Member Functions
	GB05BOptrSplitAndKillByCrossSection (G4String particleToBias, G4String name="SplitAndKillByXS")
virtual	~GB05BOptrSplitAndKillByCrossSection ()
virtual void	StartRun ()
void	AddProcessToEquipoise (G4String processName)

Private Member Functions
virtual G4VBiasingOperation *	ProposeOccurenceBiasingOperation (const G4Track *, const G4BiasingProcessInterface *) final
virtual G4VBiasingOperation *	ProposeFinalStateBiasingOperation (const G4Track *, const G4BiasingProcessInterface *) final
virtual G4VBiasingOperation *	ProposeNonPhysicsBiasingOperation (const G4Track *, const G4BiasingProcessInterface *) final

Private Attributes
GB05BOptnSplitAndKillByCrossSection *	fSplitAndKillByCrossSection
const G4ParticleDefinition *	fParticleToBias
std::vector< G4String >	fProcessesToEquipoise
G4bool	fSetup
std::vector< const G4VProcess * >	fProcesses

Detailed Description

Definition at line 124 of file Doxymodules_biasing.h.

Constructor & Destructor Documentation

GB05BOptrSplitAndKillByCrossSection()

GB05BOptrSplitAndKillByCrossSection::GB05BOptrSplitAndKillByCrossSection	(	G4String	particleToBias,
		G4String	name = "SplitAndKillByXS"
	)

Definition at line 40 of file GB05BOptrSplitAndKillByCrossSection.cc.

  : G4VBiasingOperator(name),
    fSetup(true)
{
  fParticleToBias = G4ParticleTable::GetParticleTable()->FindParticle(particleName);
 
  if ( fParticleToBias == 0 )
    {
      G4ExceptionDescription ed;
      ed << "Particle `" << particleName << "' not found !" << G4endl;
      G4Exception("GB05BOptrSplitAndKillByCrossSection(...)",
                  "exGB05.01",
                  JustWarning,
                  ed);
    }
  
  fSplitAndKillByCrossSection =
    new GB05BOptnSplitAndKillByCrossSection("splitterFor_"+particleName);
 
}

~GB05BOptrSplitAndKillByCrossSection()

GB05BOptrSplitAndKillByCrossSection::~GB05BOptrSplitAndKillByCrossSection ( )

virtual

Definition at line 65 of file GB05BOptrSplitAndKillByCrossSection.cc.

{
  delete fSplitAndKillByCrossSection;
}

Member Function Documentation

StartRun()

void GB05BOptrSplitAndKillByCrossSection::StartRun ( )

virtual

Definition at line 72 of file GB05BOptrSplitAndKillByCrossSection.cc.

{
  // ---------------
  // -- Setup stage:
  // ---------------
  // -- Start by collecting the pointer of the physics processes
  // -- considered for the splitting by cross-sections. Doing so,
  // -- this also verifies that these physics processes are each
  // -- under control of a G4BiasingProcessInterface wrapper.
  if ( fSetup )
    {
      const G4ProcessManager* processManager = fParticleToBias->GetProcessManager();
      const G4BiasingProcessSharedData* sharedData =
        G4BiasingProcessInterface::GetSharedData( processManager );
      if ( sharedData )
        {
          for ( size_t i = 0 ; i < fProcessesToEquipoise.size() ; i++ )
            {
              G4bool processFound(false);
              for ( size_t j = 0 ;
                    j < (sharedData->GetPhysicsBiasingProcessInterfaces()).size();
                    j++ )
                {
                  const G4BiasingProcessInterface* wrapperProcess =
                    (sharedData->GetPhysicsBiasingProcessInterfaces())[j];
                  if ( fProcessesToEquipoise[i] ==
                       wrapperProcess->GetWrappedProcess()->GetProcessName() )
                    {
                      fProcesses.push_back( wrapperProcess->GetWrappedProcess() );
                      processFound = true;
                      break;
                    }
                }
              if ( !processFound )
                {
                  G4String particleName = "(unknown)";
                  if ( fParticleToBias != nullptr )
                    {
                      particleName = fParticleToBias->GetParticleName();
                    }
                  G4ExceptionDescription ed;
                  ed << "Process `" << fProcessesToEquipoise[i]
                     << "' not found for particle `" << particleName << "'"
                     << G4endl;
                  G4Exception("GB05BOptrSplitAndKillByCrossSection::StartRun(...)",
                              "exGB05.02",
                              JustWarning,
                              ed);
                }
            }
        }
      fSetup = false;
    }
  
  if ( fProcessesToEquipoise.size() == 0 || fProcesses.size() == 0 )
    {
      G4ExceptionDescription ed;
      ed << "No processes to counterbalance for defined or found ! "
         << "Biasing will do nothing."
         << G4endl;
      G4Exception("GB05BOptrSplitAndKillByCrossSection::StartRun(...)",
                  "exGB05.03",
                  JustWarning,
                  ed);
    }
 
}

ProposeOccurenceBiasingOperation()

virtual G4VBiasingOperation * GB05BOptrSplitAndKillByCrossSection::ProposeOccurenceBiasingOperation ( const G4Track *  , const G4BiasingProcessInterface *    )

inlinefinalprivatevirtual

Definition at line 75 of file GB05BOptrSplitAndKillByCrossSection.hh.

  { return 0; }

ProposeFinalStateBiasingOperation()

virtual G4VBiasingOperation * GB05BOptrSplitAndKillByCrossSection::ProposeFinalStateBiasingOperation ( const G4Track *  , const G4BiasingProcessInterface *    )

inlinefinalprivatevirtual

Definition at line 81 of file GB05BOptrSplitAndKillByCrossSection.hh.

  { return 0; }

ProposeNonPhysicsBiasingOperation()

G4VBiasingOperation * GB05BOptrSplitAndKillByCrossSection::ProposeNonPhysicsBiasingOperation ( const G4Track *  track, const G4BiasingProcessInterface *    )

finalprivatevirtual

Definition at line 143 of file GB05BOptrSplitAndKillByCrossSection.cc.

{
  
  // -----------------------------------------------------
  // -- Check if current particle type is the one to bias:
  // -----------------------------------------------------
  if ( track->GetDefinition() != fParticleToBias ) return 0;
 
  // --------------------------------------------------------------------
  // -- Compute the total cross-section for the physics processes
  // -- considered.
  // -- These physics processes have been updated to the current track
  // -- state by their related wrapper G4BiasingProcessInterface objects,
  // -- the cross-sections/mean free pathes are hence usable.
  // --------------------------------------------------------------------
  G4double totalCrossSection(0.0);
  for ( size_t i = 0 ; i < fProcesses.size() ; i++ )
    {
      G4double interactionLength = fProcesses[i]->GetCurrentInteractionLength();
      if ( interactionLength < DBL_MAX/10. )
        totalCrossSection += 1./interactionLength;
    }
  if ( totalCrossSection < DBL_MIN ) return 0;
 
  G4double totalInteractionLength = 1./totalCrossSection;
  
  // ---------------------------------------------------------------------
  // -- Passes the updated "absorption" cross-section (interaction length)
  // -- to the biasing operation, and returns this operation:
  // ---------------------------------------------------------------------
  fSplitAndKillByCrossSection->SetInteractionLength( totalInteractionLength );
  
  return fSplitAndKillByCrossSection;
  
}

AddProcessToEquipoise()

void GB05BOptrSplitAndKillByCrossSection::AddProcessToEquipoise

(

G4String

processName

)

Definition at line 181 of file GB05BOptrSplitAndKillByCrossSection.cc.

{
  fProcessesToEquipoise.push_back( processName );
}

Member Data Documentation

fSplitAndKillByCrossSection

GB05BOptnSplitAndKillByCrossSection* GB05BOptrSplitAndKillByCrossSection::fSplitAndKillByCrossSection

private

Definition at line 102 of file GB05BOptrSplitAndKillByCrossSection.hh.

fParticleToBias

const G4ParticleDefinition* GB05BOptrSplitAndKillByCrossSection::fParticleToBias

private

Definition at line 103 of file GB05BOptrSplitAndKillByCrossSection.hh.

fProcessesToEquipoise

std::vector< G4String > GB05BOptrSplitAndKillByCrossSection::fProcessesToEquipoise

private

Definition at line 104 of file GB05BOptrSplitAndKillByCrossSection.hh.

fSetup

G4bool GB05BOptrSplitAndKillByCrossSection::fSetup

private

Definition at line 105 of file GB05BOptrSplitAndKillByCrossSection.hh.

fProcesses

std::vector< const G4VProcess* > GB05BOptrSplitAndKillByCrossSection::fProcesses

private

Definition at line 106 of file GB05BOptrSplitAndKillByCrossSection.hh.

---

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

• .doxygen/Doxymodules_biasing.h
• extended/biasing/GB05/include/GB05BOptrSplitAndKillByCrossSection.hh
• extended/biasing/GB05/src/GB05BOptrSplitAndKillByCrossSection.cc