include/Geant4/G4GeometryCell.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 // G4GeometryCell
0027 //
0028 // Class description:
0029 //
0030 // This class is used by scoring and importance sampling.
0031 // It serves to address a "cell". A "cell" is somewhat related to a
0032 // touchable. It is identified by a reference to a G4VPhysicalVolume
0033 // and a number (replica number). Only simple replicas are supported.
0034
0035 // Author: Michael Dressel (CERN), 2002
0036 // ----------------------------------------------------------------------
0037 #ifndef G4GEOMETRYCELL_HH
0038 #define G4GEOMETRYCELL_HH
0039
0040 #include "globals.hh"
0041
0042 class G4VPhysicalVolume;
0043
0044 /**
0045  * @brief G4GeometryCell is used for scoring and importance sampling.
0046  * It defines a "cell", which, similar to the concept of "touchable",
0047  + is identified by a reference to a G4VPhysicalVolume and a number
0048  * (replica number).
0049  */
0050
0051 class G4GeometryCell
0052 {
0053   public:
0054
0055     /**
0056      * Constructor. Initialises volume and replica number.
0057      *  @param[in] aVolume The name of the physical volume.
0058      *  @param[in] RepNum The associated replica number.
0059      */
0060     G4GeometryCell(const G4VPhysicalVolume& aVolume, G4int RepNum);
0061
0062     /**
0063      * Copy constructor and assignment operator.
0064      */
0065     G4GeometryCell(const G4GeometryCell& rhs) = default;
0066     G4GeometryCell& operator=(const G4GeometryCell& rhs);
0067
0068     /**
0069      * Default Destructor.
0070      */
0071     ~G4GeometryCell() = default;
0072
0073     /**
0074      * Returns the physical volume of the cell.
0075      */
0076     const G4VPhysicalVolume& GetPhysicalVolume() const;
0077
0078     /**
0079      * Returns the replica number of the cell.
0080      */
0081     G4int GetReplicaNumber() const;
0082
0083   private:
0084
0085     /** Pointer to the physical volume of the "cell"; treated as identifier. */
0086     const G4VPhysicalVolume* fVPhysicalVolume = nullptr;
0087
0088     /** Replica number of the "cell". */
0089     G4int fRepNum = 0;
0090 };
0091
0092 G4bool operator==(const G4GeometryCell& k1, const G4GeometryCell& k2);
0093 G4bool operator!=(const G4GeometryCell& k1, const G4GeometryCell& k2);
0094
0095 #endif