include/Geant4/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-06-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 class G4LogicalBorderSurface : public G4LogicalSurface
0051 {
0052   public:
0053
0054     G4LogicalBorderSurface( const G4String& name,
0055                                   G4VPhysicalVolume* vol1,
0056                                   G4VPhysicalVolume* vol2,
0057                                   G4SurfaceProperty* surfaceProperty );
0058     ~G4LogicalBorderSurface() override;
0059       // Constructor and destructor
0060
0061     G4LogicalBorderSurface(const G4LogicalBorderSurface&) = delete;
0062     G4LogicalBorderSurface& operator=(const G4LogicalBorderSurface&) = delete;
0063       // Copy constructor and assignment operator not allowed.
0064
0065     G4bool operator==( const G4LogicalBorderSurface& right ) const;
0066     G4bool operator!=( const G4LogicalBorderSurface& right ) const;
0067       // Operators
0068
0069     static G4LogicalBorderSurface* GetSurface( const G4VPhysicalVolume* vol1,
0070                                                const G4VPhysicalVolume* vol2 );
0071     inline void SetPhysicalVolumes( G4VPhysicalVolume* vol1,
0072                                     G4VPhysicalVolume* vol2 );
0073     inline const G4VPhysicalVolume* GetVolume1() const;
0074     inline const G4VPhysicalVolume* GetVolume2() const;
0075     inline std::size_t GetIndex() const;
0076       // Generic accessors
0077
0078     inline void SetVolume1( G4VPhysicalVolume* vol1 );
0079     inline void SetVolume2( G4VPhysicalVolume* vol2 );
0080       // To use with care!
0081
0082     static void CleanSurfaceTable();
0083     static const G4LogicalBorderSurfaceTable* GetSurfaceTable();
0084     static std::size_t GetNumberOfBorderSurfaces();
0085     static void DumpInfo();
0086       // To handle the table of surfaces
0087
0088   private:
0089
0090     G4VPhysicalVolume* Volume1;  // Physical Volume pointer on side 1
0091     G4VPhysicalVolume* Volume2;  // Physical Volume pointer on side 2
0092
0093     std::size_t Index;           // Creation order index
0094
0095     static G4LogicalBorderSurfaceTable *theBorderSurfaceTable;
0096       // The static Table of BorderSurfaces
0097 };
0098
0099 // ********************************************************************
0100 // Inline methods
0101 // ********************************************************************
0102
0103 #include "G4LogicalBorderSurface.icc"
0104
0105 #endif