The base factory for the LHC magnet geometry factory. More...

#include <BDSMagnetOuterFactoryLHC.hh>

Inheritance diagram for BDSMagnetOuterFactoryLHC:

Collaboration diagram for BDSMagnetOuterFactoryLHC:

Public Member Functions
	BDSMagnetOuterFactoryLHC (G4bool isLeftOffset)

virtual BDSMagnetOuter *	CreateSectorBend (G4String name, G4double length, const BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	sector bend outer volume

virtual BDSMagnetOuter *	CreateRectangularBend (G4String name, G4double length, const BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	rectangular bend outer volume

virtual BDSMagnetOuter *	CreateQuadrupole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	quadrupole outer volume

virtual BDSMagnetOuter *	CreateSextupole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	sextupole outer volume

virtual BDSMagnetOuter *	CreateOctupole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	octupole outer volume

virtual BDSMagnetOuter *	CreateDecapole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	decapole outer volume

virtual BDSMagnetOuter *	CreateSolenoid (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	solenoid outer volume

virtual BDSMagnetOuter *	CreateMultipole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	general multipole outer volume - could be any 2N order multipole

virtual BDSMagnetOuter *	CreateRfCavity (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	RF cavity outer volume.

virtual BDSMagnetOuter *	CreateMuonSpoiler (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)
	muon spoiler outer volume

virtual BDSMagnetOuter *	CreateKicker (G4String name, G4double length, const BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe, G4bool vertical)
	horizontal and vertical kicker outer volume

Public Member Functions inherited from BDSMagnetOuterFactoryBase
virtual BDSMagnetOuter *	CreateSectorBend (G4String name, G4double length, const BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	sector bend outer volume

virtual BDSMagnetOuter *	CreateRectangularBend (G4String name, G4double length, const BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	rectangular bend outer volume

virtual BDSMagnetOuter *	CreateQuadrupole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	quadrupole outer volume

virtual BDSMagnetOuter *	CreateSextupole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	sextupole outer volume

virtual BDSMagnetOuter *	CreateOctupole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	octupole outer volume

virtual BDSMagnetOuter *	CreateDecapole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	decapole outer volume

virtual BDSMagnetOuter *	CreateSolenoid (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	solenoid outer volume

virtual BDSMagnetOuter *	CreateMultipole (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	general multipole outer volume - could be any 2N order multipole

virtual BDSMagnetOuter *	CreateRfCavity (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	RF cavity outer volume.

virtual BDSMagnetOuter *	CreateMuonSpoiler (G4String name, G4double length, BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe)=0
	muon spoiler outer volume

virtual BDSMagnetOuter *	CreateKicker (G4String name, G4double length, const BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe, G4bool vertical)=0
	horizontal and vertical kicker outer volume

virtual void	CleanUp ()
	Empty containers for next use - factories are never deleted so can't rely on scope.

void	CleanUpBase ()
	Non-virtual clean up that can be used in the constructor.

virtual	~BDSMagnetOuterFactoryBase ()
	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.

Static Public Attributes
static const G4double	beamSeparation = 194.00*CLHEP::mm
	Used in many places - make it a constant in the code and put here as most relevant.

Protected Member Functions
G4bool	IsLeftOffset ()

Protected Member Functions inherited from BDSMagnetOuterFactoryBase
virtual void	CreateLogicalVolumes (const G4String &name, G4Colour colour, G4Material outerMaterial)

virtual void	SetUserLimits ()
	Attach default user limits to all logical volumes.

void	BuildMagnetContainerSolidAngled (const G4String &name, G4double magnetContainerLength, G4double magnetContainerRadius, G4bool flatFaces=false)

void	BuildMagnetContainerSolidStraight (const G4String &name, G4double magnetContainerLength, G4double magnetContainerRadius)

void	CreateMagnetContainerComponent ()

void	SetFaceNormals (BDSMagnetOuter *outer)
	Copy face normals from members to an instance of outer.

Protected Attributes
G4bool	isLeftOffset

Protected Attributes inherited from BDSMagnetOuterFactoryBase
G4VSolid *	poleSolid
	Solid for an individual pole that will be placed multiple times.

G4VSolid *	yokeSolid
	Solid for outer part that connects all poles.

G4VSolid *	containerSolid

G4VSolid *	magnetContainerSolid

G4LogicalVolume *	poleLV

G4LogicalVolume *	yokeLV

G4LogicalVolume *	containerLV

G4LogicalVolume *	magnetContainerLV

G4VPhysicalVolume *	yokePV

G4VisAttributes *	outerVisAttributes

BDSExtent	magContExtent

BDSGeometryComponent *	magnetContainer

G4ThreeVector	inputFaceNormal

G4ThreeVector	outputFaceNormal

G4bool	sensitiveOuter
	Cache of global constants variable.

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.

Private Types
enum class	YokeColour { dipole , kicker }
	Enum up front for yoke colouring. More...

Private Member Functions
BDSMagnetOuter *	CreateLHCDipole (const G4String &name, G4double length, const BDSBeamPipe beamPipe, G4double containerLength, const BDSMagnetOuterInfo recipe, YokeColour colourIn)

void	TestInputParameters (const BDSBeamPipe *beamPipe, G4double &horizontalWidthIn)
	test inputs for no null pointers or overlapping volumes due to poorly defined sizes

Private Attributes
BDSMagnetOuterFactoryBase *	cylindrical
	Default factory to fall back to.

Detailed Description

The base factory for the LHC magnet geometry factory.

This class is not a singleton unlike the other factories as it will be constructed twice by each derived class

Author: Laurie Nevay

Definition at line 38 of file BDSMagnetOuterFactoryLHC.hh.

Member Enumeration Documentation

◆ YokeColour

enum class BDSMagnetOuterFactoryLHC::YokeColour

strongprivate

Enum up front for yoke colouring.

Definition at line 42 of file BDSMagnetOuterFactoryLHC.hh.

Constructor & Destructor Documentation

◆ BDSMagnetOuterFactoryLHC()

BDSMagnetOuterFactoryLHC::BDSMagnetOuterFactoryLHC ( G4bool isLeftOffset )

explicit

Definition at line 63 of file BDSMagnetOuterFactoryLHC.cc.

◆ ~BDSMagnetOuterFactoryLHC()

BDSMagnetOuterFactoryLHC::~BDSMagnetOuterFactoryLHC ( )

virtual

Definition at line 69 of file BDSMagnetOuterFactoryLHC.cc.

Member Function Documentation

◆ CreateDecapole()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateDecapole	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

decapole outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 1592 of file BDSMagnetOuterFactoryLHC.cc.

References BDSMagnetOuterFactoryBase::CreateDecapole(), and cylindrical.

Here is the call graph for this function:

◆ CreateKicker()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateKicker	(	G4String	name,
		G4double	length,
		const BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe,
		G4bool	vertical
	)

virtual

horizontal and vertical kicker outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 1637 of file BDSMagnetOuterFactoryLHC.cc.

References CreateLHCDipole().

Here is the call graph for this function:

◆ CreateLHCDipole()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateLHCDipole	(	const G4String &	name,
		G4double	length,
		const BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe,
		YokeColour	colourIn
	)

private

Our own function in this class that has the yoke colour so we can reuse the code for kickers

Definition at line 83 of file BDSMagnetOuterFactoryLHC.cc.

References beamSeparation, BDSMagnetOuterFactoryBase::BuildMagnetContainerSolidAngled(), BDS::CalculateFaces(), BDS::CalculateOrientation(), BDSFactoryBase::checkOverlaps, BDSMagnetOuterFactoryBase::CleanUp(), BDSBeamPipe::ContainerIsCircular(), BDSFactoryBase::containerVisAttr, BDSFactoryBase::defaultUserLimits, BDSColours::GetColour(), BDSGeometryComponent::GetContainerLogicalVolume(), BDSBeamPipe::GetContainerRadius(), BDSBeamPipe::GetContainerSubtractionSolid(), BDSMaterials::GetMaterial(), BDSBeamPipeFactory::Instance(), BDSColours::Instance(), BDSGlobalConstants::Instance(), BDSMaterials::Instance(), BDS::IsFinite(), BDSFactoryBase::lengthSafety, BDSFactoryBase::lengthSafetyLarge, BDSFactoryBase::nSegmentsPerCircle, BDSGeometryComponent::RegisterDaughter(), BDSGeometryComponent::RegisterLogicalVolume(), BDSGeometryComponent::RegisterPhysicalVolume(), BDSGeometryComponent::RegisterSensitiveVolume(), BDSGeometryComponent::RegisterVisAttributes(), BDSMagnetOuterFactoryBase::SetFaceNormals(), TestInputParameters(), BDSBeamPipeInfo::vacuumMaterial, and BDSMagnetOuterFactoryBase::yokeSolid.

Referenced by CreateKicker(), and CreateSectorBend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateMultipole()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateMultipole	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

general multipole outer volume - could be any 2N order multipole

Implements BDSMagnetOuterFactoryBase.

Definition at line 1610 of file BDSMagnetOuterFactoryLHC.cc.

References BDSMagnetOuterFactoryBase::CreateMultipole(), and cylindrical.

Here is the call graph for this function:

◆ CreateMuonSpoiler()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateMuonSpoiler	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

muon spoiler outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 1628 of file BDSMagnetOuterFactoryLHC.cc.

References BDSMagnetOuterFactoryBase::CreateMuonSpoiler(), and cylindrical.

Here is the call graph for this function:

◆ CreateOctupole()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateOctupole	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

octupole outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 1583 of file BDSMagnetOuterFactoryLHC.cc.

References BDSMagnetOuterFactoryBase::CreateOctupole(), and cylindrical.

Here is the call graph for this function:

◆ CreateQuadrupole()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateQuadrupole	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

quadrupole outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 996 of file BDSMagnetOuterFactoryLHC.cc.

References beamSeparation, BDSMagnetOuterFactoryBase::BuildMagnetContainerSolidStraight(), BDSFactoryBase::checkOverlaps, BDSMagnetOuterFactoryBase::CleanUp(), BDSBeamPipe::ContainerIsCircular(), BDSFactoryBase::containerVisAttr, BDSFactoryBase::defaultUserLimits, BDSGeometryComponent::GetContainerLogicalVolume(), BDSBeamPipe::GetContainerRadius(), BDSBeamPipe::GetContainerSubtractionSolid(), BDSMaterials::GetMaterial(), BDSBeamPipeFactory::Instance(), BDSColours::Instance(), BDSGlobalConstants::Instance(), BDSMaterials::Instance(), BDSFactoryBase::lengthSafety, BDSFactoryBase::lengthSafetyLarge, BDSFactoryBase::nSegmentsPerCircle, BDSGeometryComponent::RegisterDaughter(), BDSGeometryComponent::RegisterLogicalVolume(), BDSGeometryComponent::RegisterPhysicalVolume(), BDSGeometryComponent::RegisterRotationMatrix(), BDSGeometryComponent::RegisterSolid(), BDSGeometryComponent::RegisterVisAttributes(), BDSMagnetOuterFactoryBase::SetFaceNormals(), TestInputParameters(), BDSBeamPipeInfo::vacuumMaterial, and BDSMagnetOuterFactoryBase::yokeSolid.

Here is the call graph for this function:

◆ CreateRectangularBend()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateRectangularBend	(	G4String	name,
		G4double	length,
		const BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

rectangular bend outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 987 of file BDSMagnetOuterFactoryLHC.cc.

References CreateSectorBend().

Here is the call graph for this function:

◆ CreateRfCavity()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateRfCavity	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

RF cavity outer volume.

Implements BDSMagnetOuterFactoryBase.

Definition at line 1619 of file BDSMagnetOuterFactoryLHC.cc.

References BDSMagnetOuterFactoryBase::CreateRfCavity(), and cylindrical.

Here is the call graph for this function:

◆ CreateSectorBend()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateSectorBend	(	G4String	name,
		G4double	length,
		const BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

sector bend outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 74 of file BDSMagnetOuterFactoryLHC.cc.

References CreateLHCDipole().

Referenced by CreateRectangularBend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateSextupole()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateSextupole	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)

virtual

sextupole outer volume

Implements BDSMagnetOuterFactoryBase.

Definition at line 1574 of file BDSMagnetOuterFactoryLHC.cc.

References BDSMagnetOuterFactoryBase::CreateSextupole(), and cylindrical.

Here is the call graph for this function:

◆ CreateSolenoid()

BDSMagnetOuter * BDSMagnetOuterFactoryLHC::CreateSolenoid	(	G4String	name,
		G4double	length,
		BDSBeamPipe *	beamPipe,
		G4double	containerLength,
		const BDSMagnetOuterInfo *	recipe
	)