| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // class G4GlobalMagFieldMessenger
27 //
28 // Implementation of the G4GlobalMagFieldMessenger class
29 //
30 // Author: Ivana Hrivnacova, 28/08/2013 (ivana@ipno.in2p3.fr)
31 // --------------------------------------------------------------------
32
33 #include "G4GlobalMagFieldMessenger.hh"
34 #include "G4UniformMagField.hh"
35 #include "G4FieldManager.hh"
36 #include "G4TransportationManager.hh"
37 #include "G4UIdirectory.hh"
38 #include "G4UIcmdWith3VectorAndUnit.hh"
39 #include "G4UIcmdWithAnInteger.hh"
40 #include "G4UnitsTable.hh"
41 #include "G4SystemOfUnits.hh"
42
43 //______________________________________________________________________________
44
45 G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger(const G4ThreeVector& value)
46 {
47 fDirectory = new G4UIdirectory("/globalField/");
48 fDirectory->SetGuidance("Global uniform magnetic field UI commands");
49
50 fSetValueCmd = new G4UIcmdWith3VectorAndUnit("/globalField/setValue",this);
51 fSetValueCmd->SetGuidance("Set uniform magnetic field value.");
52 fSetValueCmd->SetParameterName("Bx", "By", "By", false);
53 fSetValueCmd->SetUnitCategory("Magnetic flux density");
54 fSetValueCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
55
56 fSetVerboseCmd = new G4UIcmdWithAnInteger("/globalField/verbose",this);
57 fSetVerboseCmd->SetGuidance("Set verbose level: ");
58 fSetVerboseCmd->SetGuidance(" 0: no output");
59 fSetVerboseCmd->SetGuidance(" 1: printing new field value");
60 fSetVerboseCmd->SetParameterName("globalFieldVerbose", false);
61 fSetVerboseCmd->SetRange("globalFieldVerbose>=0");
62 fSetVerboseCmd->AvailableForStates(G4State_PreInit,G4State_Idle);
63
64 // Create field
65 fMagField = new G4UniformMagField(value);
66
67 // Set field value (the field is not activated if value is zero)
68 SetField(value, "G4GlobalMagFieldMessenger::G4GlobalMagFieldMessenger");
69 }
70
71 //______________________________________________________________________________
72
73 G4GlobalMagFieldMessenger::~G4GlobalMagFieldMessenger()
74 {
75 delete fMagField;
76 delete fSetValueCmd;
77 delete fSetVerboseCmd;
78 delete fDirectory;
79 }
80
81 //______________________________________________________________________________
82
83 void G4GlobalMagFieldMessenger::SetField(const G4ThreeVector& value,
84 const G4String& /*inFunction*/)
85 {
86 // Get field manager (or create it if it does not yet exist)
87 G4FieldManager* fieldManager
88 = G4TransportationManager::GetTransportationManager()->GetFieldManager();
89
90 // Inactivate field if its value is zero
91 if ( value == G4ThreeVector() )
92 {
93 fieldManager->SetDetectorField(nullptr);
94 fieldManager->CreateChordFinder(nullptr);
95
96 if ( fVerboseLevel > 0 )
97 {
98 G4cout << "Magnetic field is inactive, fieldValue = (0,0,0)." << G4endl;
99 }
100 }
101 else
102 {
103 fMagField->SetFieldValue(value);
104 fieldManager->SetDetectorField(fMagField);
105 fieldManager->CreateChordFinder(fMagField);
106
107 if ( fVerboseLevel > 0 )
108 {
109 G4cout << "Magnetic field is active, fieldValue = ("
110 << G4BestUnit(value, "Magnetic flux density")
111 << ")." << G4endl;
112 }
113 }
114 }
115
116 //______________________________________________________________________________
117
118 void G4GlobalMagFieldMessenger::SetNewValue(G4UIcommand* command, G4String newValue)
119 {
120 if ( command == fSetValueCmd )
121 {
122 SetField(fSetValueCmd->GetNew3VectorValue(newValue),
123 "G4GlobalMagFieldMessenger::SetNewValue");
124 }
125 else if ( command == fSetVerboseCmd )
126 {
127 SetVerboseLevel(fSetVerboseCmd->GetNewIntValue(newValue));
128 }
129 }
130
131 //______________________________________________________________________________
132
133 void G4GlobalMagFieldMessenger::SetFieldValue(const G4ThreeVector& value)
134 {
135 SetField(value, "G4GlobalMagFieldMessenger::SetFieldValue");
136 }
137
138 //______________________________________________________________________________
139
140 G4ThreeVector G4GlobalMagFieldMessenger::GetFieldValue() const
141 {
142 if ( fMagField != nullptr ) { return fMagField->GetConstantFieldValue(); }
143
144 return {};
145 }
146