include/Geant4/G4VWeightWindowStore.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 // G4VWeightWindowStore
0027 //
0028 // Class description:
0029 //
0030 // Interface class for a weight window store. It defines how the lower
0031 // weight window bound can be obtained from a weight window store.
0032
0033 // Author: Michael Dressel (CERN), 2003
0034 // ----------------------------------------------------------------------
0035 #ifndef G4VWEIGHTWINDOWSTORE_HH
0036 #define G4VWEIGHTWINDOWSTORE_HH
0037
0038 #include "globals.hh"
0039
0040 class G4GeometryCell;
0041 class G4VPhysicalVolume;
0042
0043 /**
0044  * @brief G4VWeightWindowStore is an interface class for a weight window store.
0045  * It defines how the lower weight window bound can be obtained from a weight
0046  * window store.
0047  */
0048
0049 class G4VWeightWindowStore
0050 {
0051   public:
0052
0053     /**
0054      * Default Constructor and Destructor.
0055      */
0056     G4VWeightWindowStore() = default;
0057     virtual ~G4VWeightWindowStore() = default;
0058
0059     /**
0060      * Computes a lower weight bound value of a "cell" addressed by a
0061      * G4GeometryCell and the corresponding energy from the store.
0062      */
0063     virtual G4double GetLowerWeight(const G4GeometryCell& gCell,
0064                                           G4double partEnergy) const = 0;
0065
0066     /**
0067      * Returns true if the gCell is in the store, else false.
0068      */
0069     virtual G4bool IsKnown(const G4GeometryCell& gCell) const = 0;
0070
0071     /**
0072      * Returns a reference to the wolrd volume of the geometry.
0073      */
0074     virtual const G4VPhysicalVolume& GetWorldVolume() const = 0;
0075 };
0076
0077 #endif