G4UniformMagField Class Reference

G4UniformMagField is a class for defining a uniform magnetic field. More...

#include <G4UniformMagField.hh>

Inheritance diagram for G4UniformMagField:

Public Member Functions
	G4UniformMagField (const G4ThreeVector &FieldVector)
	G4UniformMagField (G4double vField, G4double vTheta, G4double vPhi)
	~G4UniformMagField () override=default
	G4UniformMagField (const G4UniformMagField &p)
G4UniformMagField &	operator= (const G4UniformMagField &p)
void	GetFieldValue (const G4double yTrack[4], G4double *MagField) const override
void	SetFieldValue (const G4ThreeVector &newFieldValue)
G4ThreeVector	GetConstantFieldValue () const
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
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

G4UniformMagField is a class for defining a uniform magnetic field.

Definition at line 45 of file G4UniformMagField.hh.

Constructor & Destructor Documentation

G4UniformMagField() [1/3]

G4UniformMagField::G4UniformMagField

(

const G4ThreeVector &

FieldVector

)

Constructor for G4UniformMagField, a field with value equal to 'FieldVector'.

Parameters

[in]

FieldVector

The field vector value.

Definition at line 34 of file G4UniformMagField.cc.

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

Referenced by Clone(), G4UniformMagField(), operator=(), and ~G4UniformMagField().

G4UniformMagField() [2/3]

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

Alternative constructor for G4UniformMagField.

Parameters

[in]	vField	The field component.
[in]	vTheta	The Theta component.
[in]	vPhi	The Phi component.

Definition at line 76 of file G4UniformMagField.cc.

{
   if ( (vField<0) || (vTheta<0) || (vTheta>pi) || (vPhi<0) || (vPhi>twopi) )
   {
      std::ostringstream msg;
      msg << "ERROR in G4UniformMagField::G4UniformMagField() : "
          << "Invalid parameter(s). " << std::endl;
      msg << " Expected " << std::endl;
      
      msg << " - Magnitude vField: Value = " << vField
          << "  Expected vField > 0 " ;
      if ( vField<0) {  msg << " <------ Erroneous "; }
      msg << std::endl;      
 
      msg << " - Theta angle: Value = " << vTheta
          << "  Expected between 0 <= theta <= pi = " << pi << " ";
      if ( (vTheta<0) || (vTheta>pi) ) { msg << " <------ Erroneous "; }
 
      msg << std::endl;
      msg << " - Phi   angle: Value = " << vPhi
          << "  Expected between 0 <=  phi  <= 2*pi = " << twopi << std::endl;
      if ( (vPhi<0) || (vPhi>twopi) ) { msg << " <------ Erroneous "; }
      
      G4Exception("G4UniformMagField::G4UniformMagField()",
                  "GeomField0002", FatalException, msg );
   }
   fFieldComponents[0] = vField*std::sin(vTheta)*std::cos(vPhi) ;
   fFieldComponents[1] = vField*std::sin(vTheta)*std::sin(vPhi) ;
   fFieldComponents[2] = vField*std::cos(vTheta) ;
}

~G4UniformMagField()

G4UniformMagField::~G4UniformMagField ( )

overridedefault

Default Destructor.

G4UniformMagField() [3/3]

G4UniformMagField::G4UniformMagField

(

const G4UniformMagField &

p

)

Copy constructor and assignment operator.

Definition at line 41 of file G4UniformMagField.cc.

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

Member Function Documentation

Clone()

G4Field * G4UniformMagField::Clone ( ) const

overridevirtual

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

Reimplemented from G4Field.

Definition at line 61 of file G4UniformMagField.cc.

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

GetConstantFieldValue()

G4ThreeVector G4UniformMagField::GetConstantFieldValue

(

)

const

Returns the constant field value.

Definition at line 119 of file G4UniformMagField.cc.

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

GetFieldValue()

void G4UniformMagField::GetFieldValue ( const G4double yTrack[4], G4double * MagField ) const

overridevirtual

Returns the field value 'MagField' on given time 'yTrack'.

Implements G4MagneticField.

Definition at line 111 of file G4UniformMagField.cc.

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

operator=()

G4UniformMagField & G4UniformMagField::operator=

(

const G4UniformMagField &

p

)

Definition at line 50 of file G4UniformMagField.cc.

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

SetFieldValue()

void G4UniformMagField::SetFieldValue

(

const G4ThreeVector &

newFieldValue

)

Sets the field value.

Definition at line 69 of file G4UniformMagField.cc.

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

---

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

• G4UniformMagField.hh
• G4UniformMagField.cc