Files
geant4/examples/extended/biasing/GB06/include/GB06BOptrSplitAndKillByImportance.hh
2025-12-05 08:54:02 +01:00

114 lines
4.9 KiB
C++

//
// ********************************************************************
// * License and Disclaimer *
// * *
// * The Geant4 software is copyright of the Copyright Holders of *
// * the Geant4 Collaboration. It is provided under the terms and *
// * conditions of the Geant4 Software License, included in the file *
// * LICENSE and available at http://cern.ch/geant4/license . These *
// * include a list of copyright holders. *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. Please see the license in the file LICENSE and URL above *
// * for the full disclaimer and the limitation of liability. *
// * *
// * This code implementation is the result of the scientific and *
// * technical work of the GEANT4 collaboration. *
// * By using, copying, modifying or distributing the software (or *
// * any work based on the software) you agree to acknowledge its *
// * use in resulting scientific publications, and indicate your *
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
/// \file GB06BOptrSplitAndKillByImportance.hh
/// \brief Definition of the GB06BOptrSplitAndKillByImportance class
//---------------------------------------------------------------
//
// GB06BOptrSplitAndKillByImportance
//
// Class Description:
// A G4VBiasingOperator concrete implementation example to
// illustrate how to bias physics processes cross-section for
// one particle type.
// The G4VBiasingOperation G4BOptnChangeImportance is
// selected by this operator, and is sent to each process
// calling the operator.
// A simple constant bias to the cross-section is applied,
// but more sophisticated changes can be applied.
//
//---------------------------------------------------------------
//
#ifndef GB06BOptrSplitAndKillByImportance_hh
#define GB06BOptrSplitAndKillByImportance_hh 1
#include "G4VBiasingOperator.hh"
class GB06BOptnSplitAndKillByImportance;
class G4BiasingProcessSharedData;
class G4ParallelGeometriesLimiterProcess;
class G4ParticleDefinition;
class G4VPhysicalVolume;
#include <map>
class GB06BOptrSplitAndKillByImportance : public G4VBiasingOperator
{
public:
// ------------------------------------------------------------
// -- Constructor: takes the name of the particle type to bias:
// ------------------------------------------------------------
GB06BOptrSplitAndKillByImportance(G4String particleToBias,
G4String name = "SplitAndKillByImportance");
~GB06BOptrSplitAndKillByImportance() override;
// -- method called at beginning of run:
void StartRun() override;
private:
// -----------------------------
// -- Mandatory from base class:
// -----------------------------
// -- Not used:
G4VBiasingOperation* ProposeOccurenceBiasingOperation(const G4Track*,
const G4BiasingProcessInterface*) final
{
return nullptr;
}
// -- Not used:
G4VBiasingOperation* ProposeFinalStateBiasingOperation(const G4Track*,
const G4BiasingProcessInterface*) final
{
return nullptr;
}
// -- Used method : it will return the biasing operation that will split particles
// -- with a probabilty depending on the total absorption cross-section.
G4VBiasingOperation* ProposeNonPhysicsBiasingOperation(const G4Track*,
const G4BiasingProcessInterface*) final;
// ---------------------------------------
// -- Method specific to this application:
// ---------------------------------------
public:
void SetParallelWorld(G4VPhysicalVolume* parallelWorld) { fParallelWorld = parallelWorld; }
// -- The importance map, linking a replica number to an volume importance:
std::map<G4int, G4int>& GetImportanceMap() { return fImportanceMap; }
private:
GB06BOptnSplitAndKillByImportance* fSplitAndKillByImportance;
const G4ParticleDefinition* fParticleToBias;
G4VPhysicalVolume* fParallelWorld;
G4int fParallelWorldIndex;
const G4BiasingProcessSharedData* fBiasingSharedData;
const G4ParallelGeometriesLimiterProcess* fBiasingLimiterProcess;
std::map<G4int, G4int> fImportanceMap;
};
#endif