include/Geant4/G4VIStore.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 // G4VIStore
0027 //
0028 // Class description:
0029 //
0030 // An interface of an "importance store" used by importance sampling.
0031 // It defines how a importance value together with a "cell"
0032 // (a G4VPhysicalVolume and a replica number) has to be added
0033 // to the "importance store" and how a importance value can be derived
0034 // from the "importance store".
0035
0036 // Author: Michael Dressel (CERN), 2002
0037 // ----------------------------------------------------------------------
0038 #ifndef G4VISTORE_HH
0039 #define G4VISTORE_HH
0040
0041 #include "globals.hh"
0042
0043 class G4GeometryCell;
0044 class G4VPhysicalVolume;
0045
0046 /**
0047  * @brief G4VIStore is an interface of an "importance store" used by importance
0048  * sampling. It defines how an importance value together with a "cell"
0049  * (a G4VPhysicalVolume and a replica number) has to be added to the
0050  * "importance store" and how a importance value can be derived from the
0051  * "importance store".
0052  */
0053
0054 class  G4VIStore
0055 {
0056   public:
0057
0058     /**
0059      * Default Constructor and Destructor.
0060      */
0061     G4VIStore() = default;
0062     virtual ~G4VIStore() = default;
0063
0064     /**
0065      * Returns the importance value of a "cell" from the store addressed
0066      * by 'gCell'.
0067      *  @param[in] gCell The cell of reference.
0068      *  @returns The associated importance weight.
0069      */
0070     virtual G4double GetImportance(const G4GeometryCell& gCell) const = 0;
0071
0072     /**
0073      * Returns true if 'gCell' is in the store, else false.
0074      *  @param[in] gCell The cell of reference.
0075      *  @returns true if present in the store, false otherwise.
0076      */
0077     virtual G4bool IsKnown(const G4GeometryCell& gCell) const = 0;
0078
0079     /**
0080      * Returns a reference to the world volume of the "importance" geometry.
0081      */
0082     virtual const G4VPhysicalVolume& GetWorldVolume() const = 0;
0083 };
0084
0085 #endif