BDSGaborLens Class Reference

Gabor lens based on prototype design at Imperial College (https://doi.org/10.3390/app11104357) More...

#include <BDSGaborLens.hh>

Inheritance diagram for BDSGaborLens:

Collaboration diagram for BDSGaborLens:

Public Member Functions
	BDSGaborLens (const G4String &nameIn, G4double lengthIn, G4double horizontalWidthIn, G4double anodeLengthIn, G4Material *anodeMaterialIn, G4double anodeRadiusIn, G4double anodeThicknessIn, G4double electrodeLengthIn, G4Material *electrodeMaterialIn, G4double electrodeRadiusIn, G4double electrodeThicknessIn, G4Material *outerMaterialIn, G4Colour *colourIn, BDSBeamPipeInfo *beamPipeInfoIn=nullptr, BDSFieldInfo *vacuumFieldInfoIn=nullptr)
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 void	SetMinimumKineticEnergy (G4double)
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 G4String	Material () const
	Return the name of a material associated with the component - ie the primary material.
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
virtual void	Build ()
virtual void	BuildContainerLogicalVolume ()
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
G4double	horizontalWidth
G4double	anodeRadius
G4double	anodeLength
G4Material *	anodeMaterial
G4double	anodeThickness
G4double	electrodeRadius
G4double	electrodeLength
G4Material *	electrodeMaterial
G4double	electrodeThickness
G4Material *	outerMaterial
G4Colour *	colour
BDSFieldInfo *	vacuumFieldInfo
G4double	vacuumLength
G4double	endcapsLength
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().

Private Member Functions
	BDSGaborLens ()=delete
	total length of both end caps
void	BuildBeamPipe ()
	Build the beam pipe.
void	BuildOuter ()
	Build the outer volume.
BDSGaborLens &	operator= (const BDSGaborLens &)=delete
	Assignment and copy constructor not implemented nor used.
	BDSGaborLens (BDSGaborLens &)=delete
	Assignment and copy constructor not implemented nor used.

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

Gabor lens based on prototype design at Imperial College (https://doi.org/10.3390/app11104357)

Author

Will Shields

Definition at line 34 of file BDSGaborLens.hh.

Constructor & Destructor Documentation

BDSGaborLens() [1/2]

BDSGaborLens::BDSGaborLens	(	const G4String &	nameIn,
		G4double	lengthIn,
		G4double	horizontalWidthIn,
		G4double	anodeLengthIn,
		G4Material *	anodeMaterialIn,
		G4double	anodeRadiusIn,
		G4double	anodeThicknessIn,
		G4double	electrodeLengthIn,
		G4Material *	electrodeMaterialIn,
		G4double	electrodeRadiusIn,
		G4double	electrodeThicknessIn,
		G4Material *	outerMaterialIn,
		G4Colour *	colourIn,
		BDSBeamPipeInfo *	beamPipeInfoIn = nullptr,
		BDSFieldInfo *	vacuumFieldInfoIn = nullptr
	)

Definition at line 50 of file BDSGaborLens.cc.

~BDSGaborLens()

BDSGaborLens::~BDSGaborLens ( )

virtual

Definition at line 125 of file BDSGaborLens.cc.

BDSGaborLens() [2/2]

BDSGaborLens::BDSGaborLens ( )

privatedelete

total length of both end caps

Private default constructor to force the use of the supplied one.

Member Function Documentation

Build()

void BDSGaborLens::Build ( )

protectedvirtual

This calls BuildContainerLogicalVolume() and then sets the visual attributes of the container logical volume. This should be overridden by derived class to add more geometry apart from the container volume. The overridden Build() function can however, call make use of this function to call BuildContainerLogicalVolume() by calling BDSAcceleratorComponent::Build() at the beginning.

Reimplemented from BDSAcceleratorComponent.

Definition at line 140 of file BDSGaborLens.cc.

References BDSAcceleratorComponent::Build(), BuildBeamPipe(), and BuildOuter().

Here is the call graph for this function:

BuildBeamPipe()

void BDSGaborLens::BuildBeamPipe ( )

private

Build the beam pipe.

Definition at line 248 of file BDSGaborLens.cc.

References BDSAcceleratorComponent::beamPipeInfo, BDSAcceleratorComponent::checkOverlaps, BDSAcceleratorComponent::chordLength, BDSAcceleratorComponent::GetAcceleratorVacuumLogicalVolumes(), BDSColours::GetColour(), BDSGeometryComponent::GetContainerLogicalVolume(), BDSBeamPipe::GetVacuumLogicalVolume(), BDSGeometryComponent::InheritExtents(), BDSBeamPipeFactory::Instance(), BDSColours::Instance(), BDSFieldBuilder::Instance(), BDSAcceleratorComponent::lengthSafety, BDSAcceleratorComponent::lengthSafetyLarge, BDSAcceleratorComponent::name, BDSGeometryComponent::RegisterDaughter(), BDSFieldBuilder::RegisterFieldForConstruction(), BDSGeometryComponent::RegisterLogicalVolume(), BDSGeometryComponent::RegisterPhysicalVolume(), BDSGeometryComponent::RegisterSolid(), and BDSAcceleratorComponent::SetAcceleratorVacuumLogicalVolume().

Referenced by Build().

Here is the call graph for this function:

Here is the caller graph for this function:

BuildContainerLogicalVolume()

void BDSGaborLens::BuildContainerLogicalVolume ( )

protectedvirtual

Build the container solid and logical volume that all parts of the component will contained within - must be provided by derived class.

Implements BDSAcceleratorComponent.

Definition at line 128 of file BDSGaborLens.cc.

References BDSAcceleratorComponent::beamPipeInfo, BDSAcceleratorComponent::chordLength, BDSAcceleratorComponent::lengthSafety, BDSAcceleratorComponent::name, and BDSBeamPipeInfo::vacuumMaterial.

BuildOuter()

void BDSGaborLens::BuildOuter ( )

private

Build the outer volume.

Definition at line 147 of file BDSGaborLens.cc.

References BDSAcceleratorComponent::beamPipeInfo, BDSAcceleratorComponent::checkOverlaps, BDSAcceleratorComponent::chordLength, BDSBeamPipeInfo::Extent(), BDSColours::GetColour(), BDSMaterials::GetMaterial(), BDSColours::Instance(), BDSMaterials::Instance(), BDSAcceleratorComponent::lengthSafety, BDSAcceleratorComponent::lengthSafetyLarge, BDSExtent::MaximumAbsTransverse(), BDSAcceleratorComponent::name, BDSGeometryComponent::RegisterLogicalVolume(), BDSGeometryComponent::RegisterPhysicalVolume(), and BDSGeometryComponent::RegisterSolid().

Referenced by Build().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

anodeLength

G4double BDSGaborLens::anodeLength

protected

Definition at line 61 of file BDSGaborLens.hh.

anodeMaterial

G4Material* BDSGaborLens::anodeMaterial

protected

Definition at line 62 of file BDSGaborLens.hh.

anodeRadius

G4double BDSGaborLens::anodeRadius

protected

Definition at line 60 of file BDSGaborLens.hh.

anodeThickness

G4double BDSGaborLens::anodeThickness

protected

Definition at line 63 of file BDSGaborLens.hh.

colour

G4Colour* BDSGaborLens::colour

protected

Definition at line 69 of file BDSGaborLens.hh.

electrodeLength

G4double BDSGaborLens::electrodeLength

protected

Definition at line 65 of file BDSGaborLens.hh.

electrodeMaterial

G4Material* BDSGaborLens::electrodeMaterial

protected

Definition at line 66 of file BDSGaborLens.hh.

electrodeRadius

G4double BDSGaborLens::electrodeRadius

protected

Definition at line 64 of file BDSGaborLens.hh.

electrodeThickness

G4double BDSGaborLens::electrodeThickness

protected

Definition at line 67 of file BDSGaborLens.hh.

endcapsLength

G4double BDSGaborLens::endcapsLength

protected

Definition at line 72 of file BDSGaborLens.hh.

horizontalWidth

G4double BDSGaborLens::horizontalWidth

protected

Definition at line 59 of file BDSGaborLens.hh.

outerMaterial

G4Material* BDSGaborLens::outerMaterial

protected

Definition at line 68 of file BDSGaborLens.hh.

vacuumFieldInfo

BDSFieldInfo* BDSGaborLens::vacuumFieldInfo

protected

Definition at line 70 of file BDSGaborLens.hh.

vacuumLength

G4double BDSGaborLens::vacuumLength

protected

Definition at line 71 of file BDSGaborLens.hh.

---

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

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