B5MagneticField Class Reference

Magnetic field. More...

#include <B5MagneticField.hh>

Inheritance 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

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.cxx.

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

~B5MagneticField()

B5MagneticField::~B5MagneticField ( )

virtual

Definition at line 48 of file B5MagneticField.cxx.

{ delete fMessenger; }

Member Function Documentation

GetFieldValue()

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

virtual

Definition at line 50 of file B5MagneticField.cxx.

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

GetField()

G4double B5MagneticField::GetField ( ) const

inline

Definition at line 50 of file B5MagneticField.hh.

{ return fBy; }

DefineCommands()

void B5MagneticField::DefineCommands ( )

private

Definition at line 59 of file B5MagneticField.cxx.

{
  // 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.");
}

Member Data Documentation

fMessenger

G4GenericMessenger* B5MagneticField::fMessenger

private

Definition at line 55 of file B5MagneticField.hh.

fBy

G4double B5MagneticField::fBy

private

Definition at line 56 of file B5MagneticField.hh.

---

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

• examples/A01/geant4/include/B5MagneticField.hh
• examples/A01/geant4/src/B5MagneticField.cxx