G4TUniformMagneticField Class Reference

G4TUniformMagneticField is a templated version of G4UniformMagneticField. More...

#include <G4TUniformMagneticField.hh>

Inheritance diagram for G4TUniformMagneticField:

Public Member Functions
	G4TUniformMagneticField (const G4ThreeVector &FieldVector)
	G4TUniformMagneticField (G4double vField, G4double vTheta, G4double vPhi)
virtual	~G4TUniformMagneticField ()=default
	G4TUniformMagneticField (const G4TUniformMagneticField &p)
G4TUniformMagneticField &	operator= (const G4TUniformMagneticField &p)
void	GetFieldValue (const G4double yTrack[4], G4double *B) const
void	SetFieldValue (const G4ThreeVector &newFieldVector)
G4ThreeVector	GetConstantFieldValue () const
virtual G4TUniformMagneticField *	Clone () const
Public Member Functions inherited from G4MagneticField
	G4MagneticField ()
	~G4MagneticField () override=default
	G4MagneticField (const G4MagneticField &r)
G4MagneticField &	operator= (const G4MagneticField &p)
G4bool	DoesFieldChangeEnergy () const override
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

G4TUniformMagneticField is a templated version of G4UniformMagneticField.

Definition at line 47 of file G4TUniformMagneticField.hh.

Constructor & Destructor Documentation

G4TUniformMagneticField() [1/3]

G4TUniformMagneticField::G4TUniformMagneticField ( const G4ThreeVector & FieldVector )

inline

Definition at line 51 of file G4TUniformMagneticField.hh.

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

Referenced by Clone(), G4TUniformMagneticField(), and operator=().

G4TUniformMagneticField() [2/3]

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

inline

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

~G4TUniformMagneticField()

virtual G4TUniformMagneticField::~G4TUniformMagneticField ( )

virtualdefault

G4TUniformMagneticField() [3/3]

G4TUniformMagneticField::G4TUniformMagneticField ( const G4TUniformMagneticField & p )

inline

Definition at line 76 of file G4TUniformMagneticField.hh.

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

Member Function Documentation

Clone()

virtual G4TUniformMagneticField * G4TUniformMagneticField::Clone ( ) const

inlinevirtual

Interface method to implement cloning, needed by multi-threading. Here issuing a fatal exception, as expecting this to be implemented concretely in derived classes.

Reimplemented from G4Field.

Definition at line 116 of file G4TUniformMagneticField.hh.

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

GetConstantFieldValue()

G4ThreeVector G4TUniformMagneticField::GetConstantFieldValue ( ) const

inline

Definition at line 107 of file G4TUniformMagneticField.hh.

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

GetFieldValue()

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

inlinevirtual

Given the position time vector 'Point', returns the value of the field in the array 'Bfield'.

Parameters

[in]	Point	The position time vector.
[out]	Bfield	The field array in output.

Implements G4MagneticField.

Definition at line 92 of file G4TUniformMagneticField.hh.

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

operator=()

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

inline

Definition at line 83 of file G4TUniformMagneticField.hh.

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

SetFieldValue()

void G4TUniformMagneticField::SetFieldValue ( const G4ThreeVector & newFieldVector )

inline

Definition at line 100 of file G4TUniformMagneticField.hh.

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

---

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

• G4TUniformMagneticField.hh