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

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

#include <BDSFieldMagDecapole.hh>

Inheritance diagram for BDSFieldMagDecapole:
Inheritance graph
Collaboration diagram for BDSFieldMagDecapole:
Collaboration graph

Public Member Functions

 BDSFieldMagDecapole (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

 BDSFieldMagDecapole ()
 Private default constructor to force use of supplied constructor.
 

Private Attributes

G4double bQuadruplePrime
 B'''' - the fourth derivative of the magnetic field. More...
 
G4double bQPNormed
 B'''' / 4! 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 decapole.

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

Definition at line 36 of file BDSFieldMagDecapole.hh.

Constructor & Destructor Documentation

◆ BDSFieldMagDecapole()

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

Definition at line 30 of file BDSFieldMagDecapole.cc.

◆ ~BDSFieldMagDecapole()

virtual BDSFieldMagDecapole::~BDSFieldMagDecapole ( )
inlinevirtual

Definition at line 42 of file BDSFieldMagDecapole.hh.

Member Function Documentation

◆ GetField()

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

Access the field value.

Implements BDSFieldMag.

Definition at line 41 of file BDSFieldMagDecapole.cc.

References bQPNormed.

Field Documentation

◆ bQPNormed

G4double BDSFieldMagDecapole::bQPNormed
private

B'''' / 4!

Definition at line 56 of file BDSFieldMagDecapole.hh.

Referenced by GetField().

◆ bQuadruplePrime

G4double BDSFieldMagDecapole::bQuadruplePrime
private

B'''' - the fourth derivative of the magnetic field.

Definition at line 53 of file BDSFieldMagDecapole.hh.


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