BDSCollimatorJawTip Class Reference

Collimator with jaws having a bulk material and a tip of a different material. More...

#include <BDSCollimatorJawTip.hh>

Inheritance diagram for BDSCollimatorJawTip:

Collaboration diagram for BDSCollimatorJawTip:

Public Member Functions
	BDSCollimatorJawTip (const G4String &nameIn, G4double lengthIn, G4double horizontalWidthIn, G4double xHalfGapIn, G4double yHalfHeightIn, G4double xsizeLeftIn, G4double xsizeRightIn, G4double leftJawTiltIn, G4double rightJawTiltIn, G4double tipThicknessIn, G4bool buildLeftJawIn, G4bool buildRightJawIn, G4Material *collimatorMaterialIn, G4Material *collimatorTipMaterialIn, G4Material *vacuumMaterialIn, G4Colour *colourIn=nullptr, G4Colour *tipColourIn=nullptr)
BDSCollimatorJawTip &	operator= (const BDSCollimatorJawTip &)=delete
	Assignment and copy constructor not implemented nor used.
	BDSCollimatorJawTip (BDSCollimatorJawTip &)=delete
	Assignment and copy constructor not implemented nor used.
Public Member Functions inherited from BDSCollimatorJaw
	BDSCollimatorJaw (const G4String &nameIn, G4double lengthIn, G4double horizontalWidthIn, G4double xHalfGapIn, G4double yHalfHeightIn, G4double xsizeLeftIn, G4double xsizeRightIn, G4double leftJawTiltIn, G4double rightJawTiltIn, G4bool buildLeftJawIn, G4bool buildRightJawIn, G4Material *collimatorMaterialIn, G4Material *vacuumMaterialIn, G4Colour *colourIn=nullptr, const G4String &objectType="jcol")
G4double	GetJawTiltLeft () const
G4double	GetJawTiltRight () const
Public Member Functions inherited from BDSCollimator
	BDSCollimator (const G4String &name, G4double length, G4double horizontalWidth, const G4String &type, G4Material *collimatorMaterial, G4Material *vacuumMaterial, G4double xApertureIn=0, G4double yApertureIn=0, G4double xApertureOutIn=0, G4double yApertureOutIn=0, G4Colour *colourIn=nullptr, G4bool circularOuterIn=false)
virtual void	SetMinimumKineticEnergy (G4double minimimumKineticEnergyIn)
BDSCollimator &	operator= (const BDSCollimator &)=delete
	Assignment and copy constructor not implemented nor used.
	BDSCollimator (BDSCollimator &)=delete
	Assignment and copy constructor not implemented nor used.
virtual G4String	Material () const
	Accessor.
virtual G4double	XApertureIn () const
	Accessor.
virtual G4double	XApertureOut () const
	Accessor.
virtual G4double	YApertureIn () const
	Accessor.
virtual G4double	YApertureOut () const
	Accessor.
Public Member Functions inherited from BDSAcceleratorComponent
	BDSAcceleratorComponent (const G4String &name, G4double arcLength, G4double angle, const G4String &type, BDSBeamPipeInfo *beamPipeInfo=nullptr, const G4ThreeVector &inputFaceNormalIn=G4ThreeVector(0, 0,-1), const G4ThreeVector &outputFaceNormalIn=G4ThreeVector(0, 0, 1), BDSFieldInfo *fieldInfoIn=nullptr)
virtual void	Initialise ()
virtual void	SetRegion (const G4String &regionIn)
	Set the region name for this component.
void	SetField (BDSFieldInfo *fieldInfoIn)
	Set the field definition for the whole component.
virtual G4String	GetName () const
	The name of the component without modification.
G4double	GetAngle () const
G4double	Sagitta () const
	Calculate the sagitta - ie the distance between the chord and the arc at the centre.
G4String	GetType () const
	Get a string describing the type of the component.
G4String	GetRegion () const
	Get the region name for this component.
virtual G4bool	HasAField () const
	Whether this component has a field or not (ie is active). Implicit cast of pointer to bool.
virtual void	SetFieldUsePlacementWorldTransform ()
BDSBeamPipeInfo *	GetBeamPipeInfo () const
virtual std::set< G4LogicalVolume * >	GetAcceleratorVacuumLogicalVolumes () const
	Access the 'vacuum' volume(s) in this component if any. Default is empty set.
virtual std::set< G4LogicalVolume * >	GetAcceleratorMaterialLogicalVolumes () const
	Return a set of logical volumes excluding the ones in the 'vacuum' set.
void	IncrementCopyNumber ()
	Increment (+1) the number of times this component has been copied.
G4int	GetCopyNumber () const
	Get the number of times this component has been copied.
BDSSimpleComponent *	EndPieceBefore () const
BDSSimpleComponent *	EndPieceAfter () const
virtual void	SetBiasVacuumList (const std::list< std::string > &biasVacuumListIn)
	Copy the bias list to this element.
virtual void	SetBiasMaterialList (const std::list< std::string > &biasMaterialListIn)
	Copy the bias list to this element.
virtual void	SetBiasMaterialLVList (const std::list< std::string > &biasMaterialLVListIn)
	Copy the bias list to this element.
virtual G4double	GetArcLength () const
virtual G4double	GetChordLength () const
G4ThreeVector	InputFaceNormal () const
G4ThreeVector	OutputFaceNormal () const
G4bool	AngledInputFace () const
	Whether the face normal is angled at all w.r.t. the incoming / outgoing reference trajectory.
G4bool	AngledOutputFace () const
	Whether the face normal is angled at all w.r.t. the incoming / outgoing reference trajectory.
std::list< std::string >	GetBiasVacuumList () const
	Access the bias list copied from parser.
std::list< std::string >	GetBiasMaterialList () const
	Access the bias list copied from parser.
std::list< std::string >	GetBiasMaterialLVList () const
	Access the bias list copied from parser.
virtual void	SetInputFaceNormal (const G4ThreeVector &input)
	Allow updating of face normals. Virtual so derived class may apply it to daughters.
virtual void	SetOutputFaceNormal (const G4ThreeVector &output)
	Allow updating of face normals. Virtual so derived class may apply it to daughters.
Public Member Functions inherited from BDSGeometryComponent
	BDSGeometryComponent (G4VSolid *containerSolidIn, G4LogicalVolume *containerLVIn, const BDSExtent &extentIn=BDSExtent(), const BDSExtent &innerExtentIn=BDSExtent(), const G4ThreeVector &placementOffsetIn=G4ThreeVector(0, 0, 0), G4RotationMatrix *placementRotationIn=nullptr)
	BDSGeometryComponent (G4AssemblyVolume *containerAssemblyIn, const BDSExtent &extentIn=BDSExtent(), const BDSExtent &innerExtentIn=BDSExtent(), const G4ThreeVector &placementOffsetIn=G4ThreeVector(0, 0, 0), G4RotationMatrix *placementRotationIn=nullptr)
	BDSGeometryComponent (const BDSGeometryComponent &component)
	Copy constructor (no copying of registered objects)
BDSGeometryComponent &	operator= (const BDSGeometryComponent &)=delete
	Assignment operator not used.
G4bool	ContainerIsAssembly () const
	Whether the container is an assembly. If not, it's a logical volume.
void	SetPlacementOffset (const G4ThreeVector &offsetIn)
	Set the offset from 0,0,0 that the object should ideally be placed in its parent.
G4ThreeVector	GetExtentPositive () const
	Get the extent of the object in the positive direction in all dimensions.
G4ThreeVector	GetExtentNegative () const
	Get the extent of the object in the negative direction in all dimensions.
void	InheritExtents (BDSGeometryComponent const *const anotherComponent)
	Update the extents of this object with those of another object.
void	InheritExtents (BDSGeometryComponent const *const anotherComponent, const G4ThreeVector &offset)
void	RegisterDaughter (BDSGeometryComponent *anotherComponent)
void	RegisterSolid (G4VSolid *solid)
void	RegisterSolid (const std::set< G4VSolid * > &solids)
	Similarly for a set of unique solids.
void	RegisterLogicalVolume (G4LogicalVolume *logicalVolume)
void	RegisterLogicalVolume (const std::set< G4LogicalVolume * > &localVolumes)
	Apply RegisterLogicalVolume() to a set of logical volumes.
void	RegisterSensitiveVolume (G4LogicalVolume *sensitiveVolume, BDSSDType sensitivityType)
void	RegisterSensitiveVolume (const std::set< G4LogicalVolume * > &sensitiveVolumes, BDSSDType sensitivityType)
void	RegisterSensitiveVolume (const std::map< G4LogicalVolume *, BDSSDType > &sensitiveVolumes)
	Copy in a mapping of sensitive volumes to sensitive detectors.
void	RegisterPhysicalVolume (G4VPhysicalVolume *physicalVolume)
void	RegisterPhysicalVolume (const std::set< G4VPhysicalVolume * > &physicalVolumes)
	Apply RegisterPhysicalVolume() to a set of physical volumes.
void	RegisterRotationMatrix (G4RotationMatrix *rotationMatrix)
void	RegisterRotationMatrix (const std::set< G4RotationMatrix * > &rotationMatrices)
	Apply Register RotationMatrix() to a set of rotation matrices.
void	RegisterVisAttributes (G4VisAttributes *visAttribute)
void	RegisterVisAttributes (const std::set< G4VisAttributes * > &visAttributes)
	Apply RegisterVisAttribute() to a set of visualisation attributes.
void	RegisterUserLimits (G4UserLimits *userLimit)
void	RegisterUserLimits (const std::set< G4UserLimits * > &userLimits)
	Apply RegisterUserLimit to a set of user limits.
void	InheritObjects (BDSGeometryComponent *component)
virtual std::set< G4LogicalVolume * >	GetAllLogicalVolumes () const
	Access all logical volumes belonging to this component.
virtual std::set< G4LogicalVolume * >	GetAllBiasingVolumes () const
	Return all logical volumes that should be used for biasing minus any that are in the excluded set.
virtual std::map< G4LogicalVolume *, BDSSDType >	GetAllSensitiveVolumes () const
	Access all sensitive volumes belonging to this component.
void	MakeAllVolumesSensitive (BDSSDType stype=BDSSDType::energydep)
virtual void	AttachSensitiveDetectors ()
	Attach a sensitive detector class to all registered sensitive volumes in this component.
virtual void	ExcludeLogicalVolumeFromBiasing (G4LogicalVolume *lv)
void	StripOuterAndMakeAssemblyVolume ()
	Change from a container logical volume to an assembly volume.
G4VSolid *	GetContainerSolid () const
	Accessor - see member for more info.
G4LogicalVolume *	GetContainerLogicalVolume () const
	Accessor - see member for more info.
G4AssemblyVolume *	GetContainerAssemblyVolume () const
	Accessor - see member for more info.
G4Transform3D	GetPlacementTransform () const
	Accessor - see member for more info.
G4ThreeVector	GetPlacementOffset () const
	Accessor - see member for more info.
G4RotationMatrix *	GetPlacementRotation () const
	Accessor - see member for more info.
BDSExtent	GetExtent () const
	Accessor - see member for more info.
BDSExtent	GetInnerExtent () const
	Accessor - see member for more info.
std::pair< G4double, G4double >	GetExtentX () const
	Accessor - see member for more info.
std::pair< G4double, G4double >	GetExtentY () const
	Accessor - see member for more info.
std::pair< G4double, G4double >	GetExtentZ () const
	Accessor - see member for more info.
std::pair< G4double, G4double >	GetInnerExtentX () const
	Accessor - see member for more info.
std::pair< G4double, G4double >	GetInnerExtentY () const
	Accessor - see member for more info.
std::pair< G4double, G4double >	GetInnerExtentZ () const
	Accessor - see member for more info.
virtual std::set< G4VPhysicalVolume * >	GetAllPhysicalVolumes () const
	Accessor - see member for more info.
virtual std::set< G4RotationMatrix * >	GetAllRotationMatrices () const
	Accessor - see member for more info.
virtual std::set< G4VisAttributes * >	GetAllVisAttributes () const
	Accessor - see member for more info.
virtual std::set< G4UserLimits * >	GetAllUserLimits () const
	Accessor - see member for more info.
virtual std::set< BDSGeometryComponent * >	GetAllDaughters () const
	Accessor - see member for more info.
virtual std::set< G4VSolid * >	GetAllSolids () const
	Accessor - see member for more info.
void	SetExtent (const BDSExtent &extIn)
	Set extent.
void	SetInnerExtent (const BDSExtent &extIn)
	Set extent.

Protected Member Functions
void	UpdateCalculations ()
	Adjust the calculated values to include the space for the tips that are separate placements.
void	CheckParametersForTips ()
virtual void	Build () override
	Override function in BDSCollimator for totally different construction.
virtual void	BuildTips ()
Protected Member Functions inherited from BDSCollimatorJaw
void	Calculations ()
	Calculate offsets and sizes.
virtual void	CheckParameters () override
virtual void	BuildContainerLogicalVolume () override
	Override function in BDSCollimator for different size based container.
virtual void	BuildInnerCollimator () final
	To fulfill inheritance but unused.
Protected Member Functions inherited from BDSCollimator
G4UserLimits *	CollimatorUserLimits ()
	Return either default user limits or custom ones based on optional minimumKineticEnergy.
Protected Member Functions inherited from BDSAcceleratorComponent
void	SetAcceleratorVacuumLogicalVolume (G4LogicalVolume *accVacLVIn)
void	SetAcceleratorVacuumLogicalVolume (const std::set< G4LogicalVolume * > &accVacLVIn)
virtual void	BuildUserLimits ()
virtual void	AttachUserLimits () const
	Doesn't change member variables, but may change their contents.

Protected Attributes
G4Colour *	tipColour
G4double	tipThickness
G4Material *	collimatorTipMaterial
G4ThreeVector	leftJawTipPos
G4ThreeVector	rightJawTipPos
Protected Attributes inherited from BDSCollimatorJaw
G4double	xSizeLeft
	Offset of jaw 1.
G4double	xSizeRight
	Offset of jaw 2.
G4double	xHalfGap
	Half gap separation between jaws.
G4double	jawTiltLeft
	Tilt of jaw 1 (angle in x-z plane)
G4double	jawTiltRight
	Tilt of jaw 2 (angle in x-z plane)
G4double	yHalfHeight
	Half height of each jaw.
G4bool	buildLeftJaw
	Build left jaw or not.
G4bool	buildRightJaw
	Build right jaw or not.
G4bool	buildAperture
	Build aperture or not.
G4double	leftJawHalfGap
G4double	rightJawHalfGap
G4double	leftJawWidth
G4double	rightJawWidth
G4double	vacuumWidth
G4ThreeVector	leftJawPos
G4ThreeVector	rightJawPos
G4ThreeVector	vacuumOffset
G4LogicalVolume *	collimatorLV
	In case of no aperture, cache this volume for derived classes to place inside.
Protected Attributes inherited from BDSCollimator
G4double	horizontalWidth
	Horizontal width.
G4Material *	collimatorMaterial
	Material.
G4Material *	vacuumMaterial
	Vacuum material.
G4double	xAperture
	Aperture at entrance in x dimension.
G4double	yAperture
	Aperture at entrance in y dimension.
G4double	xApertureOut
	Aperture at exit in x dimension.
G4double	yApertureOut
	Aperture at exit in y dimension.
G4bool	tapered
	Flag for tapered collimator.
G4Colour *	colour
	Colour of collimator.
G4double	minKineticEnergy
	Optional minimum kinetic energy for collimator materials.
G4bool	circularOuter
	Aperture type of the collimator.
G4bool	collimatorTypeSensitivity
	Whether to use special collimator hits or not.
G4VSolid *	collimatorSolid
	Geometrical objects:
G4VSolid *	innerSolid
	Geometrical objects:
G4VSolid *	vacuumSolid
	Geometrical objects:
Protected Attributes inherited from BDSAcceleratorComponent
BDSBeamPipeInfo *	beamPipeInfo
	Optional beam pipe recipe that is written out to the survey if it exists.
std::set< G4LogicalVolume * >	acceleratorVacuumLV
	A set of logical volumes we classify as 'vacuum' for biasing purposes.
BDSSimpleComponent *	endPieceBefore
BDSSimpleComponent *	endPieceAfter
G4UserLimits *	userLimits
	Cache of user limits.
BDSFieldInfo *	fieldInfo
	Recipe for field that could overlay this whole component.
const G4String	name
	Const protected member variable that may not be changed by derived classes.
const G4double	arcLength
	Const protected member variable that may not be changed by derived classes.
const G4String	type
	Const protected member variable that may not be changed by derived classes.
G4double	chordLength
	Protected member variable that can be modified by derived classes.
G4double	angle
	Protected member variable that can be modified by derived classes.
G4String	region
	Protected member variable that can be modified by derived classes.
Protected Attributes inherited from BDSGeometryComponent
G4bool	containerIsAssembly
	True if the 'container' is really an assembly; false if an LV.
G4VSolid *	containerSolid
G4LogicalVolume *	containerLogicalVolume
G4AssemblyVolume *	containerAssembly
BDSExtent	outerExtent
BDSExtent	innerExtent
std::set< BDSGeometryComponent * >	allDaughters
	registry of all daughter geometry components
std::set< G4VSolid * >	allSolids
	registry of all solids belonging to this component
std::set< G4LogicalVolume * >	allLogicalVolumes
std::map< G4LogicalVolume *, BDSSDType >	sensitivity
G4bool	overrideSensitivity
std::set< G4VPhysicalVolume * >	allPhysicalVolumes
	registry of all physical volumes belonging to this component
std::set< G4RotationMatrix * >	allRotationMatrices
	registry of all rotation matrices belonging to this component
std::set< G4VisAttributes * >	allVisAttributes
	registry of all visualisation attributes belonging to this component
std::set< G4UserLimits * >	allUserLimits
	registry of all user limits belonging to this component
G4ThreeVector	placementOffset
G4RotationMatrix *	placementRotation
std::set< G4LogicalVolume * > *	lvsExcludedFromBiasing
	Volumes that should not be included when return GetAllBiasingVolumes().

Additional Inherited Members
Static Public Member Functions inherited from BDSGeometryComponent
static void	AttachUserLimitsToAssembly (G4AssemblyVolume *av, G4UserLimits *ul)
	Utility function to apply user limits to an assembly volume as there's not interface.
Static Public Attributes inherited from BDSAcceleratorComponent
static G4double	lengthSafetyLarge = 0
Static Protected Attributes inherited from BDSAcceleratorComponent
static G4double	lengthSafety = -1
	Useful variable often used in construction.
static G4Material *	emptyMaterial = nullptr
	Useful variable often used in construction.
static G4Material *	worldMaterial = nullptr
	Useful variable often used in construction.
static G4bool	checkOverlaps = false
	Useful variable often used in construction.
static G4bool	sensitiveOuter = true
	Useful variable often used in construction.
static G4bool	sensitiveVacuum = false
	Useful variable often used in construction.
static G4VisAttributes *	containerVisAttr = nullptr
	Useful variable often used in construction.

Detailed Description

Collimator with jaws having a bulk material and a tip of a different material.

@autor Giacomo Broggi

Definition at line 36 of file BDSCollimatorJawTip.hh.

Constructor & Destructor Documentation

BDSCollimatorJawTip()

BDSCollimatorJawTip::BDSCollimatorJawTip	(	const G4String &	nameIn,
		G4double	lengthIn,
		G4double	horizontalWidthIn,
		G4double	xHalfGapIn,
		G4double	yHalfHeightIn,
		G4double	xsizeLeftIn,
		G4double	xsizeRightIn,
		G4double	leftJawTiltIn,
		G4double	rightJawTiltIn,
		G4double	tipThicknessIn,
		G4bool	buildLeftJawIn,
		G4bool	buildRightJawIn,
		G4Material *	collimatorMaterialIn,
		G4Material *	collimatorTipMaterialIn,
		G4Material *	vacuumMaterialIn,
		G4Colour *	colourIn = nullptr,
		G4Colour *	tipColourIn = nullptr
	)

Definition at line 37 of file BDSCollimatorJawTip.cc.

~BDSCollimatorJawTip()

BDSCollimatorJawTip::~BDSCollimatorJawTip ( )

virtual

Definition at line 69 of file BDSCollimatorJawTip.cc.

Member Function Documentation

Build()

void BDSCollimatorJawTip::Build ( )

overrideprotectedvirtual

Override function in BDSCollimator for totally different construction.

Reimplemented from BDSCollimatorJaw.

Definition at line 109 of file BDSCollimatorJawTip.cc.

References BDSCollimatorJaw::Build(), and CheckParametersForTips().

Here is the call graph for this function:

BuildTips()

void BDSCollimatorJawTip::BuildTips ( )

protectedvirtual

Definition at line 116 of file BDSCollimatorJawTip.cc.

CheckParametersForTips()

void BDSCollimatorJawTip::CheckParametersForTips ( )

protected

Check and update parameters before construction. Called at the start of Build() as we can't call a virtual function in a constructor.

Definition at line 88 of file BDSCollimatorJawTip.cc.

References BDSCollimatorJaw::buildAperture, BDSCollimatorJaw::buildLeftJaw, BDSCollimatorJaw::buildRightJaw, BDSCollimator::horizontalWidth, BDSAcceleratorComponent::lengthSafety, and BDSAcceleratorComponent::name.

Referenced by Build().

Here is the caller graph for this function:

UpdateCalculations()

void BDSCollimatorJawTip::UpdateCalculations ( )

protected

Adjust the calculated values to include the space for the tips that are separate placements.

Definition at line 72 of file BDSCollimatorJawTip.cc.

References BDSCollimatorJaw::Calculations(), and BDSAcceleratorComponent::lengthSafety.

Here is the call graph for this function:

Field Documentation

collimatorTipMaterial

G4Material* BDSCollimatorJawTip::collimatorTipMaterial

protected

Definition at line 79 of file BDSCollimatorJawTip.hh.

leftJawTipPos

G4ThreeVector BDSCollimatorJawTip::leftJawTipPos

protected

Definition at line 80 of file BDSCollimatorJawTip.hh.

rightJawTipPos

G4ThreeVector BDSCollimatorJawTip::rightJawTipPos

protected

Definition at line 81 of file BDSCollimatorJawTip.hh.

tipColour

G4Colour* BDSCollimatorJawTip::tipColour

protected

Definition at line 77 of file BDSCollimatorJawTip.hh.

tipThickness

G4double BDSCollimatorJawTip::tipThickness

protected

Definition at line 78 of file BDSCollimatorJawTip.hh.

---

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

• /__w/bdsim/bdsim/include/BDSCollimatorJawTip.hh
• /__w/bdsim/bdsim/src/BDSCollimatorJawTip.cc