G4UniformElectricField Class Reference

G4UniformElectricField is class defining a uniform electric magnetic field. More...

#include <G4UniformElectricField.hh>

Inheritance diagram for G4UniformElectricField:

Public Member Functions
	G4UniformElectricField (const G4ThreeVector &FieldVector)
	G4UniformElectricField (G4double vField, G4double vTheta, G4double vPhi)
	~G4UniformElectricField () override=default
	G4UniformElectricField (const G4UniformElectricField &p)
G4UniformElectricField &	operator= (const G4UniformElectricField &p)
void	GetFieldValue (const G4double pos[4], G4double *field) const override
G4Field *	Clone () const override
Public Member Functions inherited from G4ElectricField
	G4ElectricField ()=default
	~G4ElectricField () override=default
	G4ElectricField (const G4ElectricField &r)=default
G4ElectricField &	operator= (const G4ElectricField &p)
G4bool	DoesFieldChangeEnergy () const override
Public Member Functions inherited from G4ElectroMagneticField
	G4ElectroMagneticField ()
	~G4ElectroMagneticField () override=default
	G4ElectroMagneticField (const G4ElectroMagneticField &r)=default
G4ElectroMagneticField &	operator= (const G4ElectroMagneticField &p)
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

G4UniformElectricField is class defining a uniform electric magnetic field.

Definition at line 46 of file G4UniformElectricField.hh.

Constructor & Destructor Documentation

G4UniformElectricField() [1/3]

G4UniformElectricField::G4UniformElectricField

(

const G4ThreeVector &

FieldVector

)

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

Parameters

[in]

FieldVector

The field vector value.

Definition at line 34 of file G4UniformElectricField.cc.

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

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

G4UniformElectricField() [2/3]

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

Alternative constructor for G4UniformElectricField.

Parameters

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

Definition at line 45 of file G4UniformElectricField.cc.

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

~G4UniformElectricField()

G4UniformElectricField::~G4UniformElectricField ( )

overridedefault

Default Destructor.

G4UniformElectricField() [3/3]

G4UniformElectricField::G4UniformElectricField

(

const G4UniformElectricField &

p

)

Copy constructor and assignment operator.

Definition at line 63 of file G4UniformElectricField.cc.

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

Member Function Documentation

Clone()

G4Field * G4UniformElectricField::Clone ( ) const

overridevirtual

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

Reimplemented from G4Field.

Definition at line 85 of file G4UniformElectricField.cc.

{
   return new G4UniformElectricField( G4ThreeVector(fFieldComponents[3],
                                                    fFieldComponents[4],
                                                    fFieldComponents[5]));
}

GetFieldValue()

void G4UniformElectricField::GetFieldValue ( const G4double pos[4], G4double * field ) const

overridevirtual

Returns the field value 'field' on given time 'pos'.

Implements G4ElectricField.

Definition at line 94 of file G4UniformElectricField.cc.

{
   fieldBandE[0] = 0.0;
   fieldBandE[1] = 0.0;
   fieldBandE[2] = 0.0;
   fieldBandE[3] = fFieldComponents[3];
   fieldBandE[4] = fFieldComponents[4];
   fieldBandE[5] = fFieldComponents[5];
}

operator=()

G4UniformElectricField & G4UniformElectricField::operator=

(

const G4UniformElectricField &

p

)

Definition at line 74 of file G4UniformElectricField.cc.

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

---

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

• G4UniformElectricField.hh
• G4UniformElectricField.cc