B5MagneticField Class Reference

Magnetic field. More...

#include <B5MagneticField.hh>

Inheritance diagram for B5MagneticField:

Collaboration diagram for B5MagneticField:

Public Member Functions
	B5MagneticField ()
virtual	~B5MagneticField ()
virtual void	GetFieldValue (const G4double point[4], double *bField) const
void	SetField (G4double val)
G4double	GetField () const
Public Member Functions inherited from G4MagneticField
	G4MagneticField ()
virtual	~G4MagneticField ()
	G4MagneticField (const G4MagneticField &r)
G4MagneticField &	operator= (const G4MagneticField &p)
G4bool	DoesFieldChangeEnergy () const
Public Member Functions inherited from G4ElectroMagneticField
	G4ElectroMagneticField ()
virtual	~G4ElectroMagneticField ()
	G4ElectroMagneticField (const G4ElectroMagneticField &r)
G4ElectroMagneticField &	operator= (const G4ElectroMagneticField &p)
Public Member Functions inherited from G4Field
	G4Field (G4bool gravityOn=false)
	G4Field (const G4Field &)
virtual	~G4Field ()
G4Field &	operator= (const G4Field &p)
G4bool	IsGravityActive () const
void	SetGravityActive (G4bool OnOffFlag)
virtual G4Field *	Clone () const

Private Member Functions
void	DefineCommands ()

Private Attributes
G4GenericMessenger *	fMessenger
G4double	fBy

Detailed Description

Magnetic field.

Definition at line 41 of file B5MagneticField.hh.

Constructor & Destructor Documentation

B5MagneticField()

B5MagneticField::B5MagneticField

(

)

Definition at line 39 of file B5MagneticField.cc.

: G4MagneticField(), fMessenger(0), fBy(1.0*tesla)
{
    // define commands for this class
    DefineCommands();
}

Here is the call graph for this function:

~B5MagneticField()

B5MagneticField::~B5MagneticField ( )

virtual

Definition at line 48 of file B5MagneticField.cc.

{ 
    delete fMessenger; 
}

Member Function Documentation

DefineCommands()

void B5MagneticField::DefineCommands ( )

private

Definition at line 62 of file B5MagneticField.cc.

{
    // Define /B5/field command directory using generic messenger class
    fMessenger = new G4GenericMessenger(this, 
                                        "/B5/field/", 
                                        "Field control");

    // fieldValue command 
    G4GenericMessenger::Command& valueCmd
      = fMessenger->DeclareMethodWithUnit("value","tesla",
                                  &B5MagneticField::SetField, 
                                  "Set field strength.");
    valueCmd.SetParameterName("field", true);
    valueCmd.SetDefaultValue("1.");
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetField()

G4double B5MagneticField::GetField ( ) const

inline

Definition at line 50 of file B5MagneticField.hh.

{ return fBy; }

Here is the call graph for this function:

GetFieldValue()

void B5MagneticField::GetFieldValue ( const G4double  point[4], double *  bField  ) const

virtual

Implements G4MagneticField.

Definition at line 53 of file B5MagneticField.cc.

{
    bField[0] = 0.;
    bField[1] = fBy;
    bField[2] = 0.;
}

SetField()

void B5MagneticField::SetField ( G4double  val )

inline

Definition at line 49 of file B5MagneticField.hh.

{ fBy = val; }

Here is the caller graph for this function:

Member Data Documentation

fBy

G4double B5MagneticField::fBy

private

Definition at line 56 of file B5MagneticField.hh.

fMessenger

G4GenericMessenger* B5MagneticField::fMessenger

private

Definition at line 55 of file B5MagneticField.hh.

---

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

• B5MagneticField.hh
• B5MagneticField.cc