include/Geant4/G4ImportanceAlgorithm.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 // G4ImportanceAlgorithm
0027 //
0028 // Class description:
0029 //
0030 // An implementation of a G4VImportanceAlgorithm (see description in
0031 // G4VImportanceAlgorithm header).
0032
0033 // Author: Michael Dressel (CERN), 2002
0034 // ----------------------------------------------------------------------
0035 #ifndef G4IMPORTANCEALGORITHM_HH
0036 #define G4IMPORTANCEALGORITHM_HH
0037
0038 #include "G4Threading.hh"
0039 #include "G4VImportanceAlgorithm.hh"
0040
0041 /**
0042  * @brief G4ImportanceAlgorithm is a concrete implementation of a
0043  * G4VImportanceAlgorithm.
0044  */
0045
0046 class G4ImportanceAlgorithm : public G4VImportanceAlgorithm
0047 {
0048   public:
0049
0050     /**
0051      * Default Constructor and Destructor.
0052      */
0053     G4ImportanceAlgorithm() = default;
0054     ~G4ImportanceAlgorithm() override = default;
0055
0056     /**
0057      * Calculates the number of tracks and their weight according to the
0058      * pre and post importance value and the weight of the mother track.
0059      *  @param[in] ipre "pre" importance value.
0060      *  @param[in] ipost "post" importance value.
0061      *  @param[in] init_w Initial weight value.
0062      *  @returns A struct containing the number of copies (including the
0063      *           mother track) to be produced and the weight of each track.
0064      */
0065     G4Nsplit_Weight Calculate(G4double ipre,
0066                               G4double ipost,
0067                               G4double init_w) const override;
0068
0069   private:
0070
0071     /**
0072      * Simple internal loggers.
0073      */
0074     void Error(const G4String& m) const;
0075     void Warning(const G4String& m) const;
0076
0077   private:
0078
0079     mutable G4bool fWarned = false;
0080 };
0081
0082 #endif