G4TUniformMagneticField Class Reference

#include <G4TUniformMagneticField.hh>

Inheritance diagram for G4TUniformMagneticField:

Public Member Functions
virtual G4TUniformMagneticField *	Clone () const
G4bool	DoesFieldChangeEnergy () const
	G4TUniformMagneticField (const G4ThreeVector &FieldVector)
	G4TUniformMagneticField (const G4TUniformMagneticField &p)
	G4TUniformMagneticField (G4double vField, G4double vTheta, G4double vPhi)
G4ThreeVector	GetConstantFieldValue () const
void	GetFieldValue (const G4double yTrack[4], G4double *B) const
G4bool	IsGravityActive () const
G4TUniformMagneticField &	operator= (const G4TUniformMagneticField &p)
void	SetFieldValue (const G4ThreeVector &newFieldVector)
void	SetGravityActive (G4bool OnOffFlag)
virtual	~G4TUniformMagneticField ()

Static Public Attributes
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Private Attributes
G4double	fFieldComponents [3]
G4bool	fGravityActive = false

Detailed Description

Definition at line 34 of file G4TUniformMagneticField.hh.

Constructor & Destructor Documentation

G4TUniformMagneticField() [1/3]

G4TUniformMagneticField::G4TUniformMagneticField ( const G4ThreeVector &  FieldVector )

inline

Definition at line 38 of file G4TUniformMagneticField.hh.

    {
      fFieldComponents[0] = FieldVector.x();
      fFieldComponents[1] = FieldVector.y();
      fFieldComponents[2] = FieldVector.z();
    }

References fFieldComponents, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

Referenced by Clone().

G4TUniformMagneticField() [2/3]

G4TUniformMagneticField::G4TUniformMagneticField ( G4double  vField, G4double  vTheta, G4double  vPhi  )

inline

Definition at line 47 of file G4TUniformMagneticField.hh.

    {
      if ( (vField<0) || (vTheta<0) || (vTheta>pi) || (vPhi<0) || (vPhi>twopi) )
      {
         G4Exception("G4TUniformMagneticField::G4TUniformMagneticField()",
                     "GeomField0002", FatalException, "Invalid parameters.") ;
      }
      fFieldComponents[0] = vField*std::sin(vTheta)*std::cos(vPhi) ;
      fFieldComponents[1] = vField*std::sin(vTheta)*std::sin(vPhi) ;
      fFieldComponents[2] = vField*std::cos(vTheta) ;
    }

References FatalException, fFieldComponents, G4Exception(), pi, and twopi.

~G4TUniformMagneticField()

virtual G4TUniformMagneticField::~G4TUniformMagneticField ( )

inlinevirtual

Definition at line 61 of file G4TUniformMagneticField.hh.

{;}

G4TUniformMagneticField() [3/3]

G4TUniformMagneticField::G4TUniformMagneticField ( const G4TUniformMagneticField &  p )

inline

Definition at line 63 of file G4TUniformMagneticField.hh.

       : G4MagneticField(p)
    {
       for (G4int i=0; i<3; ++i)
          fFieldComponents[i] = p.fFieldComponents[i];
    }

References fFieldComponents.

Member Function Documentation

Clone()

virtual G4TUniformMagneticField * G4TUniformMagneticField::Clone ( ) const

inlinevirtual

Reimplemented from G4Field.

Definition at line 103 of file G4TUniformMagneticField.hh.

    { 
       return new G4TUniformMagneticField( G4ThreeVector(this->fFieldComponents[0],
                                                         this->fFieldComponents[1],
                                                         this->fFieldComponents[2]) );
    }

References fFieldComponents, and G4TUniformMagneticField().

DoesFieldChangeEnergy()

G4bool G4MagneticField::DoesFieldChangeEnergy ( ) const

inlinevirtualinherited

Implements G4Field.

Definition at line 52 of file G4MagneticField.hh.

{ return false; }

Referenced by export_G4MagneticField().

GetConstantFieldValue()

G4ThreeVector G4TUniformMagneticField::GetConstantFieldValue ( ) const

inline

Definition at line 94 of file G4TUniformMagneticField.hh.

    {
       G4ThreeVector B(fFieldComponents[0],
                       fFieldComponents[1],
                       fFieldComponents[2]);
       return B;
    }

References B(), and fFieldComponents.

GetFieldValue()

void G4TUniformMagneticField::GetFieldValue ( const G4double  yTrack[4], G4double *  B  ) const

inlinevirtual

Implements G4MagneticField.

Definition at line 79 of file G4TUniformMagneticField.hh.

    {
       B[0]= fFieldComponents[0] ;
       B[1]= fFieldComponents[1] ;
       B[2]= fFieldComponents[2] ;
    }

References B(), and fFieldComponents.

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().

operator=()

G4TUniformMagneticField & G4TUniformMagneticField::operator= ( const G4TUniformMagneticField &  p )

inline

Definition at line 70 of file G4TUniformMagneticField.hh.

    {
      if (&p == this) return *this;
      for (G4int i=0; i<3; ++i)
         fFieldComponents[i] = p.fFieldComponents[i];
      return *this;
    }

References fFieldComponents.

SetFieldValue()

void G4TUniformMagneticField::SetFieldValue ( const G4ThreeVector &  newFieldVector )

inline

Definition at line 87 of file G4TUniformMagneticField.hh.

    {
       fFieldComponents[0] = newFieldVector.x();
       fFieldComponents[1] = newFieldVector.y();
       fFieldComponents[2] = newFieldVector.z();
    }

References fFieldComponents, CLHEP::Hep3Vector::x(), CLHEP::Hep3Vector::y(), and CLHEP::Hep3Vector::z().

SetGravityActive()

void G4Field::SetGravityActive ( G4bool  OnOffFlag )

inlineinherited

Definition at line 106 of file G4Field.hh.

{ 
  fGravityActive = OnOffFlag; 
}

References G4Field::fGravityActive.

Field Documentation

fFieldComponents

G4double G4TUniformMagneticField::fFieldComponents[3]

private

Definition at line 111 of file G4TUniformMagneticField.hh.

Referenced by Clone(), G4TUniformMagneticField(), GetConstantFieldValue(), GetFieldValue(), operator=(), and SetFieldValue().

fGravityActive

G4bool G4Field::fGravityActive = false

privateinherited

Definition at line 96 of file G4Field.hh.

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

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/G4TUniformMagneticField.hh