G4PVDivision.hh File Reference

#include "geomdefs.hh"
#include "G4PVReplica.hh"
#include "G4VDivisionParameterisation.hh"

Go to the source code of this file.

Functions
	G4PVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4LogicalVolume *pMother, const EAxis pAxis, const G4int nReplicas, const G4double width, const G4double offset)
	G4PVDivision represents many touchable detector elements differing only in their positioning. The elements' positions are calculated by means of a simple linear formula.
	G4PVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4LogicalVolume *pMother, const EAxis pAxis, const G4int nReplicas, const G4double offset)
	G4PVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4LogicalVolume *pMother, const EAxis pAxis, const G4double width, const G4double offset)
	G4PVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4VPhysicalVolume *pMother, const EAxis pAxis, const G4int nReplicas, const G4double width, const G4double offset)
	~G4PVDivision () override
	G4PVDivision (const G4PVDivision &)=delete
G4PVDivision &	operator= (const G4PVDivision &)=delete
G4bool	IsMany () const override
G4bool	IsReplicated () const override
G4int	GetMultiplicity () const override
G4bool	IsParameterised () const override
G4VPVParameterisation *	GetParameterisation () const override
void	GetReplicationData (EAxis &axis, G4int &nReplicas, G4double &width, G4double &offset, G4bool &consuming) const override
EAxis	GetDivisionAxis () const
EVolume	VolumeType () const override
G4bool	IsRegularStructure () const override
G4int	GetRegularStructureId () const override

Variables
EAxis	faxis
EAxis	fdivAxis
G4int	fnReplicas = 0
G4double	fwidth = 0.0
G4double	foffset = 0.0
G4VDivisionParameterisation *	fparam = nullptr

Function Documentation

G4PVDivision() [1/5]

G4PVDivision ( const G4PVDivision & )

delete

Copy constructor and assignment operator not allowed.

G4PVDivision() [2/5]

G4PVDivision::G4PVDivision	(	const G4String &	pName,
		G4LogicalVolume *	pLogical,
		G4LogicalVolume *	pMother,
		const EAxis	pAxis,
		const G4double	width,
		const G4double	offset )

Constructor with width.

Parameters

[in]	pName	The volume name.
[in]	pLogical	Pointer to the logical volume of the division.
[in]	pMother	Pointer to the logical volume of the mother.
[in]	pAxis	The axis along which do the division.
[in]	width	The witdh of the divided slice along the axis.
[in]	offset	The optional offset distance from mother's border.

Definition at line 111 of file G4PVDivision.cc.

  : G4PVReplica(pName, 0, pAxis, pLogical, pMotherLogical)
{
  if (pMotherLogical == nullptr)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "NULL pointer specified as mother! Volume: " + pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
    return;
  }
  if (pLogical == pMotherLogical)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "Cannot place a volume inside itself! Volume: "+ pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
  }
  pMotherLogical->AddDaughter(this);
  SetMotherLogical(pMotherLogical);
  SetParameterisation(pMotherLogical, pAxis, 0, width, offset, DivWIDTH);
  CheckAndSetParameters (pAxis, 0, width, offset, DivWIDTH, pMotherLogical);
}

G4PVDivision() [3/5]

G4PVDivision::G4PVDivision	(	const G4String &	pName,
		G4LogicalVolume *	pLogical,
		G4LogicalVolume *	pMother,
		const EAxis	pAxis,
		const G4int	nReplicas,
		const G4double	offset )

Constructor with number of divisions.

Parameters

[in]	pName	The volume name.
[in]	pLogical	Pointer to the logical volume of the division.
[in]	pMother	Pointer to the logical volume of the mother.
[in]	pAxis	The axis along which do the division.
[in]	nReplicas	The number of copies to replicate.
[in]	offset	The optional offset distance from mother's border.

Definition at line 79 of file G4PVDivision.cc.

  : G4PVReplica(pName, nDivs, pAxis, pLogical, pMotherLogical)
{
  if (pMotherLogical == nullptr)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "NULL pointer specified as mother! Volume: " << pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
    return;
  }
  if (pLogical == pMotherLogical)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "Cannot place a volume inside itself! Volume: " << pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
  }
  pMotherLogical->AddDaughter(this);
  SetMotherLogical(pMotherLogical);
  SetParameterisation(pMotherLogical, pAxis, nDivs, 0., offset, DivNDIV);
  CheckAndSetParameters (pAxis, nDivs, 0., offset, DivNDIV, pMotherLogical);
}

G4PVDivision() [4/5]

G4PVDivision::G4PVDivision	(	const G4String &	pName,
		G4LogicalVolume *	pLogical,
		G4LogicalVolume *	pMother,
		const EAxis	pAxis,
		const G4int	nReplicas,
		const G4double	width,
		const G4double	offset )

G4PVDivision represents many touchable detector elements differing only in their positioning. The elements' positions are calculated by means of a simple linear formula.

Division may occur along:

o Cartesian axes (kXAxis,kYAxis,kZAxis)

The divisions, of specified width have coordinates of form (-width*(nReplicas-1)*0.5+n*width,0,0) where n=0.. nReplicas-1 for the case of kXAxis, and are unrotated.

o Radial axis (cylindrical polar) (kRho)

The divisions are cons/tubs sections, centred on the origin and are unrotated. They have radii of width*n+offset to width*(n+1)+offset where n=0..nReplicas-1

o Phi axis (cylindrical polar) (kPhi) The divisions are `phi sections' or wedges, and of cons/tubs form They have phi of offset+n*width to offset+(n+1)*width where n=0..nReplicas-1 */

class G4PVDivision : public G4PVReplica { public:

/** Constructor with number of divisions and width.

Parameters

[in]	pName	The volume name.
[in]	pLogical	Pointer to the logical volume of the division.
[in]	pMother	Pointer to the logical volume of the mother.
[in]	pAxis	The axis along which do the division.
[in]	nReplicas	The number of copies to replicate.
[in]	width	The witdh of the divided slice along the axis.
[in]	offset	The optional offset distance from mother's border.

Definition at line 44 of file G4PVDivision.cc.

  : G4PVReplica(pName, nDivs, pAxis, pLogical, pMotherLogical)
{
  if (pMotherLogical == nullptr)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "NULL pointer specified as mother for volume: " << pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
    return;
  }
  if (pLogical == pMotherLogical)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "Cannot place a volume inside itself! Volume: " << pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
  }
  pMotherLogical->AddDaughter(this);
  SetMotherLogical(pMotherLogical);
  SetParameterisation(pMotherLogical, pAxis, nDivs,
                      width, offset, DivNDIVandWIDTH);
  CheckAndSetParameters (pAxis, nDivs, width, offset,
                         DivNDIVandWIDTH, pMotherLogical);
}

Referenced by G4GDMLWrite::AddModule(), G4tgbVolume::ConstructG4PhysVol(), G4PVDivisionFactory::CreatePVDivision(), G4PVDivisionFactory::CreatePVDivision(), G4PVDivisionFactory::CreatePVDivision(), G4PVDivisionFactory::CreatePVDivision(), G4GDMLWriteStructure::DivisionvolWrite(), G4PVDivision(), G4PVDivisionFactory::IsPVDivision(), operator=(), G4ScoringBox::SetupGeometry(), G4ScoringCylinder::SetupGeometry(), and G4GDMLWriteStructure::TraverseVolumeTree().

G4PVDivision() [5/5]

G4PVDivision::G4PVDivision	(	const G4String &	pName,
		G4LogicalVolume *	pLogical,
		G4VPhysicalVolume *	pMother,
		const EAxis	pAxis,
		const G4int	nReplicas,
		const G4double	width,
		const G4double	offset )

Constructor in mother physical volume (same as first constructor).

Parameters

[in]	pName	The volume name.
[in]	pLogical	Pointer to the logical volume of the division.
[in]	pMother	Pointer to the physical volume of the mother.
[in]	pAxis	The axis along which do the division.
[in]	nReplicas	The number of copies to replicate.
[in]	width	The witdh of the divided slice along the axis.
[in]	offset	The optional offset distance from mother's border.

Definition at line 143 of file G4PVDivision.cc.

  : G4PVReplica(pName, nDivs, pAxis, pLogical,
                pMotherPhysical != nullptr ? pMotherPhysical->GetLogicalVolume() : nullptr)
{
  if (pMotherPhysical == nullptr)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "NULL pointer specified as mother for volume: " << pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
    return;
  }
  G4LogicalVolume* pMotherLogical = pMotherPhysical->GetLogicalVolume();
  if (pLogical == pMotherLogical)
  {
    std::ostringstream message;
    message << "Invalid setup." << G4endl
            << "Cannot place a volume inside itself! Volume: " << pName;
    G4Exception("G4PVDivision::G4PVDivision()", "GeomDiv0002",
                FatalException, message);
  }
  pMotherLogical->AddDaughter(this);
  SetMotherLogical(pMotherLogical);
  SetParameterisation(pMotherLogical, pAxis, nDivs,
                      width, offset, DivNDIVandWIDTH);
  CheckAndSetParameters (pAxis, nDivs, width, offset,
                         DivNDIVandWIDTH, pMotherLogical);
}

GetDivisionAxis()

EAxis G4ReplicatedSlice::GetDivisionAxis

(

)

const

Returns the axis along which the division is made.

Returns

The string Id of the axis.

Definition at line 275 of file G4PVDivision.cc.

{
  return fdivAxis;
}

GetMultiplicity()

G4int GetMultiplicity ( ) const

override

Returns the number of divisions.

Referenced by G4PVParameterised::CheckOverlaps().

GetParameterisation()

G4VPVParameterisation * GetParameterisation ( ) const

override

Returns the pointer to the parameterisation algorithm.

Referenced by G4PhysicalVolumeModel::CalculateExtent(), and G4PhysicalVolumeModel::VisitGeometryAndGetVisReps().

GetRegularStructureId()

G4int GetRegularStructureId ( ) const

override

Referenced by GetRegularStructureId().

GetReplicationData()

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

override

Fills arguments with the attributes from the base replica.

Parameters

[in,out]	axis	Axis of parameterisation returned.
[in,out]	nReplicas	The number of division copies.
[in,out]	width	Width of the division slice.
[in,out]	offset	Potential offset in replication.
[in,out]	consuming	Flag of replica characterisation (always false for parameterisations).

Referenced by G4PhysicalVolumeModel::VisitGeometryAndGetVisReps().

IsMany()

G4bool IsMany ( ) const

override

Not used.

IsParameterised()

G4bool IsParameterised ( ) const

override

Returns true to identify if it is a parameterised physical volume.

IsRegularStructure()

G4bool IsRegularStructure ( ) const

override

Methods to identify volumes that can have revised 'regular' navigation. Currently divisions do not qualify for this.

Referenced by IsRegularStructure().

IsReplicated()

G4bool IsReplicated ( ) const

override

Returns true.

Referenced by G4LogicalVolume::AddDaughter(), and G4PhysicalVolumeModel::VisitGeometryAndGetVisReps().

operator=()

G4PVDivision & operator= ( const G4PVDivision & )

delete

VolumeType()

EVolume VolumeType ( ) const

override

Returns the volume type characterisation.

Returns

The string Id of the volume type, i.e. 'kParameterised'.

Referenced by G4ITNavigator1::GetLocalExitNormal(), G4ITNavigator2::GetLocalExitNormal(), G4Navigator::GetLocalExitNormal(), G4ITNavigator1::LocateGlobalPointAndSetup(), G4ITNavigator2::LocateGlobalPointAndSetup(), and G4Navigator::LocateGlobalPointAndSetup().

~G4PVDivision()

G4PVDivision::~G4PVDivision ( )

overridedefault

Destructor.

Variable Documentation

faxis

EAxis faxis

protected

Axis of optimisation.

Definition at line 246 of file G4PVDivision.hh.

Referenced by G4PVReplica(), and G4PVParameterised::GetReplicationData().

fdivAxis

EAxis fdivAxis

protected

Axis of division.

Definition at line 249 of file G4PVDivision.hh.

Referenced by GetDivisionAxis().

fnReplicas

G4int fnReplicas = 0

protected

Number of divisions.

Definition at line 252 of file G4PVDivision.hh.

Referenced by G4PVReplica(), and G4PVParameterised::GetReplicationData().

foffset

G4double foffset = 0.0

protected

Definition at line 255 of file G4PVDivision.hh.

Referenced by G4PVReplica(), and G4PVParameterised::GetReplicationData().

fparam

G4VDivisionParameterisation* fparam = nullptr

protected

Pointer to the parameterisation algorithm.

Definition at line 258 of file G4PVDivision.hh.

fwidth

G4double fwidth = 0.0

protected

Width of the division slice and potential offset.

Definition at line 255 of file G4PVDivision.hh.

Referenced by G4ExcitedMesonConstructor::ConstructMesons(), G4PVReplica(), G4PVParameterised::GetReplicationData(), and G4Abla::width().