Factory for circular beam pipes. More...

#include <BDSBeamPipeFactoryCircular.hh>

Inheritance diagram for BDSBeamPipeFactoryCircular:

Collaboration diagram for BDSBeamPipeFactoryCircular:

Public Member Functions
virtual BDSBeamPipe *	CreateBeamPipe (const G4String &nameIn, G4double lengthIn, G4double aper1=0, G4double aper2=0, G4double aper3=0, G4double aper4=0, G4Material vacuumMaterialIn=nullptr, G4double beamPipeThicknessIn=0, G4Material beamPipeMaterialIn=nullptr, const G4String &pointsFileIn="", const G4String &pointsUnitIn="")
	create a flat ended beampipe

virtual BDSBeamPipe *	CreateBeamPipe (const G4String &nameIn, G4double lengthIn, const G4ThreeVector &inputFaceNormalIn, const G4ThreeVector &outputFaceNormalIn, G4double aper1=0, G4double aper2=0, G4double aper3=0, G4double aper4=0, G4Material vacuumMaterialIn=nullptr, G4double beamPipeThicknessIn=0, G4Material beamPipeMaterialIn=nullptr, const G4String &pointsFileIn="", const G4String &pointsUnitIn="")

Public Member Functions inherited from BDSBeamPipeFactoryBase
virtual BDSBeamPipe *	CreateBeamPipe (const G4String &nameIn, G4double lengthIn, G4double aper1=0, G4double aper2=0, G4double aper3=0, G4double aper4=0, G4Material vacuumMaterialIn=nullptr, G4double beamPipeThicknessIn=0, G4Material beamPipeMaterialIn=nullptr, const G4String &pointsFileIn="", const G4String &pointsUnitIn="")=0
	create a flat ended beampipe

virtual BDSBeamPipe *	CreateBeamPipe (const G4String &nameIn, G4double lengthIn, const G4ThreeVector &inputFaceNormalIn, const G4ThreeVector &outputFaceNormalIn, G4double aper1=0, G4double aper2=0, G4double aper3=0, G4double aper4=0, G4Material vacuumMaterialIn=nullptr, G4double beamPipeThicknessIn=0, G4Material beamPipeMaterialIn=nullptr, const G4String &pointsFileIn="", const G4String &pointsUnitIn="")=0

virtual	~BDSBeamPipeFactoryBase ()
	Virtual base destructor.

Public Member Functions inherited from BDSFactoryBase
virtual void	FactoryBaseCleanUp ()
	Empty containers for next use - factories are never deleted so can't rely on scope.

Private Member Functions
BDSBeamPipe *	CommonFinalConstruction (const G4String &nameIn, G4Material vacuumMaterialIn, G4Material beamPipeMaterialIn, G4double lengthIn, G4double containerRadiusIn)

void	CreateGeneralAngledSolids (const G4String &nameIn, G4double lengthIn, G4double aper1In, G4double beamPipeThicknessIn, const G4ThreeVector &inputfaceIn, const G4ThreeVector &outputfaceIn, G4double &containerRadius)
	Pass containerRadius by reference to update.

Additional Inherited Members
Protected Member Functions inherited from BDSBeamPipeFactoryBase
	BDSBeamPipeFactoryBase ()
	base constructor

void	CleanUpBase ()

virtual void	CleanUp ()

void	CommonConstruction (const G4String &nameIn, G4Material vacuumMaterialIn, G4Material beamPipeMaterialIn, G4double length)
	finalise beampipe construction

BDSBeamPipe *	BuildBeamPipeAndRegisterVolumes (BDSExtent extent, G4double containerRadius, G4bool containerIsCircular=false)
	build beampipe and register logical volumes

virtual void	BuildLogicalVolumes (const G4String &nameIn, G4Material vacuumMaterialIn, G4Material beamPipeMaterialIn)
	build logical volumes

virtual void	SetVisAttributes (G4Material beamPipeMaterialIn, G4Material vacuumMaterialIn)
	Set visual attributes.

virtual void	SetUserLimits (G4double length)
	Set user limits.

virtual void	PlaceComponents (const G4String &nameIn)
	Place volumes.

Static Protected Member Functions inherited from BDSBeamPipeFactoryBase
static void	CheckAngledVolumeCanBeBuilt (G4double length, const G4ThreeVector &inputfaceAngle, const G4ThreeVector &outputfaceAngle, G4double horizontalWidth, const G4String &name)
	check if a beam pipe volume with angled faces can be constructed

Protected Attributes inherited from BDSBeamPipeFactoryBase
G4bool	sensitiveBeamPipe
	Whether the beam pipe will record energy deposition.

G4bool	sensitiveVacuum
	Whether the vacuum will record any energy deposition.

G4bool	storeApertureImpacts
	Whether to store aperture impacts.

G4VSolid *	vacuumSolid

G4VSolid *	beamPipeSolid

G4VSolid *	containerSolid

G4VSolid *	containerSubtractionSolid
	Longer (in length) version of container solid for unambiguous subtraction.

G4LogicalVolume *	vacuumLV

G4LogicalVolume *	beamPipeLV

G4LogicalVolume *	containerLV

G4PVPlacement *	vacuumPV

G4PVPlacement *	beamPipePV

G4ThreeVector	inputFaceNormal
	For recording the face normals in the finished pipe component.

G4ThreeVector	outputFaceNormal
	For recording the face normals in the finished pipe component.

Protected Attributes inherited from BDSFactoryBase
std::set< G4LogicalVolume * >	allLogicalVolumes

std::set< G4VPhysicalVolume * >	allPhysicalVolumes

std::set< G4RotationMatrix * >	allRotationMatrices

std::set< G4UserLimits * >	allUserLimits

std::set< G4VSolid * >	allSolids

std::set< G4VisAttributes * >	allVisAttributes

G4double	lengthSafety
	Cache of global constants variable.

G4double	lengthSafetyLarge
	Cache of global constants variable.

G4bool	checkOverlaps
	Cache of global constants variable.

G4bool	visDebug
	Cache of global constants variable.

G4int	nSegmentsPerCircle
	Cache of global constants variable.

G4VisAttributes *	containerVisAttr
	Cache of global constants variable.

G4UserLimits *	defaultUserLimits
	Cache of global constants variable.

Detailed Description

Factory for circular beam pipes.

Author: Laurie Nevay

Definition at line 31 of file BDSBeamPipeFactoryCircular.hh.

Constructor & Destructor Documentation

◆ BDSBeamPipeFactoryCircular()

BDSBeamPipeFactoryCircular::BDSBeamPipeFactoryCircular ( )

Definition at line 36 of file BDSBeamPipeFactoryCircular.cc.

◆ ~BDSBeamPipeFactoryCircular()

virtual BDSBeamPipeFactoryCircular::~BDSBeamPipeFactoryCircular ( )

inlinevirtual

Definition at line 35 of file BDSBeamPipeFactoryCircular.hh.

Member Function Documentation

◆ CommonFinalConstruction()

BDSBeamPipe * BDSBeamPipeFactoryCircular::CommonFinalConstruction	(	const G4String &	nameIn,
		G4Material *	vacuumMaterialIn,
		G4Material *	beamPipeMaterialIn,
		G4double	lengthIn,
		G4double	containerRadiusIn
	)

private

Abstract common build features to one function use member variables unique to this factory to pass them around.

only the solids are unique, once we have those, the logical volumes and placement in the container are the same. group all this functionality together

Definition at line 110 of file BDSBeamPipeFactoryCircular.cc.

References BDSBeamPipeFactoryBase::BuildBeamPipeAndRegisterVolumes(), BDSBeamPipeFactoryBase::CommonConstruction(), and BDSBeamPipeFactoryBase::containerSubtractionSolid.

Referenced by CreateBeamPipe().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateBeamPipe() [1/2]

BDSBeamPipe * BDSBeamPipeFactoryCircular::CreateBeamPipe	(	const G4String &	nameIn,
		G4double	lengthIn,
		const G4ThreeVector &	inputFaceNormalIn,
		const G4ThreeVector &	outputFaceNormalIn,
		G4double	aper1 = `0`,
		G4double	aper2 = `0`,
		G4double	aper3 = `0`,
		G4double	aper4 = `0`,
		G4Material *	vacuumMaterialIn = `nullptr`,
		G4double	beamPipeThicknessIn = `0`,
		G4Material *	beamPipeMaterialIn = `nullptr`,
		const G4String &	pointsFileIn = `""`,
		const G4String &	pointsUnitIn = `""`
	)

virtual

Create a beam pipe with angled faces as described by unit normal vectors. The input face normal vector must have a negative z component and the output face a positive z component.

Implements BDSBeamPipeFactoryBase.

Definition at line 81 of file BDSBeamPipeFactoryCircular.cc.

References CommonFinalConstruction(), CreateGeneralAngledSolids(), BDSBeamPipeFactoryBase::inputFaceNormal, and BDSBeamPipeFactoryBase::outputFaceNormal.

Here is the call graph for this function:

◆ CreateBeamPipe() [2/2]

BDSBeamPipe * BDSBeamPipeFactoryCircular::CreateBeamPipe	(	const G4String &	nameIn,
		G4double	lengthIn,
		G4double	aper1 = `0`,
		G4double	aper2 = `0`,
		G4double	aper3 = `0`,
		G4double	aper4 = `0`,
		G4Material *	vacuumMaterialIn = `nullptr`,
		G4double	beamPipeThicknessIn = `0`,
		G4Material *	beamPipeMaterialIn = `nullptr`,
		const G4String &	pointsFileIn = `""`,
		const G4String &	pointsUnitIn = `""`
	)

virtual

create a flat ended beampipe

Implements BDSBeamPipeFactoryBase.

Definition at line 39 of file BDSBeamPipeFactoryCircular.cc.

References CommonFinalConstruction(), BDSFactoryBase::lengthSafety, and BDSFactoryBase::lengthSafetyLarge.

Referenced by BDSBeamPipeFactoryElliptical::CreateBeamPipe().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateGeneralAngledSolids()

void BDSBeamPipeFactoryCircular::CreateGeneralAngledSolids	(	const G4String &	nameIn,
		G4double	lengthIn,
		G4double	aper1In,
		G4double	beamPipeThicknessIn,
		const G4ThreeVector &	inputfaceIn,
		const G4ThreeVector &	outputfaceIn,
		G4double &	containerRadius
	)