Gabriele Cosmo
273 lines
12 KiB
C++
273 lines
12 KiB
C++
//
|
|
// ********************************************************************
|
|
// * 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. *
|
|
// ********************************************************************
|
|
//
|
|
// G4VPhysicalVolume
|
|
//
|
|
// Class description:
|
|
//
|
|
// This is an Abstract Base class for the representation of positioned volume.
|
|
// The volume is placed within a mother volume, relative to its coordinate
|
|
// system. Either a single positioned volume or many positioned volume can
|
|
// be represented by a particular G4VPhysicalVolume.
|
|
|
|
// 15.01.13, G.Cosmo, A.Dotti: Modified for thread-safety for MT
|
|
// 28.08.96, P.Kent: Replaced transform by rotmat + vector
|
|
// 25.07.96, P.Kent: Modified interface for new `Replica' capable geometry
|
|
// 24.07.95, P.Kent: First non-stub version
|
|
// --------------------------------------------------------------------
|
|
#ifndef G4VPHYSICALVOLUME_HH
|
|
#define G4VPHYSICALVOLUME_HH 1
|
|
|
|
#include "G4Types.hh"
|
|
#include "G4String.hh"
|
|
|
|
#include "geomdefs.hh"
|
|
|
|
#include "G4RotationMatrix.hh"
|
|
#include "G4ThreeVector.hh"
|
|
#include "G4GeomSplitter.hh"
|
|
|
|
class G4LogicalVolume;
|
|
class G4VPVParameterisation;
|
|
|
|
class G4PVData
|
|
{
|
|
// Encapsulates the fields associated to G4VPhysicalVolume
|
|
// that are not read-only - they will change during simulation
|
|
// and must have a per-thread state.
|
|
|
|
public:
|
|
|
|
G4PVData() = default;
|
|
|
|
void initialize()
|
|
{
|
|
frot = nullptr;
|
|
tx = 0.; ty = 0.; tz = 0.;
|
|
}
|
|
|
|
G4RotationMatrix* frot = nullptr;
|
|
G4double tx = 0., ty = 0., tz = 0.;
|
|
};
|
|
|
|
using G4PVManager = G4GeomSplitter<G4PVData>;
|
|
// Implementation detail for use of G4PVData objects
|
|
|
|
class G4VPhysicalVolume
|
|
{
|
|
public:
|
|
|
|
G4VPhysicalVolume(G4RotationMatrix* pRot,
|
|
const G4ThreeVector& tlate,
|
|
const G4String& pName,
|
|
G4LogicalVolume* pLogical,
|
|
G4VPhysicalVolume* pMother);
|
|
// Initialise volume, positioned in a frame which is rotated by *pRot,
|
|
// relative to the coordinate system of the mother volume pMother.
|
|
// The center of the object is then placed at tlate in the new
|
|
// coordinates. If pRot=0 the volume is unrotated with respect to its
|
|
// mother. The physical volume is added to the mother's logical volume.
|
|
//
|
|
// Must be called by all subclasses. pMother must point to a valid parent
|
|
// volume, except in the case of the world/top volume, when it =0.
|
|
//
|
|
// The constructor also registers volume with physical volume Store.
|
|
// Note that the Store may be removed or dynamically built in future
|
|
// because of memory constraints.
|
|
|
|
virtual ~G4VPhysicalVolume();
|
|
// Destructor, will be subclassed. Removes volume from volume Store.
|
|
|
|
G4VPhysicalVolume(const G4VPhysicalVolume&) = delete;
|
|
G4VPhysicalVolume& operator=(const G4VPhysicalVolume&) = delete;
|
|
// No copy constructor and assignment operator.
|
|
|
|
inline G4bool operator == (const G4VPhysicalVolume& p) const;
|
|
// Equality defined by equal addresses only.
|
|
|
|
// Access functions
|
|
//
|
|
// The following are accessor functions that make a distinction
|
|
// between whether the rotation/translation is being made for the
|
|
// frame or the object/volume that is being placed.
|
|
// (They are the inverse of each other).
|
|
|
|
G4RotationMatrix* GetObjectRotation() const; // Obsolete
|
|
G4RotationMatrix GetObjectRotationValue() const; // Replacement
|
|
G4ThreeVector GetObjectTranslation() const;
|
|
// Return the rotation/translation of the Object relative to the mother.
|
|
const G4RotationMatrix* GetFrameRotation() const;
|
|
G4ThreeVector GetFrameTranslation() const;
|
|
// Return the rotation/translation of the Frame used to position
|
|
// this volume in its mother volume (opposite of object rot/trans).
|
|
|
|
// Older access functions, that do not distinguish between frame/object!
|
|
|
|
const G4ThreeVector GetTranslation() const;
|
|
const G4RotationMatrix* GetRotation() const;
|
|
// Old access functions, that do not distinguish between frame/object!
|
|
// They return the translation/rotation of the volume.
|
|
|
|
// Set functions
|
|
|
|
void SetTranslation(const G4ThreeVector& v);
|
|
G4RotationMatrix* GetRotation();
|
|
void SetRotation(G4RotationMatrix*);
|
|
// NOT INTENDED FOR GENERAL USE.
|
|
// Non constant versions of above. Used to change transformation
|
|
// for replication/parameterisation mechanism.
|
|
|
|
inline G4LogicalVolume* GetLogicalVolume() const;
|
|
// Return the associated logical volume.
|
|
inline void SetLogicalVolume(G4LogicalVolume* pLogical);
|
|
// Set the logical volume. Must not be called when geometry closed.
|
|
|
|
inline G4LogicalVolume* GetMotherLogical() const;
|
|
// Return the current mother logical volume pointer.
|
|
inline void SetMotherLogical(G4LogicalVolume* pMother);
|
|
// Set the mother logical volume. Must not be called when geometry closed.
|
|
|
|
inline const G4String& GetName() const;
|
|
// Return the volume's name.
|
|
void SetName(const G4String& pName);
|
|
// Set the volume's name.
|
|
|
|
virtual G4int GetMultiplicity() const;
|
|
// Returns number of object entities (1 for normal placements,
|
|
// n for replicas or parameterised).
|
|
|
|
// Functions required of subclasses
|
|
|
|
virtual EVolume VolumeType() const = 0;
|
|
// Characterise the type of volume - normal/replicated/parameterised.
|
|
virtual G4bool IsMany() const = 0;
|
|
// Return true if the volume is MANY (not implemented yet).
|
|
virtual G4int GetCopyNo() const = 0;
|
|
// Return the volumes copy number.
|
|
virtual void SetCopyNo(G4int CopyNo) = 0;
|
|
// Set the volumes copy number.
|
|
virtual G4bool IsReplicated() const = 0;
|
|
// Return true if replicated (single object instance represents
|
|
// many real volumes), else false.
|
|
virtual G4bool IsParameterised() const = 0;
|
|
// Return true if parameterised (single object instance represents
|
|
// many real parameterised volumes), else false.
|
|
virtual G4VPVParameterisation* GetParameterisation() const = 0;
|
|
// Return replicas parameterisation object (able to compute dimensions
|
|
// and transformations of replicas), or NULL if not applicable.
|
|
virtual void GetReplicationData(EAxis& axis,
|
|
G4int& nReplicas,
|
|
G4double& width,
|
|
G4double& offset,
|
|
G4bool& consuming) const = 0;
|
|
// Return replication information. No-op for no replicated volumes.
|
|
virtual G4bool IsRegularStructure() const = 0;
|
|
// Returns true if the underlying volume structure is regular.
|
|
virtual G4int GetRegularStructureId() const = 0;
|
|
// Returns non-zero code in case the underlying volume structure
|
|
// is regular, voxel-like. Value is id for structure type.
|
|
// If non-zero the volume is a candidate for specialised
|
|
// navigation such as 'nearest neighbour' directly on volumes.
|
|
virtual G4bool CheckOverlaps(G4int res=1000, G4double tol=0.,
|
|
G4bool verbose=true, G4int errMax=1);
|
|
// 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.
|
|
// Concrete implementation is done and required only for placed and
|
|
// parameterised volumes. Returns true if the volume is overlapping.
|
|
|
|
public:
|
|
|
|
G4VPhysicalVolume(__void__&);
|
|
// Fake default constructor for usage restricted to direct object
|
|
// persistency for clients requiring preallocation of memory for
|
|
// persistifiable objects.
|
|
|
|
inline G4int GetInstanceID() const;
|
|
// Returns the instance ID.
|
|
|
|
static const G4PVManager& GetSubInstanceManager();
|
|
// Returns the private data instance manager.
|
|
|
|
static void Clean();
|
|
// Clear memory allocated by sub-instance manager.
|
|
|
|
inline EVolume DeduceVolumeType() const;
|
|
// Old VolumeType() method, replaced by virtual method,
|
|
// kept for checking
|
|
|
|
protected:
|
|
|
|
void InitialiseWorker(G4VPhysicalVolume* pMasterObject,
|
|
G4RotationMatrix* pRot, const G4ThreeVector& tlate);
|
|
// This method is similar to the constructor. It is used by each worker
|
|
// thread to achieve the partial effect as that of the master thread.
|
|
|
|
void TerminateWorker(G4VPhysicalVolume* pMasterObject);
|
|
// This method is similar to the destructor. It is used by each worker
|
|
// thread to achieve the partial effect as that of the master thread.
|
|
|
|
protected:
|
|
|
|
G4int instanceID;
|
|
// For use in implementing the per-thread data,
|
|
// It is equivalent to a pointer to a G4PVData object.
|
|
G4GEOM_DLL static G4PVManager subInstanceManager;
|
|
// Needed to use G4PVManager for the G4PVData per-thread objects.
|
|
|
|
private:
|
|
|
|
G4LogicalVolume* flogical = nullptr; // The logical volume representing the
|
|
// physical and tracking attributes of
|
|
// the volume
|
|
G4String fname; // The name of the volume
|
|
G4LogicalVolume* flmother = nullptr; // The current mother logical volume
|
|
|
|
G4PVData* pvdata = nullptr; // Shadow pointer for use of object persistency
|
|
};
|
|
|
|
// NOTE:
|
|
// The type G4PVManager is introduced to encapsulate the methods used by
|
|
// both the master thread and worker threads to allocate memory space for
|
|
// the fields encapsulated by the class G4PVData. When each thread
|
|
// initializes the value for these fields, it refers to them using a macro
|
|
// definition defined below. For every G4VPhysicalVolume instance, there is
|
|
// a corresponding G4PVData instance. All G4PVData instances are organized
|
|
// by the class G4PVManager as an array.
|
|
// The field "int instanceID" is added to the class G4VPhysicalVolume.
|
|
// The value of this field in each G4VPhysicalVolume instance is the subscript
|
|
// of the corresponding G4PVData instance.
|
|
// In order to use the class G4PVManager, we add a static member in the class
|
|
// G4VPhysicalVolume as follows: "static G4PVManager subInstanceManager;".
|
|
// For the master thread, the array for G4PVData instances grows dynamically
|
|
// along with G4VPhysicalVolume instances are created. For each worker thread,
|
|
// it copies the array of G4PVData instances from the master thread.
|
|
// In addition, it invokes a method similiar to the constructor explicitly
|
|
// to achieve the partial effect for each instance in the array.
|
|
|
|
#include "G4VPhysicalVolume.icc"
|
|
|
|
#endif
|