include/Geant4/G4VExternalPhysicalVolume.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 // G4VExternalPhysicalVolume
0027 //
0028 // Class description:
0029 //
0030 // Base class to represent a physical volume managed by an external
0031 // sub-navigator.
0032 //
0033 // Intial assumptions:
0034 //   * volume type is similar to G4PVPlacement -- not replicated
0035 //   * external navigator may provide 'many'/Boolean operation
0036
0037 // Author: J.Apostolakis, CERN - October 2019
0038 // ----------------------------------------------------------------------
0039 #ifndef G4VEXTERNALPHYSICSVOLUME_HH
0040 #define G4VEXTERNALPHYSICSVOLUME_HH 1
0041
0042 #include "G4VPhysicalVolume.hh"
0043 #include "G4Transform3D.hh"
0044
0045 class G4VExternalPhysicalVolume : public G4VPhysicalVolume
0046 {
0047   public:
0048
0049     G4VExternalPhysicalVolume( G4RotationMatrix* pRot,
0050                                const G4ThreeVector& tlate,
0051                                G4LogicalVolume* pCurrentLogical,
0052                                const G4String& pName,
0053                                G4VPhysicalVolume* pMother );
0054
0055     G4VExternalPhysicalVolume(const G4VExternalPhysicalVolume&) = delete;
0056     G4VExternalPhysicalVolume& operator=(const G4VExternalPhysicalVolume&) = delete;
0057       // Forbidden copy constructor and assignment operator.
0058
0059     ~G4VExternalPhysicalVolume() override;
0060       // Default destructor.
0061
0062     G4bool CheckOverlaps(G4int res=1000, G4double tol=0.,
0063                          G4bool verbose=true, G4int maxErr=1) override = 0;
0064       // Verifies if the placed volume is overlapping with existing
0065       // daughters or with the mother volume. Provides default resolution
0066       // for the number of points to be generated and verified.
0067       // A tolerance for the precision of the overlap check can be specified,
0068       // by default it is set to maximum precision.
0069       // Reports a maximum of overlaps errors according to parameter in input.
0070       // Returns true if the volume is overlapping.
0071
0072     G4VExternalPhysicalVolume(__void__&);
0073       // Fake default constructor for usage restricted to direct object
0074       // persistency for clients requiring preallocation of memory for
0075       // persistifiable objects.
0076
0077     EVolume VolumeType() const final;
0078     G4bool IsMany() const final;
0079
0080     G4bool IsReplicated() const final;
0081     G4bool IsParameterised() const final;
0082     G4VPVParameterisation* GetParameterisation() const final;
0083     void GetReplicationData(EAxis& axis,
0084                             G4int& nReplicas,
0085                             G4double& width,
0086                             G4double& offset,
0087                             G4bool& consuming) const final;
0088
0089     // Methods for use with Regular Navigation
0090     //
0091     G4bool  IsRegularStructure() const final;
0092     G4int   GetRegularStructureId() const final;
0093
0094     void SetMany(G4bool overlap);
0095       // Set the 'many' flag
0096
0097   private:
0098
0099     G4bool fMany = false;
0100 };
0101
0102 #endif