G4GlobalMagFieldMessenger, a global uniform magnetic field messenger class. It creates/deletes the global uniform magnetic field and activates/inactivates it according to the set field value. The field value can be changed either interactively via the UI command or via the SetFieldValue() function. More...

#include <G4GlobalMagFieldMessenger.hh>

Inheritance diagram for G4GlobalMagFieldMessenger:

Public Member Functions
	G4GlobalMagFieldMessenger (const G4ThreeVector &value=G4ThreeVector())
	~G4GlobalMagFieldMessenger () override
void	SetNewValue (G4UIcommand *, G4String) override
void	SetFieldValue (const G4ThreeVector &value)
G4ThreeVector	GetFieldValue () const
void	SetVerboseLevel (G4int verboseLevel)
G4int	GetVerboseLevel () const
Public Member Functions inherited from G4UImessenger
	G4UImessenger ()=default
	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
virtual	~G4UImessenger ()
virtual G4String	GetCurrentValue (G4UIcommand *command)
G4bool	CommandsShouldBeInMaster () const

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)
G4String	LtoS (G4long l)
G4String	DtoS (G4double a)
G4String	BtoS (G4bool b)
G4int	StoI (const G4String &s)
G4long	StoL (const G4String &s)
G4double	StoD (const G4String &s)
G4bool	StoB (const G4String &s)
void	AddUIcommand (G4UIcommand *newCommand)
void	CreateDirectory (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)
template<typename T>
T *	CreateCommand (const G4String &cname, const G4String &dsc)
Protected Attributes inherited from G4UImessenger
G4UIdirectory *	baseDir = nullptr
G4String	baseDirName = ""
G4bool	commandsShouldBeInMaster = false

Detailed Description

G4GlobalMagFieldMessenger, a global uniform magnetic field messenger class. It creates/deletes the global uniform magnetic field and activates/inactivates it according to the set field value. The field value can be changed either interactively via the UI command or via the SetFieldValue() function.

Definition at line 62 of file G4GlobalMagFieldMessenger.hh.

Constructor & Destructor Documentation

◆ G4GlobalMagFieldMessenger()

G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger ( const G4ThreeVector & value = G4ThreeVector() )

Constructor and Destructor.

Definition at line 43 of file G4GlobalMagFieldMessenger.cc.

{
  fDirectory = new G4UIdirectory("/globalField/");
  fDirectory->SetGuidance("Global uniform magnetic field UI commands");
  
  fSetValueCmd = new G4UIcmdWith3VectorAndUnit("/globalField/setValue",this);
  fSetValueCmd->SetGuidance("Set uniform magnetic field value.");
  fSetValueCmd->SetParameterName("Bx", "By", "By", false);
  fSetValueCmd->SetUnitCategory("Magnetic flux density");
  fSetValueCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  fSetVerboseCmd = new G4UIcmdWithAnInteger("/globalField/verbose",this);
  fSetVerboseCmd->SetGuidance("Set verbose level: ");
  fSetVerboseCmd->SetGuidance("  0: no output");
  fSetVerboseCmd->SetGuidance("  1: printing new field value");
  fSetVerboseCmd->SetParameterName("globalFieldVerbose", false);
  fSetVerboseCmd->SetRange("globalFieldVerbose>=0");
  fSetVerboseCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
  
  // Create field
  fMagField = new G4UniformMagField(value);
  
  // Set field value (the field is not activated if value is zero)
  SetField(value, "G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger");
}

◆ ~G4GlobalMagFieldMessenger()

G4GlobalMagFieldMessenger::~G4GlobalMagFieldMessenger ( )

override

Definition at line 71 of file G4GlobalMagFieldMessenger.cc.

{
  delete fMagField;
  delete fSetValueCmd;
  delete fSetVerboseCmd;
  delete fDirectory;
}

Member Function Documentation

◆ GetFieldValue()

G4ThreeVector G4GlobalMagFieldMessenger::GetFieldValue ( ) const

Definition at line 138 of file G4GlobalMagFieldMessenger.cc.

{
  if ( fMagField != nullptr ) { return fMagField->GetConstantFieldValue(); }
  
  return {};
}  

◆ GetVerboseLevel()

G4int G4GlobalMagFieldMessenger::GetVerboseLevel ( ) const

inline

Definition at line 110 of file G4GlobalMagFieldMessenger.hh.

{
  return fVerboseLevel;
}

◆ SetFieldValue()

void G4GlobalMagFieldMessenger::SetFieldValue ( const G4ThreeVector & value )

Setter and accessor for the field value.

Definition at line 131 of file G4GlobalMagFieldMessenger.cc.

{
  SetField(value, "G4GlobalMagFieldMessenger::SetFieldValue");
}  

◆ SetNewValue()

void G4GlobalMagFieldMessenger::SetNewValue	(	G4UIcommand *	command,
		G4String	newValue )

overridevirtual

Setter for UI command.

Reimplemented from G4UImessenger.

Definition at line 116 of file G4GlobalMagFieldMessenger.cc.

{
  if ( command == fSetValueCmd )
  {
    SetField(fSetValueCmd->GetNew3VectorValue(newValue),
             "G4GlobalMagFieldMessenger::SetNewValue");
  }
  else if ( command == fSetVerboseCmd )
  {
    SetVerboseLevel(fSetVerboseCmd->GetNewIntValue(newValue));
  }  
}

◆ SetVerboseLevel()

void G4GlobalMagFieldMessenger::SetVerboseLevel ( G4int verboseLevel )

inline

Verbosity control.

Definition at line 105 of file G4GlobalMagFieldMessenger.hh.

{
  fVerboseLevel = verboseLevel;
}

Referenced by SetNewValue().

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

Public Member Functions

Additional Inherited Members