Construction of the geometry in the case of a link model. More...

#include <BDSLinkDetectorConstruction.hh>

Inheritance diagram for BDSLinkDetectorConstruction:

Collaboration diagram for BDSLinkDetectorConstruction:

Public Member Functions
	BDSLinkDetectorConstruction ()
	Default constructor.

virtual G4VPhysicalVolume *	Construct ()

G4int	AddLinkCollimatorJaw (const std::string &collimatorName, const std::string &materialName, G4double length, G4double halfApertureLeft, G4double halfApertureRight, G4double rotation, G4double xOffset, G4double yOffset, G4double jawTiltLeft=0.0, G4double jawTiltRight=0.0, G4bool buildLeftJaw=true, G4bool buildRightJaw=true, G4bool isACrystal=false, G4double crystalAngle=0, G4bool sampleIn=false)
	Interface to append a collimator of jaw style to the linking.

G4int	AddLinkCollimatorTipJaw (const std::string &collimatorName, const std::string &materialName, const std::string &tipMaterialName, G4double tipThickness, G4double length, G4double halfApertureLeft, G4double halfApertureRight, G4double rotation, G4double xOffset, G4double yOffset, G4double jawTiltLeft=0.0, G4double jawTiltRight=0.0, G4bool buildLeftJaw=true, G4bool buildRightJaw=true)
	Interface to append a tip collimator jaw to the linking.

G4int	AddLinkElement (GMAD::Element el)
	Interface to append an element.

void	SetDesignParticle (const BDSParticleDefinition *defIn)
	Set the design particle definition.

void	SetPrimaryGeneratorAction (BDSLinkPrimaryGeneratorAction *pgIn)

void	BuildPhysicsBias ()

const std::map< std::string, G4int > &	NameToElementIndex () const

const std::map< int, int > &	LinkIDToBeamlineIndex () const

G4int	NumberOfElements () const

void	SetSamplerWorldID (G4int samplerWorldIDIn)

const BDSBeamline *	LinkBeamline () const


BDSExtent	WorldExtent () const
	Accessor.

BDSLinkRegistry *	LinkRegistry () const
	Accessor.

Private Member Functions
void	UpdateWorldSolid ()

G4int	PlaceOneComponent (const BDSBeamlineElement *element, const G4String &originalName)
	Place a beam line element in the world.

Private Attributes
G4Box *	worldSolid

G4VPhysicalVolume *	worldPV

BDSExtent	worldExtent

BDSBeamline *	linkBeamline

BDSLinkRegistry *	linkRegistry

BDSLinkPrimaryGeneratorAction *	primaryGeneratorAction

const BDSParticleDefinition *	designParticle
	Particle definition all components are built w.r.t. Includes rigidity etc.

G4ChannelingOptrMultiParticleChangeCrossSection *	crystalBiasing

G4int	samplerWorldID
	Cache of the index to which parallel world the sampler one is.

BDSBeamlineIntegral *	integral

std::map< std::string, G4int >	nameToElementIndex
	Build up a copy here too.

std::map< G4int, G4int >	linkIDToBeamlineIndex
	Special linkID to linkBeamline index.

Detailed Description

Construction of the geometry in the case of a link model.

Author: Laurie Nevay

Definition at line 52 of file BDSLinkDetectorConstruction.hh.

Constructor & Destructor Documentation

◆ BDSLinkDetectorConstruction()

BDSLinkDetectorConstruction::BDSLinkDetectorConstruction ( )

Default constructor.

Definition at line 67 of file BDSLinkDetectorConstruction.cc.

References BDSSDManager::SetLinkRegistry().

Here is the call graph for this function:

◆ ~BDSLinkDetectorConstruction()

BDSLinkDetectorConstruction::~BDSLinkDetectorConstruction ( )

virtual

Definition at line 84 of file BDSLinkDetectorConstruction.cc.

Member Function Documentation

◆ AddLinkCollimatorJaw()

G4int BDSLinkDetectorConstruction::AddLinkCollimatorJaw	(	const std::string &	collimatorName,
		const std::string &	materialName,
		G4double	length,
		G4double	halfApertureLeft,
		G4double	halfApertureRight,
		G4double	rotation,
		G4double	xOffset,
		G4double	yOffset,
		G4double	jawTiltLeft = `0.0`,
		G4double	jawTiltRight = `0.0`,
		G4bool	buildLeftJaw = `true`,
		G4bool	buildRightJaw = `true`,
		G4bool	isACrystal = `false`,
		G4double	crystalAngle = `0`,
		G4bool	sampleIn = `false`
	)

Interface to append a collimator of jaw style to the linking.

Definition at line 187 of file BDSLinkDetectorConstruction.cc.

References BDSBeamline::AddComponent(), GMAD::Element::aper1, GMAD::Element::apertureType, BDSBeamline::back(), BDSCrystalInfo::bendingAngleYAxis, designParticle, BDSExtent::DZ(), BDSGeometryComponent::GetExtent(), BDSAcceleratorComponent::GetName(), BDSGeometryComponent::GetName(), GMAD::Element::jawTiltRight, GMAD::Element::l, linkIDToBeamlineIndex, BDS::LowerCase(), nameToElementIndex, GMAD::Element::offsetX, GMAD::Element::offsetY, PlaceOneComponent(), GMAD::Element::region, BDSBeamline::size(), GMAD::Element::tilt, BDSExtent::TiltOffset(), BDSExtent::TransverseBoundingRadius(), GMAD::Element::type, UpdateWorldSolid(), BDSException::what(), GMAD::Element::xsizeRight, and GMAD::Element::ysize.

Referenced by BDSIMLink::AddLinkCollimatorJaw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddLinkCollimatorTipJaw()

G4int BDSLinkDetectorConstruction::AddLinkCollimatorTipJaw	(	const std::string &	collimatorName,
		const std::string &	materialName,
		const std::string &	tipMaterialName,
		G4double	tipThickness,
		G4double	length,
		G4double	halfApertureLeft,
		G4double	halfApertureRight,
		G4double	rotation,
		G4double	xOffset,
		G4double	yOffset,
		G4double	jawTiltLeft = `0.0`,
		G4double	jawTiltRight = `0.0`,
		G4bool	buildLeftJaw = `true`,
		G4bool	buildRightJaw = `true`
	)

Interface to append a tip collimator jaw to the linking.

Definition at line 350 of file BDSLinkDetectorConstruction.cc.

References BDSBeamline::AddComponent(), GMAD::Element::apertureType, BDSBeamline::back(), designParticle, BDSExtent::DZ(), BDSGeometryComponent::GetExtent(), BDSAcceleratorComponent::GetName(), BDSGeometryComponent::GetName(), GMAD::Element::jawTiltRight, GMAD::Element::l, linkIDToBeamlineIndex, nameToElementIndex, GMAD::Element::offsetX, GMAD::Element::offsetY, PlaceOneComponent(), GMAD::Element::region, BDSBeamline::size(), GMAD::Element::tilt, BDSExtent::TiltOffset(), GMAD::Element::tipMaterial, GMAD::Element::tipThickness, BDSExtent::TransverseBoundingRadius(), GMAD::Element::type, UpdateWorldSolid(), BDSException::what(), GMAD::Element::xsizeRight, and GMAD::Element::ysize.

Referenced by BDSIMLink::AddLinkCollimatorTipJaw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddLinkElement()

G4int BDSLinkDetectorConstruction::AddLinkElement ( GMAD::Element el )

Interface to append an element.

Definition at line 446 of file BDSLinkDetectorConstruction.cc.

References BDSBeamline::AddComponent(), GMAD::Element::apertureType, BDSBeamline::back(), designParticle, BDSExtent::DZ(), BDSGeometryComponent::GetExtent(), BDSAcceleratorComponent::GetName(), BDSGeometryComponent::GetName(), linkIDToBeamlineIndex, nameToElementIndex, GMAD::Element::offsetX, GMAD::Element::offsetY, PlaceOneComponent(), BDSBeamline::size(), GMAD::Element::tilt, BDSExtent::TiltOffset(), BDSExtent::TransverseBoundingRadius(), GMAD::Element::type, UpdateWorldSolid(), and BDSException::what().

Referenced by BDSIMLink::AddLinkElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BuildPhysicsBias()

void BDSLinkDetectorConstruction::BuildPhysicsBias ( )

Definition at line 565 of file BDSLinkDetectorConstruction.cc.

◆ Construct()

G4VPhysicalVolume * BDSLinkDetectorConstruction::Construct ( )

virtual

Definition at line 94 of file BDSLinkDetectorConstruction.cc.

◆ LinkBeamline()

const BDSBeamline * BDSLinkDetectorConstruction::LinkBeamline ( ) const

inline

Definition at line 112 of file BDSLinkDetectorConstruction.hh.

◆ LinkIDToBeamlineIndex()

const std::map< int, int > & BDSLinkDetectorConstruction::LinkIDToBeamlineIndex ( ) const

inline

Definition at line 109 of file BDSLinkDetectorConstruction.hh.

◆ LinkRegistry()

BDSLinkRegistry * BDSLinkDetectorConstruction::LinkRegistry ( ) const

inline

Accessor.

Definition at line 103 of file BDSLinkDetectorConstruction.hh.

Referenced by BDSLinkPrimaryGeneratorAction::GeneratePrimaries().

Here is the caller graph for this function:

◆ NameToElementIndex()

const std::map< std::string, G4int > & BDSLinkDetectorConstruction::NameToElementIndex ( ) const

inline

Definition at line 108 of file BDSLinkDetectorConstruction.hh.

◆ NumberOfElements()

G4int BDSLinkDetectorConstruction::NumberOfElements ( ) const

inline

Definition at line 110 of file BDSLinkDetectorConstruction.hh.

◆ PlaceOneComponent()

G4int BDSLinkDetectorConstruction::PlaceOneComponent	(	const BDSBeamlineElement *	element,
		const G4String &	originalName
	)

private

Place a beam line element in the world.

Definition at line 521 of file BDSLinkDetectorConstruction.cc.

References BDSSamplerPlane::ChordLength(), BDSLinkComponent::Component(), BDSBeamlineElement::GetAcceleratorComponent(), BDSGeometryComponent::GetContainerLogicalVolume(), BDSBeamlineElement::GetCopyNo(), BDSBeamlineElement::GetPlacementName(), BDSBeamlineElement::GetPlacementTransform(), BDSBeamlineElement::GetSamplerType(), BDSBeamlineElement::GetSPositionStart(), BDSGlobalConstants::Instance(), BDSSamplerRegistry::Instance(), BDSBeamlineElement::PlaceElement(), BDSSamplerRegistry::RegisterSampler(), and samplerWorldID.

Referenced by AddLinkCollimatorJaw(), AddLinkCollimatorTipJaw(), and AddLinkElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDesignParticle()

void BDSLinkDetectorConstruction::SetDesignParticle ( const BDSParticleDefinition * defIn )

inline

Set the design particle definition.

Definition at line 97 of file BDSLinkDetectorConstruction.hh.

References designParticle.

Referenced by BDSIMLink::Initialise().

Here is the caller graph for this function:

◆ SetPrimaryGeneratorAction()

void BDSLinkDetectorConstruction::SetPrimaryGeneratorAction ( BDSLinkPrimaryGeneratorAction * pgIn )

inline

Definition at line 98 of file BDSLinkDetectorConstruction.hh.

◆ SetSamplerWorldID()

void BDSLinkDetectorConstruction::SetSamplerWorldID ( G4int samplerWorldIDIn )

inline

Definition at line 111 of file BDSLinkDetectorConstruction.hh.

◆ UpdateWorldSolid()

void BDSLinkDetectorConstruction::UpdateWorldSolid ( )

private

Create the worldSolid if it doesn't exist and if not expand it to the extent of the linkBeamline member. Update worldExtent member also.

Definition at line 496 of file BDSLinkDetectorConstruction.cc.

References BDSExtentGlobal::ExpandToEncompass(), BDSBeamline::GetExtentGlobal(), BDSExtentGlobal::GetMaximumExtentAbsolute(), and BDSLinkPrimaryGeneratorAction::SetWorldExtent().

Referenced by AddLinkCollimatorJaw(), AddLinkCollimatorTipJaw(), and AddLinkElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WorldExtent()

BDSExtent BDSLinkDetectorConstruction::WorldExtent ( ) const

inline

Accessor.

Definition at line 102 of file BDSLinkDetectorConstruction.hh.

Field Documentation

◆ crystalBiasing

G4ChannelingOptrMultiParticleChangeCrossSection* BDSLinkDetectorConstruction::crystalBiasing

private

Definition at line 133 of file BDSLinkDetectorConstruction.hh.

◆ designParticle

const BDSParticleDefinition* BDSLinkDetectorConstruction::designParticle

private

Particle definition all components are built w.r.t. Includes rigidity etc.

Definition at line 130 of file BDSLinkDetectorConstruction.hh.

Referenced by AddLinkCollimatorJaw(), AddLinkCollimatorTipJaw(), AddLinkElement(), and SetDesignParticle().

◆ integral

BDSBeamlineIntegral* BDSLinkDetectorConstruction::integral

private

Definition at line 139 of file BDSLinkDetectorConstruction.hh.

◆ linkBeamline

BDSBeamline* BDSLinkDetectorConstruction::linkBeamline

private

Definition at line 125 of file BDSLinkDetectorConstruction.hh.

◆ linkIDToBeamlineIndex

std::map<G4int, G4int> BDSLinkDetectorConstruction::linkIDToBeamlineIndex

private

Special linkID to linkBeamline index.

Definition at line 142 of file BDSLinkDetectorConstruction.hh.

Referenced by AddLinkCollimatorJaw(), AddLinkCollimatorTipJaw(), and AddLinkElement().

◆ linkRegistry

BDSLinkRegistry* BDSLinkDetectorConstruction::linkRegistry

private

Definition at line 126 of file BDSLinkDetectorConstruction.hh.

◆ nameToElementIndex

std::map<std::string, G4int> BDSLinkDetectorConstruction::nameToElementIndex

private

Build up a copy here too.

Definition at line 141 of file BDSLinkDetectorConstruction.hh.

Referenced by AddLinkCollimatorJaw(), AddLinkCollimatorTipJaw(), and AddLinkElement().

◆ primaryGeneratorAction

BDSLinkPrimaryGeneratorAction* BDSLinkDetectorConstruction::primaryGeneratorAction

private

Definition at line 127 of file BDSLinkDetectorConstruction.hh.

◆ samplerWorldID

G4int BDSLinkDetectorConstruction::samplerWorldID

private

Cache of the index to which parallel world the sampler one is.

Definition at line 137 of file BDSLinkDetectorConstruction.hh.

Referenced by PlaceOneComponent().

◆ worldExtent

BDSExtent BDSLinkDetectorConstruction::worldExtent

private

Definition at line 124 of file BDSLinkDetectorConstruction.hh.

◆ worldPV

G4VPhysicalVolume* BDSLinkDetectorConstruction::worldPV

private

Definition at line 123 of file BDSLinkDetectorConstruction.hh.

◆ worldSolid

G4Box* BDSLinkDetectorConstruction::worldSolid

private

Definition at line 122 of file BDSLinkDetectorConstruction.hh.

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

/__w/bdsim/bdsim/include/BDSLinkDetectorConstruction.hh
/__w/bdsim/bdsim/src/BDSLinkDetectorConstruction.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BDSLinkDetectorConstruction()

◆ ~BDSLinkDetectorConstruction()

Member Function Documentation

◆ AddLinkCollimatorJaw()

◆ AddLinkCollimatorTipJaw()

◆ AddLinkElement()

◆ BuildPhysicsBias()

◆ Construct()

◆ LinkBeamline()

◆ LinkIDToBeamlineIndex()

◆ LinkRegistry()

◆ NameToElementIndex()

◆ NumberOfElements()

◆ PlaceOneComponent()

◆ SetDesignParticle()

◆ SetPrimaryGeneratorAction()

◆ SetSamplerWorldID()

◆ UpdateWorldSolid()

◆ WorldExtent()

Field Documentation

◆ crystalBiasing

◆ designParticle

◆ integral

◆ linkBeamline

◆ linkIDToBeamlineIndex

◆ linkRegistry

◆ nameToElementIndex

◆ primaryGeneratorAction

◆ samplerWorldID

◆ worldExtent

◆ worldPV

◆ worldSolid