G4TQuadrupoleMagField Class Reference

#include <G4TQuadrupoleMagField.hh>

Inheritance diagram for G4TQuadrupoleMagField:

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

Static Public Attributes
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Private Attributes
G4double	fGradient
G4bool	fGravityActive = false
G4ThreeVector	fOrigin
G4RotationMatrix *	fpMatrix

Detailed Description

Definition at line 48 of file G4TQuadrupoleMagField.hh.

Constructor & Destructor Documentation

G4TQuadrupoleMagField() [1/2]

G4TQuadrupoleMagField::G4TQuadrupoleMagField ( G4double  pGradient )

inline

Definition at line 52 of file G4TQuadrupoleMagField.hh.

  {
    fGradient = pGradient ;
    fOrigin   = G4ThreeVector( 0.0, 0.0, 0.0) ;
    fpMatrix  = &IdentityMatrix;
  }

References fGradient, fOrigin, fpMatrix, and IdentityMatrix.

Referenced by Clone().

G4TQuadrupoleMagField() [2/2]

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

inline

Definition at line 59 of file G4TQuadrupoleMagField.hh.

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

References fGradient, fOrigin, and fpMatrix.

~G4TQuadrupoleMagField()

virtual G4TQuadrupoleMagField::~G4TQuadrupoleMagField ( )

inlinevirtual

Definition at line 68 of file G4TQuadrupoleMagField.hh.

{;}

Member Function Documentation

Clone()

G4TQuadrupoleMagField * G4TQuadrupoleMagField::Clone ( ) const

inlinevirtual

Reimplemented from G4Field.

Definition at line 98 of file G4TQuadrupoleMagField.hh.

        {
            //TODO: Can the fpMatrix be shared??
            return new G4TQuadrupoleMagField(this->fGradient,
                    this->fOrigin,
                    this->fpMatrix);
        }

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

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 G4TQuadrupoleMagField::GetFieldValue ( const G4double  y[7], G4double  B[3]  ) const

inline

Definition at line 70 of file G4TQuadrupoleMagField.hh.

        {
            G4ThreeVector r_global = G4ThreeVector(
                    y[0] - fOrigin.x(), 
                    y[1] - fOrigin.y(), 
                    y[2] - fOrigin.z());
 
            G4ThreeVector r_local = G4ThreeVector(
                    fpMatrix->colX() * r_global,
                    fpMatrix->colY() * r_global,
                    fpMatrix->colZ() * r_global);
 
            G4ThreeVector B_local = G4ThreeVector(
                    fGradient * r_local.y(),
                    fGradient * r_local.x(),
                    0);
 
            G4ThreeVector B_global = G4ThreeVector(
                    fpMatrix->inverse().rowX() * B_local,
                    fpMatrix->inverse().rowY() * B_local,
                    fpMatrix->inverse().rowZ() * B_local);
 
            B[0] = B_global.x() ;
            B[1] = B_global.y() ;
            B[2] = B_global.z() ;
        }

References B(), CLHEP::HepRotation::colX(), CLHEP::HepRotation::colY(), CLHEP::HepRotation::colZ(), fGradient, fOrigin, fpMatrix, CLHEP::HepRotation::inverse(), CLHEP::HepRotation::rowX(), CLHEP::HepRotation::rowY(), CLHEP::HepRotation::rowZ(), 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 G4TQuadrupoleMagField::fGradient

private

Definition at line 108 of file G4TQuadrupoleMagField.hh.

Referenced by Clone(), G4TQuadrupoleMagField(), 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 G4TQuadrupoleMagField::fOrigin

private

Definition at line 109 of file G4TQuadrupoleMagField.hh.

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

fpMatrix

G4RotationMatrix* G4TQuadrupoleMagField::fpMatrix

private

Definition at line 110 of file G4TQuadrupoleMagField.hh.

Referenced by Clone(), G4TQuadrupoleMagField(), 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 file:

• source/geometry/magneticfield/include/G4TQuadrupoleMagField.hh