A01LocalMagField Class Reference

Definition of a uniform magnetic field within a given region. More...

#include <A01LocalMagField.h>

Inheritance diagram for A01LocalMagField:

Public Member Functions
	A01LocalMagField (Double_t Bx, Double_t By, Double_t Bz)
	A01LocalMagField ()
virtual	~A01LocalMagField ()
virtual void	Field (const Double_t *, Double_t *B)

Private Member Functions
	A01LocalMagField (const A01LocalMagField &)
A01LocalMagField &	operator= (const A01LocalMagField &)

Private Attributes
Double_t	fB [3]
	Magnetic field vector.

Detailed Description

Definition of a uniform magnetic field within a given region.

Date

Author

I. Hrivnacova; IPN, Orsay

Definition at line 29 of file A01LocalMagField.h.

Constructor & Destructor Documentation

A01LocalMagField() [1/3]

A01LocalMagField::A01LocalMagField	(	Double_t	Bx,
		Double_t	By,
		Double_t	Bz )

Standard constructor

Parameters

Bx	The x component of the field value (in kiloGauss)
By	The y component of the field value (in kiloGauss)
Bz	The z component of the field value (in kiloGauss)

Definition at line 26 of file A01LocalMagField.cxx.

  : TVirtualMagField("A01 magnetic field")
{
  /// Standard constructor
  /// \param Bx   The x component of the field value (in kiloGauss)
  /// \param By   The y component of the field value (in kiloGauss)
  /// \param Bz   The z component of the field value (in kiloGauss)
 
  fB[0] = Bx;
  fB[1] = By;
  fB[2] = Bz;
}

A01LocalMagField() [2/3]

A01LocalMagField::A01LocalMagField

(

)

Default constructor

Definition at line 40 of file A01LocalMagField.cxx.

                                   : TVirtualMagField()
{
  /// Default constructor
  fB[0] = 0.;
  fB[1] = 0.;
  fB[2] = 0.;
}

~A01LocalMagField()

A01LocalMagField::~A01LocalMagField ( )

virtual

Destructor

Definition at line 49 of file A01LocalMagField.cxx.

{
  /// Destructor
}

A01LocalMagField() [3/3]

A01LocalMagField::A01LocalMagField ( const A01LocalMagField & )

private

Member Function Documentation

Field()

void A01LocalMagField::Field ( const Double_t * , Double_t * B )

virtual

Fill in the field value B in the given position at x. The local field is uniform in the associated volume.

Parameters

B	The field value (in kiloGauss)

Definition at line 55 of file A01LocalMagField.cxx.

{
  /// Fill in the field value B in the given position at x.
  /// The local field is uniform in the associated volume.
  /// \param B   The field value (in kiloGauss)
 
  B[0] = fB[0];
  B[1] = fB[1];
  B[2] = fB[2];
}

operator=()

A01LocalMagField & A01LocalMagField::operator= ( const A01LocalMagField & )

private

Member Data Documentation

fB

Double_t A01LocalMagField::fB[3]

private

Magnetic field vector.

Definition at line 42 of file A01LocalMagField.h.

---

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

• examples/A01/include/A01LocalMagField.h
• examples/A01/src/A01LocalMagField.cxx