G4UniformElectricField Class Reference

#include <G4UniformElectricField.hh>

Inheritance diagram for G4UniformElectricField:

Public Member Functions
virtual G4Field *	Clone () const
G4bool	DoesFieldChangeEnergy () const
	G4UniformElectricField (const G4ThreeVector &FieldVector)
	G4UniformElectricField (const G4UniformElectricField &p)
	G4UniformElectricField (G4double vField, G4double vTheta, G4double vPhi)
virtual void	GetFieldValue (const G4double pos[4], G4double *field) const
G4bool	IsGravityActive () const
G4UniformElectricField &	operator= (const G4UniformElectricField &p)
void	SetGravityActive (G4bool OnOffFlag)
virtual	~G4UniformElectricField ()

Static Public Attributes
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Private Attributes
G4double	fFieldComponents [6]
G4bool	fGravityActive = false

Detailed Description

Definition at line 41 of file G4UniformElectricField.hh.

Constructor & Destructor Documentation

G4UniformElectricField() [1/3]

G4UniformElectricField::G4UniformElectricField

(

const G4ThreeVector &

FieldVector

)

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();
}

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

Referenced by Clone().

G4UniformElectricField() [2/3]

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

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) ;
}

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

~G4UniformElectricField()

G4UniformElectricField::~G4UniformElectricField ( )

virtual

Definition at line 63 of file G4UniformElectricField.cc.

{
}

G4UniformElectricField() [3/3]

G4UniformElectricField::G4UniformElectricField

(

const G4UniformElectricField &

p

)

Definition at line 67 of file G4UniformElectricField.cc.

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

References fFieldComponents.

Member Function Documentation

Clone()

G4Field * G4UniformElectricField::Clone ( ) const

virtual

Reimplemented from G4Field.

Definition at line 89 of file G4UniformElectricField.cc.

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

References fFieldComponents, and G4UniformElectricField().

DoesFieldChangeEnergy()

G4bool G4ElectricField::DoesFieldChangeEnergy ( ) const

inlinevirtualinherited

Implements G4ElectroMagneticField.

Definition at line 52 of file G4ElectricField.hh.

{ return true; }

GetFieldValue()

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

virtual

Implements G4ElectricField.

Definition at line 98 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];
}

References 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=()

G4UniformElectricField & G4UniformElectricField::operator=

(

const G4UniformElectricField &

p

)

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

References fFieldComponents, and G4ElectricField::operator=().

SetGravityActive()

void G4Field::SetGravityActive ( G4bool  OnOffFlag )

inlineinherited

Definition at line 106 of file G4Field.hh.

{ 
  fGravityActive = OnOffFlag; 
}

References G4Field::fGravityActive.

Field Documentation

fFieldComponents

G4double G4UniformElectricField::fFieldComponents[6]

private

Definition at line 64 of file G4UniformElectricField.hh.

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

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 files:

• source/geometry/magneticfield/include/G4UniformElectricField.hh
• source/geometry/magneticfield/src/G4UniformElectricField.cc