G4VExternalPhysicalVolume is a base class to represent a physical volume managed by an external sub-navigator. More...

#include <G4VExternalPhysicalVolume.hh>

Inheritance diagram for G4VExternalPhysicalVolume:

Public Member Functions
	G4VExternalPhysicalVolume (G4RotationMatrix pRot, const G4ThreeVector &tlate, G4LogicalVolume pCurrentLogical, const G4String &pName, G4VPhysicalVolume *pMother)
	G4VExternalPhysicalVolume (__void__ &)
	G4VExternalPhysicalVolume (const G4VExternalPhysicalVolume &)=delete
G4VExternalPhysicalVolume &	operator= (const G4VExternalPhysicalVolume &)=delete
	~G4VExternalPhysicalVolume () override=default
G4bool	CheckOverlaps (G4int res=1000, G4double tol=0., G4bool verbose=true, G4int maxErr=1) override=0
EVolume	VolumeType () const final
G4bool	IsMany () const final
void	SetMany (G4bool overlap)
G4bool	IsReplicated () const final
G4bool	IsParameterised () const final
G4VPVParameterisation *	GetParameterisation () const final
void	GetReplicationData (EAxis &axis, G4int &nReplicas, G4double &width, G4double &offset, G4bool &consuming) const final
G4bool	IsRegularStructure () const final
G4int	GetRegularStructureId () const final
Public Member Functions inherited from G4VPhysicalVolume
	G4VPhysicalVolume (G4RotationMatrix pRot, const G4ThreeVector &tlate, const G4String &pName, G4LogicalVolume pLogical, G4VPhysicalVolume *pMother)
virtual	~G4VPhysicalVolume ()
	G4VPhysicalVolume (const G4VPhysicalVolume &)=delete
G4VPhysicalVolume &	operator= (const G4VPhysicalVolume &)=delete
G4bool	operator== (const G4VPhysicalVolume &p) const
G4RotationMatrix *	GetObjectRotation () const
G4RotationMatrix	GetObjectRotationValue () const
G4ThreeVector	GetObjectTranslation () const
const G4RotationMatrix *	GetFrameRotation () const
G4ThreeVector	GetFrameTranslation () const
const G4ThreeVector	GetTranslation () const
const G4RotationMatrix *	GetRotation () const
G4RotationMatrix *	GetRotation ()
void	SetTranslation (const G4ThreeVector &v)
void	SetRotation (G4RotationMatrix *)
G4LogicalVolume *	GetLogicalVolume () const
void	SetLogicalVolume (G4LogicalVolume *pLogical)
G4LogicalVolume *	GetMotherLogical () const
void	SetMotherLogical (G4LogicalVolume *pMother)
const G4String &	GetName () const
void	SetName (const G4String &pName)
virtual G4int	GetMultiplicity () const
virtual G4int	GetCopyNo () const =0
virtual void	SetCopyNo (G4int CopyNo)=0
	G4VPhysicalVolume (__void__ &)
G4int	GetInstanceID () const
EVolume	DeduceVolumeType () const

Additional Inherited Members
Static Public Member Functions inherited from G4VPhysicalVolume
static const G4PVManager &	GetSubInstanceManager ()
static void	Clean ()
Protected Member Functions inherited from G4VPhysicalVolume
void	InitialiseWorker (G4VPhysicalVolume pMasterObject, G4RotationMatrix pRot, const G4ThreeVector &tlate)
void	TerminateWorker (G4VPhysicalVolume *pMasterObject)
Protected Attributes inherited from G4VPhysicalVolume
G4int	instanceID
Static Protected Attributes inherited from G4VPhysicalVolume
static G4GEOM_DLL G4PVManager	subInstanceManager

Detailed Description

G4VExternalPhysicalVolume is a base class to represent a physical volume managed by an external sub-navigator.

Definition at line 50 of file G4VExternalPhysicalVolume.hh.

Constructor & Destructor Documentation

◆ G4VExternalPhysicalVolume() [1/3]

G4VExternalPhysicalVolume::G4VExternalPhysicalVolume	(	G4RotationMatrix *	pRot,
		const G4ThreeVector &	tlate,
		G4LogicalVolume *	pCurrentLogical,
		const G4String &	pName,
		G4VPhysicalVolume *	pMother )

Constructor implementing G4VPhysicalVolume signature.

Parameters

[in]	pRot	The pointer to the rotation in the mother volume.
[in]	tlate	Traslation vector in the mother volume.
[in]	pCurrentLogical	Pointer to its logical volume.
[in]	pName	The volume name.
[in]	pMotherLogical	Pointer to the logical volume of the mother.

Definition at line 40 of file G4VExternalPhysicalVolume.cc.

   : G4VPhysicalVolume(pRot, tlate, pName, pLogical, pMother)
{
  if (pMother != nullptr)
  {
    G4LogicalVolume* motherLogical = pMother->GetLogicalVolume();
    if (pLogical == motherLogical)
    {
      G4Exception("G4VExternalPhysicalVolume::G4VExternalPhysicalVolume()",
                  "GeomVol0002", FatalException,
                  "Cannot place a volume inside itself!");
    }
    SetMotherLogical(motherLogical);
    motherLogical->AddDaughter(this);
  }
}

Referenced by G4VExternalPhysicalVolume(), and operator=().

◆ G4VExternalPhysicalVolume() [2/3]

G4VExternalPhysicalVolume::G4VExternalPhysicalVolume ( __void__ & a )

Fake default constructor for usage restricted to direct object persistency for clients requiring preallocation of memory for persistifiable objects.

Definition at line 66 of file G4VExternalPhysicalVolume.cc.

  : G4VPhysicalVolume(a)
{
}

◆ G4VExternalPhysicalVolume() [3/3]

G4VExternalPhysicalVolume::G4VExternalPhysicalVolume ( const G4VExternalPhysicalVolume & )

delete

Copy constructor and assignment operator not allowed.

◆ ~G4VExternalPhysicalVolume()

G4VExternalPhysicalVolume::~G4VExternalPhysicalVolume ( )

overridedefault

Default Destructor.

Member Function Documentation

◆ CheckOverlaps()

G4bool G4VExternalPhysicalVolume::CheckOverlaps	(	G4int	res = 1000,
		G4double	tol = 0.,
		G4bool	verbose = true,
		G4int	maxErr = 1 )

overridepure virtual

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.

Parameters

[in]	res	The number of points to generate on volume's surface.
[in]	tol	The precision tolerance for the overlap check, below which to ignore overlaps (deafult is maximim precision).
[in]	verbose	Verbosity mode (default is true).
[in]	maxErr	Maximum of overlaps errors to report (default is 1).

Returns: True if an overlap occurs.

Reimplemented from G4VPhysicalVolume.

◆ GetParameterisation()

G4VPVParameterisation * G4VExternalPhysicalVolume::GetParameterisation ( ) const

finalvirtual

Returns a pointer to the replicas parameterisation object/algorithm (able to compute dimensions and transformations of replicas), or a null pointer if not applicable.

Implements G4VPhysicalVolume.

Definition at line 106 of file G4VExternalPhysicalVolume.cc.

{
  return nullptr;
}

Referenced by CheckOverlaps().

◆ GetRegularStructureId()

G4int G4VExternalPhysicalVolume::GetRegularStructureId ( ) const

finalvirtual

Returns non-zero code in case the underlying volume structure is regular, voxel-like. The value is an identifier for the structure type. If non-zero the volume is a candidate for specialised navigation such as 'nearest neighbour' directly on volumes.

Implements G4VPhysicalVolume.

Definition at line 135 of file G4VExternalPhysicalVolume.cc.

{
  return 0;  
}           

Referenced by CheckOverlaps().

◆ GetReplicationData()

void G4VExternalPhysicalVolume::GetReplicationData	(	EAxis &	axis,
		G4int &	nReplicas,
		G4double &	width,
		G4double &	offset,
		G4bool &	consuming ) const

finalvirtual

Returns the replication information. No-op for non replicated volumes.

Parameters

[in,out]	axis	The axis of replication/parameterisation.
[in,out]	nReplicas	The number of replicated/parameterised objects.
[in,out]	width	The width of replicated object.
[in,out]	offset	The optional offset distance from mother's border.
[in,out]	consuming	Flag of replica characterisation (always true for pure replicas).