G4QuadrupoleMagField Class Reference

G4QuadrupoleMagField allows for the creation of quadrupole magnetic field, given the gradient value for quadrupole magnetic lense. More...

#include <G4QuadrupoleMagField.hh>

Inheritance diagram for G4QuadrupoleMagField:

Public Member Functions
	G4QuadrupoleMagField (G4double pGradient)
	G4QuadrupoleMagField (G4double pGradient, const G4ThreeVector &pOrigin, G4RotationMatrix *pMatrix)
	~G4QuadrupoleMagField () override=default
void	GetFieldValue (const G4double yTrack[], G4double B[]) const override
G4Field *	Clone () const override
Public Member Functions inherited from G4MagneticField
	G4MagneticField ()
	~G4MagneticField () override=default
	G4MagneticField (const G4MagneticField &r)
G4MagneticField &	operator= (const G4MagneticField &p)
G4bool	DoesFieldChangeEnergy () const override
void	GetFieldValue (const G4double Point[4], G4double *Bfield) const override=0
G4FieldType	GetFieldType () const override
Public Member Functions inherited from G4Field
	G4Field (G4bool gravityOn=false)
virtual	~G4Field ()=default
	G4Field (const G4Field &p)=default
G4Field &	operator= (const G4Field &p)
G4bool	IsGravityActive () const
void	SetGravityActive (G4bool OnOffFlag)

Additional Inherited Members
Static Public Attributes inherited from G4Field
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Detailed Description

G4QuadrupoleMagField allows for the creation of quadrupole magnetic field, given the gradient value for quadrupole magnetic lense.

Definition at line 52 of file G4QuadrupoleMagField.hh.

Constructor & Destructor Documentation

G4QuadrupoleMagField() [1/2]

G4QuadrupoleMagField::G4QuadrupoleMagField

(

G4double

pGradient

)

Constructor for G4QuadrupoleMagField.

Parameters

[in]

pGradient

Field gradient value.

Definition at line 39 of file G4QuadrupoleMagField.cc.

{
   fGradient = pGradient;
   fpMatrix  = &IdentityMatrix;
}

Referenced by Clone().

G4QuadrupoleMagField() [2/2]

G4QuadrupoleMagField::G4QuadrupoleMagField	(	G4double	pGradient,
		const G4ThreeVector &	pOrigin,
		G4RotationMatrix *	pMatrix )

Constructor for G4QuadrupoleMagField.

Parameters

[in]	pGradient	Field gradient value.
[in]	pOrigin	Origin position.
[in]	pMatrix	Rotation matrix.

Definition at line 47 of file G4QuadrupoleMagField.cc.

{
   fGradient = pGradient ;
   fOrigin   = pOrigin ;
   fpMatrix  = pMatrix ;
}

~G4QuadrupoleMagField()

G4QuadrupoleMagField::~G4QuadrupoleMagField ( )

overridedefault

Default Destructor.

Member Function Documentation

Clone()

G4Field * G4QuadrupoleMagField::Clone ( ) const

overridevirtual

Returns a pointer to a new allocated clone of this object.

Reimplemented from G4Field.

Definition at line 58 of file G4QuadrupoleMagField.cc.

{
   return new G4QuadrupoleMagField(fGradient, fOrigin, fpMatrix);
}

GetFieldValue()

void G4QuadrupoleMagField::GetFieldValue ( const G4double yTrack[], G4double B[] ) const

override

Returns the field value on the given position 'yTrack'.

Parameters

[in]	yTrack	Time position array.
[out]	B	The returned field array.

Definition at line 65 of file G4QuadrupoleMagField.cc.

{
  //  with displaced origin and rotation
 
  G4ThreeVector r_global = G4ThreeVector(y[0] - fOrigin.x(),
                                         y[1] - fOrigin.y(),
                                         y[2] - fOrigin.z());
  
  const G4ThreeVector r_local = (*fpMatrix) * r_global;
  const G4ThreeVector B_local( fGradient * r_local.y(),
                               fGradient * r_local.x(), 0);
  const G4ThreeVector B_global = fpMatrix->inverse() * B_local;
 
  B[0] = B_global.x();
  B[1] = B_global.y();
  B[2] = B_global.z();
}

---

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

• G4QuadrupoleMagField.hh
• G4QuadrupoleMagField.cc