#include <G4GlobalMagFieldMessenger.hh>

Inheritance diagram for G4GlobalMagFieldMessenger:

Collaboration diagram for G4GlobalMagFieldMessenger:

Public Member Functions
	G4GlobalMagFieldMessenger (const G4ThreeVector &value=G4ThreeVector())

virtual	~G4GlobalMagFieldMessenger ()

virtual void	SetNewValue (G4UIcommand *, G4String)

void	SetFieldValue (const G4ThreeVector &value)

G4ThreeVector	GetFieldValue () const

void	SetVerboseLevel (G4int verboseLevel)

G4int	GetVerboseLevel () const

Public Member Functions inherited from G4UImessenger
	G4UImessenger ()

	G4UImessenger (const G4String &path, const G4String &dsc, G4bool commandsToBeBroadcasted=true)

virtual	~G4UImessenger ()

virtual G4String	GetCurrentValue (G4UIcommand *command)

G4bool	operator== (const G4UImessenger &messenger) const

G4bool	CommandsShouldBeInMaster () const

Private Member Functions
void	SetField (const G4ThreeVector &value, const G4String &inFunction)

Private Attributes
G4UniformMagField *	fMagField

G4int	fVerboseLevel

G4UIdirectory *	fDirectory

G4UIcmdWith3VectorAndUnit *	fSetValueCmd

G4UIcmdWithAnInteger *	fSetVerboseCmd

Additional Inherited Members
Protected Member Functions inherited from G4UImessenger
G4String	ItoS (G4int i)

G4String	DtoS (G4double a)

G4String	BtoS (G4bool b)

G4int	StoI (G4String s)

G4double	StoD (G4String s)

G4bool	StoB (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

G4String	baseDirName

G4bool	commandsShouldBeInMaster

Detailed Description

Definition at line 56 of file G4GlobalMagFieldMessenger.hh.

Constructor & Destructor Documentation

◆ G4GlobalMagFieldMessenger()

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

Definition at line 49 of file G4GlobalMagFieldMessenger.cc.

  : G4UImessenger(),
    fMagField(0),
    fVerboseLevel(0),
    fDirectory(0),
    fSetValueCmd(0),
    fSetVerboseCmd(0)
 {
   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");
 }

Here is the call graph for this function:

◆ ~G4GlobalMagFieldMessenger()

G4GlobalMagFieldMessenger::~G4GlobalMagFieldMessenger ( )

virtual

Definition at line 83 of file G4GlobalMagFieldMessenger.cc.

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

Member Function Documentation

◆ GetFieldValue()

G4ThreeVector G4GlobalMagFieldMessenger::GetFieldValue ( ) const

Definition at line 150 of file G4GlobalMagFieldMessenger.cc.

 {
   if ( fMagField ) return fMagField->GetConstantFieldValue();
   
   return G4ThreeVector();
 }  

Here is the call graph for this function:

◆ GetVerboseLevel()

G4int G4GlobalMagFieldMessenger::GetVerboseLevel ( ) const

inline

Definition at line 88 of file G4GlobalMagFieldMessenger.hh.

89 { return fVerboseLevel; }

G4GlobalMagFieldMessenger::fVerboseLevel

G4int fVerboseLevel

Definition: G4GlobalMagFieldMessenger.hh:76

◆ SetField()

void G4GlobalMagFieldMessenger::SetField	(	const G4ThreeVector &	value,
		const G4String &	inFunction
	)

private

Definition at line 93 of file G4GlobalMagFieldMessenger.cc.

 {
   // Get field manager (or create it if it does not yet exist)
   G4FieldManager* fieldManager
     = G4TransportationManager::GetTransportationManager()->GetFieldManager();
 
   // Inactivate field if its value is zero
   if ( value == G4ThreeVector() )
   {
     fieldManager->SetDetectorField(0);
     fieldManager->CreateChordFinder(0);
     
     if ( fVerboseLevel > 0 )
     {
       G4cout << "Magnetic field is inactive, fieldValue = (0,0,0)." << G4endl;
     }
   } 
   else
   { 
     fMagField->SetFieldValue(value);
     fieldManager->SetDetectorField(fMagField);
     fieldManager->CreateChordFinder(fMagField);
     
     if ( fVerboseLevel > 0 )
     {
       G4cout << "Magnetic field is active, fieldValue = (" 
              << G4BestUnit(value, "Magnetic flux density") 
              << ")." << G4endl;
     }
   }  
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetFieldValue()

void G4GlobalMagFieldMessenger::SetFieldValue ( const G4ThreeVector & value )

Definition at line 143 of file G4GlobalMagFieldMessenger.cc.

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

Here is the call graph for this function:

◆ SetNewValue()

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

virtual

Reimplemented from G4UImessenger.

Definition at line 128 of file G4GlobalMagFieldMessenger.cc.

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