B5::MagneticField Class Reference

Magnetic field. More...

#include <Doxymodules_basic.h>

Inheritance diagram for B5::MagneticField:

Public Member Functions
	MagneticField ()
	~MagneticField () override
void	GetFieldValue (const G4double point[4], double *bField) const override
void	SetField (G4double val)
G4double	GetField () const

Private Member Functions
void	DefineCommands ()

Private Attributes
G4GenericMessenger *	fMessenger = nullptr
G4double	fBy = 1.0*CLHEP::tesla

Detailed Description

Magnetic field.

Definition at line 196 of file Doxymodules_basic.h.

Constructor & Destructor Documentation

MagneticField()

B5::MagneticField::MagneticField

(

)

Definition at line 41 of file MagneticField.cc.

{
  // define commands for this class
  DefineCommands();
}

~MagneticField()

B5::MagneticField::~MagneticField ( )

override

Definition at line 49 of file MagneticField.cc.

{
  delete fMessenger;
}

Member Function Documentation

GetFieldValue()

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

override

Definition at line 54 of file MagneticField.cc.

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

SetField()

void B5::MagneticField::SetField ( G4double  val )

inline

Definition at line 53 of file MagneticField.hh.

{ fBy = val; }

GetField()

G4double B5::MagneticField::GetField ( ) const

inline

Definition at line 54 of file MagneticField.hh.

{ return fBy; }

DefineCommands()

void B5::MagneticField::DefineCommands ( )

private

Definition at line 63 of file MagneticField.cc.

{
  // Define /B5/field command directory using generic messenger class
  fMessenger = new G4GenericMessenger(this,
                                      "/B5/field/",
                                      "Field control");
 
  // fieldValue command
  auto& valueCmd
    = fMessenger->DeclareMethodWithUnit("value","tesla",
                                &MagneticField::SetField,
                                "Set field strength.");
  valueCmd.SetParameterName("field", true);
  valueCmd.SetDefaultValue("1.");
}

Member Data Documentation

fMessenger

G4GenericMessenger* B5::MagneticField::fMessenger = nullptr

private

Definition at line 59 of file MagneticField.hh.

fBy

G4double B5::MagneticField::fBy = 1.0*CLHEP::tesla

private

Definition at line 60 of file MagneticField.hh.

---

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

• .doxygen/Doxymodules_basic.h
• basic/B5/include/MagneticField.hh
• basic/B5/src/MagneticField.cc