volumes/include/G4LogicalBorderSurface.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 // G4LogicalBorderSurface
0027 //
0028 // Class description:
0029 //
0030 // A Logical Surface class for surfaces defined by the boundary
0031 // of two physical volumes.
0032
0033 // Author: John Apostolakis (CERN), 17 June 1997
0034 // --------------------------------------------------------------------
0035 #ifndef G4LogicalBorderSurface_hh
0036 #define G4LogicalBorderSurface_hh 1
0037
0038 #include <map>
0039
0040 #include "G4LogicalSurface.hh"
0041 #include "G4VPhysicalVolume.hh"
0042
0043 class G4VPhysicalVolume;
0044 class G4LogicalBorderSurface;
0045
0046 using G4LogicalBorderSurfaceTable
0047       = std::map<std::pair<const G4VPhysicalVolume*,
0048                            const G4VPhysicalVolume*>, G4LogicalBorderSurface*>;
0049
0050 /**
0051  * @brief G4LogicalBorderSurface is a Logical Surface class for surfaces
0052  * defined by the boundary of two physical volumes.
0053  */
0054
0055 class G4LogicalBorderSurface : public G4LogicalSurface
0056 {
0057   public:
0058
0059     /**
0060      * Constructor and Destructor.
0061      */
0062     G4LogicalBorderSurface( const G4String& name,
0063                                   G4VPhysicalVolume* vol1,
0064                                   G4VPhysicalVolume* vol2,
0065                                   G4SurfaceProperty* surfaceProperty );
0066     ~G4LogicalBorderSurface() override;
0067
0068     /**
0069      * Copy constructor and assignment operator are not allowed.
0070      */
0071     G4LogicalBorderSurface(const G4LogicalBorderSurface&) = delete;
0072     G4LogicalBorderSurface& operator=(const G4LogicalBorderSurface&) = delete;
0073
0074     /**
0075      * Equality operators.
0076      */
0077     G4bool operator==( const G4LogicalBorderSurface& right ) const;
0078     G4bool operator!=( const G4LogicalBorderSurface& right ) const;
0079
0080     /**
0081      * Generic accessors and setters.
0082      */
0083     static G4LogicalBorderSurface* GetSurface( const G4VPhysicalVolume* vol1,
0084                                                const G4VPhysicalVolume* vol2 );
0085     inline void SetPhysicalVolumes( G4VPhysicalVolume* vol1,
0086                                     G4VPhysicalVolume* vol2 );
0087     inline const G4VPhysicalVolume* GetVolume1() const;
0088     inline const G4VPhysicalVolume* GetVolume2() const;
0089     inline std::size_t GetIndex() const;
0090     inline void SetVolume1( G4VPhysicalVolume* vol1 );
0091     inline void SetVolume2( G4VPhysicalVolume* vol2 );
0092
0093     /**
0094      * Handling of the table of surfaces.
0095      */
0096     static void CleanSurfaceTable();
0097     static const G4LogicalBorderSurfaceTable* GetSurfaceTable();
0098     static std::size_t GetNumberOfBorderSurfaces();
0099     static void DumpInfo();
0100
0101   private:
0102
0103     G4VPhysicalVolume* Volume1;  // Physical Volume pointer on side 1
0104     G4VPhysicalVolume* Volume2;  // Physical Volume pointer on side 2
0105
0106     std::size_t Index;           // Creation order index
0107
0108     /** The static Table of BorderSurfaces. */
0109     static G4LogicalBorderSurfaceTable* theBorderSurfaceTable;
0110 };
0111
0112 // ********************************************************************
0113 // Inline methods
0114 // ********************************************************************
0115
0116 #include "G4LogicalBorderSurface.icc"
0117
0118 #endif