G4LineCurrentMagField is a class describing a line current magnetic field. The line current is directed along the Z axis and crosses the XY plane in the origin point. More...

#include <G4LineCurrentMagField.hh>

Inheritance diagram for G4LineCurrentMagField:

Public Member Functions
	G4LineCurrentMagField (G4double pFieldConstant)
	~G4LineCurrentMagField () override=default
void	GetFieldValue (const G4double yTrack[], G4double B[]) const override
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
void	GetFieldValue (const G4double Point[4], G4double *Bfield) const override=0
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

G4LineCurrentMagField is a class describing a line current magnetic field. The line current is directed along the Z axis and crosses the XY plane in the origin point.

Definition at line 48 of file G4LineCurrentMagField.hh.

Constructor & Destructor Documentation

◆ G4LineCurrentMagField()

G4LineCurrentMagField::G4LineCurrentMagField ( G4double pFieldConstant )

Constructor for G4LineCurrentMagField.

Parameters

[in] pFieldConstant Value of the constant field.

Definition at line 34 of file G4LineCurrentMagField.cc.

{
   fFieldConstant = pFieldConstant ;
}

Referenced by Clone().

◆ ~G4LineCurrentMagField()

G4LineCurrentMagField::~G4LineCurrentMagField ( )

overridedefault

Default Destructor.

Member Function Documentation

◆ Clone()

G4Field * G4LineCurrentMagField::Clone ( ) const

overridevirtual

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

Reimplemented from G4Field.

Definition at line 41 of file G4LineCurrentMagField.cc.

{
   return new G4LineCurrentMagField( fFieldConstant );
}

◆ GetFieldValue()

void G4LineCurrentMagField::GetFieldValue	(	const G4double	yTrack[],
		G4double	B[] ) const

override

Returns the field value on the given position 'yTrack'.

Parameters

[in]	yTrack	Time position array.
[out]	B	The returned field array.

Definition at line 48 of file G4LineCurrentMagField.cc.

{
   //   G4double fFieldConstant = 100 ;
   G4double a = 1.00 ;   // mm
   G4double x = a*yTrack[0], y = a*yTrack[1] ;
   G4double x2 = x*x, y2 = y*y, r2 = x2 + y2 ;
   G4double r = std::sqrt(r2+a*a) ;
   G4double Br = fFieldConstant/r;
   B[0] = -Br*y/r ;
   B[1] = Br*x/r ;
   B[2] = 0.0 ;
}

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

Public Member Functions