include/Geant4/G4BiasingHelper.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4BiasingHelper
0027 //
0028 // Class Description:
0029 //
0030 // A utility class to help configuring code for biasing.
0031 //
0032 // Author: Marc Verderi, September 2013.
0033 // --------------------------------------------------------------------
0034 #ifndef G4BiasingHelper_h
0035 #define G4BiasingHelper_h 1
0036
0037 #include "globals.hh"
0038
0039 #include <vector>
0040
0041 class G4ProcessManager;
0042 class G4ParallelGeometriesLimiterProcess;
0043
0044 class G4BiasingHelper
0045 {
0046   public:
0047
0048     // -- Substitute, in the process manager passed, physics process "physicsProcessToBias"
0049     // -- with a version wrapped by a G4BiasingProcessInterface wrapped, to put this physics
0050     // -- process under biasing.
0051     // -- Only processes of process type 2 (EM), 3 (Optical), 4 (Had.) and 6 (Decay) will be
0052     // -- wrapped.
0053     // -- A name for this wrapped process can be given (otherwise a default one is provided:
0054     // -- e.g. for process "phot" this will be "biasWrapper(phot)").
0055     static G4bool ActivatePhysicsBiasing(G4ProcessManager* pmanager,
0056                                          const G4String& physicsProcessToBias,
0057                      const G4String& wrappedName = "");
0058     // -- Insert, in the process manager passed, a G4BiasingProcessInterface process that
0059     // -- will deal with non-modifying physics biasing (splitting, killing). A name for
0060     // -- this process can be passed, otherwise the default name "biasWrapper(0)" is used.
0061     static void ActivateNonPhysicsBiasing(G4ProcessManager* pmanager,
0062                       const G4String& nonPhysicsProcessName = "");
0063
0064     // -- Add a G4ParallelGeometriesLimiterProcess instance to the given process manager
0065     // -- The pointer of the added process is returned.
0066     static G4ParallelGeometriesLimiterProcess*
0067            AddLimiterProcess(G4ProcessManager* pmanager,
0068                              const G4String& processName = "biasLimiter");
0069 };
0070
0071 #endif