G4SextupoleMagField Class Reference

G4SextupoleMagField is a class for defining a sextupole magnetic field. More...

#include <G4SextupoleMagField.hh>

Inheritance diagram for G4SextupoleMagField:

Public Member Functions
	G4SextupoleMagField (G4double pGradient)
	G4SextupoleMagField (G4double pGradient, const G4ThreeVector &pOrigin, G4RotationMatrix *pMatrix)
	~G4SextupoleMagField () 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

G4SextupoleMagField is a class for defining a sextupole magnetic field.

Definition at line 49 of file G4SextupoleMagField.hh.

Constructor & Destructor Documentation

G4SextupoleMagField() [1/2]

G4SextupoleMagField::G4SextupoleMagField

(

G4double

pGradient

)

Constructor for G4SextupoleMagField.

Parameters

[in]

pGradient

Field gradient value.

Definition at line 41 of file G4SextupoleMagField.cc.

{
   fGradient = pGradient;
   fpMatrix  = &IdentityMatrix;
}

Referenced by Clone().

G4SextupoleMagField() [2/2]

G4SextupoleMagField::G4SextupoleMagField	(	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 G4SextupoleMagField.cc.

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

~G4SextupoleMagField()

G4SextupoleMagField::~G4SextupoleMagField ( )

overridedefault

Default Destructor.

Member Function Documentation

Clone()

G4Field * G4SextupoleMagField::Clone ( ) const

overridevirtual

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

Reimplemented from G4Field.

Definition at line 56 of file G4SextupoleMagField.cc.

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

GetFieldValue()

void G4SextupoleMagField::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 63 of file G4SextupoleMagField.cc.

{
  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.x() * r_local.y(),fGradient * ( std::pow(r_local.x(),2) - std::pow(r_local.y(),2) )/2 ,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:

• G4SextupoleMagField.hh
• G4SextupoleMagField.cc