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