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

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

#include <BDSFieldMagQuadrupole.hh>

Inheritance diagram for BDSFieldMagQuadrupole:
Inheritance graph
Collaboration diagram for BDSFieldMagQuadrupole:
Collaboration graph

Public Member Functions

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

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

Private Attributes

G4double bPrime
 B' - the field gradient - a constant for a quadrupole. 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 quadrupole.

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

Definition at line 36 of file BDSFieldMagQuadrupole.hh.

Constructor & Destructor Documentation

◆ BDSFieldMagQuadrupole()

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

Definition at line 29 of file BDSFieldMagQuadrupole.cc.

◆ ~BDSFieldMagQuadrupole()

virtual BDSFieldMagQuadrupole::~BDSFieldMagQuadrupole ( )
inlinevirtual

Definition at line 42 of file BDSFieldMagQuadrupole.hh.

Member Function Documentation

◆ GetField()

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

Access the field value.

Implements BDSFieldMag.

Definition at line 40 of file BDSFieldMagQuadrupole.cc.

References bPrime.

Field Documentation

◆ bPrime

G4double BDSFieldMagQuadrupole::bPrime
private

B' - the field gradient - a constant for a quadrupole.

Definition at line 53 of file BDSFieldMagQuadrupole.hh.

Referenced by GetField().


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