G4PVDivisionFactory Class Reference

G4PVDivisionFactory implements the interfaces for creating volume divisions (defined in G4VPVDivisionFactory) for G4PVDivision type. More...

#include <G4PVDivisionFactory.hh>

Inheritance diagram for G4PVDivisionFactory:

Public Member Functions
	~G4PVDivisionFactory () override=default
G4VPhysicalVolume *	CreatePVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4LogicalVolume *pMother, const EAxis pAxis, const G4int nReplicas, const G4double width, const G4double offset) override
G4VPhysicalVolume *	CreatePVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4LogicalVolume *pMother, const EAxis pAxis, const G4int nReplicas, const G4double offset) override
G4VPhysicalVolume *	CreatePVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4LogicalVolume *pMother, const EAxis pAxis, const G4double width, const G4double offset) override
G4VPhysicalVolume *	CreatePVDivision (const G4String &pName, G4LogicalVolume *pLogical, G4LogicalVolume *pMother, const G4VPVParameterisation *param) override
G4bool	IsPVDivision (const G4VPhysicalVolume *pv) const override
Public Member Functions inherited from G4VPVDivisionFactory
virtual	~G4VPVDivisionFactory ()=default

Static Public Member Functions
static G4PVDivisionFactory *	GetInstance ()
Static Public Member Functions inherited from G4VPVDivisionFactory
static G4VPVDivisionFactory *	Instance ()

Protected Member Functions
	G4PVDivisionFactory ()=default
Protected Member Functions inherited from G4VPVDivisionFactory
	G4VPVDivisionFactory ()=default

Additional Inherited Members
Static Protected Attributes inherited from G4VPVDivisionFactory
static G4ThreadLocal G4VPVDivisionFactory *	fgInstance = nullptr

Detailed Description

G4PVDivisionFactory implements the interfaces for creating volume divisions (defined in G4VPVDivisionFactory) for G4PVDivision type.

Definition at line 48 of file G4PVDivisionFactory.hh.

Constructor & Destructor Documentation

~G4PVDivisionFactory()

G4PVDivisionFactory::~G4PVDivisionFactory ( )

overridedefault

Default Destructor.

G4PVDivisionFactory()

G4PVDivisionFactory::G4PVDivisionFactory ( )

protecteddefault

Protected default Constructor.

Referenced by GetInstance(), and ~G4PVDivisionFactory().

Member Function Documentation

CreatePVDivision() [1/4]

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

overridevirtual

Creates a division, using the width of the division slice.

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.

Returns

The pointer to physical divided volume.

Implements G4VPVDivisionFactory.

Definition at line 84 of file G4PVDivisionFactory.cc.

{     
  // Create division - with width
  // ---
 
  return new G4PVDivision(pName, pLogical, pMotherLogical, 
                          pAxis, width, offset);
}    

CreatePVDivision() [2/4]

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

overridevirtual

Creates a division, using the 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.

Returns

The pointer to physical divided volume.

Implements G4VPVDivisionFactory.

Definition at line 67 of file G4PVDivisionFactory.cc.

{     
  // Create division - with number of divisions 
  // ---
 
  return new G4PVDivision(pName, pLogical, pMotherLogical, 
                          pAxis, nReplicas, offset);
}    

CreatePVDivision() [3/4]

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

overridevirtual

Creates a division, using 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.

Returns

The pointer to physical divided volume.

Implements G4VPVDivisionFactory.

Definition at line 49 of file G4PVDivisionFactory.cc.

{     
  // Create division - with number of divisions and width
  // ---
 
  return new G4PVDivision(pName, pLogical, pMotherLogical, 
                          pAxis, nReplicas, width, offset);
}    

CreatePVDivision() [4/4]

G4VPhysicalVolume * G4PVDivisionFactory::CreatePVDivision ( const G4String & pName, G4LogicalVolume * pLogical, G4LogicalVolume * pMother, const G4VPVParameterisation * param )

overridevirtual

Creates a division, using a parameterisation algorithm.

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]	param	The pointer to the parameterisation algorithm.

Returns

The pointer to physical divided volume.

Implements G4VPVDivisionFactory.

Definition at line 101 of file G4PVDivisionFactory.cc.

{     
  // Create division - with parameterisation
  // ---
 
  // Get parameterisation data
  //
  const auto divParam = dynamic_cast<const G4VDivisionParameterisation*>(param);
 
  if (divParam == nullptr)
  {
    G4Exception("G4PVDivisionFactory::CreatePVDivision()",
                "GeomDiv0001", FatalException,
                "Unexpected parameterisation type!");
    return nullptr;
  }
  
  EAxis axis = divParam->GetAxis();
  G4int nofDivisions = divParam->GetNoDiv();
  G4double width = divParam->GetWidth();
  G4double offset = divParam->GetOffset();
 
  return new G4PVDivision(pName, pLogical, pMotherLogical, 
                          axis, nofDivisions, width, offset);
}    

GetInstance()

G4PVDivisionFactory * G4PVDivisionFactory::GetInstance ( )

static

Creates the unique instance of the singleton.

Definition at line 37 of file G4PVDivisionFactory.cc.

{
  if (fgInstance == nullptr)
  {
    fgInstance =  new G4PVDivisionFactory;
  }
  return dynamic_cast<G4PVDivisionFactory*>(fgInstance);
} 

Referenced by G4GDMLReadStructure::DivisionvolRead().

IsPVDivision()

G4bool G4PVDivisionFactory::IsPVDivision ( const G4VPhysicalVolume * pv ) const

overridevirtual

Returns true if 'pv' is a pointer to a division.

Implements G4VPVDivisionFactory.

Definition at line 132 of file G4PVDivisionFactory.cc.

{ 
  // Returns true if pv is division
  // ---
 
  return dynamic_cast<const G4PVDivision*>(pv) != nullptr;
}

---

The documentation for this class was generated from the following files:

• G4PVDivisionFactory.hh
• G4PVDivisionFactory.cc