// // ******************************************************************** // * License and Disclaimer * // * * // * The Geant4 software is copyright of the Copyright Holders of * // * the Geant4 Collaboration. It is provided under the terms and * // * conditions of the Geant4 Software License, included in the file * // * LICENSE and available at http://cern.ch/geant4/license . These * // * include a list of copyright holders. * // * * // * Neither the authors of this software system, nor their employing * // * institutes,nor the agencies providing financial support for this * // * work make any representation or warranty, express or implied, * // * regarding this software system or assume any liability for its * // * use. Please see the license in the file LICENSE and URL above * // * for the full disclaimer and the limitation of liability. * // * * // * This code implementation is the result of the scientific and * // * technical work of the GEANT4 collaboration. * // * By using, copying, modifying or distributing the software (or * // * any work based on the software) you agree to acknowledge its * // * use in resulting scientific publications, and indicate your * // * acceptance of all terms of the Geant4 Software license. * // ******************************************************************** // // G4PVPlacement // // Class description: // // Class representing a single volume positioned within and relative // to a mother volume. // Author: Paul Kent (CERN), 24.07.1995 - First non-stub version // ---------------------------------------------------------------------- #ifndef G4PVPLACEMENT_HH #define G4PVPLACEMENT_HH #include "G4VPhysicalVolume.hh" #include "G4Transform3D.hh" /** * @brief G4PVPlacement represents a single volume positioned within and * relative to a mother volume. */ class G4PVPlacement : public G4VPhysicalVolume { public: /** * Initialises a single volume, positioned in a frame which is rotated by * '*pRot' and traslated by 'tlate', relative to the coordinate system of * the mother volume 'pMotherLogical'. * If 'pRot=nullptr' the volume is unrotated with respect to its mother. * The physical volume is added to the mother's logical volume. * This is a very natural way of defining a physical volume, and is * especially useful when creating subdetectors: the mother volumes are * not placed until a later stage of the assembly program. * @param[in] pRot The pointer to the rotation in the mother volume. * @param[in] tlate Traslation vector in the mother volume. * @param[in] pCurrentLogical Pointer to its logical volume. * @param[in] pName The volume name. * @param[in] pMotherLogical Pointer to the logical volume of the mother. * @param[in] pMany Flag to identify if the volume is meant to be * considered an overlapping structure, or not. - not used. * @param[in] pCopyNo The optional custom copy number. Should be set to 0 * for the first volume of a given type. * @param[in] pSurfChk Boolean flag, if true activates check for overlaps * with existing volumes (false by default). */ G4PVPlacement(G4RotationMatrix* pRot, const G4ThreeVector& tlate, G4LogicalVolume* pCurrentLogical, const G4String& pName, G4LogicalVolume* pMotherLogical, G4bool pMany, G4int pCopyNo, G4bool pSurfChk = false); /** * Additional constructor, which expects a G4Transform3D object that * represents the direct rotation and translation of the solid (NOT of the * frame). The G4Transform3D argument should be constructed by: * i) First rotating it to align the solid to the system of * reference of its mother volume *pMotherLogical, and * ii) Then placing the solid at the location Transform3D.getTranslation(), * with respect to the origin of the system of coordinates of the * mother volume. * This construct is useful for the people who prefer to think in terms * of moving objects in a given reference frame. * All other arguments are the same as for the previous constructor. * @param[in] Transform3D The transformation in the 3D space. * @param[in] pCurrentLogical Pointer to its logical volume. * @param[in] pName The volume name. * @param[in] pMotherLogical Pointer to the logical volume of the mother. * @param[in] pMany Flag to identify if the volume is meant to be * considered an overlapping structure, or not. - not used. * @param[in] pCopyNo The optional custom copy number. Should be set to 0 * for the first volume of a given type. * @param[in] pSurfChk Boolean flag, if true activates check for overlaps * with existing volumes (false by default). */ G4PVPlacement(const G4Transform3D& Transform3D, G4LogicalVolume* pCurrentLogical, const G4String& pName, G4LogicalVolume* pMotherLogical, G4bool pMany, G4int pCopyNo, G4bool pSurfChk = false); /** * A simple variation of the first constructor, only specifying the * mother volume as a pointer to its physical volume instead of its * logical volume. The effect is exactly the same. */ G4PVPlacement(G4RotationMatrix* pRot, const G4ThreeVector& tlate, const G4String& pName, G4LogicalVolume* pLogical, G4VPhysicalVolume* pMother, G4bool pMany, G4int pCopyNo, G4bool pSurfChk = false); /** * Utilises both variations above (from first and third constructors). * The effect is the same as for the second constructor. */ G4PVPlacement(const G4Transform3D& Transform3D, const G4String& pName, G4LogicalVolume* pLogical, G4VPhysicalVolume* pMother, G4bool pMany, G4int pCopyNo, G4bool pSurfChk = false); /** * Fake default constructor for usage restricted to direct object * persistency for clients requiring preallocation of memory for * persistifiable objects. */ G4PVPlacement(__void__&); /** * Default Destructor. */ ~G4PVPlacement() override; /** * Copy constructor and assignment operator not allowed. */ G4PVPlacement(const G4PVPlacement&) = delete; G4PVPlacement& operator=(const G4PVPlacement&) = delete; /** * Returns/sets the copy number associated to the volume. */ inline G4int GetCopyNo() const override { return fcopyNo; } void SetCopyNo(G4int CopyNo) override; /** * Verifies if the placed volume is overlapping with existing daughters * or with the mother volume. Provides default resolution for the number * of points to be generated and verified. * A tolerance for the precision of the overlap check can be specified, * by default it is set to maximum precision. * Reports a maximum of overlaps errors according to parameter in input. * @param[in] res The number of points to generate on volume's surface. * @param[in] tol The precision tolerance for the overlap check, below * which to ignore overlaps (default is maximim precision). * @param[in] verbose Verbosity mode (default is true). * @param[in] maxErr Maximum of overlaps errors to report (default is 1). * @returns True if an overlap occurs. */ G4bool CheckOverlaps(G4int res = 1000, G4double tol = 0., G4bool verbose = true, G4int maxErr = 1) override; /** * Stub methods, unused for placed volumes. */ G4bool IsMany() const override; G4bool IsReplicated() const override; G4bool IsParameterised() const override; G4VPVParameterisation* GetParameterisation() const override; void GetReplicationData(EAxis& axis, G4int& nReplicas, G4double& width, G4double& offset, G4bool& consuming) const override; /** * Used only for specialised repeated volumes. Always false with Id 0. */ G4bool IsRegularStructure() const override; G4int GetRegularStructureId() const override; /** * Returns the volume type characterisation. */ EVolume VolumeType() const override; private: /** * Auxiliary function for 2nd constructor (one with G4Transform3D). * Creates a new RotMatrix on the heap (using "new") and copies * its argument into it. */ static G4RotationMatrix* NewPtrRotMatrix(const G4RotationMatrix& RotMat); private: /** Flag for overlapping structure - not used. */ G4bool fmany = false; /** Flag for allocation of the rotation matrix. */ G4bool fallocatedRotM = false; /** Optional copy number, for identification. */ G4int fcopyNo = 0; }; #endif