G4QuadrupoleMagField Class Reference

#include <G4QuadrupoleMagField.hh>

Inheritance diagram for G4QuadrupoleMagField:

Public Member Functions
G4Field *	Clone () const
G4bool	DoesFieldChangeEnergy () const
	G4QuadrupoleMagField (G4double pGradient)
	G4QuadrupoleMagField (G4double pGradient, G4ThreeVector pOrigin, G4RotationMatrix *pMatrix)
virtual void	GetFieldValue (const G4double Point[4], G4double *Bfield) const =0
void	GetFieldValue (const G4double yTrack[], G4double B[]) const
G4bool	IsGravityActive () const
void	SetGravityActive (G4bool OnOffFlag)
	~G4QuadrupoleMagField ()

Static Public Attributes
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Private Attributes
G4double	fGradient = 0.0
G4bool	fGravityActive = false
G4ThreeVector	fOrigin = G4ThreeVector(0.0, 0.0, 0.0)
G4RotationMatrix *	fpMatrix = nullptr

Detailed Description

Definition at line 48 of file G4QuadrupoleMagField.hh.

Constructor & Destructor Documentation

G4QuadrupoleMagField() [1/2]

G4QuadrupoleMagField::G4QuadrupoleMagField

(

G4double

pGradient

)

Definition at line 40 of file G4QuadrupoleMagField.cc.

{
   fGradient = pGradient;
   fpMatrix  = &IdentityMatrix;
}

References fGradient, fpMatrix, and IdentityMatrix.

Referenced by Clone().

G4QuadrupoleMagField() [2/2]

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

Definition at line 48 of file G4QuadrupoleMagField.cc.

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

References fGradient, fOrigin, and fpMatrix.

~G4QuadrupoleMagField()

G4QuadrupoleMagField::~G4QuadrupoleMagField

(

)

Definition at line 66 of file G4QuadrupoleMagField.cc.

{
}

Member Function Documentation

Clone()

G4Field * G4QuadrupoleMagField::Clone ( ) const

virtual

Reimplemented from G4Field.

Definition at line 59 of file G4QuadrupoleMagField.cc.

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

References fGradient, fOrigin, fpMatrix, and G4QuadrupoleMagField().

DoesFieldChangeEnergy()

G4bool G4MagneticField::DoesFieldChangeEnergy ( ) const

inlinevirtualinherited

Implements G4Field.

Definition at line 52 of file G4MagneticField.hh.

{ return false; }

Referenced by export_G4MagneticField().

GetFieldValue() [1/2]

virtual void G4MagneticField::GetFieldValue ( const G4double  Point[4], G4double *  Bfield  ) const

pure virtualinherited

Implements G4Field.

Implemented in PyG4MagneticField, pyG4MagneticField::CB_PyG4MagneticField, G4CachedMagneticField, G4TCachedMagneticField< T_Field >, G4TUniformMagneticField, and G4UniformMagField.

Referenced by G4CachedMagneticField::GetFieldValue().

GetFieldValue() [2/2]

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

Definition at line 72 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();
}

References B(), fGradient, fOrigin, fpMatrix, CLHEP::HepRotation::inverse(), CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

IsGravityActive()

G4bool G4Field::IsGravityActive ( ) const

inlineinherited

Definition at line 101 of file G4Field.hh.

{
  return fGravityActive;
}

References G4Field::fGravityActive.

Referenced by G4CoupledTransportation::AlongStepGetPhysicalInteractionLength(), and G4RepleteEofM::G4RepleteEofM().

SetGravityActive()

void G4Field::SetGravityActive ( G4bool  OnOffFlag )

inlineinherited

Definition at line 106 of file G4Field.hh.

{ 
  fGravityActive = OnOffFlag; 
}

References G4Field::fGravityActive.

Field Documentation

fGradient

G4double G4QuadrupoleMagField::fGradient = 0.0

private

Definition at line 64 of file G4QuadrupoleMagField.hh.

Referenced by Clone(), G4QuadrupoleMagField(), and GetFieldValue().

fGravityActive

G4bool G4Field::fGravityActive = false

privateinherited

Definition at line 96 of file G4Field.hh.

Referenced by G4Field::IsGravityActive(), G4Field::operator=(), and G4Field::SetGravityActive().

fOrigin

G4ThreeVector G4QuadrupoleMagField::fOrigin = G4ThreeVector(0.0, 0.0, 0.0)

private

Definition at line 65 of file G4QuadrupoleMagField.hh.

Referenced by Clone(), G4QuadrupoleMagField(), and GetFieldValue().

fpMatrix

G4RotationMatrix* G4QuadrupoleMagField::fpMatrix = nullptr

private

Definition at line 66 of file G4QuadrupoleMagField.hh.

Referenced by Clone(), G4QuadrupoleMagField(), and GetFieldValue().

MAX_NUMBER_OF_COMPONENTS

constexpr G4int G4Field::MAX_NUMBER_OF_COMPONENTS = 24

staticconstexprinherited

Definition at line 92 of file G4Field.hh.

Referenced by G4BFieldIntegrationDriver::CurvatureRadius().

---

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

• source/geometry/magneticfield/include/G4QuadrupoleMagField.hh
• source/geometry/magneticfield/src/G4QuadrupoleMagField.cc