Class that provides the magnetic strength in an octupole. More...

#include <BDSFieldMagOctupole.hh>

Inheritance diagram for BDSFieldMagOctupole:

Collaboration diagram for BDSFieldMagOctupole:

Public Member Functions
	BDSFieldMagOctupole (BDSMagnetStrength const *strength, G4double const brho)

virtual G4ThreeVector	GetField (const G4ThreeVector &position, const G4double t=0) const
	Access the field value.

Public Member Functions inherited from BDSFieldMag
	BDSFieldMag ()

	BDSFieldMag (G4Transform3D transformIn)

virtual G4bool	TimeVarying () const

virtual void	GetFieldValue (const G4double point[4], G4double *field) const

virtual G4ThreeVector	GetFieldTransformed (const G4ThreeVector &position, const G4double t) const
	Get the field value after applying transform for local offset.

virtual void	SetTransform (const G4Transform3D &transformIn)

void	SetModulator (BDSModulator *modulatorIn)
	Set the optional modulator.

G4bool	FiniteStrength () const
	Accessor.

Private Member Functions
	BDSFieldMagOctupole ()
	Private default constructor to force use of supplied constructor.

Private Attributes
G4double	bTriplePrime
	3rd derivative of the magnetic field

G4double	bTPNormed
	bTriplePrime / 3! cached for simplicity

Additional Inherited Members
Protected Attributes inherited from BDSFieldMag
G4bool	finiteStrength
	Flag to cache whether finite nor not.

G4Transform3D	transform
	Transform to apply for the field relative to the local coordinates of the geometry.

G4bool	transformIsNotIdentity
	Cache of whether to use transform at all.

BDSModulator *	modulator
	Optional modulator;.

Detailed Description

Class that provides the magnetic strength in an octupole.

The magnetic field is calculated from the octuupole strength parameter "k3" and a design rigidity (brho).

Definition at line 36 of file BDSFieldMagOctupole.hh.

Constructor & Destructor Documentation

◆ BDSFieldMagOctupole()

BDSFieldMagOctupole::BDSFieldMagOctupole	(	BDSMagnetStrength const *	strength,
		G4double const	brho
	)

Definition at line 30 of file BDSFieldMagOctupole.cc.

◆ ~BDSFieldMagOctupole()

virtual BDSFieldMagOctupole::~BDSFieldMagOctupole ( )

inlinevirtual

Definition at line 42 of file BDSFieldMagOctupole.hh.

Member Function Documentation

◆ GetField()

G4ThreeVector BDSFieldMagOctupole::GetField	(	const G4ThreeVector &	position,
		const G4double	t = `0`
	)		const

virtual

Access the field value.

Implements BDSFieldMag.

Definition at line 42 of file BDSFieldMagOctupole.cc.

References bTPNormed.

Field Documentation

◆ bTPNormed

G4double BDSFieldMagOctupole::bTPNormed

private

bTriplePrime / 3! cached for simplicity

Definition at line 56 of file BDSFieldMagOctupole.hh.

Referenced by GetField().

◆ bTriplePrime

G4double BDSFieldMagOctupole::bTriplePrime

private

3rd derivative of the magnetic field

Definition at line 53 of file BDSFieldMagOctupole.hh.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members