#include <G4UniformMagField.hh>

Inheritance diagram for G4UniformMagField:

Public Member Functions
virtual G4Field *	Clone () const override

G4bool	DoesFieldChangeEnergy () const

	G4UniformMagField (const G4ThreeVector &FieldVector)

	G4UniformMagField (const G4UniformMagField &p)

	G4UniformMagField (G4double vField, G4double vTheta, G4double vPhi)

G4ThreeVector	GetConstantFieldValue () const

virtual void	GetFieldValue (const G4double yTrack[4], G4double *MagField) const override final

G4bool	IsGravityActive () const

G4UniformMagField &	operator= (const G4UniformMagField &p)

void	SetFieldValue (const G4ThreeVector &newFieldValue)

void	SetGravityActive (G4bool OnOffFlag)

virtual	~G4UniformMagField () override

Static Public Attributes
static constexpr G4int	MAX_NUMBER_OF_COMPONENTS = 24

Private Attributes
G4double	fFieldComponents [3]

G4bool	fGravityActive = false

Detailed Description

Definition at line 41 of file G4UniformMagField.hh.

Constructor & Destructor Documentation

◆ G4UniformMagField() [1/3]

G4UniformMagField::G4UniformMagField ( const G4ThreeVector & FieldVector )

Definition at line 34 of file G4UniformMagField.cc.

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

◆ G4UniformMagField() [2/3]

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

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

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

◆ ~G4UniformMagField()

G4UniformMagField::~G4UniformMagField ( )

overridevirtual

Definition at line 41 of file G4UniformMagField.cc.

42{

43}

◆ G4UniformMagField() [3/3]

G4UniformMagField::G4UniformMagField ( const G4UniformMagField & p )

Definition at line 45 of file G4UniformMagField.cc.

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

References fFieldComponents.

Member Function Documentation

◆ Clone()

G4Field * G4UniformMagField::Clone ( ) const

overridevirtual

Reimplemented from G4Field.

Definition at line 65 of file G4UniformMagField.cc.

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

References fFieldComponents, and G4UniformMagField().

◆ DoesFieldChangeEnergy()

G4bool G4MagneticField::DoesFieldChangeEnergy ( ) const

inlinevirtualinherited

Implements G4Field.

Definition at line 52 of file G4MagneticField.hh.

52{ return false; }

Referenced by export_G4MagneticField().

◆ GetConstantFieldValue()

G4ThreeVector G4UniformMagField::GetConstantFieldValue ( ) const

Definition at line 123 of file G4UniformMagField.cc.

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

References B(), and fFieldComponents.

Referenced by export_G4UniformMagField(), and G4GlobalMagFieldMessenger::GetFieldValue().

◆ GetFieldValue()

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

finaloverridevirtual

Implements G4MagneticField.

Definition at line 115 of file G4UniformMagField.cc.

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

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

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

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

◆ SetFieldValue()

void G4UniformMagField::SetFieldValue ( const G4ThreeVector & newFieldValue )

Definition at line 73 of file G4UniformMagField.cc.

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

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

Referenced by export_G4UniformMagField(), and G4GlobalMagFieldMessenger::SetField().

◆ SetGravityActive()

void G4Field::SetGravityActive ( G4bool OnOffFlag )

inlineinherited

Definition at line 106 of file G4Field.hh.

{ 
  fGravityActive = OnOffFlag; 
}

References G4Field::fGravityActive.

Field Documentation

◆ fFieldComponents

G4double G4UniformMagField::fFieldComponents[3]

private

Definition at line 70 of file G4UniformMagField.hh.

Referenced by Clone(), G4UniformMagField(), 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 files:

source/geometry/magneticfield/include/G4UniformMagField.hh
source/geometry/magneticfield/src/G4UniformMagField.cc

Public Member Functions

Static Public Attributes

Private Attributes