BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Public Member Functions | Private Member Functions | Private Attributes
BDSFieldMagSextupole Class Reference

Class that provides the magnetic strength in a sextupole. More...

#include <BDSFieldMagSextupole.hh>

Inheritance diagram for BDSFieldMagSextupole:
Inheritance graph
Collaboration diagram for BDSFieldMagSextupole:
Collaboration graph

Public Member Functions

 BDSFieldMagSextupole (BDSMagnetStrength const *strength, G4double const brho)
 
virtual G4ThreeVector GetField (const G4ThreeVector &position, const G4double t=0) const
 Access the field value. More...
 
- Public Member Functions inherited from BDSFieldMag
 BDSFieldMag ()
 
 BDSFieldMag (G4Transform3D transformIn)
 
virtual G4ThreeVector GetField (const G4ThreeVector &position, const G4double t=0) const =0
 
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. More...
 
virtual void SetTransform (const G4Transform3D &transformIn)
 
G4bool FiniteStrength () const
 Accessor. More...
 

Private Member Functions

 BDSFieldMagSextupole ()
 Private default constructor to avoid usage.
 

Private Attributes

G4double bDoublePrime
 B'' - second derivative of the magnetic field. More...
 
G4double halfBDoublePrime
 bDoublePrime / 2! cached More...
 

Additional Inherited Members

- Protected Attributes inherited from BDSFieldMag
G4bool finiteStrength
 Flag to cache whether finite nor not. More...
 
G4Transform3D transform
 Transform to apply for the field relative to the local coordinates of the geometry. More...
 

Detailed Description

Class that provides the magnetic strength in a sextupole.

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

Definition at line 36 of file BDSFieldMagSextupole.hh.

Constructor & Destructor Documentation

◆ BDSFieldMagSextupole()

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

Definition at line 31 of file BDSFieldMagSextupole.cc.

◆ ~BDSFieldMagSextupole()

virtual BDSFieldMagSextupole::~BDSFieldMagSextupole ( )
inlinevirtual

Definition at line 42 of file BDSFieldMagSextupole.hh.

Member Function Documentation

◆ GetField()

G4ThreeVector BDSFieldMagSextupole::GetField ( const G4ThreeVector &  position,
const G4double  t = 0 
) const
virtual

Access the field value.

Implements BDSFieldMag.

Definition at line 43 of file BDSFieldMagSextupole.cc.

References bDoublePrime, and halfBDoublePrime.

Field Documentation

◆ bDoublePrime

G4double BDSFieldMagSextupole::bDoublePrime
private

B'' - second derivative of the magnetic field.

Definition at line 53 of file BDSFieldMagSextupole.hh.

Referenced by GetField().

◆ halfBDoublePrime

G4double BDSFieldMagSextupole::halfBDoublePrime
private

bDoublePrime / 2! cached

Definition at line 56 of file BDSFieldMagSextupole.hh.

Referenced by GetField().


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