Holder struct of all information required to create the outer geometry of a magnet. More...

#include <BDSMagnetOuterInfo.hh>

Collaboration diagram for BDSMagnetOuterInfo:

Public Member Functions
	BDSMagnetOuterInfo ()
	default constructor

	BDSMagnetOuterInfo (const G4String &nameIn, BDSMagnetGeometryType geometryTypeIn, G4double horizontalWidthIn, G4Material outerMaterialIn, G4double innerRadiusIn, G4double vhRatioIn=1, G4double angleInIn=0, G4double angleOutIn=0, G4bool yokeOnLeft=false, G4bool hStyle=false, G4bool buildEndPiecesIn=true, G4double coilWidthFractionIn=0.65, G4double coilHeightFractionIn=0.8, const G4String &geometryTypeAndPathIn="", G4Colour colourIn=nullptr, G4bool autoColour=true)
	extra constructor to assign all members at once

G4double	MinimumIntersectionRadiusRequired () const

Data Fields
G4String	name

BDSMagnetGeometryType	geometryType

G4double	horizontalWidth

G4Material *	outerMaterial

G4double	innerRadius

G4double	vhRatio

G4double	angleIn

G4double	angleOut

G4bool	yokeOnLeft

G4bool	hStyle
	H Style for dipoles. If not, it's assumed C style.

G4bool	buildEndPieces

G4double	coilWidthFraction

G4double	coilHeightFraction

G4String	geometryTypeAndPath

G4Colour *	colour

G4bool	autoColour

Detailed Description

Holder struct of all information required to create the outer geometry of a magnet.

This reduces the number of argument to all magnet constructors plus aggregates common tasks in the component factory.

Author: Laurie Nevay

Definition at line 40 of file BDSMagnetOuterInfo.hh.

Constructor & Destructor Documentation

◆ BDSMagnetOuterInfo() [1/2]

BDSMagnetOuterInfo::BDSMagnetOuterInfo ( )

default constructor

Definition at line 27 of file BDSMagnetOuterInfo.cc.

References BDSColours::GetColour(), and BDSColours::Instance().

Here is the call graph for this function:

◆ BDSMagnetOuterInfo() [2/2]

BDSMagnetOuterInfo::BDSMagnetOuterInfo	(	const G4String &	nameIn,
		BDSMagnetGeometryType	geometryTypeIn,
		G4double	horizontalWidthIn,
		G4Material *	outerMaterialIn,
		G4double	innerRadiusIn,
		G4double	vhRatioIn = `1`,
		G4double	angleInIn = `0`,
		G4double	angleOutIn = `0`,
		G4bool	yokeOnLeft = `false`,
		G4bool	hStyle = `false`,
		G4bool	buildEndPiecesIn = `true`,
		G4double	coilWidthFractionIn = `0.65`,
		G4double	coilHeightFractionIn = `0.8`,
		const G4String &	geometryTypeAndPathIn = `""`,
		G4Colour *	colourIn = `nullptr`,
		G4bool	autoColour = `true`
	)

extra constructor to assign all members at once

Definition at line 47 of file BDSMagnetOuterInfo.cc.

Member Function Documentation

◆ MinimumIntersectionRadiusRequired()

G4double BDSMagnetOuterInfo::MinimumIntersectionRadiusRequired ( ) const

inline

Definition at line 81 of file BDSMagnetOuterInfo.hh.

Field Documentation

◆ angleIn

G4double BDSMagnetOuterInfo::angleIn

Definition at line 70 of file BDSMagnetOuterInfo.hh.

◆ angleOut

G4double BDSMagnetOuterInfo::angleOut

Definition at line 71 of file BDSMagnetOuterInfo.hh.

◆ autoColour

G4bool BDSMagnetOuterInfo::autoColour

Definition at line 79 of file BDSMagnetOuterInfo.hh.

◆ buildEndPieces

G4bool BDSMagnetOuterInfo::buildEndPieces

Definition at line 74 of file BDSMagnetOuterInfo.hh.

◆ coilHeightFraction

G4double BDSMagnetOuterInfo::coilHeightFraction

Definition at line 76 of file BDSMagnetOuterInfo.hh.

◆ coilWidthFraction

G4double BDSMagnetOuterInfo::coilWidthFraction

Definition at line 75 of file BDSMagnetOuterInfo.hh.

◆ colour

G4Colour* BDSMagnetOuterInfo::colour

Definition at line 78 of file BDSMagnetOuterInfo.hh.

◆ geometryType

BDSMagnetGeometryType BDSMagnetOuterInfo::geometryType

Definition at line 65 of file BDSMagnetOuterInfo.hh.

◆ geometryTypeAndPath

G4String BDSMagnetOuterInfo::geometryTypeAndPath

Definition at line 77 of file BDSMagnetOuterInfo.hh.

◆ horizontalWidth

G4double BDSMagnetOuterInfo::horizontalWidth

Definition at line 66 of file BDSMagnetOuterInfo.hh.

◆ hStyle

G4bool BDSMagnetOuterInfo::hStyle

H Style for dipoles. If not, it's assumed C style.

Definition at line 73 of file BDSMagnetOuterInfo.hh.

Referenced by BDSMagnetOuterFactoryPolesBase::CreateKicker(), BDSMagnetOuterFactoryPolesBase::CreateRectangularBend(), BDSMagnetOuterFactoryPolesBase::CreateSectorBend(), and BDSComponentFactory::PrepareMagnetOuterInfo().

◆ innerRadius

G4double BDSMagnetOuterInfo::innerRadius

Definition at line 68 of file BDSMagnetOuterInfo.hh.

◆ name

G4String BDSMagnetOuterInfo::name

Definition at line 64 of file BDSMagnetOuterInfo.hh.

◆ outerMaterial

G4Material* BDSMagnetOuterInfo::outerMaterial

Definition at line 67 of file BDSMagnetOuterInfo.hh.

◆ vhRatio

G4double BDSMagnetOuterInfo::vhRatio

Definition at line 69 of file BDSMagnetOuterInfo.hh.

◆ yokeOnLeft

G4bool BDSMagnetOuterInfo::yokeOnLeft

Definition at line 72 of file BDSMagnetOuterInfo.hh.

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

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

Public Member Functions

Data Fields